diff options
| author | Birte Kristina Friesel <derf@finalrewind.org> | 2023-08-19 12:43:43 +0200 |
|---|---|---|
| committer | Birte Kristina Friesel <derf@finalrewind.org> | 2023-08-19 12:43:43 +0200 |
| commit | b85e8a1e04b2021843f7fb11337bc5a298635b7b (patch) | |
| tree | 67db7a85306b8a0d2f124a949f503459d0da6677 /templates/api_documentation.html.ep | |
| parent | 85022709d75940a3f84cdbe462f9b261b38fc69e (diff) | |
API: Support HAFAS checkin (via journeyID)
Diffstat (limited to 'templates/api_documentation.html.ep')
| -rw-r--r-- | templates/api_documentation.html.ep | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/templates/api_documentation.html.ep b/templates/api_documentation.html.ep index ab90dec..0847139 100644 --- a/templates/api_documentation.html.ep +++ b/templates/api_documentation.html.ep @@ -102,7 +102,7 @@ <p style="font-family: Monospace;"> curl -X POST -H "Content-Type: application/json" -d '{"token":"<%= $uid %>-<%= $token->{travel} // 'TOKEN' %>"}' <%= $api_root %>/travel </p> - <p>Payload zum Einchecken, optional mit Zielwahl:</p> + <p>Payload zum Einchecken per IRIS-Backend (Schienenverkehr DE/DB), optional mit Zielwahl:</p> <p style="font-family: Monospace;"> {<br/> "token" : "<%= $uid %>-<%= $token->{travel} // 'TOKEN' %>",<br/> @@ -116,6 +116,19 @@ "comment" : "Beliebiger Text" (optional, überschreibt vorherigen Kommentar)<br/> } </p> + <p>Payload zum Einchecken per HAFAS-Backend (Nahverkehr und außerhalb DE/DB), optional mit Zielwahl. fromStation und toStation müssen mit den Unterwegshalten übereinstimmen, z.B. "Hauptbahnhof (U Gleis 2+4), Essen (Ruhr)" statt "Essen Hbf".</p> + <p style="font-family: Monospace;"> + {<br/> + "token" : "<%= $uid %>-<%= $token->{travel} // 'TOKEN' %>",<br/> + "action" : "checkin",<br/> + "train" : {<br/> + "journeyID" : "1|1426396|4|80|19082023",<br/> + }<br/> + "fromStation" : 651806, (Name oder EVA-Nummer)<br/> + "toStation" : 654645, (optional, Name oder EVA-Nummer)<br/> + "comment" : "Beliebiger Text" (optional, überschreibt vorherigen Kommentar)<br/> + } + </p> <p>Payload zur Wahl eines neuen Ziels, wenn bereits eingecheckt:</p> <p style="font-family: Monospace;"> {<br/> |