Skip to main content

511NY

GET api/GetMessageSigns

Returns all VMS.

Request Information

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

URI Parameters

Api Call
NameDescriptionTypeAdditional information
key

string

Required

format

Valid values are xml or json.

string

Required

Response Information

Resource Description


Api Call
NameDescriptionTypeAdditional information
ID

string

None.

Name

A name assigned to the message sign. It will contain a fairly good description of the location where the message sign is deployed.

string

None.

Roadway

string

None.

DirectionOfTravel

One of the following directions of travel: None, All Directions, Northbound, Eastbound, Southbound, Westbound, Inbound, Outbound, Both Directions.

string

None.

Messages

An collection of the messages which are currently rotating on the message sign.

None.

Latitude

decimal number

None.

Longitude

decimal number

None.

Response Formats

application/xml, text/xml

Sample:
<ArrayOfMessageSign xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MessageSign>
    <Latitude>1.1</Latitude>
    <Longitude>2.1</Longitude>
    <ID>sample string 1</ID>
    <Name>sample string 2</Name>
    <Roadway>sample string 3</Roadway>
    <DirectionOfTravel>sample string 4</DirectionOfTravel>
    <Messages>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </Messages>
  </MessageSign>
  <MessageSign>
    <Latitude>1.1</Latitude>
    <Longitude>2.1</Longitude>
    <ID>sample string 1</ID>
    <Name>sample string 2</Name>
    <Roadway>sample string 3</Roadway>
    <DirectionOfTravel>sample string 4</DirectionOfTravel>
    <Messages>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </Messages>
  </MessageSign>
</ArrayOfMessageSign>

application/json, text/json

Sample:
[
  {
    "Latitude": 1.1,
    "Longitude": 2.1,
    "ID": "sample string 1",
    "Name": "sample string 2",
    "Roadway": "sample string 3",
    "DirectionOfTravel": "sample string 4",
    "Messages": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "Latitude": 1.1,
    "Longitude": 2.1,
    "ID": "sample string 1",
    "Name": "sample string 2",
    "Roadway": "sample string 3",
    "DirectionOfTravel": "sample string 4",
    "Messages": [
      "sample string 1",
      "sample string 2"
    ]
  }
]