summaryrefslogtreecommitdiff
path: root/templates/api_documentation.html.ep
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2020-01-26 16:12:31 +0100
committerDaniel Friesel <derf@finalrewind.org>2020-01-26 16:12:31 +0100
commit556bafffcfa205057a4ab75c027788a67ea36f3f (patch)
tree4c05dee134f2e82e98054193b91c5c281ad4b8d6 /templates/api_documentation.html.ep
parentcc25a56864f3276e91b17e20de25652247c9d8e9 (diff)
more API documentation
Diffstat (limited to 'templates/api_documentation.html.ep')
-rw-r--r--templates/api_documentation.html.ep14
1 files 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 @@
<p>
Manueller Import vergangener Zugfahrten (eine Fahrt pro API-Aufruf).
</p>
+ <p>
+ 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
+ <em>dryRun</em> und ein Vergleich der zurückgegebenen Stationsnamen
+ mit den eingegebenen. Komplett unbekannte Stationsnamen führen
+ standardmäßig zu einem Fehler (siehe <em>lax</em>)
+ </p>
<p style="font-family: Monospace;">
curl -X POST -H "Content-Type: application/json" -d '{"token":"<%= $uid %>-<%= $token->{import} // 'TOKEN' %>"}' <%= $api_root %>/import
</p>
@@ -172,7 +181,7 @@
{<br/>
"token" : "<%= $uid %>-<%= $token->{import} // 'TOKEN' %>",<br/>
"dryRun" : true/false, (optional: wenn true, wird die Eingabe validiert, aber keine Zugfahrt angelegt)<br/>
- "lax" : true/Fals, (optional: wenn true, werden unbekannte Unterwegshalte akzeptiert)<br/>
+ "lax" : true/false, (optional: wenn true, werden unbekannte Unterwegshalte akzeptiert)<br/>
"cancelled" : true/false, (Zugausfall?)<br/>
"train" : {<br/>
"type" : "S", (Zugtyp, z.B. ICE, RE, S)<br/>
@@ -203,7 +212,8 @@
"success" : true,<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/>
- "result" : { ... } (Eingetragene Daten, Datenformat nicht näher spezifiziert und beliebig variabel)<br/>
+ "result" : { ... } (Eingetragene Daten. Das Datenformat kann sich
+ ohne Berücksichtigung der API-Version ändern)<br/>
}
</p>
<p>