v1

latestSwagger 2.02026-07-14120752.1 KB

XML - Schedule

<h4 class="text-primary">Description</h4> <p>Returns schedules for a given route variant for a given date.</p> <h4 class="text-primary">Response Elements</h4> <table class="table table-condensed table-hover"> <thead> <tr> <th class="col-md-3">Element</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>Direction0/Direction1</td> <td> Arrays containing trip information (<a href= "#Trip">Trip</a>).<br> <br> Most routes will return content in both Direction0 and Direction1 elements, though a few (especially ones which run in a loop, such as the U8) will return content only for Direction0 and NULL content for Direction1.<br> <br> 0 or 1 are binary properties. There is no specific mapping to direction, but a different value for the same route signifies that the route is in an opposite direction. </td> </tr> <tr> <td>Name</td> <td>Descriptive name for the route.</td> </tr> <tr> <td colspan="2"> <div class="text-primary" style="margin-top: 1em"> <a id="Trip" name="Trip">Trip Elements</a> </div> </td> </tr> <tr> <td style="text-decoration: line-through">DirectionNum</td> <td><span class="text-danger">Deprecated.</span> Use the TripDirectionText element to denote the general direction of the trip.</td> </tr> <tr> <td>EndTime</td> <td>Scheduled end date and time (Eastern Standard Time) for this trip. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.: 2014-10-27T13:17:00).</td> </tr> <tr> <td>RouteID</td> <td>Bus route variant. This can be used in several other bus methods which accept variants.</td> </tr> <tr> <td>StartTime</td> <td>Scheduled start date and time (Eastern Standard Time) for this trip. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.: 2014-10-27T13:17:00).</td> </tr> <tr> <td>StopTimes</td> <td> Array containing location and time information (<a href= "#StopTime">StopTime</a>). </td> </tr> <tr> <td>TripDirectionText</td> <td>General direction of the trip (NORTH, SOUTH, EAST, WEST, LOOP, etc.).</td> </tr> <tr> <td>TripHeadsign</td> <td>Descriptive text of where the bus is headed. This is similar, but not necessarily identical, to what is displayed on the bus.</td> </tr> <tr> <td>TripID</td> <td>Unique trip ID. This can be correlated with the data returned from the schedule-related methods.</td> </tr> <tr> <td colspan="2"> <div class="text-primary" style="margin-top: 1em"> <a id="StopTime" name="StopTime">StopTime Elements</a> </div> </td> </tr> <tr> <td>StopID</td> <td>7-digit regional ID which can be used in various bus-related methods. If unavailable, the StopID will be 0 or NULL.</td> </tr> <tr> <td>StopName</td> <td>Stop name. May be slightly different from what is spoken or displayed in the bus.</td> </tr> <tr> <td>StopSeq</td> <td>Order of the stop in the sequence of StopTimes.</td> </tr> <tr> <td>Time</td> <td>Scheduled departure date and time (Eastern Standard Time) from this stop. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.: 2014-10-27T13:17:00).</td> </tr> </tbody> </table>
get/RouteSchedule

Query parameters

RouteID'70' required

Bus route variant, e.g.: 70, 10A, 10Av1.

Datestring

Date in YYYY-MM-DD format for which to retrieve schedule. Defaults to today's date unless specified.

IncludingVariationsfalse | true

Whether or not to include variations. For example, if B30 is specified, include all variations such as B30v1, B30v2, etc.

Response

Default response code.