GET Special Alerts
Returns all special alert notifications.
Request Information
https://nc.prod.traveliq.co//api/v2/get/alerts
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| key |
Developer Key |
string |
Required |
| format |
Valid values are 'xml' or 'json', default 'json'. |
string |
Optional |
Response Information
Resource Description
| Name | Description | Type |
|---|---|---|
| Id |
A unique identifier. |
integer |
| Message |
The special alert details. |
string |
| Notes |
Additional special alert details. |
string |
| StartTime |
The start time of the special alert in Unix time. More information |
integer |
| EndTime |
The end time of the special alert in Unix time. More information |
integer |
| Regions |
A list of regions affected. |
list |
| HighImportance |
Whether the special alert is flagged as high importance. |
boolean |
| SendNotification |
Whether the special alert is disseminated over communication channels (SMS, Email, IVR). |
boolean |
Response Formats
JSON
[
{
"Id": 22,
"Message": "Road work in place - one lane is currently open - both lanes should be open sometime Tuesday morning 2/4/2020",
"Notes": null,
"StartTime": 1580711160,
"EndTime": 1580849700,
"Regions": [
"Asheville",
"Charlotte",
"Eastern Mountains",
"Fayetteville",
"Northern Coastal",
"Rural Piedmont",
"Southern Coastal",
"Triad",
"Triangle",
"Western Mountains"
],
"HighImportance": false,
"SendNotification": true
}
]
XML
<AlertsList>
<Alerts>
<Id>22</Id>
<Message>Road work in place - one lane is currently open - both lanes should be open sometime Tuesday morning 2/4/2020</Message>
<Notes/>
<StartTime>1580711160</StartTime>
<EndTime>1580849700</EndTime>
<Regions>Kodiak</Regions>
<HighImportance>false</HighImportance>
<SendNotification>true</SendNotification>
</Alerts>
</AlertsList>