Response & schema reference
Download the complete schema set
Section titled “Download the complete schema set”Download all four files for your client.
| File | Contents |
|---|---|
| PlanRequest.proto | Request, user speeds, flex and pricing options |
| PlanResult.proto | Results, trips, legs, places, alerts, booking and fares |
| Modes.proto | Transit and non-transit enums |
| DirectionType.proto | Journey direction enum |
PlanResult
Section titled “PlanResult”| Field | Meaning |
|---|---|
trips[] | Travel options in this result frame |
timestamp | Result timestamp |
errors[] | Routing errors (code, message) |
modifiers[] | Request modifications used for this group |
grade | Group-level relative grade |
containsOnDemand, containsWithSurcharge | Optional, source-dependent flags |
TripPattern
Section titled “TripPattern”| Fields | Meaning |
|---|---|
aimedStartTime, aimedEndTime | Scheduled/planned times |
expectedStartTime, expectedEndTime | Expected times when mapped |
duration, transfers | Minutes and transfer count |
waitingTime, walkTime | Optional minutes |
distance, streetDistance | Optional metres |
legs[], systemNotices[] | Timeline and general notices |
id | Trip identity in returned results |
itineraryHash | Opaque replay identifier for transit/flex itineraries; empty for purely non-transit trips |
grade | Individual trip grade |
pricingInfo | Optional total, leg fares, discounts and transfer instructions |
Response details by experience
Section titled “Response details by experience”- Trips, legs and maps: place labels, geometry, waiting, branding and rental data.
- Realtime and alerts: expected times, platforms, cancellations and scoped situations.
- Flexible journeys: booking arrangements and uncertainty flags.
- Fares: cents, status, discounts and check-in changes.
- Accessibility: optional wheelchair and bike-permission flags.
Use a matching schema set
Section titled “Use a matching schema set”Keep these files together and update them as a set. Use enum names in your display code and preserve optional values when decoding.