Skip to content

Definition of API for Bus/Train cancellation Bot #2

@nirgilboa

Description

@nirgilboa

This is intended to document the APIs we're interested in having on top of the django-multi-gtfs project in order for users to report cancellations of trips, similar to: https://t.me/opentrain_bot

Buses

  1. GET a list of matching bus stations at current location:
    Parameters:
  • Location (lat, long)
  • Timestamp
  • Bus number
  • Distance (optional)
  • Time window (optional)

Response:

  • List of stations

Station:

  • station id
  • station name
  • station number
  • location (lat/long)
  • BusRoutes

BusRoute:

  • bus number
  • direction / description
  1. GET a list matching trips given a station id at specific location
    Parameters:
  • Station id
  • Timestamp
  • Time window (optional)
  • Bus number

Response:

  • List of BusStopTime

BusStopTime:

  • Station id
  • Timestamp at station
  • BusTrip id

BusTrip:

  • List of BusStopTime

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions