Alert list
Retrieve a list of alerts. See SDK envelope request for more information.
The payload type is
INFOCASTING.
The payload content should be in the following format:
<infocasting type="ALERT-LIST" id="1234567" auid="1111111-1111-1111-1111-111111111111"> <alertStatus>alert-status</alertStatus> <channel>alert-folder</channel> <publishedBy>username</publishedBy> <startDate>Alert start date (search range start) </startDate> <endDate> Alert start date (search range end) </endDate> <includeTracking>Y|N</includeTracking> <includeMetastore>Y|N</includeMetastore> </infocasting>
Tag | Mandatory | Description |
---|---|---|
<infocasting> | Yes | Root node of the payload content. Attributes:
See Publish alert API for additional uses for this node. |
<alertStatus> | No | One or more of the following status types, comma-delimited (not case-sensitive):
|
<channel> | No | Numeric alert folder that may be a comma-delimited list of IDs. If this tag is not present, alerts from all folders are returned. |
<publishedBy> | No | Username of the user who published the alert(s). |
<startDate> | No | Start of search date range: include alerts in which the date and time that the notification became live (distributed to end-users) is after startDate. Format: yyyy/mm/ddThh:mm:ss |
<endDate> | No | End of search date range: include alerts in which the date and time that the notification became live (distributed to end-users) is before endDate. If present, must be later than search range start time. Format: yyyy/mm/ddThh:mm:ss |
<includeTracking> | No | If present, tracking numbers are included in response. |
<includeMetastore> | No | If Y is present, the metastoreJSON property is returned for each alert in the list. |
The SDK response will be:
<alerts> <alert id=”alert id” auid=”auid”> <title>alert title</title> <body>alert body</body> <url>Target URL</url> <responseOptions> <responseOption> <responseId></responseId> <responseText>ok</responseText> </responseOption> . . . </responseOptions> <channel>folder name</channel> <startDate></startDate> <endDate></endDate> <publishedBy>username</publishedBy> <alertStatus>Standby|Scheduled|Live|ENDED</alertStatus> <type>Other</type> <severity> Unknown</severity> <!--Tracking numbers are included when includeTracking = Y in request--> <targeted>123</targeted> <sent>123</sent> <received>123</received> <acknowledged>111</acknowledged> <noResponse>12</noResponse> <!--Metastore in JSON format is included when includeMetastore=Y in request--> <metaStoreJSON> { "pushbuttonAlpha": { "deliveryType":"SDKAlert", "room":"3509", "room occupant":"John Smith" } } <metaStoreJSON> </alert> . . . </alerts>