/friend
Gets a specific friend using the ID of the friend.
Authorizations
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
GET /api/rest/friend/{friendId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
"code": "text",
"message": "text"
}
Once a friend is deleted, re-creating a friend will set the friendship status to outgoing.
Authorizations
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
DELETE /api/rest/friend/{friendId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
"code": "text",
"message": "text"
}
Searches all friends in the system and returning the metadata for all matches against the given search filter.
Authorizations
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
GET /api/rest/friend HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
"code": "text",
"message": "text"
}
Last updated