From bd372d57e2f9dfd8ba651e19f6adfa69ceda9c09 Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Fri, 20 Dec 2019 16:23:41 +0100 Subject: Travel API: Add "deprecated" field --- templates/api_documentation.html.ep | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) (limited to 'templates') diff --git a/templates/api_documentation.html.ep b/templates/api_documentation.html.ep index 2e3e66d..53159a1 100644 --- a/templates/api_documentation.html.ep +++ b/templates/api_documentation.html.ep @@ -73,6 +73,12 @@

Checkin per API. Sobald eine Zielstation bekannt ist, erfolgt der Checkout wie beim Webinterface automatisch zehn Minuten nach Ankunft. + 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 + 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.

curl -X POST -H "Content-Type: application/json" -d '{"token":"<%= $uid %>-<%= $token->{travel} // 'TOKEN' %>"}' <%= $api_root %>/travel @@ -88,7 +94,7 @@ }
"fromStation" : "Essen Hbf", (DS100 oder EVA-Nummer sind ebenfalls möglich)
"toStation" : "Berlin Hbf", (optional, DS100 oder EVA-Nummer sind ebenfalls möglich)
- "comment" : "Beliebiger Text" (optional)
+ "comment" : "Beliebiger Text" (optional, überschreibt vorherigen Kommentar)
}

Payload zur Wahl eines neuen Ziels, wenn bereits eingecheckt:

@@ -96,9 +102,9 @@ {
"token" : "<%= $uid %>-<%= $token->{travel} // 'TOKEN' %>",
"action" : "checkout",
- "force" : True/False, (wenn True: Checkout jetzt durchführen und auftretende Fehler ignorieren. Kann zu Logeinträgen ohne Ankunftsdaten führen.)
+ "force" : true/false, (wenn true: Checkout jetzt durchführen und auftretende Fehler ignorieren. Kann zu Logeinträgen ohne Ankunftsdaten führen.)
"toStation" : "Berlin Hbf", (DS100 oder EVA-Nummer sind ebenfalls möglich)
- "comment" : "Beliebiger Text" (optional)
+ "comment" : "Beliebiger Text" (optional, überschreibt vorherigen Kommentar)
}

Payload zum Rückgängigmachen eines Checkins (nur während der Fahrt möglich):

@@ -113,7 +119,8 @@

{
- "success" : True,
+ "success" : true,
+ "deprecated" : true / false, (falls true: Diese API-Version wird irgendwann abgeschaltet, bitte auf eine neue umsteigen)
"status" : { aktueller Nutzerstatus gemäß Status-API }
}

@@ -122,7 +129,8 @@

{
- "success" : False,
+ "success" : false,
+ "deprecated" : true / false, (falls true: Diese API-Version wird irgendwann abgeschaltet, bitte auf eine neue umsteigen)
"error" : "Begründung",
"status" : { aktueller Nutzerstatus gemäß Status-API }
} @@ -143,9 +151,9 @@

{
"token" : "<%= $uid %>-<%= $token->{import} // 'TOKEN' %>",
- "dryRun" : True/False, (optional: wenn True, wird die Eingabe validiert, aber keine Zugfahrt angelegt)
- "lax" : True/Fals, (optional: wenn True, werden unbekannte Unterwegshalte akzeptiert)
- "cancelled" : True/False, (Zugausfall?)
+ "dryRun" : true/false, (optional: wenn true, wird die Eingabe validiert, aber keine Zugfahrt angelegt)
+ "lax" : true/Fals, (optional: wenn true, werden unbekannte Unterwegshalte akzeptiert)
+ "cancelled" : true/false, (Zugausfall?)
"train" : {
"type" : "S", (Zugtyp, z.B. ICE, RE, S)
"line" : "6", (Linie als String, bei Zügen ohne Linie wie IC/ICE u.ä. null)
@@ -174,7 +182,7 @@

{
- "success" : True,
+ "success" : true,
"id" : 1234, (ID der eingetragenen Zugfahrt)
"result" : { ... } (Eingetragene Daten, Datenformat nicht näher spezifiziert und beliebig variabel)
} @@ -184,7 +192,7 @@

{
- "success" : False,
+ "success" : false,
"error" : "Begründung"
}

-- cgit v1.2.3