GET /api/users/{UserID}/settings

Returns the account settings of a user, including UserID, email address, and the notification events for which the user has opted to receive emails.

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

Back to top

URL

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

Back to top

Sample Request

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

Request URL

https://{hostname}/api/users/45742f96-aad2-45d8-b507-420cf07c87ff.acmepaymentscorp/settings

Sample request headers

Accept: application/json

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
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.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
UserID Path string Required The unique ID for a specific user.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the user's account settings in JSON format.

Back to top

Sample Response

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

Sample response headers

Status Code: 200 OK
Content-Type: application/json
Date:  Tue, 13 Dec 2016 23:01:51 GMT

Sample response body

In the example below, line breaks have been added for display purposes.

{
  "UserID":"45742f96-aad2-45d8-b507-420cf07c87ff.acmepaymentscorp",
  "Email":"administrator@acmepaymentscorp",
  "OptedNotification":[
    "com.soa.notification.type.news.update",
    "com.soa.notification.type.appteam",
    "com.soa.notification.type.post.comment",
    "com.soa.notification.type.privateapi",
    "com.soa.notification.type.api.auto.connect",
    "com.soa.notification.type.contract.state.change",
    "com.soa.notification.type.app.lifecycle",
    "com.soa.notification.type.app.alert",
    "com.soa.notification.type.app.post",
    "com.soa.notification.type.ticket.change"
  ]
}

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
AccountSettings AccountSettings Contains information about the user's account settings, including basic information and the user's choices with regard to notification emails.

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 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.

404 The resource could not be found. For example, you might get this if you have a typo in the URL, or if the Accept header is set to a wrong value.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics