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
AuthorizationstringRequired
Path parameters
profileIdanyRequired
Query parameters
offsetanyOptionalDefault: 0
countanyOptionalDefault: 20
Responses
get
/follower/{profileId}
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
AuthorizationstringRequired
Path parameters
profileIdanyRequired
Query parameters
offsetanyOptionalDefault: 0
countanyOptionalDefault: 20
Responses
get
/followee/{profileId}
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
AuthorizationstringRequired
Path parameters
profileIdanyRequired
Body

Represents a request to follow a player Follower.

followedIdanyRequired

The profile id which to follow.

Responses
post
/follower/{profileId}
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
AuthorizationstringRequired
Path parameters
profileIdanyRequired
profileToUnfollowIdanyRequired
Responses
delete
/follower/{profileId}/{profileToUnfollowId}
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
AuthorizationstringRequired
Path parameters
profileIdanyRequired
followedIdanyRequired
Responses
get
/follower/{profileId}/{followedId}
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
AuthorizationstringRequired
Path parameters
friendIdanyRequired
Responses
get
/friend/{friendId}
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
AuthorizationstringRequired
Path parameters
friendIdanyRequired
Responses
delete
/friend/{friendId}
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
AuthorizationstringRequired
Query parameters
offsetanyOptionalDefault: 0
countanyOptionalDefault: 20
searchanyOptional
Responses
get
/friend
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
AuthorizationstringRequired
Query parameters
applicationanyOptional
applicationConfigurationanyOptional
offsetanyOptionalDefault: 0
countanyOptionalDefault: 20
Header parameters
Facebook-OAuthTokenanyOptional
Responses
get
/friend_uninvited/facebook
GET /api/rest/friend_uninvited/facebook HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
  "code": "text",
  "message": "text"
}

Last updated