API Documentation Home

GET Advisories

Returns all advisories.

Request Information

http://ctroads.org/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":2001,
    "Message":"HWY 6 Northbound - Argyle Street between 6th Line and Braemar Avenue remains closed. ONLY Southbound traffic turning ONTO Argyle Street from Highway 6 will be permitted.",
    "Notes":"Argyle Street between 6th Line and Braemar Avenue remains closed. ONLY Southbound traffic turning ONTO Argyle Street from Highway 6 will be permitted.",
    "StartTime": "1515646800",
    "EndTime": "1517634000",
    "Regions":[
      "Central",
      "Eastern",   
      "Northwest"     
    ],
	"HighImportance": true,
	"SendNotification": true
  },
  {
    "Id":2143,
    "Message":"Clairville: The right lane is closed in both directions on 427 at South of Clairville due to flooding. Use caution in the area.",
    "Notes":" 427 is still open but one should expect major delays in affected areas. Use caution in the area.”,
    "StartTime": "1514346800",
    "EndTime": "1517143000",
    "Regions":[
      "Northwest"
    ],
	"HighImportance": false,
	"SendNotification": false
  }
]

XML

Sample:

<AlertsList>
  <Alerts>
    <Id>2001</Id>
    <Message>
      HWY 6 Northbound - Argyle Street between 6th Line and Braemar Avenue remains closed. ONLY Southbound traffic turning ONTO Argyle Street from Highway 6 will be permitted.
    </Message>
    <Notes>
      Argyle Street between 6th Line and Braemar Avenue remains closed. ONLY Southbound traffic turning ONTO Argyle Street from Highway 6 will be permitted.
    </Notes>
    <StartTime>1515646800</StartTime>
    <EndTime>1517634000</EndTime>
    <Regions>
      <Regions>Central</Regions>
      <Regions>Eastern</Regions> 
      <Regions>Northwest</Regions>  
    </Regions>
	<HighImportance>true</HighImportance>
	<SendNotification>true</SendNotification>
  </Alerts>
  <Alerts>
    <Id>2143</Id>
    <Message>
      Clairville: The right lane is closed in both directions on 427 at South of Clairville due to flooding. Use caution in the area.
    </Message>
    <Notes>
      427 is still open but one should expect major delays in affected areas. Use caution in the area.
    </Notes>
    <StartTime>1514346800</StartTime>
    <EndTime>1517143000</EndTime>
    <Regions>
      <Regions>Northwest</Regions>
    </Regions>
	<HighImportance>false</HighImportance>
	<SendNotification>false</SendNotification>
  </Alerts>
</AlertsList>