GET route/{routes}/schedule/{booking}?direction={direction}&destination={destination}&dayCode={dayCode}&hasAllStops={hasAllStops}&stopId={stopId}
Retrieve stops and schedules for a given route.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| routes |
The route for the schedules (comma delimited). |
string |
Required |
| booking |
Unique id that represents a specific schedule for the period of time associated with the data to be retrieved. Use 'Current' or leave empty to return current schedule information. Use 'Next' to return information for the next schedule once it's available. Use a valid BookingId to retrieve schedule information for a specific booking, if available. |
string |
None. |
| direction |
Optional direction of the given route. |
string |
None. |
| destination |
Optional destination of the given route. |
string |
None. |
| dayCode |
Optional day code (Weekday, Saturday, Sunday) (default today detected). |
string |
None. |
| hasAllStops |
True when all the stops, including waypoints, are needed in the results or false (default) when only stops with a placeID assigned are needed. |
boolean |
Default value is False |
| stopId |
Optional Id511 code for a given stop. When provided, the schedule information returned is just for this particular stop. |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
TripScheduleInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| BookingId |
Unique id that represents a specific schedule name for the period of time associated with the requested data |
string |
None. |
| RouteProfiles |
Collection of route descriptions |
Collection of RouteProfile |
None. |
| DateExceptions |
Collection of service date exceptions |
Collection of DateException |
None. |
| Stops |
Collection of stops fot the requested routes |
Collection of TripScheduleStop |
None. |
| Routes |
Collection of route |
Collection of TripScheduleRoute |
None. |
Response Formats
application/json, text/json
Sample:
{
"BookingId": "sample string 1",
"RouteProfiles": [
{
"RouteId": "sample string 1",
"Profile": "sample string 2"
},
{
"RouteId": "sample string 1",
"Profile": "sample string 2"
}
],
"DateExceptions": [
{
"RouteId": "sample string 1",
"ServiceExceptions": [
{
"ExceptionCode": "sample string 1",
"PatternId": "sample string 2",
"TripId": [
"sample string 1",
"sample string 2"
],
"OperatingDays": "sample string 3",
"ExceptionDates": [
"sample string 1",
"sample string 2"
],
"ExceptionNotices": [
"sample string 1",
"sample string 2"
]
},
{
"ExceptionCode": "sample string 1",
"PatternId": "sample string 2",
"TripId": [
"sample string 1",
"sample string 2"
],
"OperatingDays": "sample string 3",
"ExceptionDates": [
"sample string 1",
"sample string 2"
],
"ExceptionNotices": [
"sample string 1",
"sample string 2"
]
}
]
},
{
"RouteId": "sample string 1",
"ServiceExceptions": [
{
"ExceptionCode": "sample string 1",
"PatternId": "sample string 2",
"TripId": [
"sample string 1",
"sample string 2"
],
"OperatingDays": "sample string 3",
"ExceptionDates": [
"sample string 1",
"sample string 2"
],
"ExceptionNotices": [
"sample string 1",
"sample string 2"
]
},
{
"ExceptionCode": "sample string 1",
"PatternId": "sample string 2",
"TripId": [
"sample string 1",
"sample string 2"
],
"OperatingDays": "sample string 3",
"ExceptionDates": [
"sample string 1",
"sample string 2"
],
"ExceptionNotices": [
"sample string 1",
"sample string 2"
]
}
]
}
],
"Stops": [
{
"StopId": "sample string 1",
"PlaceName": "sample string 2",
"PlaceId": "sample string 3",
"StopDescription": "sample string 4",
"Longitude": 5.0,
"Latitude": 6.0,
"City": "sample string 7"
},
{
"StopId": "sample string 1",
"PlaceName": "sample string 2",
"PlaceId": "sample string 3",
"StopDescription": "sample string 4",
"Longitude": 5.0,
"Latitude": 6.0,
"City": "sample string 7"
}
],
"Routes": [
{
"RouteId": "sample string 1",
"LineDirection": "sample string 2",
"LineDestination": "sample string 3",
"DayCode": [
"sample string 1",
"sample string 2"
],
"OperatingDOW": "sample string 4",
"Trips": [
{
"StartTime": "00:00:00.1234567",
"PatternId": "sample string 2",
"TripId": [
"sample string 1",
"sample string 2"
],
"Status": "sample string 3",
"StopTimes": [
{
"StopTime": "2024-05-05T10:07:09.947028-07:00",
"StopId": "sample string 2",
"PlaceId": "sample string 3",
"Occupancy": "sample string 4"
},
{
"StopTime": "2024-05-05T10:07:09.947028-07:00",
"StopId": "sample string 2",
"PlaceId": "sample string 3",
"Occupancy": "sample string 4"
}
]
},
{
"StartTime": "00:00:00.1234567",
"PatternId": "sample string 2",
"TripId": [
"sample string 1",
"sample string 2"
],
"Status": "sample string 3",
"StopTimes": [
{
"StopTime": "2024-05-05T10:07:09.947028-07:00",
"StopId": "sample string 2",
"PlaceId": "sample string 3",
"Occupancy": "sample string 4"
},
{
"StopTime": "2024-05-05T10:07:09.947028-07:00",
"StopId": "sample string 2",
"PlaceId": "sample string 3",
"Occupancy": "sample string 4"
}
]
}
]
},
{
"RouteId": "sample string 1",
"LineDirection": "sample string 2",
"LineDestination": "sample string 3",
"DayCode": [
"sample string 1",
"sample string 2"
],
"OperatingDOW": "sample string 4",
"Trips": [
{
"StartTime": "00:00:00.1234567",
"PatternId": "sample string 2",
"TripId": [
"sample string 1",
"sample string 2"
],
"Status": "sample string 3",
"StopTimes": [
{
"StopTime": "2024-05-05T10:07:09.947028-07:00",
"StopId": "sample string 2",
"PlaceId": "sample string 3",
"Occupancy": "sample string 4"
},
{
"StopTime": "2024-05-05T10:07:09.947028-07:00",
"StopId": "sample string 2",
"PlaceId": "sample string 3",
"Occupancy": "sample string 4"
}
]
},
{
"StartTime": "00:00:00.1234567",
"PatternId": "sample string 2",
"TripId": [
"sample string 1",
"sample string 2"
],
"Status": "sample string 3",
"StopTimes": [
{
"StopTime": "2024-05-05T10:07:09.947028-07:00",
"StopId": "sample string 2",
"PlaceId": "sample string 3",
"Occupancy": "sample string 4"
},
{
"StopTime": "2024-05-05T10:07:09.947028-07:00",
"StopId": "sample string 2",
"PlaceId": "sample string 3",
"Occupancy": "sample string 4"
}
]
}
]
}
]
}
text/html
Sample:
{"BookingId":"sample string 1","RouteProfiles":[{"RouteId":"sample string 1","Profile":"sample string 2"},{"RouteId":"sample string 1","Profile":"sample string 2"}],"DateExceptions":[{"RouteId":"sample string 1","ServiceExceptions":[{"ExceptionCode":"sample string 1","PatternId":"sample string 2","TripId":["sample string 1","sample string 2"],"OperatingDays":"sample string 3","ExceptionDates":["sample string 1","sample string 2"],"ExceptionNotices":["sample string 1","sample string 2"]},{"ExceptionCode":"sample string 1","PatternId":"sample string 2","TripId":["sample string 1","sample string 2"],"OperatingDays":"sample string 3","ExceptionDates":["sample string 1","sample string 2"],"ExceptionNotices":["sample string 1","sample string 2"]}]},{"RouteId":"sample string 1","ServiceExceptions":[{"ExceptionCode":"sample string 1","PatternId":"sample string 2","TripId":["sample string 1","sample string 2"],"OperatingDays":"sample string 3","ExceptionDates":["sample string 1","sample string 2"],"ExceptionNotices":["sample string 1","sample string 2"]},{"ExceptionCode":"sample string 1","PatternId":"sample string 2","TripId":["sample string 1","sample string 2"],"OperatingDays":"sample string 3","ExceptionDates":["sample string 1","sample string 2"],"ExceptionNotices":["sample string 1","sample string 2"]}]}],"Stops":[{"StopId":"sample string 1","PlaceName":"sample string 2","PlaceId":"sample string 3","StopDescription":"sample string 4","Longitude":5.0,"Latitude":6.0,"City":"sample string 7"},{"StopId":"sample string 1","PlaceName":"sample string 2","PlaceId":"sample string 3","StopDescription":"sample string 4","Longitude":5.0,"Latitude":6.0,"City":"sample string 7"}],"Routes":[{"RouteId":"sample string 1","LineDirection":"sample string 2","LineDestination":"sample string 3","DayCode":["sample string 1","sample string 2"],"OperatingDOW":"sample string 4","Trips":[{"StartTime":"00:00:00.1234567","PatternId":"sample string 2","TripId":["sample string 1","sample string 2"],"Status":"sample string 3","StopTimes":[{"StopTime":"2024-05-05T10:07:09.947028-07:00","StopId":"sample string 2","PlaceId":"sample string 3","Occupancy":"sample string 4"},{"StopTime":"2024-05-05T10:07:09.947028-07:00","StopId":"sample string 2","PlaceId":"sample string 3","Occupancy":"sample string 4"}]},{"StartTime":"00:00:00.1234567","PatternId":"sample string 2","TripId":["sample string 1","sample string 2"],"Status":"sample string 3","StopTimes":[{"StopTime":"2024-05-05T10:07:09.947028-07:00","StopId":"sample string 2","PlaceId":"sample string 3","Occupancy":"sample string 4"},{"StopTime":"2024-05-05T10:07:09.947028-07:00","StopId":"sample string 2","PlaceId":"sample string 3","Occupancy":"sample string 4"}]}]},{"RouteId":"sample string 1","LineDirection":"sample string 2","LineDestination":"sample string 3","DayCode":["sample string 1","sample string 2"],"OperatingDOW":"sample string 4","Trips":[{"StartTime":"00:00:00.1234567","PatternId":"sample string 2","TripId":["sample string 1","sample string 2"],"Status":"sample string 3","StopTimes":[{"StopTime":"2024-05-05T10:07:09.947028-07:00","StopId":"sample string 2","PlaceId":"sample string 3","Occupancy":"sample string 4"},{"StopTime":"2024-05-05T10:07:09.947028-07:00","StopId":"sample string 2","PlaceId":"sample string 3","Occupancy":"sample string 4"}]},{"StartTime":"00:00:00.1234567","PatternId":"sample string 2","TripId":["sample string 1","sample string 2"],"Status":"sample string 3","StopTimes":[{"StopTime":"2024-05-05T10:07:09.947028-07:00","StopId":"sample string 2","PlaceId":"sample string 3","Occupancy":"sample string 4"},{"StopTime":"2024-05-05T10:07:09.947028-07:00","StopId":"sample string 2","PlaceId":"sample string 3","Occupancy":"sample string 4"}]}]}]}
application/xml, text/xml
Sample:
<TripScheduleInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ACTransit.Transit.Domain.Models">
<BookingId>sample string 1</BookingId>
<DateExceptions>
<DateException>
<RouteId>sample string 1</RouteId>
<ServiceExceptions>
<ServiceException>
<ExceptionCode>sample string 1</ExceptionCode>
<ExceptionDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</ExceptionDates>
<ExceptionNotices xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</ExceptionNotices>
<OperatingDays>sample string 3</OperatingDays>
<PatternId>sample string 2</PatternId>
<TripId xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</TripId>
</ServiceException>
<ServiceException>
<ExceptionCode>sample string 1</ExceptionCode>
<ExceptionDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</ExceptionDates>
<ExceptionNotices xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</ExceptionNotices>
<OperatingDays>sample string 3</OperatingDays>
<PatternId>sample string 2</PatternId>
<TripId xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</TripId>
</ServiceException>
</ServiceExceptions>
</DateException>
<DateException>
<RouteId>sample string 1</RouteId>
<ServiceExceptions>
<ServiceException>
<ExceptionCode>sample string 1</ExceptionCode>
<ExceptionDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</ExceptionDates>
<ExceptionNotices xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</ExceptionNotices>
<OperatingDays>sample string 3</OperatingDays>
<PatternId>sample string 2</PatternId>
<TripId xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</TripId>
</ServiceException>
<ServiceException>
<ExceptionCode>sample string 1</ExceptionCode>
<ExceptionDates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</ExceptionDates>
<ExceptionNotices xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</ExceptionNotices>
<OperatingDays>sample string 3</OperatingDays>
<PatternId>sample string 2</PatternId>
<TripId xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</TripId>
</ServiceException>
</ServiceExceptions>
</DateException>
</DateExceptions>
<RouteProfiles>
<RouteProfile>
<Profile>sample string 2</Profile>
<RouteId>sample string 1</RouteId>
</RouteProfile>
<RouteProfile>
<Profile>sample string 2</Profile>
<RouteId>sample string 1</RouteId>
</RouteProfile>
</RouteProfiles>
<Routes>
<TripScheduleRoute>
<DayCode xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</DayCode>
<LineDestination>sample string 3</LineDestination>
<LineDirection>sample string 2</LineDirection>
<OperatingDOW>sample string 4</OperatingDOW>
<RouteId>sample string 1</RouteId>
<Trips>
<TripScheduleTrip>
<PatternId>sample string 2</PatternId>
<StartTime>PT0.1234567S</StartTime>
<Status>sample string 3</Status>
<StopTimes>
<TripScheduleStopTime>
<Occupancy>sample string 4</Occupancy>
<PlaceId>sample string 3</PlaceId>
<StopId>sample string 2</StopId>
<StopTime>2024-05-05T10:07:09.947028-07:00</StopTime>
</TripScheduleStopTime>
<TripScheduleStopTime>
<Occupancy>sample string 4</Occupancy>
<PlaceId>sample string 3</PlaceId>
<StopId>sample string 2</StopId>
<StopTime>2024-05-05T10:07:09.947028-07:00</StopTime>
</TripScheduleStopTime>
</StopTimes>
<TripId xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</TripId>
</TripScheduleTrip>
<TripScheduleTrip>
<PatternId>sample string 2</PatternId>
<StartTime>PT0.1234567S</StartTime>
<Status>sample string 3</Status>
<StopTimes>
<TripScheduleStopTime>
<Occupancy>sample string 4</Occupancy>
<PlaceId>sample string 3</PlaceId>
<StopId>sample string 2</StopId>
<StopTime>2024-05-05T10:07:09.947028-07:00</StopTime>
</TripScheduleStopTime>
<TripScheduleStopTime>
<Occupancy>sample string 4</Occupancy>
<PlaceId>sample string 3</PlaceId>
<StopId>sample string 2</StopId>
<StopTime>2024-05-05T10:07:09.947028-07:00</StopTime>
</TripScheduleStopTime>
</StopTimes>
<TripId xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</TripId>
</TripScheduleTrip>
</Trips>
</TripScheduleRoute>
<TripScheduleRoute>
<DayCode xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</DayCode>
<LineDestination>sample string 3</LineDestination>
<LineDirection>sample string 2</LineDirection>
<OperatingDOW>sample string 4</OperatingDOW>
<RouteId>sample string 1</RouteId>
<Trips>
<TripScheduleTrip>
<PatternId>sample string 2</PatternId>
<StartTime>PT0.1234567S</StartTime>
<Status>sample string 3</Status>
<StopTimes>
<TripScheduleStopTime>
<Occupancy>sample string 4</Occupancy>
<PlaceId>sample string 3</PlaceId>
<StopId>sample string 2</StopId>
<StopTime>2024-05-05T10:07:09.947028-07:00</StopTime>
</TripScheduleStopTime>
<TripScheduleStopTime>
<Occupancy>sample string 4</Occupancy>
<PlaceId>sample string 3</PlaceId>
<StopId>sample string 2</StopId>
<StopTime>2024-05-05T10:07:09.947028-07:00</StopTime>
</TripScheduleStopTime>
</StopTimes>
<TripId xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</TripId>
</TripScheduleTrip>
<TripScheduleTrip>
<PatternId>sample string 2</PatternId>
<StartTime>PT0.1234567S</StartTime>
<Status>sample string 3</Status>
<StopTimes>
<TripScheduleStopTime>
<Occupancy>sample string 4</Occupancy>
<PlaceId>sample string 3</PlaceId>
<StopId>sample string 2</StopId>
<StopTime>2024-05-05T10:07:09.947028-07:00</StopTime>
</TripScheduleStopTime>
<TripScheduleStopTime>
<Occupancy>sample string 4</Occupancy>
<PlaceId>sample string 3</PlaceId>
<StopId>sample string 2</StopId>
<StopTime>2024-05-05T10:07:09.947028-07:00</StopTime>
</TripScheduleStopTime>
</StopTimes>
<TripId xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</TripId>
</TripScheduleTrip>
</Trips>
</TripScheduleRoute>
</Routes>
<Stops>
<TripScheduleStop>
<City>sample string 7</City>
<Latitude>6</Latitude>
<Longitude>5</Longitude>
<PlaceId>sample string 3</PlaceId>
<PlaceName>sample string 2</PlaceName>
<StopDescription>sample string 4</StopDescription>
<StopId>sample string 1</StopId>
</TripScheduleStop>
<TripScheduleStop>
<City>sample string 7</City>
<Latitude>6</Latitude>
<Longitude>5</Longitude>
<PlaceId>sample string 3</PlaceId>
<PlaceName>sample string 2</PlaceName>
<StopDescription>sample string 4</StopDescription>
<StopId>sample string 1</StopId>
</TripScheduleStop>
</Stops>
</TripScheduleInfo>