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: Self (logged in) or Site Admin (for any user).

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

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

Back to top

Sample Request

The example below shows a request for a specific FollowingID.

Request URL

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

Sample request headers

Accept: text/plain
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

Not applicable.

Back to top

Request Headers

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

Header Description
Accept text/plain

Back to top

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.

Back to top

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.

Back to top

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

Back to top

Response Headers

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

Header Description
Content-Type text/plain

Back to top

Response Body

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

Back to top

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.
406 Not acceptable. For example, you would get this if you specified an inapplicable value for the Accept header.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics