Reportproblemwithtrip 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.
{
"operationId": "reportProblemWithTrip",
"method": "GET",
"path": "/api/where/report-problem-with-trip/{tripID}.json",
"summary": "Submit a user-generated problem report for a particular trip.",
"description": "",
"tags": [],
"parameters": [
{
"name": "tripID",
"in": "path",
"required": true,
"description": "The ID of the trip",
"schema": {
"type": "string"
}
},
{
"name": "serviceDate",
"in": "query",
"required": false,
"description": "The service date of the trip",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "vehicleID",
"in": "query",
"required": false,
"description": "The vehicle actively serving the trip",
"schema": {
"type": "string"
}
},
{
"name": "stopID",
"in": "query",
"required": false,
"description": "A stop ID indicating where the user is experiencing the problem",
"schema": {
"type": "string"
}
},
{
"name": "code",
"in": "query",
"required": false,
"description": "A string code identifying the nature of the problem",
"schema": {
"type": "string",
"enum": [
"vehicle_never_came",
"vehicle_came_early",
"vehicle_came_late",
"wrong_headsign",
"vehicle_does_not_stop_here",
"other"
]
}
},
{
"name": "userComment",
"in": "query",
"required": false,
"description": "Additional comment text supplied by the user describing the problem",
"schema": {
"type": "string"
}
},
{
"name": "userOnVehicle",
"in": "query",
"required": false,
"description": "Indicator if the user is on the transit vehicle experiencing the problem",
"schema": {
"type": "boolean"
}
},
{
"name": "userVehicleNumber",
"in": "query",
"required": false,
"description": "The vehicle number, as reported by the user",
"schema": {
"type": "string"
}
},
{
"name": "userLat",
"in": "query",
"required": false,
"description": "The reporting user\u2019s current latitude",
"schema": {
"type": "number",
"format": "float"
}
},
{
"name": "userLon",
"in": "query",
"required": false,
"description": "The reporting user\u2019s current longitude",
"schema": {
"type": "number",
"format": "float"
}
},
{
"name": "userLocationAccuracy",
"in": "query",
"required": false,
"description": "The reporting user\u2019s location accuracy, in meters",
"schema": {
"type": "number",
"format": "float"
}
}
]
}