Friends and Followers

Search Followers

get

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

Authorizations

auth_bearersession_secret

AuthorizationstringRequired

Path parameters

profileIdanyRequired

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

/follower/{profileId}

HTTPcURLJavaScriptPython

GET /api/rest/follower/{profileId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Search Followers

get

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

Authorizations

auth_bearersession_secret

AuthorizationstringRequired

Path parameters

profileIdanyRequired

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

/followee/{profileId}

HTTPcURLJavaScriptPython

GET /api/rest/followee/{profileId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Creates a Follower relationship between two profiles.

post

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

Authorizations

auth_bearersession_secret

AuthorizationstringRequired

Path parameters

profileIdanyRequired

Body

*/*

Represents a request to follow a player Follower.

followedIdanyRequired

The profile id which to follow.

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

*/*

post

/follower/{profileId}

HTTPcURLJavaScriptPython

POST /api/rest/follower/{profileId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 19

{
  "followedId": null
}

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

Deletes a Follower relationship

delete

Authorizations

auth_bearersession_secret

AuthorizationstringRequired

Path parameters

profileIdanyRequired

profileToUnfollowIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

delete

/follower/{profileId}/{profileToUnfollowId}

HTTPcURLJavaScriptPython

DELETE /api/rest/follower/{profileId}/{profileToUnfollowId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

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

get

Authorizations

auth_bearersession_secret

AuthorizationstringRequired

Path parameters

profileIdanyRequired

followedIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

/follower/{profileId}/{followedId}

HTTPcURLJavaScriptPython

GET /api/rest/follower/{profileId}/{followedId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Gets a Specific Friend

get

Gets a specific friend using the ID of the friend.

Authorizations

auth_bearersession_secret

AuthorizationstringRequired

Path parameters

friendIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

/friend/{friendId}

HTTPcURLJavaScriptPython

GET /api/rest/friend/{friendId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Deletes a Friend

delete

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

Authorizations

auth_bearersession_secret

AuthorizationstringRequired

Path parameters

friendIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

delete

/friend/{friendId}

HTTPcURLJavaScriptPython

DELETE /api/rest/friend/{friendId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Search Friends

get

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

Authorizations

auth_bearersession_secret

AuthorizationstringRequired

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

searchanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

/friend

HTTPcURLJavaScriptPython

GET /api/rest/friend HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Get Univited Facebook Friends

get

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

Authorizations

auth_bearersession_secret

AuthorizationstringRequired

Query parameters

applicationanyOptional

applicationConfigurationanyOptional

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

Header parameters

Facebook-OAuthTokenanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

/friend_uninvited/facebook

HTTPcURLJavaScriptPython

GET /api/rest/friend_uninvited/facebook HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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