summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDerf Null <derf@finalrewind.org>2023-05-29 15:06:28 +0200
committerDerf Null <derf@finalrewind.org>2023-05-29 15:06:28 +0200
commit24584f71b1c19d16af29b547fe27bae8c8ad5d5c (patch)
tree186344abdc83375288ce00a56396ec367474f119
parent0f9519c40bca8583e3b0ec6a05850ce84ea2e686 (diff)
update API documentation
-rw-r--r--templates/api_documentation.html.ep15
1 files changed, 10 insertions, 5 deletions
diff --git a/templates/api_documentation.html.ep b/templates/api_documentation.html.ep
index c9125a2..d2f9261 100644
--- a/templates/api_documentation.html.ep
+++ b/templates/api_documentation.html.ep
@@ -27,7 +27,9 @@
<p style="font-family: Monospace;">
{<br/>
"deprecated" : true / false, (falls true: Diese API-Version wird irgendwann abgeschaltet, bitte auf eine neue umsteigen)<br/>
+ "actionTime" : 1234567, (UNIX-Timestamp des letzten Checkin/Checkout)<br/>
"checkedIn" : true / false,<br/>
+ "comment": "Kommentar",<br/>
"fromStation" : { (letzter Checkin)<br/>
"name" : "Essen Hbf",<br/>
"ds100" : "EE",<br/>
@@ -57,12 +59,15 @@
…<br/>
],<br/>
"train" : {<br/>
- "type" : "S", (aktueller / letzter Zugtyp)<br/>
- "line" : "6", (Linie als String, nicht immer numerisch, ggf. null)<br/>
- "no" : "30634", (Zugnummer als String)<br/>
- "id" : "7512500863736016593", (IRIS-spezifische Zug-ID)<br/>
+ "type" : "S", (aktueller / letzter Zugtyp)<br/>
+ "line" : "6", (Linie als String, nicht immer numerisch, ggf. null)<br/>
+ "no" : "30634", (Zugnummer als String)<br/>
+ "id" : "7512500863736016593" (IRIS-spezifische Zug-ID)<br/>
},<br/>
- "actionTime" : 1234567, (UNIX-Timestamp des letzten Checkin/Checkout)<br/>
+ "visibility" : {<br/>
+ "desc": "private" / "unlisted" / "followers" / "travelynx" / "public",<br/>
+ "level": 10 / 30 / 60 / 80 / 100<br/>
+ }<br/>
}
</p>
<p>