GET route/{routeName}/tripsinstructions?direction={direction}&scheduleType={scheduleType}

Retrieve a list of all trips that travel along the specified route with travel instructions (optionally filtered by direction.)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
routeName

The route for whose trips should be retrieved.

string

Required

direction

Used to filter trips only to those travelling the specified direction.

string

Default value is

scheduleType

The schedule for which trips to retrieve: Options are Weekday, Saturday and Sunday.

TripScheduleType

None.

Body Parameters

None.

Response Information

Resource Description

Collection of TripInstruction
NameDescriptionTypeAdditional information
TimePoints

The operator driving instructions at each time point.

Collection of TimePointInstruction

None.

InstructionsText

The operator driving instructions as text.

string

None.

TripId

integer

None.

RouteName

The route which this trip is currently running

string

None.

ScheduleType

The schedule for which this trip is being run

TripScheduleType

None.

StartTime

The scheduled start time for the trip

date

None.

Direction

The direction the current trip is heading

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "TimePoints": [
      {
        "Instruction": "sample string 1",
        "TripId": 2,
        "Sequence": 3,
        "Latitude": 1.0,
        "Longitude": 1.0
      },
      {
        "Instruction": "sample string 1",
        "TripId": 2,
        "Sequence": 3,
        "Latitude": 1.0,
        "Longitude": 1.0
      }
    ],
    "InstructionsText": "sample string 1",
    "TripId": 2,
    "RouteName": "sample string 3",
    "ScheduleType": 0,
    "StartTime": "2022-06-28T07:26:40.3333005-07:00",
    "Direction": "sample string 5"
  },
  {
    "TimePoints": [
      {
        "Instruction": "sample string 1",
        "TripId": 2,
        "Sequence": 3,
        "Latitude": 1.0,
        "Longitude": 1.0
      },
      {
        "Instruction": "sample string 1",
        "TripId": 2,
        "Sequence": 3,
        "Latitude": 1.0,
        "Longitude": 1.0
      }
    ],
    "InstructionsText": "sample string 1",
    "TripId": 2,
    "RouteName": "sample string 3",
    "ScheduleType": 0,
    "StartTime": "2022-06-28T07:26:40.3333005-07:00",
    "Direction": "sample string 5"
  }
]

text/html

Sample:
[{"TimePoints":[{"Instruction":"sample string 1","TripId":2,"Sequence":3,"Latitude":1.0,"Longitude":1.0},{"Instruction":"sample string 1","TripId":2,"Sequence":3,"Latitude":1.0,"Longitude":1.0}],"InstructionsText":"sample string 1","TripId":2,"RouteName":"sample string 3","ScheduleType":0,"StartTime":"2022-06-28T07:26:40.3333005-07:00","Direction":"sample string 5"},{"TimePoints":[{"Instruction":"sample string 1","TripId":2,"Sequence":3,"Latitude":1.0,"Longitude":1.0},{"Instruction":"sample string 1","TripId":2,"Sequence":3,"Latitude":1.0,"Longitude":1.0}],"InstructionsText":"sample string 1","TripId":2,"RouteName":"sample string 3","ScheduleType":0,"StartTime":"2022-06-28T07:26:40.3333005-07:00","Direction":"sample string 5"}]

application/xml, text/xml

Sample:
<ArrayOfTripInstruction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ACTransit.Transit.Domain.Models">
  <TripInstruction>
    <Direction>sample string 5</Direction>
    <RouteName>sample string 3</RouteName>
    <ScheduleType>Weekday</ScheduleType>
    <StartTime>2022-06-28T07:26:40.3333005-07:00</StartTime>
    <TripId>2</TripId>
    <InstructionsText>sample string 1</InstructionsText>
    <TimePoints>
      <TimePointInstruction>
        <Latitude>1</Latitude>
        <Longitude>1</Longitude>
        <Sequence>3</Sequence>
        <TripId>2</TripId>
        <Instruction>sample string 1</Instruction>
      </TimePointInstruction>
      <TimePointInstruction>
        <Latitude>1</Latitude>
        <Longitude>1</Longitude>
        <Sequence>3</Sequence>
        <TripId>2</TripId>
        <Instruction>sample string 1</Instruction>
      </TimePointInstruction>
    </TimePoints>
  </TripInstruction>
  <TripInstruction>
    <Direction>sample string 5</Direction>
    <RouteName>sample string 3</RouteName>
    <ScheduleType>Weekday</ScheduleType>
    <StartTime>2022-06-28T07:26:40.3333005-07:00</StartTime>
    <TripId>2</TripId>
    <InstructionsText>sample string 1</InstructionsText>
    <TimePoints>
      <TimePointInstruction>
        <Latitude>1</Latitude>
        <Longitude>1</Longitude>
        <Sequence>3</Sequence>
        <TripId>2</TripId>
        <Instruction>sample string 1</Instruction>
      </TimePointInstruction>
      <TimePointInstruction>
        <Latitude>1</Latitude>
        <Longitude>1</Longitude>
        <Sequence>3</Sequence>
        <TripId>2</TripId>
        <Instruction>sample string 1</Instruction>
      </TimePointInstruction>
    </TimePoints>
  </TripInstruction>
</ArrayOfTripInstruction>