Unverified Commit 85cb3011 authored by Kenny's avatar Kenny
Browse files

Add documentation for API checkin with MOTIS

parent 9d8181ba

templates/api_documentation.html.ep

+14 −0
Changes for templates/api_documentation.html.ep: 14 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -139,6 +139,20 @@ 
	"fromStation" : 8000080, <span class="explanation">(Name oder EVA-Nummer – bei bahn.de nur EVA-Nummer)</span>

	"toStation" : 8006486, <span class="explanation">(optional, Name oder EVA-Nummer – bei bahn.de nur EVA-Nummer)</span>

	"comment" : "Beliebiger Text" <span class="explanation">(optional, überschreibt vorherigen Kommentar)</span>

}

		</pre>

		<p>Payload zum Einchecken per MOTIS-Backend (Transitous), optional mit Zielwahl. toStation musst mit den Unterwegshalten übereinstimmen, z.B. "Hauptbahnhof (U Gleis 2+4), Essen (Ruhr)" statt "Essen Hbf".</p>

		<pre class="api-example">

{

	"token" : "<%= $uid %>-<%= $token->{travel} // 'TOKEN' %>",

	"action" : "checkin",

	"motis" : "transitous", <span class="explanation">(MOTIS-Instanz)</span>

	"train" : {

		"journeyID" : "20261005_00:21_de-DELFI_3426294544", <span class="explanation">(MOTIS tripId)</span>

	}

	"fromStation" : "de-DELFI_de:05374:44101:7:72", <span class="explanation">(MOTIS stopId)</span>

	"toStation" : "Gummersbach Bf", <span class="explanation">(optional, zurzeit Name, siehe <a target="_blank" href="https://codeberg.org/derf/travelynx/issues/7">Codeberg-Issue</a>)</span>

	"comment" : "Beliebiger Text" <span class="explanation">(optional, überschreibt vorherigen Kommentar)</span>

}

		</pre>

		<p>Payload zur Wahl eines neuen Ziels, wenn bereits eingecheckt:</p>