PrivateCoffee/travelynx
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

API docs: Zug → Fahrt

Browse source
This commit is contained in:
Birte Kristina Friesel 2023-08-14 12:29:07 +02:00
parent caf1afa610
commit cc381d199f
No known key found for this signature in database
GPG key ID: 19E6E524EBB177BA
1 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
templates/api_documentation.html.ep
View file

@ -59,10 +59,10 @@
…<br/> …<br/>
],<br/> ],<br/>
"train" : {<br/> "train" : {<br/>
"type" : "S", (aktueller / letzter Zugtyp)<br/> "type" : "S", (aktueller / letzter Fahrttyp)<br/>
"line" : "6", (Linie als String, nicht immer numerisch, ggf. null)<br/> "line" : "6", (Linie als String, nicht immer numerisch, ggf. null)<br/>
"no" : "30634", (Zugnummer als String)<br/> "no" : "30634", (Fahrtnummer als String, ggf. null oder leer)<br/>
"id" : "7512500863736016593" (IRIS-spezifische Zug-ID)<br/> "id" : "7512500863736016593" (IRIS- oder HAFAS-spezifische Fahrt-ID)<br/>
},<br/> },<br/>
"visibility" : {<br/> "visibility" : {<br/>
"desc": "private" / "unlisted" / "followers" / "travelynx" / "public",<br/> "desc": "private" / "unlisted" / "followers" / "travelynx" / "public",<br/>
@ -83,19 +83,19 @@
Checkin per API. Sobald eine Zielstation bekannt ist, erfolgt der Checkin per API. Sobald eine Zielstation bekannt ist, erfolgt der
Checkout wie beim Webinterface automatisch zehn Minuten nach Ankunft. Checkout wie beim Webinterface automatisch zehn Minuten nach Ankunft.
Bitte beachten: Es wird nicht überprüft, ob die angegebene Zielstation 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.
</p> </p>
<p> <p>
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. 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 Station verkehrt oder nicht. Falls nach einem Checkin ohne Zielwahl
innerhalb von 48 Stunden kein Zielbahnhof nachgetragen wird, wird der innerhalb von 48 Stunden kein Zielbahnhof nachgetragen wird, wird der
Checkin automatisch rückgängig gemacht. Checkin automatisch rückgängig gemacht.
</p> </p>
<p> <p>
Das Verhalten des Checkout-Endpunkts hängt vom Zeitpunkt ab. Wenn der Das Verhalten des Checkout-Endpunkts hängt vom Zeitpunkt ab. Wenn die
Zug den angegebenen Zielbahnhof bereits erreicht hat, wird dort Fahrt den angegebenen Zielbahnhof bereits erreicht hat, wird dort
ausgecheckt. Andernfalls wird das Reiseziel aktualisiert und etwa zehn ausgecheckt. Andernfalls wird das Reiseziel aktualisiert und etwa zehn
Minuten nach Ankunft automatisch ausgecheckt. Minuten nach Ankunft automatisch ausgecheckt.
</p> </p>
@ -161,7 +161,7 @@
<div class="row"> <div class="row">
<div class="col s12"> <div class="col s12">
<p> <p>
Manueller Import vergangener Zugfahrten (eine Fahrt pro API-Aufruf). Manueller Import vergangener Fahrten (eine Fahrt pro API-Aufruf).
</p> </p>
<p> <p>
Bitte beachten: fromStation, toStation und intermediateStops werden Bitte beachten: fromStation, toStation und intermediateStops werden
@ -179,13 +179,13 @@
<p style="font-family: Monospace;"> <p style="font-family: Monospace;">
{<br/> {<br/>
"token" : "<%= $uid %>-<%= $token->{import} // 'TOKEN' %>",<br/> "token" : "<%= $uid %>-<%= $token->{import} // 'TOKEN' %>",<br/>
"dryRun" : true/false, (optional: wenn true, wird die Eingabe validiert, aber keine Zugfahrt angelegt)<br/> "dryRun" : true/false, (optional: wenn true, wird die Eingabe validiert, aber keine Fahrt angelegt)<br/>
"lax" : true/false, (optional: wenn true, werden unbekannte Unterwegshalte akzeptiert)<br/> "lax" : true/false, (optional: wenn true, werden unbekannte Unterwegshalte akzeptiert)<br/>
"cancelled" : true/false, (Zugausfall?)<br/> "cancelled" : true/false, (Ausfall?)<br/>
"train" : {<br/> "train" : {<br/>
"type" : "S", (Zugtyp, z.B. ICE, RE, S)<br/> "type" : "S", (Typ, z.B. ICE, RE, S, U)<br/>
"line" : "6", (Linie als String, bei Zügen ohne Linie wie IC/ICE u.ä. null)<br/> "line" : "6", (Linie als String, bei Zügen ohne Linie wie IC/ICE u.ä. null)<br/>
"no" : "30634", (Zugnummer als String)<br/> "no" : "30634", (Nummer als String, ggf. null oder leer)<br/>
},<br/> },<br/>
"fromStation" : { (Start / Checkin)<br/> "fromStation" : { (Start / Checkin)<br/>
"name" : "Essen Hbf", (Name oder DS100)<br/> "name" : "Essen Hbf", (Name oder DS100)<br/>
@ -210,7 +210,7 @@
{<br/> {<br/>
"success" : true,<br/> "success" : true,<br/>
"deprecated" : true / false, (falls true: Diese API-Version wird irgendwann abgeschaltet, bitte auf eine neue umsteigen)<br/> "deprecated" : true / false, (falls true: Diese API-Version wird irgendwann abgeschaltet, bitte auf eine neue umsteigen)<br/>
"id" : 1234, (ID der eingetragenen Zugfahrt)<br/> "id" : 1234, (ID der eingetragenen Fahrt)<br/>
"result" : { ... } (Eingetragene Daten. Das Datenformat kann sich "result" : { ... } (Eingetragene Daten. Das Datenformat kann sich
ohne Berücksichtigung der API-Version ändern)<br/> ohne Berücksichtigung der API-Version ändern)<br/>
} }