API Documentation Home

GET api/GetMainlineLinkDefinitions

Returns all link definitions for which a link status exists.

Request Information

http://ctroads.org/api/getmainlinelinkdefinitions?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.
DirectionOfTravel

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

 string

None.
RoadwayName

string

None.
EndLatitude

decimal number

None.
EndLongitude

decimal number

None.
StartLatitude

decimal number

None.
StartLongitude

decimal number

None.

Response Formats

application/xml, text/xml

Sample: 
<ArrayOfLinkDefinition xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <LinkDefinition>
    <EndLatitude>1.1</EndLatitude>
    <EndLongitude>2.1</EndLongitude>
    <StartLatitude>3.1</StartLatitude>
    <StartLongitude>4.1</StartLongitude>
    <ID>sample string 1</ID>
    <DirectionOfTravel>sample string 2</DirectionOfTravel>
    <RoadwayName>sample string 3</RoadwayName>
  </LinkDefinition>
  <LinkDefinition>
    <EndLatitude>1.1</EndLatitude>
    <EndLongitude>2.1</EndLongitude>
    <StartLatitude>3.1</StartLatitude>
    <StartLongitude>4.1</StartLongitude>
    <ID>sample string 1</ID>
    <DirectionOfTravel>sample string 2</DirectionOfTravel>
    <RoadwayName>sample string 3</RoadwayName>
  </LinkDefinition>
</ArrayOfLinkDefinition>

application/json, text/json

Sample: 
[
  {
    "EndLatitude": 1.1,
    "EndLongitude": 2.1,
    "StartLatitude": 3.1,
    "StartLongitude": 4.1,
    "ID": "sample string 1",
    "DirectionOfTravel": "sample string 2",
    "RoadwayName": "sample string 3"
  },
  {
    "EndLatitude": 1.1,
    "EndLongitude": 2.1,
    "StartLatitude": 3.1,
    "StartLongitude": 4.1,
    "ID": "sample string 1",
    "DirectionOfTravel": "sample string 2",
    "RoadwayName": "sample string 3"
  }
]