GET /api/users/{UserID}/preferences

Returns all the preferences saved for the user.

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}/preferences

Sample Request

The example below shows a request for the preferences for the specified user.

Sample Request URL

https://api.acmepaymentscorp.com/users/a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp/preferences

Sample request headers

Accept: application/json

Sample request body

Not applicable.

Request Headers

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

Header	Description
Accept	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
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.

Response

If successful, this operation returns HTTP status code 200, with the user preferences for the specified user.

Sample Response

The sample response below shows the user preferences for the specified user.

Sample response headers

Status Code: 200 OK
Content-Type: application/json
Date: Tue, 21 May 2013 17:26:26 GMT

Sample response body

{
  "UserPreference" : [ {
    "Name" : "com.soa.helptext.dashboard.helpClosed",
    "Value" : "closed"
  }, {
    "Name" : "com.soa.helptext.edit.profile.helpClosed",
    "Value" : "open"
  }, {
    "Name" : "com.soa.helptext.myapps.home.helpClosed",
    "Value" : "closed"
  } ]
}

Response Headers

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

Header	Description
Content-Type	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Response Body

Name	Type	Description
UserPreferences	UserPreferences	Contains information about the preferences a user has set regarding what shows and doesn't show in the user interface.

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. You would also get this response if you hadn't completed login before running the operation, or if you had the wrong UserID.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics