GET /api/users/{UserID}/notifications/count

Returns the number of current notifications for a 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

Back to top

URL

https://{hostname}/api/users/{UserID}/notifications/count

Back to top

Sample Request

The example below shows a request for the notifications count for the specified user.

Request URL

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

Sample request headers

Accept: text/plain

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
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 notifications count for the specified user.

Back to top

Sample Response

The sample response below shows that the specified user has 12 notifications.

Sample response headers

Status Code: 200 OK
Content-Type: text/plain
Date: Tue, 21 May 2013 16:14:03 GMT

Sample response body

12

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 string A number indicating how many notifications the user has. Archived notifications are not included; the number indicates how many notifications currently appear on the user's Dashboard.

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.

500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics