GET /api/users/{UserID}/preferences/{PreferenceName}

Returns the value of the specified user preference.

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

Back to top

Sample Request

The example below shows a request for the value of a specific user preference.

Request URL

https://{hostname}/api/users/a71553bd-5ac5-4230-aa6d-c315bae0f781.acmepaymentscorp/preferences/com.soa.helptext.edit.profile.helpClosed

Sample request headers

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

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
UserID Path string Required The unique ID for a specific user.
PreferenceName Path string Required The name of the user preference; for example, com.soa.helptext.edit.profile.helpClosed. For a list of valid values, see User Preferences.

Back to top

Response

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

Back to top

Sample Response

The sample response below shows the value of the requested user preference.

Sample response headers

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

Sample response body

{
  "Value" : "open"
}

Back to top

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

Back to top

Response Body

Name Type Description
UserPreference UserPreference Contains information about a user preference.

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.

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.

Back to top

Related Topics