Operations¶
What happens during service: the actual progress of trips, the gaps against the schedule, and live supervision.
trip_events¶
Trip event — a timestamped fact that occurred during a trip: passing a stop, departure, arrival, state change. These events, reported by the device, form the trace of what actually happened and feed the delay computation.
No identifier of its own exposed: an event is located by its trip, its date and its timestamp.
| Endpoint | Purpose |
|---|---|
GET /api/v4/groups/<group_id>/trip-events |
Lists the events that occurred over a period |
trip-updates¶
Trip update — a gap against the schedule decided by the operator: a stop skipped, moved or added, a trip diverted or cancelled. The update does not rewrite the GTFS: it overlays the schedule for a given period, and propagates to passenger information.
Identifier <trip_update_id>. An update applies to a trip and a date range; detours are a special case, identified as such.
These updates are entered from the Pysae applications and are not published in the public spec. Their effect, however, is visible to passengers through the GTFS-RT and SIRI feeds.
| Endpoint | Purpose |
|---|---|
GET /api/v4/groups/<group_id>/trip-updates/search |
Searches the updates in force |
PUT /api/v4/groups/<group_id>/trip-updates |
Records an update |
GET /api/v4/groups/<group_id>/deviations |
Lists the detours |
trip-tracking¶
Trip tracking — the account of how a trip unfolded: at what time the vehicle passed where, with what gap against the scheduled time. It is the consolidated view of execution, the one exported to analyse the service delivered.
No identifier of its own: tracking relates to a trip and its date.
| Endpoint | Purpose |
|---|---|
GET /api/v4/groups/<group_id>/stats/trip-tracking |
Aggregates tracking over a period |
GET /api/v4/groups/<group_id>/export/trip-tracking |
Exports the detail as CSV |
vehicle_movements¶
Vehicle movement — a movement of the vehicle tied to operations, including outside commercial service: the run to the start of the trip, the return to the depot, a dead run. These movements complement trips to account for the vehicle's full usage.
Identifier <vehicle_movement_id>. A movement may be attached to a block, the sequence of trips chained by a single vehicle.
| Endpoint | Purpose |
|---|---|
GET /api/v4/groups/<group_id>/vehicle_movements |
Lists the movements over a period |
GET /api/v4/groups/<group_id>/blocks/<block_id>/vehicle_movements |
Gives a block's movements |
vehicle-exploitation¶
Vehicle exploitation — the account of a vehicle's activity over a period: what it operated, when, and over what distances. Used for fleet monitoring and for exchanges with fleet management systems.
No identifier of its own: the data is obtained per vehicle and per period.
| Endpoint | Purpose |
|---|---|
GET /api/v4/groups/<group_id>/export/vehicle-exploitation |
Exports vehicle activity as CSV |
danger_zones¶
Danger zone — a point of the network flagged to drivers as requiring particular care: a narrow passage, a difficult exit, an accident-prone area. The device warns the driver on approach.
Identifier <danger_zone_id>. A zone is defined by a geographic point, a radius and the message displayed.
| Endpoint | Purpose |
|---|---|
GET /api/v4/groups/<group_id>/danger-zones |
Lists the zones declared on the network |