OneBusAway · Example Payload

Searchroute

TransitPublic TransitReal-TimeArrivalsDeparturesBusGTFSOpen SourceStop DataTrip PlanningService AlertsVehicle PositionsOpen Data

Searchroute 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": "searchRoute",
  "method": "GET",
  "path": "/api/where/search/route.json",
  "summary": "Search for a route based on its name.",
  "description": "",
  "tags": [],
  "parameters": [
    {
      "name": "input",
      "in": "query",
      "description": "The string to search for.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "maxCount",
      "in": "query",
      "description": "The max number of results to return. Defaults to 20.",
      "required": false,
      "schema": {
        "type": "integer"
      }
    }
  ]
}