Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
T
travelynx
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
derf
travelynx
Commits
cc381d19
Unverified
Commit
cc381d19
authored
1 year ago
by
Birte Kristina Friesel
Browse files
Options
Downloads
Patches
Plain Diff
API docs: Zug → Fahrt
parent
caf1afa6
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
templates/api_documentation.html.ep
+14
-14
14 additions, 14 deletions
templates/api_documentation.html.ep
with
14 additions
and
14 deletions
templates/api_documentation.html.ep
+
14
−
14
View file @
cc381d19
...
...
@@ -59,10 +59,10 @@
…<br/>
],<br/>
"train" : {<br/>
"type" : "S", (aktueller / letzter
Zug
typ)<br/>
"type" : "S", (aktueller / letzter
Fahrt
typ)<br/>
"line" : "6", (Linie als String, nicht immer numerisch, ggf. null)<br/>
"no" : "30634", (
Zug
nummer als String)<br/>
"id" : "7512500863736016593" (IRIS-spezifische
Zug
-ID)<br/>
"no" : "30634", (
Fahrt
nummer als String
, ggf. null oder leer
)<br/>
"id" : "7512500863736016593" (IRIS-
oder HAFAS-
spezifische
Fahrt
-ID)<br/>
},<br/>
"visibility" : {<br/>
"desc": "private" / "unlisted" / "followers" / "travelynx" / "public",<br/>
...
...
@@ -83,19 +83,19 @@
Checkin per API. Sobald eine Zielstation bekannt ist, erfolgt der
Checkout wie beim Webinterface automatisch zehn Minuten nach Ankunft.
Bitte beachten: Es wird nicht überprüft, ob die angegebene Zielstation
in der vorgesehenen Route de
s Zugs
vorkommt oder nicht.
in der vorgesehenen Route de
r Fahrt
vorkommt oder nicht.
</p>
<p>
Falls du zum Checkinzeitpunkt bereits in eine
n
andere
n Zug
eingecheckt
Falls du zum Checkinzeitpunkt bereits in eine andere
Fahrt
eingecheckt
bist, wirst du zunächst am gewählten Startbahnhof aus diesem ausgecheckt.
Der Checkout erfolgt unabhängig davon, ob de
r
vorherige
Zug
an dieser
Der Checkout erfolgt unabhängig davon, ob d
i
e vorherige
Fahrt
an dieser
Station verkehrt oder nicht. Falls nach einem Checkin ohne Zielwahl
innerhalb von 48 Stunden kein Zielbahnhof nachgetragen wird, wird der
Checkin automatisch rückgängig gemacht.
</p>
<p>
Das Verhalten des Checkout-Endpunkts hängt vom Zeitpunkt ab. Wenn de
r
Zug
den angegebenen Zielbahnhof bereits erreicht hat, wird dort
Das Verhalten des Checkout-Endpunkts hängt vom Zeitpunkt ab. Wenn d
i
e
Fahrt
den angegebenen Zielbahnhof bereits erreicht hat, wird dort
ausgecheckt. Andernfalls wird das Reiseziel aktualisiert und etwa zehn
Minuten nach Ankunft automatisch ausgecheckt.
</p>
...
...
@@ -161,7 +161,7 @@
<div class="row">
<div class="col s12">
<p>
Manueller Import vergangener
Zugf
ahrten (eine Fahrt pro API-Aufruf).
Manueller Import vergangener
F
ahrten (eine Fahrt pro API-Aufruf).
</p>
<p>
Bitte beachten: fromStation, toStation und intermediateStops werden
...
...
@@ -179,13 +179,13 @@
<p style="font-family: Monospace;">
{<br/>
"token" : "<%= $uid %>-<%= $token->{import} // 'TOKEN' %>",<br/>
"dryRun" : true/false, (optional: wenn true, wird die Eingabe validiert, aber keine
Zugf
ahrt angelegt)<br/>
"dryRun" : true/false, (optional: wenn true, wird die Eingabe validiert, aber keine
F
ahrt angelegt)<br/>
"lax" : true/false, (optional: wenn true, werden unbekannte Unterwegshalte akzeptiert)<br/>
"cancelled" : true/false, (
Zuga
usfall?)<br/>
"cancelled" : true/false, (
A
usfall?)<br/>
"train" : {<br/>
"type" : "S", (
Zugt
yp, z.B. ICE, RE, S)<br/>
"type" : "S", (
T
yp, z.B. ICE, RE, S
, U
)<br/>
"line" : "6", (Linie als String, bei Zügen ohne Linie wie IC/ICE u.ä. null)<br/>
"no" : "30634", (
Zugn
ummer als String)<br/>
"no" : "30634", (
N
ummer als String
, ggf. null oder leer
)<br/>
},<br/>
"fromStation" : { (Start / Checkin)<br/>
"name" : "Essen Hbf", (Name oder DS100)<br/>
...
...
@@ -210,7 +210,7 @@
{<br/>
"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
Zugf
ahrt)<br/>
"id" : 1234, (ID der eingetragenen
F
ahrt)<br/>
"result" : { ... } (Eingetragene Daten. Das Datenformat kann sich
ohne Berücksichtigung der API-Version ändern)<br/>
}
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment