API Documentation Home

GET api/GetEvents

Returns all event types.

Request Information

https://511ny.org/api/getevents?key={key}&format={format}

URI Parameters

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

Response Information

Resource Description

Api Call
Name	Description	Type	Additional information
ID	A unique identifier.	string	None.
RegionName	The region where the event occurred.	string	None.
CountyName	The county where the event occurred.	string	None.
Severity	Describes the severity of the event with default value of Unknown.	string	None.
RoadwayName	The roadway on which the event occurred.	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.	None.
NavteqLinkId	The Navteq link id on which this event occurrs. Now the first link... this is legacy and doesn't support multiple links per event	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	The latitude describing the location. Format: double between -90 and 90.	decimal number	None.
Longitude	The longitude describing the location. Format: double between -180 and 180.	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.
Schedule	The daily schedule of the event.		None.
Schedule.ScheduleId	The ID of the schedule.		None.
Schedule.Start	The start date.		None.
Schedule.End	The end date.		None.
Schedule.Continuous	Indicates whether the schedule is continuous.		None.
Schedule.ActiveDays	The days for which the schedule is active.		None.

Response Formats

application/xml, text/xml

Sample:

<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>
    <Schedule>
      <ScheduleId>1</ScheduleId>
      <Start>sample string 19</Start>
      <End>sample string 20</End>
      <Continuous>false</Continuous>
      <ActiveDays>
        <value>Sun</value>
      </ActiveDays>
    </Schedule>
  </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>
    <Schedule>
      <ScheduleId>1</ScheduleId>
      <Start>sample string 19</Start>
      <End>sample string 20</End>
      <Continuous>false</Continuous>
      <ActiveDays>
        <value>Sun</value>
      </ActiveDays>
    </Schedule>
  </Event>
</ArrayOfEvent>

application/json, text/json

Sample:

[
  {
    "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",
    "Schedule": {
      "ScheduleId": 1,
      "Start": "sample string 19",
      "End": "sample string 20",
      "Continuous": false,
      "ActiveDays": {
        ["Sun"]
      }     
    }
  },
  {
    "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",
    "Schedule": {
      "ScheduleId": 1,
      "Start": "sample string 19",
      "End": "sample string 20",
      "Continuous": false,
      "ActiveDays": {
        ["Sun"]
      }     
    }
  }
]