Example of Real-time Data API

This is the human-readable API specification for real-time data example of the DWBP document.

In this example the Transport Agency of MyCity keeps track of all bus GPS data. The API provides consumers real-time status information using a REST API. The API allows the consumer to select:

  • Current position of the bus
  • Bus arrival time
  • Bus status

API Description

Description API Parameters
Bus position {root}/bus/position/current bus_id
Bus arrival time to some stop {root}/bus/arrival_time bus_id, stop_id
Bus status
(Possible return: "on-schedule", "delay", "out-of-service")
{root}/bus/status bus_id