GET /api/users/{UserID}/notifications
Returns unarchived notifications for the specified 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}/notifications
Sample Request
The example below requests the first 5 notifications for the specified user.
Sample Request URL
https://{hostname}/api/users/ef676bf9-bbc9-43eb-b5dd-8c1997ce88bf.acmepaymentscorp/notifications?count=5
Sample request headers
GET /api/users/ef676bf9-bbc9-43eb-b5dd-8c1997ce88bf.acmepaymentscorp/notifications?count=5
Host: {hostname}
Accept: application/json, text/javascript, */*; q=0.01
Sample request body
Not applicable.
Request Headers
For general information on request header values, refer to HTTP Request Headers.
| Header | Description |
|---|---|
| Accept | application/json, text/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml |
| 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. |
| start | Query | integer | Optional | An index number indicating the starting point for the results to be returned. If not specified, results start at position 0, the first result. |
| count | Query | integer | Optional | The number of results to be returned, from the specified starting point. If not specified, all matching results are returned. |
Response
If successful, this operation returns HTTP status code 200, with information about the user's notifications in an RSS channel formatted as JSON or XML.
Sample Response
The sample response below shows six notifications returned.
Sample response headers
HTTP/1.1 200 OK Content-Type: application/json Date: Thu, 11 Mar 2021 16:00:32 GMT
Sample response body: application/json
{
"channel":{
"title":"User Notifications",
"description":"",
"startIndex":0,
"totalResults":21,
"itemsPerPage":21,
"item":[
{
"title":"App puzzle Postman",
"description":"App Team invitation issued",
"category":[
{
"value":"com.soa.notification.type.appteam.member.invited.team",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1032.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 15:59:30 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"group_member_req10110.acmepaymentscorp",
"Guid":"group_member_req10110.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"App puzzle Postman",
"description":"App Team invitation issued",
"category":[
{
"value":"com.soa.notification.type.appteam.member.invited.team",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1030.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 15:59:30 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"group_member_req10109.acmepaymentscorp",
"Guid":"group_member_req10109.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"App puzzle Postman",
"description":"App Team invitation issued",
"category":[
{
"value":"com.soa.notification.type.appteam.member.invited.team",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1028.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 15:59:30 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"group_member_req10108.acmepaymentscorp",
"Guid":"group_member_req10108.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"Game App",
"description":"App Team invitation issued",
"category":[
{
"value":"com.soa.notification.type.appteam.member.invited.team",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1024.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 15:59:00 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"group_member_req10105.acmepaymentscorp",
"Guid":"group_member_req10105.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"Game App",
"description":"App Team invitation issued",
"category":[
{
"value":"com.soa.notification.type.appteam.member.invited.team",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1022.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 15:59:00 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"group_member_req10106.acmepaymentscorp",
"Guid":"group_member_req10106.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"Game App",
"description":"App Team invitation issued",
"category":[
{
"value":"com.soa.notification.type.appteam.member.invited.team",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1026.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 15:59:00 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"group_member_req10107.acmepaymentscorp",
"Guid":"group_member_req10107.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"Accounts App",
"description":"App Team invitation issued",
"category":[
{
"value":"com.soa.notification.type.appteam.member.invited.team",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1016.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 15:57:05 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"group_member_req10094.acmepaymentscorp",
"Guid":"group_member_req10094.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"Accounts App",
"description":"App Team invitation issued",
"category":[
{
"value":"com.soa.notification.type.appteam.member.invited.team",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1020.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 15:57:05 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"group_member_req10096.acmepaymentscorp",
"Guid":"group_member_req10096.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"Accounts App",
"description":"App Team invitation issued",
"category":[
{
"value":"com.soa.notification.type.appteam.member.invited.team",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1018.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 15:57:05 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"group_member_req10095.acmepaymentscorp",
"Guid":"group_member_req10095.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"Test API_GW (UI)",
"description":"Production access requested for Accounts App",
"category":[
{
"value":"com.soa.notification.type.api.access.requested.production.appteam",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1014.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 15:55:27 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"contract_request10092.acmepaymentscorp",
"Guid":"contract_request10092.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"Test API_GW (UI)",
"description":"Access requested for Production environment",
"category":[
{
"value":"com.soa.notification.type.api.access.requested.both.apiadmin",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1013.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 15:55:27 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"contract_request10092.acmepaymentscorp",
"Guid":"contract_request10092.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"Accounts App",
"description":"Production access to the API from Scratch via Postman has been activated",
"category":[
{
"value":"com.soa.notification.type.api.access.activated.production.appteam",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1012.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 15:54:57 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"contract_request10088.acmepaymentscorp",
"Guid":"contract_request10088.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"Accounts App",
"description":"Access to API from Scratch via Postman has been Activated in the Production environment",
"category":[
{
"value":"com.soa.notification.type.api.access.state.change.apiadmin",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1011.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 15:54:57 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"contract_request10088.acmepaymentscorp",
"Guid":"contract_request10088.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"API from Scratch via Postman",
"description":"Production access requested for Accounts App",
"category":[
{
"value":"com.soa.notification.type.api.access.requested.production.appteam",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1010.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 15:54:40 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"contract_request10088.acmepaymentscorp",
"Guid":"contract_request10088.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"API from Scratch via Postman",
"description":"Access requested for Production environment",
"category":[
{
"value":"com.soa.notification.type.api.access.requested.both.apiadmin",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1009.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 15:54:40 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"contract_request10088.acmepaymentscorp",
"Guid":"contract_request10088.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"New user login: securitytest",
"description":"A user added by a Site Admin logged in for the first time.",
"category":[
{
"value":"com.soa.notification.type.user.logged.in.first.time",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1008.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 14:28:50 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"discussion10073.acmepaymentscorp",
"Guid":"discussion10073.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"acmepaymentscorp",
"description":"cPjBAgdUjPsK has accepted an invitation to be a site administrator",
"category":[
{
"value":"com.soa.notification.type.siteadmin.membership.accepted",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1007.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 09:51:14 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"group_member_req10070.acmepaymentscorp",
"Guid":"group_member_req10070.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"acmepaymentscorp",
"description":"cPjBAgdUjPsK has been invited to be a site administrator",
"category":[
{
"value":"com.soa.notification.type.siteadmin.member.invited.team",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1006.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 09:51:13 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"group_member_req10070.acmepaymentscorp",
"Guid":"group_member_req10070.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"Tenant - acmepaymentscorp",
"description":"cPjBAgdUjPsK has accepted an invitation to be a business administrator",
"category":[
{
"value":"com.soa.notification.type.bizadmin.membership.accepted",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1004.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 09:51:12 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"group_member_req10067.acmepaymentscorp",
"Guid":"group_member_req10067.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"New user login: cPjBAgdUjPsK",
"description":"A user added by a Site Admin logged in for the first time.",
"category":[
{
"value":"com.soa.notification.type.user.logged.in.first.time",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1003.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 09:51:12 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"discussion10068.acmepaymentscorp",
"Guid":"discussion10068.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
},
{
"title":"Tenant - acmepaymentscorp",
"description":"cPjBAgdUjPsK has been invited to be a business administrator",
"category":[
{
"value":"com.soa.notification.type.bizadmin.member.invited.team",
"domain":"uddi:soa.com:resourcetype"
}
],
"guid":{
"value":"notification1002.acmepaymentscorp"
},
"pubDate":"Thu, 11 Mar 2021 09:51:12 +0000",
"EntityReferences":{
"EntityReference":[
{
"Title":"group_member_req10067.acmepaymentscorp",
"Guid":"group_member_req10067.acmepaymentscorp",
"Category":[
{
"value":"board-item",
"domain":"uddi:soa.com:resourcetype"
}
]
}
]
}
}
]
},
"version":"1.0"
}
Response Headers
For general information on response header values, refer to HTTP Response Headers.
| Header | Description |
|---|---|
| Content-Type | application/json, text/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml |
Response Body
The response body is in the form of an RSS channel, and includes the items listed below. The RSS version is 1.0. The title of the RSS Channel is User Notifications, and the channel includes a description and paging values: StartIndex, TotalResults, and ItemsPerPage. Each item in the RSS channel represents a notification, and includes the information below.
| Name | Description |
|---|---|
| title | The text title of the notification. |
| description | Descriptive text for the notification. |
| category[ ] |
An array of sets of two name/value pairs, each including Value and Domain, with a value for each. For example: "value" : "com.soa.notification.type.group.membership.accepted", "domain" : "uddi:soa.com:resourcetype"; The example above indicates the notification type. |
| GUID | GUID for the notification. |
| pubdate | The date/timestamp when the information was generated. |
| Entity reference |
An array of one or more entity references for the Board item. Each includes:
|
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.