Friends and Followers | Elements Manual

Elements Manual

Search Followers

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

get

/follower/{profileId}

Authorizations

Path parameters

profileIdanyrequired

Query parameters

offsetany · default: 0

countany · default: 20

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/follower/{profileId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Search Followers

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

get

/followee/{profileId}

Authorizations

Path parameters

profileIdanyrequired

Query parameters

offsetany · default: 0

countany · default: 20

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/followee/{profileId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "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.

post

/follower/{profileId}

Authorizations

Path parameters

profileIdanyrequired

Body

followedIdanyrequired

The profile id which to follow.

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/follower/{profileId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "followedId": null
  }'

400

401

403

404

409

500

501

503

default

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

Deletes a Follower relationship

delete

/follower/{profileId}//{profileToUnfollowId}

Authorizations

Path parameters

profileIdanyrequired

profileToUnfollowIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/follower/{profileId}/{profileToUnfollowId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

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

get

/follower/{profileId}//{followedId}

Authorizations

Path parameters

profileIdanyrequired

followedIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/follower/{profileId}/{followedId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Gets a Specific Friend

Gets a specific friend using the ID of the friend.

get

/friend/{friendId}

Authorizations

Path parameters

friendIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/friend/{friendId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Deletes a Friend

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

delete

/friend/{friendId}

Authorizations

Path parameters

friendIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/friend/{friendId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Search Friends

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

get

/friend

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

searchany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/friend' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "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.

get

/friend_uninvited/facebook

Authorizations

Query parameters

applicationany

applicationConfigurationany

offsetany · default: 0

countany · default: 20

Header parameters

Facebook-OAuthTokenany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/friend_uninvited/facebook' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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