Get System Notification REST Endpoint

Former Member — Fri, 13 May 2022 19:38:08 GMT

Current Revision posted to API Documentation by Former Member on 05/13/2022 19:38:08

GET api.ashx/v2/systemnotifications/{id}.{json|xml}

Enables external applications to retrieve system notifications. If GroupId is set, the calling user must have Modify Group permissions to send a notification. If GroupId is not set, the calling user must have Manage Settings permissions or be a recipient of the notification.

Scopes

System Notifications › Read Notifications systemnotifications.notifications.readonly

Request Parameters

Name	Type	Location	Description	Required	Default	Options
GroupingKey	string	Query String	Either Id or GroupingKey is required.	Optional
Id	string	Query String	Either Id or GroupingKey is required.	Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/systemnotifications/{id}.json',
	data: { 
		'id': 'id'
	}
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "SystemNotification": {
    "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
  },
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <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>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>