OneBusAway · Example Payload

Get_Api_Where_Trips For Route_Routeid.Json

default

Get_Api_Where_Trips For Route_Routeid.Json is an example object payload from OneBusAway, with 7 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummarydescriptiontagsparameters

Example Payload

Raw ↑ 
{
  "operationId": "get_api_where_trips-for-route_routeID.json",
  "method": "GET",
  "path": "/api/where/trips-for-route/{routeID}.json",
  "summary": "Search for active trips for a specific route.",
  "description": "",
  "tags": [
    "default"
  ],
  "parameters": [
    {
      "name": "routeID",
      "in": "path",
      "required": true,
      "description": "The ID of the route.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "includeStatus",
      "in": "query",
      "required": false,
      "description": "Determine whether full tripStatus elements with real-time information are included. Defaults to false.",
      "schema": {
        "type": "boolean"
      }
    },
    {
      "name": "includeSchedule",
      "in": "query",
      "required": false,
      "description": "Determine whether full schedule elements are included. Defaults to false.",
      "schema": {
        "type": "boolean"
      }
    },
    {
      "name": "time",
      "in": "query",
      "required": false,
      "description": "Query the system at a specific time. Useful for testing.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ]
}