GET /api/users/{UserID}/following/{ResourceID}

Returns the unique ID (FollowingID) for the relationship between the specified user and the specified resource.

The FollowingID is used in the Following service by the unfollow operation.

Authorization Roles/Permissions: Must be logged in. Self (logged in) or Site Admin (for any user).

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/users/{UserID}/following/{ResourceID}

Sample Request

The example below shows a request for a specific FollowingID.

Sample Request URL

https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/following/api14806.acmepaymentscorp

Sample request headers

Accept: text/plain

Sample request body

Not applicable.

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	text/plain
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
UserID	Path	string	Required	The unique ID for a specific user.
ResourceID	Path	string	Required	The unique ID for a specific resource; for example, the ScopeID or the APIVersionID.

Response

If successful, this operation returns HTTP status code 200, with the unique ID for the "following" relationship between the specified user and the specified resource.

Sample Response

The sample response below shows a successful outcome, and the FollowingID is returned.

Sample response headers

Status Code: 200 OK
Content-Type: text/plain
Date: Thu, 16 May 2013 20:31:14 GMT

Sample response body

follow15927.acmepaymentscorp

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	text/plain

Response Body

Name	Type	Description
Response	FollowingID	The unique ID for the "following" relationship between the specified user and the specified resource.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
406	Not Acceptable. Returned if there is a problem with the request format. For example, you would get this if you specified an incorrect media type for the Accept header.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics