GET route/{routes}/waypoints

Retrieve a list of all waypoints currently servicing the specified route.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
routes

The route(s) for whose trips should be retrieved (comma delimited, use 'all' for all routes).

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of RouteWaypoints
NameDescriptionTypeAdditional information
Booking

string

None.

RouteAlpha

string

None.

Patterns

Collection of RoutePattern

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Booking": "sample string 1",
    "RouteAlpha": "sample string 2",
    "Patterns": [
      {
        "DirectionId": 1,
        "Direction": "sample string 2",
        "Destination": "sample string 3",
        "FirstPlaceId": "sample string 4",
        "LastPlaceId": "sample string 5",
        "IsDefault": true,
        "TotalDistance": 7,
        "Waypoints": [
          {
            "OrderID": 1,
            "Latitude": 1.1,
            "Longitude": 1.1,
            "Heading": 1.1,
            "DistanceToNextStop": 1,
            "DistanceFromStart": 1,
            "StopSequence": 1
          },
          {
            "OrderID": 1,
            "Latitude": 1.1,
            "Longitude": 1.1,
            "Heading": 1.1,
            "DistanceToNextStop": 1,
            "DistanceFromStart": 1,
            "StopSequence": 1
          }
        ]
      },
      {
        "DirectionId": 1,
        "Direction": "sample string 2",
        "Destination": "sample string 3",
        "FirstPlaceId": "sample string 4",
        "LastPlaceId": "sample string 5",
        "IsDefault": true,
        "TotalDistance": 7,
        "Waypoints": [
          {
            "OrderID": 1,
            "Latitude": 1.1,
            "Longitude": 1.1,
            "Heading": 1.1,
            "DistanceToNextStop": 1,
            "DistanceFromStart": 1,
            "StopSequence": 1
          },
          {
            "OrderID": 1,
            "Latitude": 1.1,
            "Longitude": 1.1,
            "Heading": 1.1,
            "DistanceToNextStop": 1,
            "DistanceFromStart": 1,
            "StopSequence": 1
          }
        ]
      }
    ]
  },
  {
    "Booking": "sample string 1",
    "RouteAlpha": "sample string 2",
    "Patterns": [
      {
        "DirectionId": 1,
        "Direction": "sample string 2",
        "Destination": "sample string 3",
        "FirstPlaceId": "sample string 4",
        "LastPlaceId": "sample string 5",
        "IsDefault": true,
        "TotalDistance": 7,
        "Waypoints": [
          {
            "OrderID": 1,
            "Latitude": 1.1,
            "Longitude": 1.1,
            "Heading": 1.1,
            "DistanceToNextStop": 1,
            "DistanceFromStart": 1,
            "StopSequence": 1
          },
          {
            "OrderID": 1,
            "Latitude": 1.1,
            "Longitude": 1.1,
            "Heading": 1.1,
            "DistanceToNextStop": 1,
            "DistanceFromStart": 1,
            "StopSequence": 1
          }
        ]
      },
      {
        "DirectionId": 1,
        "Direction": "sample string 2",
        "Destination": "sample string 3",
        "FirstPlaceId": "sample string 4",
        "LastPlaceId": "sample string 5",
        "IsDefault": true,
        "TotalDistance": 7,
        "Waypoints": [
          {
            "OrderID": 1,
            "Latitude": 1.1,
            "Longitude": 1.1,
            "Heading": 1.1,
            "DistanceToNextStop": 1,
            "DistanceFromStart": 1,
            "StopSequence": 1
          },
          {
            "OrderID": 1,
            "Latitude": 1.1,
            "Longitude": 1.1,
            "Heading": 1.1,
            "DistanceToNextStop": 1,
            "DistanceFromStart": 1,
            "StopSequence": 1
          }
        ]
      }
    ]
  }
]

text/html

Sample:
[{"Booking":"sample string 1","RouteAlpha":"sample string 2","Patterns":[{"DirectionId":1,"Direction":"sample string 2","Destination":"sample string 3","FirstPlaceId":"sample string 4","LastPlaceId":"sample string 5","IsDefault":true,"TotalDistance":7,"Waypoints":[{"OrderID":1,"Latitude":1.1,"Longitude":1.1,"Heading":1.1,"DistanceToNextStop":1,"DistanceFromStart":1,"StopSequence":1},{"OrderID":1,"Latitude":1.1,"Longitude":1.1,"Heading":1.1,"DistanceToNextStop":1,"DistanceFromStart":1,"StopSequence":1}]},{"DirectionId":1,"Direction":"sample string 2","Destination":"sample string 3","FirstPlaceId":"sample string 4","LastPlaceId":"sample string 5","IsDefault":true,"TotalDistance":7,"Waypoints":[{"OrderID":1,"Latitude":1.1,"Longitude":1.1,"Heading":1.1,"DistanceToNextStop":1,"DistanceFromStart":1,"StopSequence":1},{"OrderID":1,"Latitude":1.1,"Longitude":1.1,"Heading":1.1,"DistanceToNextStop":1,"DistanceFromStart":1,"StopSequence":1}]}]},{"Booking":"sample string 1","RouteAlpha":"sample string 2","Patterns":[{"DirectionId":1,"Direction":"sample string 2","Destination":"sample string 3","FirstPlaceId":"sample string 4","LastPlaceId":"sample string 5","IsDefault":true,"TotalDistance":7,"Waypoints":[{"OrderID":1,"Latitude":1.1,"Longitude":1.1,"Heading":1.1,"DistanceToNextStop":1,"DistanceFromStart":1,"StopSequence":1},{"OrderID":1,"Latitude":1.1,"Longitude":1.1,"Heading":1.1,"DistanceToNextStop":1,"DistanceFromStart":1,"StopSequence":1}]},{"DirectionId":1,"Direction":"sample string 2","Destination":"sample string 3","FirstPlaceId":"sample string 4","LastPlaceId":"sample string 5","IsDefault":true,"TotalDistance":7,"Waypoints":[{"OrderID":1,"Latitude":1.1,"Longitude":1.1,"Heading":1.1,"DistanceToNextStop":1,"DistanceFromStart":1,"StopSequence":1},{"OrderID":1,"Latitude":1.1,"Longitude":1.1,"Heading":1.1,"DistanceToNextStop":1,"DistanceFromStart":1,"StopSequence":1}]}]}]

application/xml, text/xml

Sample:
<ArrayOfRouteWaypoints xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ACTransit.Transit.Domain.Models">
  <RouteWaypoints>
    <Booking>sample string 1</Booking>
    <Patterns>
      <RoutePattern>
        <Destination>sample string 3</Destination>
        <Direction>sample string 2</Direction>
        <DirectionId>1</DirectionId>
        <FirstPlaceId>sample string 4</FirstPlaceId>
        <IsDefault>true</IsDefault>
        <LastPlaceId>sample string 5</LastPlaceId>
        <TotalDistance>7</TotalDistance>
        <Waypoints>
          <RouteWaypoint>
            <DistanceFromStart>1</DistanceFromStart>
            <DistanceToNextStop>1</DistanceToNextStop>
            <Heading>1.1</Heading>
            <Latitude>1.1</Latitude>
            <Longitude>1.1</Longitude>
            <OrderID>1</OrderID>
            <StopSequence>1</StopSequence>
          </RouteWaypoint>
          <RouteWaypoint>
            <DistanceFromStart>1</DistanceFromStart>
            <DistanceToNextStop>1</DistanceToNextStop>
            <Heading>1.1</Heading>
            <Latitude>1.1</Latitude>
            <Longitude>1.1</Longitude>
            <OrderID>1</OrderID>
            <StopSequence>1</StopSequence>
          </RouteWaypoint>
        </Waypoints>
      </RoutePattern>
      <RoutePattern>
        <Destination>sample string 3</Destination>
        <Direction>sample string 2</Direction>
        <DirectionId>1</DirectionId>
        <FirstPlaceId>sample string 4</FirstPlaceId>
        <IsDefault>true</IsDefault>
        <LastPlaceId>sample string 5</LastPlaceId>
        <TotalDistance>7</TotalDistance>
        <Waypoints>
          <RouteWaypoint>
            <DistanceFromStart>1</DistanceFromStart>
            <DistanceToNextStop>1</DistanceToNextStop>
            <Heading>1.1</Heading>
            <Latitude>1.1</Latitude>
            <Longitude>1.1</Longitude>
            <OrderID>1</OrderID>
            <StopSequence>1</StopSequence>
          </RouteWaypoint>
          <RouteWaypoint>
            <DistanceFromStart>1</DistanceFromStart>
            <DistanceToNextStop>1</DistanceToNextStop>
            <Heading>1.1</Heading>
            <Latitude>1.1</Latitude>
            <Longitude>1.1</Longitude>
            <OrderID>1</OrderID>
            <StopSequence>1</StopSequence>
          </RouteWaypoint>
        </Waypoints>
      </RoutePattern>
    </Patterns>
    <RouteAlpha>sample string 2</RouteAlpha>
  </RouteWaypoints>
  <RouteWaypoints>
    <Booking>sample string 1</Booking>
    <Patterns>
      <RoutePattern>
        <Destination>sample string 3</Destination>
        <Direction>sample string 2</Direction>
        <DirectionId>1</DirectionId>
        <FirstPlaceId>sample string 4</FirstPlaceId>
        <IsDefault>true</IsDefault>
        <LastPlaceId>sample string 5</LastPlaceId>
        <TotalDistance>7</TotalDistance>
        <Waypoints>
          <RouteWaypoint>
            <DistanceFromStart>1</DistanceFromStart>
            <DistanceToNextStop>1</DistanceToNextStop>
            <Heading>1.1</Heading>
            <Latitude>1.1</Latitude>
            <Longitude>1.1</Longitude>
            <OrderID>1</OrderID>
            <StopSequence>1</StopSequence>
          </RouteWaypoint>
          <RouteWaypoint>
            <DistanceFromStart>1</DistanceFromStart>
            <DistanceToNextStop>1</DistanceToNextStop>
            <Heading>1.1</Heading>
            <Latitude>1.1</Latitude>
            <Longitude>1.1</Longitude>
            <OrderID>1</OrderID>
            <StopSequence>1</StopSequence>
          </RouteWaypoint>
        </Waypoints>
      </RoutePattern>
      <RoutePattern>
        <Destination>sample string 3</Destination>
        <Direction>sample string 2</Direction>
        <DirectionId>1</DirectionId>
        <FirstPlaceId>sample string 4</FirstPlaceId>
        <IsDefault>true</IsDefault>
        <LastPlaceId>sample string 5</LastPlaceId>
        <TotalDistance>7</TotalDistance>
        <Waypoints>
          <RouteWaypoint>
            <DistanceFromStart>1</DistanceFromStart>
            <DistanceToNextStop>1</DistanceToNextStop>
            <Heading>1.1</Heading>
            <Latitude>1.1</Latitude>
            <Longitude>1.1</Longitude>
            <OrderID>1</OrderID>
            <StopSequence>1</StopSequence>
          </RouteWaypoint>
          <RouteWaypoint>
            <DistanceFromStart>1</DistanceFromStart>
            <DistanceToNextStop>1</DistanceToNextStop>
            <Heading>1.1</Heading>
            <Latitude>1.1</Latitude>
            <Longitude>1.1</Longitude>
            <OrderID>1</OrderID>
            <StopSequence>1</StopSequence>
          </RouteWaypoint>
        </Waypoints>
      </RoutePattern>
    </Patterns>
    <RouteAlpha>sample string 2</RouteAlpha>
  </RouteWaypoints>
</ArrayOfRouteWaypoints>