Skip to content

API Doc: Check Friendship Access

Carson McLean edited this page Nov 30, 2016 · 4 revisions

GET /api/friends/{authorid1}/{authorid2}

With HTTP GET it is used to checked whether {authorid1} and {authorid2} are friends.

It returns a JSON object that contains the query, the specified authors, and a boolean of whether the authors are friends.

Here is an example of a response that contains 2 author friends:
GET /api/friends/de305d54-75b4-431b-adb2-eb6b9e546013/ae345d54-75b4-431b-adb2-fb6b9e547891 HTTP/1.1
Header: Value

200 Ok ...

{	"query":"friends",
        "authors":[
            "de305d54-75b4-431b-adb2-eb6b9e546013",
            "ae345d54-75b4-431b-adb2-fb6b9e547891"
        ],
        "friends": true
}

Clone this wiki locally