GET api.ashx/v2/systemnotifications.{json|xml}
Enables listing of system notifications.
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
PageIndex | int | Query String | Page of results to return | Optional | ||
PageSize | int | Query String | Number of results to return | Optional | ||
SortBy | string | Query String | Accepted values are: LastOccurredDate (default), Count | Optional | ||
SortOrder | string | Query String | Accepted values are: Ascending, Descending | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/systemnotifications.json' }).then(function(response) { // use response });
Example Responses
JSON
{ "PageSize": 2, "PageIndex": 0, "TotalCount": 2, "SystemNotifications": [ { "GroupingKey": "groupingkey", "Subject": "subject", "Message": "message", "RecipientIds": [ 6, 25 ], "FirstOccurredDate": "2012-01-04T00:00:00", "LastOccurredDate": "2012-05-02T00:00:00", "TotalOccurrences": 8, "IsResolved": true, "GroupId": 4, "PluginType": "plugintype", "IsResolvable": true, "Id": 7 }, { "GroupingKey": "groupingkey", "Subject": "subject", "Message": "message", "RecipientIds": [ 27, 32 ], "FirstOccurredDate": "2012-06-04T00:00:00", "LastOccurredDate": "2011-05-28T00:00:00", "TotalOccurrences": 52, "IsResolved": true, "GroupId": 19, "PluginType": "plugintype", "IsResolvable": true, "Id": 112 } ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <SystemNotifications PageSize="2" PageIndex="0" TotalCount="2"> <SystemNotification> <Id>7</Id> <GroupingKey>groupingkey</GroupingKey> <Subject>subject</Subject> <Message>message</Message> <RecipientIds> <int>6</int> <int>25</int> </RecipientIds> <FirstOccurredDate>2012-01-04T00:00:00</FirstOccurredDate> <LastOccurredDate>2012-05-02T00:00:00</LastOccurredDate> <TotalOccurrences>8</TotalOccurrences> <IsResolved>true</IsResolved> <GroupId>4</GroupId> <PluginType>plugintype</PluginType> <IsResolvable>true</IsResolvable> </SystemNotification> <SystemNotification> <Id>112</Id> <GroupingKey>groupingkey</GroupingKey> <Subject>subject</Subject> <Message>message</Message> <RecipientIds> <int>27</int> <int>32</int> </RecipientIds> <FirstOccurredDate>2012-06-04T00:00:00</FirstOccurredDate> <LastOccurredDate>2011-05-28T00:00:00</LastOccurredDate> <TotalOccurrences>52</TotalOccurrences> <IsResolved>true</IsResolved> <GroupId>19</GroupId> <PluginType>plugintype</PluginType> <IsResolvable>true</IsResolvable> </SystemNotification> </SystemNotifications> <Errors> <Message>string</Message> <Message>string</Message> </Errors> </Response>