From cc381d199faafb37e73054bc46fbc6adbf5adfc8 Mon Sep 17 00:00:00 2001 From: Birte Kristina Friesel Date: Mon, 14 Aug 2023 12:29:07 +0200 Subject: API docs: Zug → Fahrt MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- templates/api_documentation.html.ep | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/templates/api_documentation.html.ep b/templates/api_documentation.html.ep index 1874f5d..ab90dec 100644 --- a/templates/api_documentation.html.ep +++ b/templates/api_documentation.html.ep @@ -59,10 +59,10 @@ …
],
"train" : {
- "type" : "S", (aktueller / letzter Zugtyp)
+ "type" : "S", (aktueller / letzter Fahrttyp)
"line" : "6", (Linie als String, nicht immer numerisch, ggf. null)
- "no" : "30634", (Zugnummer als String)
- "id" : "7512500863736016593" (IRIS-spezifische Zug-ID)
+ "no" : "30634", (Fahrtnummer als String, ggf. null oder leer)
+ "id" : "7512500863736016593" (IRIS- oder HAFAS-spezifische Fahrt-ID)
},
"visibility" : {
"desc": "private" / "unlisted" / "followers" / "travelynx" / "public",
@@ -83,19 +83,19 @@ 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. + in der vorgesehenen Route der Fahrt vorkommt oder nicht.

- Falls du zum Checkinzeitpunkt bereits in einen anderen Zug eingecheckt + 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 der vorherige Zug an dieser + 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.

- Das Verhalten des Checkout-Endpunkts hängt vom Zeitpunkt ab. Wenn der - Zug den angegebenen Zielbahnhof bereits erreicht hat, wird dort + 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.

@@ -161,7 +161,7 @@

- Manueller Import vergangener Zugfahrten (eine Fahrt pro API-Aufruf). + Manueller Import vergangener Fahrten (eine Fahrt pro API-Aufruf).

Bitte beachten: fromStation, toStation und intermediateStops werden @@ -179,13 +179,13 @@

{
"token" : "<%= $uid %>-<%= $token->{import} // 'TOKEN' %>",
- "dryRun" : true/false, (optional: wenn true, wird die Eingabe validiert, aber keine Zugfahrt angelegt)
+ "dryRun" : true/false, (optional: wenn true, wird die Eingabe validiert, aber keine Fahrt angelegt)
"lax" : true/false, (optional: wenn true, werden unbekannte Unterwegshalte akzeptiert)
- "cancelled" : true/false, (Zugausfall?)
+ "cancelled" : true/false, (Ausfall?)
"train" : {
- "type" : "S", (Zugtyp, z.B. ICE, RE, S)
+ "type" : "S", (Typ, z.B. ICE, RE, S, U)
"line" : "6", (Linie als String, bei Zügen ohne Linie wie IC/ICE u.ä. null)
- "no" : "30634", (Zugnummer als String)
+ "no" : "30634", (Nummer als String, ggf. null oder leer)
},
"fromStation" : { (Start / Checkin)
"name" : "Essen Hbf", (Name oder DS100)
@@ -210,7 +210,7 @@ {
"success" : true,
"deprecated" : true / false, (falls true: Diese API-Version wird irgendwann abgeschaltet, bitte auf eine neue umsteigen)
- "id" : 1234, (ID der eingetragenen Zugfahrt)
+ "id" : 1234, (ID der eingetragenen Fahrt)
"result" : { ... } (Eingetragene Daten. Das Datenformat kann sich ohne Berücksichtigung der API-Version ändern)
} -- cgit v1.2.3