POST /api/users/{UserID}/preferences

Changes the value of a user preference.

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

This topic includes the following sections:

HTTP Method

POST

Back to top

URL

https://{hostname}/api/users/{UserID}/preferences

Back to top

Sample Request

The example below shows a change in user preference regarding display of the Dashboard help.

Sample request URL

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

Sample request headers

POST /api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/preferences/ HTTP/1.1
Host:{hostname}
Accept: */*
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

{
  "Name":"com.soa.helptext.dashboard.helpClosed",
  "Value":"open"
}

Back to top

Request Headers

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

Header Description
Accept text/plain
Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
UserID Path string Required The unique ID for a specific user.
UserPreference Body UserPreference Required Contains information about a user preference.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the UserID in plain text.

Back to top

Sample Response

The sample response below shows successful update of this user's preferences.

Sample response headers

HTTP/1.1 200 OK
Date: Wed, 18 Jul 2012 19:01:59 GMT
Content-Type: text/plain

Sample response body

522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.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
UserID string The unique ID for a specific user.

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