API Documentation Home

GET api/GetAlerts

Returns all traffic alerts.

Request Information

http://ctroads.com/api/getalerts?key={key}&format={format}

URI Parameters

Api Call
Name	Description	Type	Additional information
key		string	Required
format	Valid values are xml or json.	string	Required

Response Information

Resource Description

Api Call
Name	Description	Type	Additional information
Id		string	None.
Message	The alert details.	string	None.
Notes	Additional alert details.	string	None.
AreaNames			None.

Response Formats

application/xml, text/xml

Sample:

<ArrayOfDbAlert xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DbAlert>
    <Id>sample string 1</Id>
    <Message>sample string 2</Message>
    <Notes>sample string 3</Notes>
    <AreaNames>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </AreaNames>
  </DbAlert>
  <DbAlert>
    <Id>sample string 1</Id>
    <Message>sample string 2</Message>
    <Notes>sample string 3</Notes>
    <AreaNames>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </AreaNames>
  </DbAlert>
</ArrayOfDbAlert>

application/json, text/json

Sample:

[
  {
    "Id": "sample string 1",
    "Message": "sample string 2",
    "Notes": "sample string 3",
    "AreaNames": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "Id": "sample string 1",
    "Message": "sample string 2",
    "Notes": "sample string 3",
    "AreaNames": [
      "sample string 1",
      "sample string 2"
    ]
  }
]