OneBusAway · Example Payload

Get_Api_Where_Shape_Shapeid.Json

Retrieve a shape (the path traveled by a transit vehicle) by ID.

TransitPublic TransitReal-TimeArrivalsDeparturesBusGTFSOpen SourceStop DataTrip PlanningService AlertsVehicle PositionsOpen Data

Get_Api_Where_Shape_Shapeid.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_shape_shapeID.json",
  "method": "GET",
  "path": "/api/where/shape/{shapeID}.json",
  "summary": "Retrieve a shape by ID",
  "description": "Retrieve a shape (the path traveled by a transit vehicle) by ID.",
  "tags": [],
  "parameters": [
    {
      "name": "shapeID",
      "in": "path",
      "required": true,
      "description": "The shape ID, encoded directly in the URL",
      "schema": {
        "type": "string"
      }
    }
  ]
}