diff options
| author | Daniel Friesel <derf@finalrewind.org> | 2019-12-20 18:33:59 +0100 |
|---|---|---|
| committer | Daniel Friesel <derf@finalrewind.org> | 2019-12-20 18:33:59 +0100 |
| commit | e7f278574fa1c5f8896791c9444868b7f60760e3 (patch) | |
| tree | 80a9ac43dafb56dcaad92557588b3d437849ada2 /templates | |
| parent | 11a2e94a04bf451a1b8411daa18d8f340a12a9c6 (diff) | |
more travel API documentation
Diffstat (limited to 'templates')
| -rw-r--r-- | templates/api_documentation.html.ep | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/templates/api_documentation.html.ep b/templates/api_documentation.html.ep index a2e5a6c..e5d026f 100644 --- a/templates/api_documentation.html.ep +++ b/templates/api_documentation.html.ep @@ -73,6 +73,10 @@ <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 des Zugs vorkommt oder nicht. + </p> + <p> Falls du zum Checkinzeitpunkt bereits in einen anderen Zug eingecheckt bist, wirst du zunächst am gewählten Startbahnhof aus diesem ausgecheckt. Der Checkout erfolgt unabhängig davon, ob der vorherige Zug an dieser @@ -80,6 +84,12 @@ 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 der + Zug den angegebenen Zielbahnhof bereits erreicht hat, wird dort + ausgecheckt. Andernfalls wird das Reiseziel aktualisiert und etwa zehn + Minuten 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 </p> @@ -102,7 +112,7 @@ {<br/> "token" : "<%= $uid %>-<%= $token->{travel} // 'TOKEN' %>",<br/> "action" : "checkout",<br/> - "force" : true/false, (wenn true: Checkout jetzt durchführen und auftretende Fehler ignorieren. Kann zu Logeinträgen ohne Ankunftsdaten führen.)<br/> + "force" : true/false, (wenn true: Checkout jetzt durchführen und auftretende Fehler ignorieren. Kann zu Logeinträgen ohne Ankunftszeit führen.)<br/> "toStation" : "Berlin Hbf", (DS100 oder EVA-Nummer sind ebenfalls möglich)<br/> "comment" : "Beliebiger Text" (optional, überschreibt vorherigen Kommentar)<br/> } |