diff options
Diffstat (limited to 'templates/api_documentation.html.ep')
| -rw-r--r-- | templates/api_documentation.html.ep | 33 |
1 files changed, 18 insertions, 15 deletions
diff --git a/templates/api_documentation.html.ep b/templates/api_documentation.html.ep index 4453286..6db9536 100644 --- a/templates/api_documentation.html.ep +++ b/templates/api_documentation.html.ep @@ -89,23 +89,25 @@ <div class="col s12"> <p> Checkin per API. Sobald eine Zielstation bekannt ist, erfolgt der - Checkout wie beim Webinterface automatisch zehn Minuten nach Ankunft. - Bitte beachten: Es wird nicht überprüft, ob die angegebene Zielstation - in der vorgesehenen Route der Fahrt vorkommt oder nicht. + Checkout wie beim Webinterface automatisch spätestens eine halbe + Stunde nach Ankunft. Bitte beachten: Es wird nicht überprüft, ob + die angegebene Zielstation in der vorgesehenen Route der Fahrt + vorkommt oder nicht. </p> <p> - Falls du zum Checkinzeitpunkt bereits in eine andere Fahrt eingecheckt - bist, wirst du zunächst am gewählten Startbahnhof aus diesem ausgecheckt. - Der Checkout erfolgt unabhängig davon, ob die vorherige Fahrt an dieser - Station verkehrt oder nicht. Falls nach einem Checkin ohne Zielwahl - innerhalb von 48 Stunden kein Zielbahnhof nachgetragen wird, wird der - Checkin automatisch rückgängig gemacht. + Falls du zum Checkinzeitpunkt bereits in eine andere Fahrt + eingecheckt bist, wirst du zunächst am gewählten Startbahnhof aus + diesem ausgecheckt. Der Checkout erfolgt unabhängig davon, ob die + vorherige Fahrt an dieser Station verkehrt oder nicht. Falls nach + einem Checkin ohne Zielwahl innerhalb von 48 Stunden kein + Zielbahnhof nachgetragen wird, wird der Checkin automatisch + rückgängig gemacht. </p> <p> Das Verhalten des Checkout-Endpunkts hängt vom Zeitpunkt ab. Wenn die Fahrt den angegebenen Zielbahnhof bereits erreicht hat, wird dort - ausgecheckt. Andernfalls wird das Reiseziel aktualisiert und etwa zehn - Minuten nach Ankunft automatisch ausgecheckt. + ausgecheckt. Andernfalls wird das Reiseziel aktualisiert und + spätestens eine halbe Stunde nach Ankunft automatisch ausgecheckt. </p> <p style="font-family: Monospace;"> curl -X POST -H "Content-Type: application/json" -d '{"token":"<%= $uid %>-<%= $token->{travel} // 'TOKEN' %>"}' <%= $api_root %>/travel @@ -129,12 +131,13 @@ {<br/> "token" : "<%= $uid %>-<%= $token->{travel} // 'TOKEN' %>",<br/> "action" : "checkin",<br/> - "hafas" : "DB", (HAFAS-Instanz – Default: Deutsche Bahn)<br/> + "dbris" : "bahn.de", (DBRIS-Instanz – Default: bahn.de)<br/> + "hafas" : null, (HAFAS-Instanz, falls verwendet, sonste null)<br/> "train" : {<br/> - "journeyID" : "1|1426396|4|80|19082023",<br/> + "journeyID" : "2|#VN#1#ST#1742845592#PI#0#ZI#315136#TA#0#DA#270325#1S#8000080#1T#1841#LS#8006486#LT#2024#PU#80#RT#1#CA#RE#ZE#10773#ZB#RE10773#PC#3#FR#8000080#FT#1841#TO#8006486#TT#2024#",<br/> }<br/> - "fromStation" : 651806, (Name oder EVA-Nummer)<br/> - "toStation" : 654645, (optional, Name oder EVA-Nummer)<br/> + "fromStation" : 8000080, (Name oder EVA-Nummer – bei bahn.de nur EVA-Nummer)<br/> + "toStation" : 8006486, (optional, Name oder EVA-Nummer – bei bahn.de nur EVA-Nummer)<br/> "comment" : "Beliebiger Text" (optional, überschreibt vorherigen Kommentar)<br/> } </p> |