GET api/GetEvents
Returns all event types.
Request Information
http://ctroads.com/api/getevents?key={key}&format={format}
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
key | string |
Required |
|
format |
Valid values are xml or json. |
string |
Required |
Response Information
Resource Description
Name | Description | Type | Additional information |
---|---|---|---|
ID | string |
None. |
|
RegionName | string |
None. |
|
CountyName | string |
None. |
|
Severity |
Describes the severity of the event with default value of Unknown. |
string |
None. |
RoadwayName | string |
None. |
|
DirectionOfTravel |
One of the following directions of travel: None, All Directions, Northbound, Eastbound, Southbound, Westbound, Inbound, Outbound, Both Directions. |
string |
None. |
Description |
A summary of the event details which often includes type of event, dates, and lanes affected. |
string |
None. |
Location |
Describes the location on the roadway where the event occurred. |
string |
None. |
LanesAffected |
Describes the lane or number of lanes affected by the event. For example: all lanes. |
string |
None. |
LanesStatus |
Describes the status of the lanes which are affected by the event. For example: closed. |
string |
None. |
LcsEntries |
Currently not used. |
None. |
|
NavteqLinkId |
The Navteq link id on which this event occurrs. |
string |
None. |
PrimaryLocation |
Describes the starting point of the section of roadway which is affected by the event. |
string |
None. |
SecondaryLocation |
Describes the end point of the section of roadway which is affected by the event. |
string |
None. |
FirstArticleCity |
The city at the starting point of the section of roadway which is affected by the event. May also include an article; for example: between New York. |
string |
None. |
SecondCity |
The city at the end point of the section of roadway which is affected by the event. |
string |
None. |
EventType |
The type of event. One of accidentsAndIncidents, roadwork, specialEvents, closures, transitMode, generalInfo, winterDrivingIndex. |
string |
None. |
EventSubType |
A more detailed and descriptive event type. No fixed list of sub types. |
string |
None. |
MapEncodedPolyline |
A Google maps encoded polyline representing the coordinates of the roadway for EventType winterDrivingIndex |
string |
None. |
LastUpdated |
The date the events details were last updated. Format: dd/MM/yyyy HH:mm:ss. |
string |
None. |
Latitude | decimal number |
None. |
|
Longitude | decimal number |
None. |
|
PlannedEndDate |
The date the event is expected to end. Format: dd/MM/yyyy HH:mm:ss. |
string |
None. |
Reported |
The date the event was reported. Format: dd/MM/yyyy HH:mm:ss. |
string |
None. |
StartDate |
The start date of the event. Format: dd/MM/yyyy HH:mm:ss. |
string |
None. |
Response Formats
application/xml, text/xml
<ArrayOfEvent xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Event> <LastUpdated>sample string 1</LastUpdated> <Latitude>2.1</Latitude> <Longitude>3.1</Longitude> <PlannedEndDate>sample string 4</PlannedEndDate> <Reported>sample string 5</Reported> <StartDate>sample string 6</StartDate> <ID>sample string 1</ID> <RegionName>sample string 2</RegionName> <CountyName>sample string 3</CountyName> <Severity>sample string 4</Severity> <RoadwayName>sample string 5</RoadwayName> <DirectionOfTravel>sample string 6</DirectionOfTravel> <Description>sample string 7</Description> <Location>sample string 8</Location> <LanesAffected>sample string 9</LanesAffected> <LanesStatus>sample string 10</LanesStatus> <LcsEntries> <LcsEntry /> <LcsEntry /> </LcsEntries> <NavteqLinkId>sample string 11</NavteqLinkId> <PrimaryLocation>sample string 12</PrimaryLocation> <SecondaryLocation>sample string 13</SecondaryLocation> <FirstArticleCity>sample string 14</FirstArticleCity> <SecondCity>sample string 15</SecondCity> <EventType>sample string 16</EventType> <EventSubType>sample string 17</EventSubType> <MapEncodedPolyline>sample string 18</MapEncodedPolyline> </Event> <Event> <LastUpdated>sample string 1</LastUpdated> <Latitude>2.1</Latitude> <Longitude>3.1</Longitude> <PlannedEndDate>sample string 4</PlannedEndDate> <Reported>sample string 5</Reported> <StartDate>sample string 6</StartDate> <ID>sample string 1</ID> <RegionName>sample string 2</RegionName> <CountyName>sample string 3</CountyName> <Severity>sample string 4</Severity> <RoadwayName>sample string 5</RoadwayName> <DirectionOfTravel>sample string 6</DirectionOfTravel> <Description>sample string 7</Description> <Location>sample string 8</Location> <LanesAffected>sample string 9</LanesAffected> <LanesStatus>sample string 10</LanesStatus> <LcsEntries> <LcsEntry /> <LcsEntry /> </LcsEntries> <NavteqLinkId>sample string 11</NavteqLinkId> <PrimaryLocation>sample string 12</PrimaryLocation> <SecondaryLocation>sample string 13</SecondaryLocation> <FirstArticleCity>sample string 14</FirstArticleCity> <SecondCity>sample string 15</SecondCity> <EventType>sample string 16</EventType> <EventSubType>sample string 17</EventSubType> <MapEncodedPolyline>sample string 18</MapEncodedPolyline> </Event> </ArrayOfEvent>
application/json, text/json
[ { "LastUpdated": "sample string 1", "Latitude": 2.1, "Longitude": 3.1, "PlannedEndDate": "sample string 4", "Reported": "sample string 5", "StartDate": "sample string 6", "ID": "sample string 1", "RegionName": "sample string 2", "CountyName": "sample string 3", "Severity": "sample string 4", "RoadwayName": "sample string 5", "DirectionOfTravel": "sample string 6", "Description": "sample string 7", "Location": "sample string 8", "LanesAffected": "sample string 9", "LanesStatus": "sample string 10", "LcsEntries": [ {}, {} ], "NavteqLinkId": "sample string 11", "PrimaryLocation": "sample string 12", "SecondaryLocation": "sample string 13", "FirstArticleCity": "sample string 14", "SecondCity": "sample string 15", "EventType": "sample string 16", "EventSubType": "sample string 17", "MapEncodedPolyline": "sample string 18" }, { "LastUpdated": "sample string 1", "Latitude": 2.1, "Longitude": 3.1, "PlannedEndDate": "sample string 4", "Reported": "sample string 5", "StartDate": "sample string 6", "ID": "sample string 1", "RegionName": "sample string 2", "CountyName": "sample string 3", "Severity": "sample string 4", "RoadwayName": "sample string 5", "DirectionOfTravel": "sample string 6", "Description": "sample string 7", "Location": "sample string 8", "LanesAffected": "sample string 9", "LanesStatus": "sample string 10", "LcsEntries": [ {}, {} ], "NavteqLinkId": "sample string 11", "PrimaryLocation": "sample string 12", "SecondaryLocation": "sample string 13", "FirstArticleCity": "sample string 14", "SecondCity": "sample string 15", "EventType": "sample string 16", "EventSubType": "sample string 17", "MapEncodedPolyline": "sample string 18" } ]