Friends and Followers | Elements Manual

Search Followers

Searches all followers in the system and returning the metadata for all matches against the given profile id.

GEThttp://localhost:8080/api/rest/follower/{profileId}

Path parameters

profileId*any

Query parameters

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/follower/{profileId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "code": "text",
  "message": "text"
}

Search Followers

Searches all followers in the system and returning the metadata for all matches against the given profile id.

GEThttp://localhost:8080/api/rest/followee/{profileId}

Path parameters

profileId*any

Query parameters

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/followee/{profileId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "code": "text",
  "message": "text"
}

Creates a Follower relationship between two profiles.

Supplying the follower object, this will store the information supplied in the body of the request.

POSThttp://localhost:8080/api/rest/follower/{profileId}

Path parameters

profileId*any

Body

followedId*any

The profile id which to follow.

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/follower/{profileId}', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "code": "text",
  "message": "text"
}

Deletes a Follower relationship

DELETEhttp://localhost:8080/api/rest/follower/{profileId}/{profileToUnfollowId}

Path parameters

profileId*any

profileToUnfollowId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/follower/{profileId}/{profileToUnfollowId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "code": "text",
  "message": "text"
}

Gets a specific profile using the ID of the profile and followed id.

GEThttp://localhost:8080/api/rest/follower/{profileId}/{followedId}

Path parameters

profileId*any

followedId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/follower/{profileId}/{followedId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "code": "text",
  "message": "text"
}

Gets a Specific Friend

Gets a specific friend using the ID of the friend.

GEThttp://localhost:8080/api/rest/friend/{friendId}

Path parameters

friendId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/friend/{friendId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "code": "text",
  "message": "text"
}

Deletes a Friend

Once a friend is deleted, re-creating a friend will set the friendship status to outgoing.

DELETEhttp://localhost:8080/api/rest/friend/{friendId}

Path parameters

friendId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/friend/{friendId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "code": "text",
  "message": "text"
}

Search Friends

Searches all friends in the system and returning the metadata for all matches against the given search filter.

GEThttp://localhost:8080/api/rest/friend

Query parameters

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/friend', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "code": "text",
  "message": "text"
}

Get Univited Facebook Friends

Returns the list of all Facebook friends who have not created a profile for the current application.

GEThttp://localhost:8080/api/rest/friend_uninvited/facebook

Query parameters

Header parameters

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/friend_uninvited/facebook', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "code": "text",
  "message": "text"
}