API Documentation Home

GET Advisories

Returns all advisories.

Request Information

https://hotline.gov.sk.ca/api/v2/get/alerts

URI Parameters

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

Resource Description
Name	Description	Type
Id	A unique identifier.	integer
Message	The advisory details.	string
Notes	Additional advisory details.	string
StartTime	The start time of the advisory in Unix time. More information	integer
EndTime	The end time of the advisory in Unix time. More information	integer
Regions	A list of regions affected.	list
HighImportance	Whether the advisory is flagged as high importance.	boolean
SendNotification	Whether the advisory is disseminated over communication channels (SMS, Email, IVR).	boolean

Response Formats

JSON

Sample:

[
  {
    "Id": 1,
    "Message": "Winter storm warning in effect",
    "Notes": "Winter storm warning in effect",
    "StartTime": 1645630020,
    "EndTime": 1646061960,
    "Regions": [
      "Athabasca Carlyle",
      "Carlyle",
      "Saskatoon"
    ],
    "HighImportance": false,
    "SendNotification": true
  }
]

XML

Sample:

<AlertsList>
    <Alerts>
        <Id>2</Id>
        <Message>Winter storm warning in effect</Message>
        <Notes>Winter storm warning in effect</Notes>
        <StartTime>1645630020</StartTime>
        <EndTime>1646061960</EndTime>
        <Regions>Athabasca Carlyle Saskatoon</Regions>
        <HighImportance>false</HighImportance>
        <SendNotification>true</SendNotification>
    </Alerts>
</AlertsList>