Skip to content
This repository has been archived by the owner on Jun 18, 2024. It is now read-only.

Latest commit

 

History

History
23 lines (21 loc) · 1.18 KB

DOCUMENTATION.md

File metadata and controls

23 lines (21 loc) · 1.18 KB

Documentation

This server serves the purpose of the backbone of the "gethere." service. It provides access to data about the lines, stops, operators and other information needed for navigation in our city infrastracture

Routes:

  • /api/operators/1/status
    • Returns { "status": "ok" } if the server is online
  • /api/operators/1/dates/:date/line/:line-name
    • Returns details about the tram/bus line
  • /api/operators/1/dates/:date/stop-groups
    • Returns all stop groups for the given date
  • /api/operators
    • Returns all supported operators by our service
  • /api/operators/1/dates/:date/lines
    • Returns data about all the line for the given date
  • /api/operators/1/dates
    • Returns all the dates data is available for
  • /api/operators/1/dates/:date/stop-groups/:stop-group-api-id/stops/:stop-discriminator
    • Returns details about the stop with the given discriminator in the given stop group on the given date
  • /api/operators/1/dates/:date/stops
    • Returns all the stops for the given date
  • /api/operators/1/dates/:date/lines/:line-name/routes/directions/:direction/variants/:variant
    • Returns details about the given variant of the line in the specified direction