Notifications REST API endpoint
Disclaimer: This endpoint documentation is generated from the latest Sitevision version. It might differ from the actual Sitevision environment where your website resides.
Use the RestApi utility of the Public API for server-side access of this endpoint.
Notifications
Get notifications for a user identity.
Applicable to: sv:userIdentity.
GET
Returns an array of objects containing notifications for a sv:userIdentity.
Requires the feature "social collaboration" and that social collaboration is enabled on the sv:site.
Requires that the caller is the targeted sv:userIdentity and is authorized to READ on the sv:site.
| Name | Type | Default | Values | Description |
|---|---|---|---|---|
| skip | number |
0 | Any positive value | Skips leading number of notifications. |
| limit | number |
10 | Any positive value | Limits the number of notifications to return. |
Example URL
400.95b3be916257bc215c3ea/notifications
Example input
{
"limit": 2
}
Example response
[
{
"id": "405.3c281b941622a3f614cc",
"isNew": true,
"message": "wrote in the group \"123\"",
"URI": "/704.545e0f49161be2620821.html",
"type": "GROUP",
"notifier": {
"id": "400.71effdf1161b89661bd2",
"fullName": "John Doe",
"BuddyIconSize_SMALL": "/images/200.7a5bf41e161e19babe917/1519916664973/portra%CC%88tt.png",
"BuddyIconSize_LARGE": "/images/200.7a5bf41e161e19babe918/1519916664976/portra%CC%88tt.png",
"BuddyIconSize_X_LARGE": "/images/200.7a5bf41e161e19babe919/1519916664979/portra%CC%88tt.png",
"targetId": "401.545e0f49161be262082a"
}
},
{
"id": "405.3c281b941622a3f614ca",
"isNew": false,
"message": "wrote on your timeline \"Hi\"",
"URI": "/4.611b56d3161ae183fc588.html?entry=424.3c281b941622a3f614c9",
"type": "WALL",
"owner": "400.60ac3219161ae66ca6310";
"notifier": {
"id": "400.71effdf1161b89661bd2",
"fullName": "John Doe",
"BuddyIconSize_SMALL": "/images/200.7a5bf41e161e19babe917/1519916664973/portra%CC%88tt.png",
"BuddyIconSize_LARGE": "/images/200.7a5bf41e161e19babe918/1519916664977/portra%CC%88tt.png",
"BuddyIconSize_X_LARGE": "/images/200.7a5bf41e161e19babe919/1519916664979/portra%CC%88tt.png",
"targetId": "424.3c281b941622a3f614c9"
}
}
]
Did you find the content on this page useful?