From b85e8a1e04b2021843f7fb11337bc5a298635b7b Mon Sep 17 00:00:00 2001
From: Birte Kristina Friesel <derf@finalrewind.org>
Date: Sat, 19 Aug 2023 12:43:43 +0200
Subject: API: Support HAFAS checkin (via journeyID)

---
 templates/api_documentation.html.ep | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

(limited to 'templates/api_documentation.html.ep')

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/>
-- 
cgit v1.2.3