OneBusAway · Example Payload

Get_Api_Where_Trip For Vehicle_Vehicleid.Json

default

Get_Api_Where_Trip For Vehicle_Vehicleid.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_trip-for-vehicle_vehicleID.json",
  "method": "GET",
  "path": "/api/where/trip-for-vehicle/{vehicleID}.json",
  "summary": "Retrieve trip for a specific vehicle",
  "description": "",
  "tags": [
    "default"
  ],
  "parameters": [
    {
      "in": "path",
      "name": "vehicleID",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "ID of the vehicle to retrieve trip details for."
    },
    {
      "in": "query",
      "name": "time",
      "schema": {
        "type": "integer",
        "format": "int64"
      },
      "description": "Time parameter to query the system at a specific time (optional)."
    },
    {
      "in": "query",
      "name": "includeTrip",
      "schema": {
        "type": "boolean"
      },
      "description": "Determines whether full <trip/> element is included in the <references/> section. Defaults to false."
    },
    {
      "in": "query",
      "name": "includeSchedule",
      "schema": {
        "type": "boolean"
      },
      "description": "Determines whether full <schedule/> element is included in the <tripDetails/> section. Defaults to false."
    },
    {
      "in": "query",
      "name": "includeStatus",
      "schema": {
        "type": "boolean"
      },
      "description": "Determines whether the full <status/> element is included in the <tripDetails/> section. Defaults to true."
    }
  ]
}