From 556bafffcfa205057a4ab75c027788a67ea36f3f Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Sun, 26 Jan 2020 16:12:31 +0100 Subject: more API documentation --- templates/api_documentation.html.ep | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/templates/api_documentation.html.ep b/templates/api_documentation.html.ep index 4a3700a..4239b51 100644 --- a/templates/api_documentation.html.ep +++ b/templates/api_documentation.html.ep @@ -164,6 +164,15 @@

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

+

+ Bitte beachten: fromStation, toStation und intermediateStops werden + mit Fuzzy Matching eingelesen. Falls ein unbekannter Stationsname + einer anderen, bekannten Station hinreichend ähnelt, kann dieser + dadurch ersetzt werden. Bei Unsicherheiten empfiehlt sich ein + dryRun und ein Vergleich der zurückgegebenen Stationsnamen + mit den eingegebenen. Komplett unbekannte Stationsnamen führen + standardmäßig zu einem Fehler (siehe lax) +

curl -X POST -H "Content-Type: application/json" -d '{"token":"<%= $uid %>-<%= $token->{import} // 'TOKEN' %>"}' <%= $api_root %>/import

@@ -172,7 +181,7 @@ {
"token" : "<%= $uid %>-<%= $token->{import} // 'TOKEN' %>",
"dryRun" : true/false, (optional: wenn true, wird die Eingabe validiert, aber keine Zugfahrt angelegt)
- "lax" : true/Fals, (optional: wenn true, werden unbekannte Unterwegshalte akzeptiert)
+ "lax" : true/false, (optional: wenn true, werden unbekannte Unterwegshalte akzeptiert)
"cancelled" : true/false, (Zugausfall?)
"train" : {
"type" : "S", (Zugtyp, z.B. ICE, RE, S)
@@ -203,7 +212,8 @@ "success" : true,
"deprecated" : true / false, (falls true: Diese API-Version wird irgendwann abgeschaltet, bitte auf eine neue umsteigen)
"id" : 1234, (ID der eingetragenen Zugfahrt)
- "result" : { ... } (Eingetragene Daten, Datenformat nicht näher spezifiziert und beliebig variabel)
+ "result" : { ... } (Eingetragene Daten. Das Datenformat kann sich + ohne Berücksichtigung der API-Version ändern)
}

-- cgit v1.2.3