Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include train line data in rail API #15

Open
houbly opened this issue Dec 16, 2021 · 0 comments
Open

Include train line data in rail API #15

houbly opened this issue Dec 16, 2021 · 0 comments
Labels
API issue Requires api access backend backend issue

Comments

@houbly
Copy link
Contributor

houbly commented Dec 16, 2021

The API endpoints currently being accessed for rail searches on this app are:

api.wmnetwork.co.uk
/rail/v2/station?q=
/rail/v2/station/:id
/rail/v1/departuresandarrivals/:id

What

  • Currently, the departures and arrivals API doesn't include the train line which each station runs on which means we can't add functionality to accurately filter train stations that run on the same line. (See design at https://www.figma.com/file/0EvvTWMZXlKDrQ9WcINGsn/Station-and-Stops?node-id=577%3A13300)
  • This might be fixed by doing one of the following:
    • Including the train lines each station runs on (e.g. Cross city, Walsall) in the /rail/v1/departuresandarrivals/:id endpoint so they can be cross-referenced between stations to determine whether two stations are on the same line
    • Creating a new endpoint where you can query the name of station line to find out which stations run on them
    • Creating a new endpoint where you can query a station to find out the departure routes that will be taken from the station
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API issue Requires api access backend backend issue
Projects
None yet
Development

No branches or pull requests

1 participant