Definition of API for Bus/Train cancellation Bot

[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

2. 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

[nirgilboa]

Script for the bus bot:

>הי

היי! אני בוט שמאפשר לדווח על רכבת/אוטובוס שלא הגיע.
בכל שלב אפשר להתחיל מהתחלה ע"י שליחת "ביי"
רכבת / אוטובוס

אוטובוס

איזה מרגיז…
שלחו לנו מיקום התחנה בבקשה :)

מיקום

👍 מה מספר הקו שלא הגיע?

25

👍 (מפה עם מיקום התחנה ואם אפשר תיאור כלומר שם הקווים והכיוון)
כן, זו! / לא, יש עוד?

כן

👍 איזו מאילו?
15:32 לכיוון הרצליה, 15:24 לכיוון הרצליה

15:32 לכיוון הרצליה

כמה זמן אתם בתחנה?
5 / 10 / 15 / 30 דקות / שעה אחרת

30 דקות

עליתם לאוטובוס בסוף?
כן / לא

קיבלתי 👍 תודה רבה על הדיווח. אני מקווה שתצליחו להגיע ליעד בקרוב… :)

נוכל להשתמש בשם שלכם?
כן / לא

לא

אוקי, לא נעלבתי..

אפשר לשלוח תמונה או סרטון או לסיים עם "ביי"