blob: 152340a694439a69b4ae40529a09be64c0725471 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
openapi: 3.0.3
info:
title: travelynx
version: 0.1.0
description: Travelynx API
servers:
- url: 'https://travelynx.de/api/v1'
- url: 'https://travellynx.de/api/v1'
- url: 'https://travelynx.finalrewind.org/api/v1'
tags:
- name: Status
description: 'Query check-in and journey status'
- name: Travel
description: 'Check into and out of trains'
- name: Import
description: 'Import a journey'
paths:
'/status/{token}':
get:
tags:
- Status
summary: Retrieves a single status.
parameters:
- in: path
name: token
schema:
$ref: '#/components/schemas/token'
required: true
description: Status Token
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/status'
components:
responses:
UnauthorizedError:
description: >-
Unauthorized. Will be returned by the server if no user was logged in or
wrong credentials were supplied.
NotFoundError:
description: >-
Not found The parameters in the request were valid, but the server did
not find a corresponding object.
ForbiddenError:
description: >-
Forbidden The logged in user is not permitted to perform this action.
(e.g. edit a status of another user.)
schemas:
token:
type: string
description: Status Token as configured on Travelynx User Panel
status:
type: object
properties:
deprecated:
type: boolean
example: false
description: if true, this API version is no longer supported and will be removed in the future
checkedIn:
type: boolean
example: true
description: Is the user currently checked into a train?
fromStation:
$ref: '#/components/schemas/departureStatus'
toStation:
$ref: '#/components/schemas/arrivalStatus'
intermediateStops:
type: array
items:
$ref: '#/components/schemas/intermediateStop'
train:
$ref: '#/components/schemas/train'
actionTime:
type: number
example: 1556083434
description: checkin/checkout epoch
departureStatus:
type: object
properties:
name:
type: string
example: "Essen Hbf"
ds100:
type: string
example: "EE"
uic:
type: number
example: 8000098
latitude:
type: number
example: 51.451355
longitude:
type: number
example: 7.014793
scheduledTime:
type: number
example: 1556083680
realtime:
type: number
example: 1556083680
arrivalStatus:
type: object
description: If journey destination is not yet known, all fields are null
nullable: true
properties:
name:
type: string
example: "Essen Stadtwald"
ds100:
type: string
example: "EESA"
uic:
type: number
example: 8001896
latitude:
type: number
example: 51.422853
longitude:
type: number
example: 7.023296
scheduledTime:
type: number
example: 1556083980
nullable: true
description: If arrival time is not yet known, this field is null
realtime:
type: number
example: 1556083980
nullable: true
description: If arrival time is not yet known, this field is null
intermediateStop:
type: object
properties:
name:
type: string
example: "Essen Süd"
scheduledArrival:
type: number
example: 1556083800
nullable: true
realArrival:
type: number
example: 1556083800
nullable: true
scheduledDeparture:
type: number
example: 1556083860
nullable: true
realDeparture:
type: number
example: 1556083860
nullable: true
train:
type: object
properties:
type:
type: string
example: "S"
line:
type: string
example: "6"
no:
type: string
example: "30634"
id:
type: string
example: "7512500863736016593"
description: IRIS-specific train ID
|
