diff options
| author | Daniel Friesel <derf@finalrewind.org> | 2019-12-17 20:01:39 +0100 |
|---|---|---|
| committer | Daniel Friesel <derf@finalrewind.org> | 2019-12-17 20:01:39 +0100 |
| commit | ae21896982b5f53c0a011740f58a97be40bf0b30 (patch) | |
| tree | 9258ac91b121b04aaa3ed2ff33a087ca95e80052 /templates/api_documentation.html.ep | |
| parent | 9adec3ee8d1badec3dcd3643774b5e5c0e866840 (diff) | |
API: Add lax option
Diffstat (limited to 'templates/api_documentation.html.ep')
| -rw-r--r-- | templates/api_documentation.html.ep | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/templates/api_documentation.html.ep b/templates/api_documentation.html.ep index b9b7b44..cf3a57a 100644 --- a/templates/api_documentation.html.ep +++ b/templates/api_documentation.html.ep @@ -78,7 +78,7 @@ <p>Payload zum Einchecken, optional mit Zielwahl:</p> <p style="font-family: Monospace;"> {<br/> - "token" : "<%= $uid %>-<%= $token->{import} // 'TOKEN' %>",<br/> + "token" : "<%= $uid %>-<%= $token->{travel} // 'TOKEN' %>",<br/> "action" : "checkin",<br/> "train" : {<br/> "type" : "ICE",<br/> @@ -92,7 +92,7 @@ <p>Payload zur Wahl eines neuen Ziels, wenn bereits eingecheckt:</p> <p style="font-family: Monospace;"> {<br/> - "token" : "<%= $uid %>-<%= $token->{import} // 'TOKEN' %>",<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/> "toStation" : "Berlin Hbf", (DS100 oder EVA-Nummer sind ebenfalls möglich)<br/> @@ -102,7 +102,7 @@ <p>Payload zum Rückgängigmachen eines Checkins (nur während der Fahrt möglich):</p> <p style="font-family: Monospace;"> {<br/> - "token" : "<%= $uid %>-<%= $token->{import} // 'TOKEN' %>",<br/> + "token" : "<%= $uid %>-<%= $token->{travel} // 'TOKEN' %>",<br/> "action" : "undo"<br/> } </p> @@ -135,13 +135,14 @@ Manueller Import vergangener Zugfahrten (eine Fahrt pro API-Aufruf). </p> <p style="font-family: Monospace;"> - curl -X POST -H "Content-Type: application/json" -d '{"token":"<%= $uid %>-<%= $token->{status} // 'TOKEN' %>"}' <%= $api_root %>/import + curl -X POST -H "Content-Type: application/json" -d '{"token":"<%= $uid %>-<%= $token->{import} // 'TOKEN' %>"}' <%= $api_root %>/import </p> <p>Payload (alle nicht als optional markierten Felder sind Pflicht):</p> <p style="font-family: Monospace;"> {<br/> "token" : "<%= $uid %>-<%= $token->{import} // 'TOKEN' %>",<br/> "dryRun" : True/False, (optional: wenn True, wird die Eingabe validiert, aber keine Zugfahrt angelegt)<br/> + "lax" : True/Fals, (optional: wenn True, werden unbekannte Unterwegshalte akzeptiert)<br/> "cancelled" : True/False, (Zugausfall?)<br/> "train" : {<br/> "type" : "S", (Zugtyp, z.B. ICE, RE, S)<br/> @@ -173,7 +174,7 @@ {<br/> "success" : True,<br/> "id" : 1234, (ID der eingetragenen Zugfahrt)<br/> - "result" : { ... } (Eingetragene Daten, Inhalt ist variabel)<br/> + "result" : { ... } (Eingetragene Daten, Datenformat nicht näher spezifiziert und beliebig variabel)<br/> } </p> <p> |