@golemio/pid 2.2.11-dev.598014130 โ†’ 2.2.11-dev.600085771

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1772 @@
1
+ openapi: 3.0.3
2
+
3
+ info:
4
+ title: ๐Ÿš‹ Public Transport
5
+ description: >-
6
+ <p>GTFS (<a href="https://gtfs.org">General Transit Feed Specification</a>) data about the city's public transportation schedules in form of an API.</p>
7
+ <p>Publisher of the data is ROPID. Schedules are valid for upcoming ~12 days, but can change as they are updated every day.</p>
8
+ <p>More about at <a href="https://pid.cz/o-systemu/opendata/">pid.cz</a>.</p>
9
+ version: 1.0.0
10
+ contact:
11
+ name: Golemio Prague Data Plaform
12
+ email: golemio@operatorict.cz
13
+ url: https://golemio.cz
14
+
15
+ servers:
16
+ - url: https://api.golemio.cz/v2
17
+ description: Main (production) server
18
+ - url: https://rabin.golemio.cz/v2
19
+ description: Test (development) server
20
+
21
+ tags:
22
+ - name: ๐Ÿงพ GTFS
23
+ description: General Transit Feed Specification data about the city's public transportation schedules in form of an API.
24
+
25
+ - name: ๐Ÿ›ค RealTime Vehicle Positions
26
+ description: ๐Ÿ’ก Response comes with special header `X-Last-Modified` with timestamp value of the latest resource update. When you use it as `?updatedSince` query parameter you will obtain only newer data than this value.
27
+
28
+ - name: ๐Ÿ—บ GTFS RealTime Vehicle Positions
29
+ description: ""
30
+
31
+ - name: ๐Ÿš PID Departure Boards
32
+ description: ""
33
+
34
+ paths:
35
+ /gtfs/services:
36
+ get:
37
+ summary: GET GTFS Services
38
+ description: ""
39
+ tags:
40
+ - ๐Ÿงพ GTFS
41
+ parameters:
42
+ - name: date
43
+ in: query
44
+ description: Filter services by specific date in format (YYYY-MM-DD).
45
+ required: false
46
+ schema:
47
+ type: string
48
+ example: 2019-01-01
49
+ - name: limit
50
+ in: query
51
+ description: Limits number of retrieved items. The maximum is 10000 (default value).
52
+ required: false
53
+ schema:
54
+ type: number
55
+ format: int64
56
+ example: 10
57
+ - name: offset
58
+ in: query
59
+ description: Number of the first items that are skipped.
60
+ required: false
61
+ schema:
62
+ type: number
63
+ format: int64
64
+ example: 0
65
+
66
+ responses:
67
+ "200":
68
+ description: successful operation
69
+ content:
70
+ application/json:
71
+ schema:
72
+ type: array
73
+ items:
74
+ $ref: "#/components/schemas/GTFSService"
75
+ "401":
76
+ $ref: "#/components/responses/UnauthorizedError"
77
+ "404":
78
+ description: Not found
79
+
80
+ /gtfs/routes:
81
+ get:
82
+ summary: GET All GTFS Routes
83
+ description: ""
84
+ tags:
85
+ - ๐Ÿงพ GTFS
86
+ parameters:
87
+ - name: limit
88
+ in: query
89
+ description: Limits number of retrieved items. The maximum is 10000 (default value).
90
+ required: false
91
+ schema:
92
+ type: number
93
+ format: int64
94
+ example: 10
95
+ - name: offset
96
+ in: query
97
+ description: Number of the first items that are skipped.
98
+ required: false
99
+ schema:
100
+ type: number
101
+ format: int64
102
+ example: 0
103
+ responses:
104
+ "200":
105
+ description: successful operation
106
+ content:
107
+ application/json:
108
+ schema:
109
+ type: array
110
+ items:
111
+ $ref: "#/components/schemas/GTFSRoute"
112
+ "401":
113
+ $ref: "#/components/responses/UnauthorizedError"
114
+ "404":
115
+ description: Not found
116
+
117
+ /gtfs/routes/{id}:
118
+ get:
119
+ summary: GET GTFS Route
120
+ description: ""
121
+ tags:
122
+ - ๐Ÿงพ GTFS
123
+ parameters:
124
+ - name: id
125
+ in: path
126
+ required: true
127
+ schema:
128
+ type: string
129
+ example: "L991"
130
+ responses:
131
+ "200":
132
+ description: successful operation
133
+ content:
134
+ application/json:
135
+ schema:
136
+ $ref: "#/components/schemas/GTFSRoute"
137
+ "401":
138
+ $ref: "#/components/responses/UnauthorizedError"
139
+ "404":
140
+ description: Not found
141
+
142
+ /gtfs/trips:
143
+ get:
144
+ summary: GET All GTFS Trips
145
+ description: ""
146
+ tags:
147
+ - ๐Ÿงพ GTFS
148
+ parameters:
149
+ - name: stopId
150
+ in: query
151
+ description: Filter trips that include specific stop.
152
+ required: false
153
+ schema:
154
+ type: string
155
+ example: "U953Z102P"
156
+ - name: date
157
+ in: query
158
+ description: Filter trips by specific date.
159
+ required: false
160
+ schema:
161
+ type: string
162
+ example: "2018-01-01"
163
+ - name: limit
164
+ in: query
165
+ description: Limits number of retrieved items. The maximum is 10000 (default value).
166
+ required: false
167
+ schema:
168
+ type: number
169
+ format: int64
170
+ example: 10
171
+ - name: offset
172
+ in: query
173
+ description: Number of the first items that are skipped.
174
+ required: false
175
+ schema:
176
+ type: number
177
+ format: int64
178
+ example: 0
179
+ responses:
180
+ "200":
181
+ description: successful operation
182
+ content:
183
+ application/json:
184
+ schema:
185
+ type: array
186
+ items:
187
+ $ref: "#/components/schemas/GTFSTrip"
188
+ "401":
189
+ $ref: "#/components/responses/UnauthorizedError"
190
+ "404":
191
+ description: Not found
192
+
193
+ /gtfs/trips/{id}:
194
+ get:
195
+ summary: GET GTFS Trip
196
+ description: ""
197
+ tags:
198
+ - ๐Ÿงพ GTFS
199
+ parameters:
200
+ - name: id
201
+ in: path
202
+ required: true
203
+ schema:
204
+ type: string
205
+ example: "991_1151_190107"
206
+ - name: includeShapes
207
+ in: query
208
+ description: Enrich trip response object with shapes.
209
+ required: false
210
+ schema:
211
+ type: boolean
212
+ example: true
213
+ - name: includeStops
214
+ in: query
215
+ description: Enrich trip response object with stops.
216
+ required: false
217
+ schema:
218
+ type: boolean
219
+ example: true
220
+ - name: includeStopTimes
221
+ in: query
222
+ description: Enrich trip response object with stops times.
223
+ required: false
224
+ schema:
225
+ type: boolean
226
+ example: true
227
+ - name: includeService
228
+ in: query
229
+ description: Enrich trip response object with service.
230
+ required: false
231
+ schema:
232
+ type: boolean
233
+ example: true
234
+ - name: includeRoute
235
+ in: query
236
+ description: Enrich trip response object with routes.
237
+ required: false
238
+ schema:
239
+ type: boolean
240
+ example: true
241
+ - name: date
242
+ in: query
243
+ description: Filter trips by specific date in format (YYYY-MM-DD).
244
+ required: false
245
+ schema:
246
+ type: string
247
+ example: "2019-01-01"
248
+ responses:
249
+ "200":
250
+ description: successful operation
251
+ content:
252
+ application/json:
253
+ schema:
254
+ allOf:
255
+ - $ref: "#/components/schemas/GTFSTrip"
256
+ - type: object
257
+ properties:
258
+ stop_times:
259
+ type: array
260
+ items:
261
+ $ref: "#/components/schemas/GTFSStopTime"
262
+ - type: object
263
+ properties:
264
+ shapes:
265
+ type: array
266
+ items:
267
+ allOf:
268
+ - $ref: "#/components/schemas/FeaturePoint"
269
+ - type: object
270
+ properties:
271
+ properties:
272
+ $ref: "#/components/schemas/GTFSShape"
273
+ - type: object
274
+ properties:
275
+ service:
276
+ $ref: "#/components/schemas/GTFSService"
277
+ - type: object
278
+ properties:
279
+ route:
280
+ $ref: "#/components/schemas/GTFSRoute"
281
+
282
+ "401":
283
+ $ref: "#/components/responses/UnauthorizedError"
284
+ "404":
285
+ description: Not found
286
+
287
+ /gtfs/shapes/{id}:
288
+ get:
289
+ summary: GET GTFS Shape
290
+ description: ""
291
+ tags:
292
+ - ๐Ÿงพ GTFS
293
+ parameters:
294
+ - name: id
295
+ in: path
296
+ required: true
297
+ schema:
298
+ type: string
299
+ example: "L991V2"
300
+ responses:
301
+ "200":
302
+ description: successful operation
303
+ content:
304
+ application/json:
305
+ schema:
306
+ type: object
307
+ properties:
308
+ type:
309
+ type: string
310
+ example: "FeatureCollection"
311
+ features:
312
+ type: array
313
+ items:
314
+ allOf:
315
+ - $ref: "#/components/schemas/FeaturePoint"
316
+ - type: object
317
+ properties:
318
+ properties:
319
+ $ref: "#/components/schemas/GTFSShape"
320
+ "401":
321
+ $ref: "#/components/responses/UnauthorizedError"
322
+ "404":
323
+ description: Not found
324
+
325
+ /gtfs/stops:
326
+ get:
327
+ summary: GET All GTFS Stops
328
+ description: ""
329
+ tags:
330
+ - ๐Ÿงพ GTFS
331
+ parameters:
332
+ - name: names
333
+ in: query
334
+ description: Name of station. Use with square brackets `names[]=NAME1&names[]=NAME2`.
335
+ required: false
336
+ schema:
337
+ type: string
338
+ example: "Proseckรก"
339
+ - name: ids
340
+ in: query
341
+ description: Get stops by stop_id. Use with square brackets `ids[]`.
342
+ required: false
343
+ schema:
344
+ type: string
345
+ example: "U476Z103P"
346
+ - name: aswIds
347
+ in: query
348
+ description: Get stops by ASW, use `_` instead of `/` or encode the slash sign with `%2F`. Use with square brackets `aswId[]`.
349
+ required: false
350
+ schema:
351
+ type: string
352
+ example: "1833_12"
353
+ - name: cisIds
354
+ in: query
355
+ description: Limits number of retrieved items. The maximum is 10000 (default value).
356
+ required: false
357
+ schema:
358
+ type: number
359
+ example: 12345
360
+ - name: limit
361
+ in: query
362
+ description: Limits number of retrieved items. The maximum is 10000 (default value).
363
+ required: false
364
+ schema:
365
+ type: number
366
+ format: int64
367
+ example: 10
368
+ - name: offset
369
+ in: query
370
+ description: Number of the first items that are skipped.
371
+ required: false
372
+ schema:
373
+ type: number
374
+ format: int64
375
+ example: 0
376
+ responses:
377
+ "200":
378
+ description: successful operation
379
+ content:
380
+ application/json:
381
+ schema:
382
+ type: array
383
+ items:
384
+ type: object
385
+ properties:
386
+ type:
387
+ type: string
388
+ example: "FeatureCollection"
389
+ features:
390
+ type: array
391
+ items:
392
+ allOf:
393
+ - $ref: "#/components/schemas/FeaturePoint"
394
+ - type: object
395
+ properties:
396
+ properties:
397
+ $ref: "#/components/schemas/GTFSStop"
398
+ "401":
399
+ $ref: "#/components/responses/UnauthorizedError"
400
+ "404":
401
+ description: Not found
402
+
403
+ /gtfs/stops/{id}:
404
+ get:
405
+ summary: GET GTFS Stop
406
+ description: ""
407
+ tags:
408
+ - ๐Ÿงพ GTFS
409
+ parameters:
410
+ - name: id
411
+ in: path
412
+ required: true
413
+ schema:
414
+ type: string
415
+ example: "U476Z104P"
416
+ responses:
417
+ "200":
418
+ description: successful operation
419
+ content:
420
+ application/json:
421
+ schema:
422
+ allOf:
423
+ - $ref: "#/components/schemas/FeaturePoint"
424
+ - type: object
425
+ properties:
426
+ properties:
427
+ $ref: "#/components/schemas/GTFSStop"
428
+ "401":
429
+ $ref: "#/components/responses/UnauthorizedError"
430
+ "404":
431
+ description: Not found
432
+
433
+ /gtfs/stoptimes/{id}:
434
+ get:
435
+ summary: GET GTFS Stop times
436
+ description: ""
437
+ tags:
438
+ - ๐Ÿงพ GTFS
439
+ parameters:
440
+ - name: id
441
+ in: path
442
+ description: ""
443
+ required: true
444
+ schema:
445
+ type: string
446
+ example: "U118Z101P"
447
+ - name: date
448
+ in: query
449
+ description: Filter stop times by specific date in format (YYYY-MM-DD).
450
+ required: false
451
+ schema:
452
+ type: string
453
+ example: "2019-01-01"
454
+ - name: from
455
+ in: query
456
+ description: Filter stop times by time departure in format (H:mm:ss).
457
+ required: false
458
+ schema:
459
+ type: string
460
+ example: "07:12:33"
461
+ - name: to
462
+ in: query
463
+ description: Filter stop times by time arrival in format (H:mm:ss).
464
+ required: false
465
+ schema:
466
+ type: string
467
+ example: "12:12:33"
468
+
469
+ - name: includeStop
470
+ in: query
471
+ description: Enrich stop times response object with stop.
472
+ required: false
473
+ schema:
474
+ type: boolean
475
+ example: true
476
+ - name: limit
477
+ in: query
478
+ description: Limits number of retrieved items. The maximum is 10000 (default value).
479
+ required: false
480
+ schema:
481
+ type: number
482
+ format: int64
483
+ example: 10
484
+ - name: offset
485
+ in: query
486
+ description: Number of the first items that are skipped.
487
+ required: false
488
+ schema:
489
+ type: number
490
+ format: int64
491
+ example: 0
492
+ responses:
493
+ "200":
494
+ description: successful operation
495
+ content:
496
+ application/json:
497
+ schema:
498
+ type: array
499
+ items:
500
+ $ref: "#/components/schemas/GTFSStopTime"
501
+ "401":
502
+ $ref: "#/components/responses/UnauthorizedError"
503
+ "404":
504
+ description: Not found
505
+
506
+ /vehiclepositions:
507
+ get:
508
+ summary: GET All Vehicle Positions
509
+ description: ""
510
+ tags:
511
+ - ๐Ÿ›ค RealTime Vehicle Positions
512
+ parameters:
513
+ - name: limit
514
+ in: query
515
+ description: Limits number of retrieved items. The maximum is 10000 (default value).
516
+ required: false
517
+ schema:
518
+ type: number
519
+ format: int64
520
+ example: 10
521
+ - name: offset
522
+ in: query
523
+ description: Number of the first items that are skipped.
524
+ required: false
525
+ schema:
526
+ type: number
527
+ format: int64
528
+ example: 0
529
+ - name: includeNotTracking
530
+ in: query
531
+ description: Enrich result dataset with not tracking trip (those trips not being on track - before and after trip)
532
+ schema:
533
+ type: boolean
534
+ example: true
535
+ - name: includePositions
536
+ in: query
537
+ description: Enrich result dataset with positions
538
+ schema:
539
+ type: boolean
540
+ example: true
541
+ - name: cisTripNumber
542
+ in: query
543
+ description: Filter result by CIS trip number
544
+ required: false
545
+ schema:
546
+ type: number
547
+ example: 1020
548
+ - name: preferredTimezone
549
+ in: query
550
+ description: Preferred timezone offset by given Country/City (use encoded slash sign with `%2F` or use `_` sign)
551
+ required: false
552
+ schema:
553
+ type: string
554
+ example: "Europe%2FPrague"
555
+ - name: routeId
556
+ in: query
557
+ description: Filter result by route id
558
+ required: false
559
+ schema:
560
+ type: string
561
+ example: "L301"
562
+ - name: routeShortName
563
+ in: query
564
+ description: Filter result by short name
565
+ required: false
566
+ schema:
567
+ type: string
568
+ example: "381"
569
+ - name: updatedSince
570
+ in: query
571
+ description: Limit results to the ones updated after (timestamp greater than)
572
+ required: false
573
+ schema:
574
+ type: string
575
+ example: "2020-04-07T06:32:29.000Z"
576
+ responses:
577
+ "200":
578
+ description: successful operation
579
+ content:
580
+ application/json:
581
+ schema:
582
+ type: array
583
+ items:
584
+ type: object
585
+ properties:
586
+ type:
587
+ type: string
588
+ example: "FeatureCollection"
589
+ features:
590
+ type: array
591
+ items:
592
+ allOf:
593
+ - $ref: "#/components/schemas/FeaturePoint"
594
+ - type: object
595
+ properties:
596
+ properties:
597
+ $ref: "#/components/schemas/VehiclepositionCompound"
598
+ "401":
599
+ $ref: "#/components/responses/UnauthorizedError"
600
+ "404":
601
+ description: Not found
602
+
603
+ /gtfs/vehiclepositions/{gtfsTripId}:
604
+ get:
605
+ summary: GET Vehicle Position
606
+ description: ""
607
+ tags:
608
+ - ๐Ÿ›ค RealTime Vehicle Positions
609
+ parameters:
610
+ - name: gtfsTripId
611
+ in: path
612
+ description: "Filter result by trip id (gtfs_trip_id)"
613
+ required: true
614
+ schema:
615
+ type: string
616
+ example: "115_107_180501"
617
+ - name: includeNotTracking
618
+ in: query
619
+ description: Enrich result dataset with not tracking trip (last tracked vehicle after its trip)
620
+ required: false
621
+ schema:
622
+ type: boolean
623
+ example: true
624
+ - name: includePositions
625
+ in: query
626
+ description: Enrich result dataset with positions
627
+ required: false
628
+ schema:
629
+ type: boolean
630
+ example: true
631
+ - name: preferredTimezone
632
+ in: query
633
+ description: Preferred timezone offset by given Country/City (use encoded slash sign by %2F or use _ sign)
634
+ required: false
635
+ schema:
636
+ type: string
637
+ example: "Europe%2FPrague"
638
+ responses:
639
+ "200":
640
+ description: successful operation
641
+ content:
642
+ application/json:
643
+ schema:
644
+ allOf:
645
+ - $ref: "#/components/schemas/FeaturePoint"
646
+ - type: object
647
+ properties:
648
+ properties:
649
+ $ref: "#/components/schemas/VehiclepositionCompound"
650
+ "401":
651
+ $ref: "#/components/responses/UnauthorizedError"
652
+ "404":
653
+ description: Not found
654
+
655
+ /vehiclepositions/gtfsrt/trip_updates.pb:
656
+ get:
657
+ summary: GET GTFS RealTime Trip Updates Protocol Buffer
658
+ description: ""
659
+ tags:
660
+ - ๐Ÿ—บ GTFS RealTime Vehicle Positions
661
+ responses:
662
+ "200":
663
+ description: successful operation
664
+ content:
665
+ application/octet-stream:
666
+ schema:
667
+ type: string
668
+ format: binary
669
+ "401":
670
+ $ref: "#/components/responses/UnauthorizedError"
671
+ "404":
672
+ description: Not found
673
+
674
+ /vehiclepositions/gtfsrt/vehicle_positions.pb:
675
+ get:
676
+ summary: GET GTFS RealTime Vehicle Positions Protocol Buffer
677
+ description: ""
678
+ tags:
679
+ - ๐Ÿ—บ GTFS RealTime Vehicle Positions
680
+ responses:
681
+ "200":
682
+ description: successful operation
683
+ content:
684
+ application/octet-stream:
685
+ schema:
686
+ type: string
687
+ format: binary
688
+ "401":
689
+ $ref: "#/components/responses/UnauthorizedError"
690
+ "404":
691
+ description: Not found
692
+
693
+ /pid/departureboards:
694
+ get:
695
+ summary: GET Departure Board
696
+ description: >-
697
+ You have to use query parameters `ids`, `cisIds`, `aswIds` or `names` in array format - eg. `ids[]=1&ids[]=3`.
698
+ **At least one of these IDs is required.** The maximum is 100 stops combined in one request.
699
+ tags:
700
+ - ๐Ÿš PID Departure Boards
701
+ parameters:
702
+ - name: ids
703
+ in: query
704
+ description: Get result by GTFS stop_id. Can be used to retrive individual stops and to separate departures of Prague and intercity routes, even if they depart from the same physical stop. A list of GTFS stops can be found in `stops.txt` file of the [GTFS feed](//opendata.praha.eu/dataset/jizdni-rady-pid).
705
+ required: false
706
+ schema:
707
+ type: string
708
+ example: "U458Z101P"
709
+ - name: aswIds
710
+ in: query
711
+ description: Get result by ASW ID. First part of the number represents the whole node. Usually it groups the stops of the same name or all stops associated with a metro station. Also returns related train stations in the node. The second part of the number is optional and represents individual stops in the node. Use `_` instead of `/` as a separator or encode the slash sign with `%2F`. A list of ASW IDs can be found in [Prague Open data](//opendata.praha.eu/dataset/zastavky-a-oznacniky-pid).
712
+ required: false
713
+ schema:
714
+ type: string
715
+ example: "458_101"
716
+ - name: cisIds
717
+ in: query
718
+ description: Get result by CIS ID. A list of CIS IDs can be found in [Prague Open data](//opendata.praha.eu/dataset/zastavky-a-oznacniky-pid).
719
+ required: false
720
+ schema:
721
+ type: number
722
+ example: 28004
723
+ - name: names
724
+ in: query
725
+ description: Get results by exact name of stop (case and whitespace sensitive). May return stops of the same name from different towns.
726
+ required: false
727
+ schema:
728
+ type: string
729
+ example: "Smรญchovskรฉ"
730
+ - name: minutesBefore
731
+ in: query
732
+ description: Set the start of interval from which to retrieve departures. Positive numbers are set in past relative to the time of request or `timeFrom` timestamp, negative numbers set the start in the future. Use to compensate for walking distance to a stop. Default is set to 0.
733
+ required: false
734
+ schema:
735
+ type: number
736
+ example: 10
737
+ - name: minutesAfter
738
+ in: query
739
+ description: Set the end of interval from which to retrieve departures. Positive numbers are set in future relative to the time of request or `timeFrom` timestamp, negative are in the past. The sum of minutesBefore and minutesAfter must be larger than zero. Default is set to 180.
740
+ required: false
741
+ schema:
742
+ type: number
743
+ example: 60
744
+ - name: timeFrom
745
+ in: query
746
+ description: Set initial timestamp for time interval given by `minutesBefore` and `minutesAfter`. Use to simulate query time different from now. Use ISO 8601 time format and URL encoded symbols - `%3A` for `:`, `%2B` for `.`, `%2F` for `+`. Time zone is set according to the `preferredTimezone` parameter. Applicable range is -6 hours +7 days from now.
747
+ required: false
748
+ schema:
749
+ type: string
750
+ example: "2021-01-21T06:00:00"
751
+ - name: preferredTimezone
752
+ in: query
753
+ description: Preferred timezone offset as defined in the IANA Time zone database in the form of Country/City (use an URL encoded slash sign `%2F` or use an underscore _ symbol), default is Europe/Prague
754
+ required: false
755
+ schema:
756
+ type: string
757
+ example: "Europe%2FPrague"
758
+ - name: mode
759
+ in: query
760
+ description: >-
761
+ Valid entries: `departures` (default), `arrivals`, `mixed`. Set how to handle behaviour in end stops. `departures` (default) returns all connections that depart from selected stops (does not return connections for which it is the final stop). `arrivals` returns all connections that arrive into the stops (does not return connections for which it is the first stop). `mixed` returns everything. Use `arrivals` to create dedicated arrival boards. Use `departures` for all other cases. Using `mixed` is not recomended as departures of adjoined routes will be returned twice.
762
+ required: false
763
+ schema:
764
+ type: string
765
+ example: "departures"
766
+ - name: order
767
+ in: query
768
+ description: >-
769
+ Valid entries: `real` (default), `timetable`. Order results by predicted time including trip delay or by timetable time.
770
+ required: false
771
+ schema:
772
+ type: string
773
+ example: "real"
774
+ - name: filter
775
+ in: query
776
+ description: >-
777
+ Valid entries: `none` (default), `routeOnce`, `routeOnceFill`, `routeHeadingOnce`, `routeHeadingOnceFill`. Define how should be the list of departures returned. `none` returns all departures within the time and item limit. `routeOnce` returns exactly one occurence of departure for each `route_id`. Works best when querying a single stop. `routeHeadingOnce` returns one entry for each pair of `route_id` and `trip_headsign`, i.e. returns departures for routes that have multiple end stops. Works well when quering one or more stops in a node. `...Fill` attributes will do the same as their namesakes but afterwards will fill the rest of request up to `total/limit` with further departures. Use to ensure both having every line/destination represented and have the display filled with departures.
778
+ required: false
779
+ schema:
780
+ type: string
781
+ example: "routeOnce"
782
+ - name: skip
783
+ in: query
784
+ description: >-
785
+ Valid entries: `canceled`, `atStop`, `untracked`. Skips trips with these attributes. Use multiple rules with `&skip[]=cancelled&skip[]=atStop` query parameter array form.
786
+ required: false
787
+ schema:
788
+ type: string
789
+ example: "canceled"
790
+ - name: limit
791
+ in: query
792
+ description: Limits the number of items in response. The maximum is 1000 (default value is 20).
793
+ required: false
794
+ schema:
795
+ type: number
796
+ format: int64
797
+ example: 0
798
+ - name: total
799
+ in: query
800
+ description: Sets the number of items that will be queried. Use in conjunction with `offset`. Up to `total - offset`, but not more than `limit` items will be then returned. If unset, is same as `limit`. The maximum is 1000 (default value is 20).
801
+ required: false
802
+ schema:
803
+ type: number
804
+ format: int64
805
+ example: 0
806
+ - name: offset
807
+ in: query
808
+ description: Number of the initial departures that are skipped. Useful for multi-page displays.
809
+ required: false
810
+ schema:
811
+ type: number
812
+ format: int64
813
+ example: 0
814
+
815
+ responses:
816
+ "200":
817
+ description: Can return empty data in departures property (empty array []) if no departures were found
818
+ content:
819
+ application/json:
820
+ schema:
821
+ $ref: "#/components/schemas/PIDDepartureBoard"
822
+ "401":
823
+ $ref: "#/components/responses/UnauthorizedError"
824
+ "404":
825
+ description: Not found
826
+
827
+ /pid/infotexts:
828
+ get:
829
+ summary: GET Infotexts
830
+ description: ""
831
+ tags:
832
+ - ๐Ÿš PID Departure Boards
833
+ responses:
834
+ "200":
835
+ description: Can return empty data in departures property (empty array []) if no departures were found
836
+ content:
837
+ application/json:
838
+ schema:
839
+ type: array
840
+ items:
841
+ allOf:
842
+ - $ref: "#/components/schemas/PIDDepartureBoardInfotext"
843
+ - type: object
844
+ properties:
845
+ related_routes:
846
+ type: array
847
+ description: ""
848
+ items:
849
+ type: string
850
+ example: "L152"
851
+ description: ""
852
+ example: ["L152", "L177"]
853
+ expiration_date:
854
+ type: string
855
+ example: "2021-01-07T12:48:06+01:00"
856
+ last_updated:
857
+ type: string
858
+ example: "2021-01-07T12:48:06+01:00"
859
+ "401":
860
+ $ref: "#/components/responses/UnauthorizedError"
861
+ "404":
862
+ description: Not found
863
+
864
+ components:
865
+ responses:
866
+ UnauthorizedError:
867
+ description: API key is missing or invalid
868
+ headers:
869
+ WWW_Authenticate:
870
+ schema:
871
+ type: string
872
+
873
+ schemas:
874
+ GTFSService:
875
+ title: GTFS Service
876
+ type: object
877
+ properties:
878
+ created_time:
879
+ type: string
880
+ example: "2018-09-09 12:32:45"
881
+ end_date:
882
+ type: string
883
+ example: "20190311"
884
+ last_modify:
885
+ type: string
886
+ example: "2018-09-09 12:32:45"
887
+ nullable: true
888
+ monday:
889
+ type: number
890
+ format: int64
891
+ example: 1
892
+ tuesday:
893
+ type: number
894
+ format: int64
895
+ example: 1
896
+ wednesday:
897
+ type: number
898
+ format: int64
899
+ example: 1
900
+ thursday:
901
+ type: number
902
+ format: int64
903
+ example: 1
904
+ friday:
905
+ type: number
906
+ format: int64
907
+ example: 1
908
+ saturday:
909
+ type: number
910
+ format: int64
911
+ example: 1
912
+ sunday:
913
+ type: number
914
+ format: int64
915
+ example: 1
916
+ service_id:
917
+ type: string
918
+ example: "1111111-1"
919
+ start_date:
920
+ type: string
921
+ example: "20190226"
922
+ required:
923
+ - created_time
924
+ - end_date
925
+ - monday
926
+ - tuesday
927
+ - wednesday
928
+ - thursday
929
+ - friday
930
+ - saturday
931
+ - sunday
932
+
933
+ GTFSTrip:
934
+ title: GTFS Trip
935
+ type: object
936
+ properties:
937
+ trip_id:
938
+ type: string
939
+ example: "991_1165_190107"
940
+ bikes_allowed:
941
+ type: number
942
+ format: int64
943
+ example: 1
944
+ block_id:
945
+ type: string
946
+ example: ""
947
+ created_time:
948
+ type: string
949
+ example: "2018-09-09 12:32:45"
950
+ nullable: true
951
+ direction_id:
952
+ type: number
953
+ format: int64
954
+ example: 0
955
+ exceptional:
956
+ type: number
957
+ format: int64
958
+ example: 0
959
+ last_modify:
960
+ type: string
961
+ example: "2018-09-09 12:32:45"
962
+ nullable: true
963
+ route_id:
964
+ type: string
965
+ example: "L991"
966
+ service_id:
967
+ type: string
968
+ example: "1111100-1"
969
+ shape_id:
970
+ type: string
971
+ example: "L991V3"
972
+ trip_headsign:
973
+ type: string
974
+ example: "Nemocnice Motol"
975
+ wheelchair_accessible:
976
+ type: number
977
+ format: int64
978
+ example: 1
979
+ required:
980
+ - trip_id
981
+ - bikes_allowed
982
+ - route_id
983
+ - service_id
984
+ - shape_id
985
+ - trip_headsign
986
+ - wheelchair_accessible
987
+
988
+ GTFSStop:
989
+ title: GTFS Stop
990
+ type: object
991
+ properties:
992
+ location_type:
993
+ type: number
994
+ format: int64
995
+ example: 0
996
+ parent_station:
997
+ type: string
998
+ example: "U118S1"
999
+ platform_code:
1000
+ type: string
1001
+ example: "A"
1002
+ stop_id:
1003
+ type: string
1004
+ example: "U118Z101P"
1005
+ stop_name:
1006
+ type: string
1007
+ example: "Flora"
1008
+ wheelchair_boarding:
1009
+ type: number
1010
+ format: int64
1011
+ example: 2
1012
+ zone_id:
1013
+ type: string
1014
+ example: "P"
1015
+ required:
1016
+ - location_type
1017
+ - parent_station
1018
+ - platform_code
1019
+ - stop_id
1020
+ - stop_name
1021
+ - wheelchair_boarding
1022
+ - zone_id
1023
+
1024
+ GTFSStopTime:
1025
+ title: GTFS Stop Time
1026
+ type: object
1027
+ properties:
1028
+ arrival_time:
1029
+ type: string
1030
+ example: "13:12:05"
1031
+ arrival_time_seconds:
1032
+ type: number
1033
+ format: int64
1034
+ nullable: true
1035
+ created_time:
1036
+ type: string
1037
+ example: "2018-09-09 12:32:45"
1038
+ departure_time:
1039
+ type: string
1040
+ example: "13:12:35"
1041
+ departure_time_seconds:
1042
+ type: number
1043
+ format: int64
1044
+ nullable: true
1045
+ drop_off_type:
1046
+ type: number
1047
+ format: int64
1048
+ example: 0
1049
+ last_modify:
1050
+ type: string
1051
+ example: "2018-09-09 12:32:45"
1052
+ nullable: true
1053
+ pickup_type:
1054
+ type: number
1055
+ format: int64
1056
+ example: 0
1057
+ shape_dist_traveled:
1058
+ type: number
1059
+ format: float
1060
+ example: 3.73622
1061
+ stop_headsign:
1062
+ type: string
1063
+ example: " "
1064
+ stop_id:
1065
+ type: string
1066
+ example: "U921Z102P"
1067
+ stop_sequence:
1068
+ type: number
1069
+ format: int64
1070
+ example: 4
1071
+ trip_id:
1072
+ type: string
1073
+ example: "991_1156_180709"
1074
+ stop:
1075
+ $ref: "#/components/schemas/GTFSStop"
1076
+ required:
1077
+ - arrival_time
1078
+ - created_time
1079
+ - departure_time
1080
+ - drop_off_type
1081
+ - pickup_type
1082
+ - shape_dist_traveled
1083
+ - stop_id
1084
+ - stop_sequence
1085
+ - trip_id
1086
+
1087
+ GTFSShape:
1088
+ title: GTFS Shape
1089
+ type: object
1090
+ properties:
1091
+ shape_dist_traveled:
1092
+ type: number
1093
+ format: float
1094
+ example: 16.46309
1095
+ shape_id:
1096
+ type: string
1097
+ example: "L991V2"
1098
+ shape_pt_sequence:
1099
+ type: number
1100
+ format: int64
1101
+ example: 123
1102
+ required:
1103
+ - shape_dist_traveled
1104
+ - shape_id
1105
+ - shape_pt_sequence
1106
+
1107
+ GTFSRoute:
1108
+ title: GTFS Route
1109
+ type: object
1110
+ properties:
1111
+ agency_id:
1112
+ type: string
1113
+ example: "99"
1114
+ created_time:
1115
+ type: string
1116
+ example: "2018-09-09 12:32:45"
1117
+ nullable: true
1118
+ is_night:
1119
+ type: boolean
1120
+ example: false
1121
+ is_regional:
1122
+ type: boolean
1123
+ example: false
1124
+ is_substitute_transport:
1125
+ type: boolean
1126
+ example: false
1127
+ last_modify:
1128
+ type: string
1129
+ example: "2018-09-09 12:32:45"
1130
+ nullable: true
1131
+ route_color:
1132
+ type: string
1133
+ example: "00A562"
1134
+ route_desc:
1135
+ type: string
1136
+ example: null
1137
+ nullable: true
1138
+ route_id:
1139
+ type: string
1140
+ example: "L991"
1141
+ route_long_name:
1142
+ type: string
1143
+ example: "Nemocnice Motol - Petล™iny - Skalka - Depo Hostivaล™"
1144
+ route_short_name:
1145
+ type: string
1146
+ example: "A"
1147
+ route_text_color:
1148
+ type: string
1149
+ example: "FFFFFF"
1150
+ route_type:
1151
+ type: string
1152
+ example: "1"
1153
+ route_url:
1154
+ type: string
1155
+ example: "https://pid.cz/linka/A"
1156
+ required:
1157
+ - agency_id
1158
+ - is_night
1159
+ - is_regional
1160
+ - is_substitute_transport
1161
+ - route_color
1162
+ - route_id
1163
+ - route_long_name
1164
+ - route_short_name
1165
+ - route_text_color
1166
+ - route_type
1167
+ - route_url
1168
+
1169
+ Point:
1170
+ title: Point
1171
+ type: array
1172
+ minItems: 2
1173
+ maxItems: 2
1174
+ items:
1175
+ type: number
1176
+ format: float
1177
+ example:
1178
+ - 14.4633
1179
+ - 50.07827
1180
+
1181
+ FeaturePoint:
1182
+ title: Feature Point
1183
+ type: object
1184
+ properties:
1185
+ geometry:
1186
+ type: object
1187
+ properties:
1188
+ type:
1189
+ type: string
1190
+ example: "Point"
1191
+ coordinates:
1192
+ $ref: "#/components/schemas/Point"
1193
+ required:
1194
+ - coordinates
1195
+ - type
1196
+ properties:
1197
+ type: object
1198
+ type:
1199
+ type: string
1200
+ example: "Feature"
1201
+ required:
1202
+ - geometry
1203
+ - properties
1204
+ - type
1205
+
1206
+ VehiclepositionCompound:
1207
+ title: Vehicleposition Compound
1208
+ type: object
1209
+ properties:
1210
+ trip:
1211
+ description: Trip properties
1212
+ $ref: "#/components/schemas/VehiclepositionTrip"
1213
+ last_position:
1214
+ description: Properties of last known position
1215
+ $ref: "#/components/schemas/VehiclepositionPosition"
1216
+ all_positions:
1217
+ type: object
1218
+ description: All known positions with their properties
1219
+ properties:
1220
+ type:
1221
+ type: string
1222
+ example: "FeatureCollection"
1223
+ features:
1224
+ type: array
1225
+ items:
1226
+ allOf:
1227
+ - $ref: "#/components/schemas/FeaturePoint"
1228
+ - type: object
1229
+ properties:
1230
+ properties:
1231
+ $ref: "#/components/schemas/VehiclepositionPosition"
1232
+ required:
1233
+ - type
1234
+
1235
+ VehiclepositionTrip:
1236
+ title: Vehicleposition Trip
1237
+ type: object
1238
+ properties:
1239
+ agency_name:
1240
+ type: object
1241
+ properties:
1242
+ real:
1243
+ type: string
1244
+ description: Agency name that normally operates the trip
1245
+ example: "OAD KO Kolรญn"
1246
+ scheduled:
1247
+ type: string
1248
+ description: Agency name that currently operates the trip (normally identical to planned_agency_name)
1249
+ example: "OAD KO Kolรญn"
1250
+ required:
1251
+ - real
1252
+ - scheduled
1253
+ cis:
1254
+ type: object
1255
+ description: All properties that come from nation central information system
1256
+ properties:
1257
+ line_id:
1258
+ type: string
1259
+ description: Full line number
1260
+ example: "100381"
1261
+ trip_number:
1262
+ type: number
1263
+ format: int64
1264
+ description: Trip number (unique within specific cis_line_id)
1265
+ example: 29
1266
+ required:
1267
+ - line_id
1268
+ - trip_number
1269
+ sequence_id:
1270
+ type: number
1271
+ format: int64
1272
+ description: Identifier of trip sequence operated by a single vehicle
1273
+ example: 1
1274
+ origin_route_name:
1275
+ type: string
1276
+ description: Name of the route from which the vehicle originates
1277
+ example: "381"
1278
+ gtfs:
1279
+ type: object
1280
+ description: All properties tied with GTFS data format
1281
+ properties:
1282
+ route_id:
1283
+ type: string
1284
+ description: Identifier of the owner route in the GTFS static feed
1285
+ example: "L381"
1286
+ route_short_name:
1287
+ type: string
1288
+ description: Identification of the line used for the public
1289
+ example: "381"
1290
+ route_type:
1291
+ type: number
1292
+ description: Identifier of the route type in the GTFS static feed
1293
+ example: 1
1294
+ trip_id:
1295
+ type: string
1296
+ description: Identifier of the trip in the GTFS static feed
1297
+ example: "381_51_180728"
1298
+ trip_headsign:
1299
+ type: string
1300
+ description: Heading of the trip (identical to what is shown on the bus)
1301
+ nullable: true
1302
+ example: "Sรญdliลกtฤ› Modล™any"
1303
+ required:
1304
+ - route_id
1305
+ - route_short_name
1306
+ - route_type
1307
+ - trip_id
1308
+ start_timestamp:
1309
+ type: string
1310
+ description: Timestamp of arrival time in first stop (UTC)
1311
+ example: "2019-03-18T11:00:00.000Z"
1312
+ vehicle_type:
1313
+ description: Type of vehicle
1314
+ $ref: "#/components/schemas/VehiclepositionVehicleType"
1315
+ vehicle_registration_number:
1316
+ type: number
1317
+ format: int64
1318
+ description: Four-digit identifier of the vehicle in the system
1319
+ example: 8635
1320
+ wheelchair_accessible:
1321
+ type: boolean
1322
+ description: Determines wheter the vehicle has wheelchair access
1323
+ example: true
1324
+ required:
1325
+ - sequence_id
1326
+ - origin_route_name
1327
+ - start_timestamp
1328
+ - vehicle_registration_number
1329
+ - wheelchair_accessible
1330
+
1331
+ VehiclepositionVehicleType:
1332
+ title: Vehicleposition Vehicle Type
1333
+ type: object
1334
+ properties:
1335
+ id:
1336
+ type: number
1337
+ format: int64
1338
+ description: Unique id code of type
1339
+ example: 1
1340
+ description_cs:
1341
+ type: string
1342
+ description: Description of type in Czech
1343
+ example: "Autobus"
1344
+ description_en:
1345
+ type: string
1346
+ description: Description of type in English
1347
+ example: "Bus"
1348
+ required:
1349
+ - id
1350
+ - description_cs
1351
+ - description_en
1352
+
1353
+ VehiclepositionPosition:
1354
+ title: Vehicleposition Position
1355
+ type: object
1356
+ properties:
1357
+ bearing:
1358
+ type: number
1359
+ format: int64
1360
+ nullable: true
1361
+ description: Bearing, in degrees (0 = north, 90 = east, 180 = south, 270 = west)
1362
+ example: 34
1363
+ delay:
1364
+ type: object
1365
+ properties:
1366
+ actual:
1367
+ type: number
1368
+ format: int64
1369
+ nullable: true
1370
+ description: Current delay, in seconds, based on actual location of a trip on its shape between stops
1371
+ example: 213
1372
+ last_stop_arrival:
1373
+ type: number
1374
+ format: int64
1375
+ nullable: true
1376
+ description: Delay, in seconds, at the last confirmed stop on arrival. Null, if the arrival time to the last stop equal departure time
1377
+ example: 23
1378
+ last_stop_departure:
1379
+ type: number
1380
+ format: int64
1381
+ nullable: true
1382
+ description: Delay, in seconds, at the last confirmed stop on departure. Null, if it was a terminal stop.
1383
+ example: -84
1384
+ last_stop:
1385
+ description: Properties for last stop passed
1386
+ properties:
1387
+ id:
1388
+ type: string
1389
+ nullable: true
1390
+ description: GTFS Static identifier of the last stop passed on the route of the trip
1391
+ example: "331"
1392
+ sequence:
1393
+ type: string
1394
+ nullable: true
1395
+ description: Sequence number of the last stop passed on the route of the trip
1396
+ example: "11"
1397
+ arrival_time:
1398
+ type: string
1399
+ nullable: true
1400
+ description: Scheduled arrival time to the last passed stop (UTC)
1401
+ example: "2019-03-18T11:00:00.000Z"
1402
+ departure_time:
1403
+ type: string
1404
+ nullable: true
1405
+ description: Scheduled departure time from the last passed stop (UTC)
1406
+ example: "2019-03-18T11:04:00.000Z"
1407
+ required:
1408
+ - id
1409
+ - sequence
1410
+ - arrival_time
1411
+ - departure_time
1412
+ next_stop:
1413
+ description: Properties of the next stop on the route of the trip
1414
+ properties:
1415
+ id:
1416
+ type: string
1417
+ nullable: true
1418
+ description: GTFS Static identifier of the next stop on the route of the trip
1419
+ example: "334"
1420
+ sequence:
1421
+ type: string
1422
+ nullable: true
1423
+ description: Sequence number of the next stop on the route of the trip
1424
+ example: "12"
1425
+ arrival_time:
1426
+ type: string
1427
+ nullable: true
1428
+ description: Scheduled arrival time of the next stop on the route of the trip
1429
+ example: "2019-03-18T11:10:00.000Z"
1430
+ departure_time:
1431
+ type: string
1432
+ nullable: true
1433
+ description: Scheduled departure time of the next stop on the route of the trip
1434
+ example: "2019-03-18T11:14:00.000Z"
1435
+ required:
1436
+ - id
1437
+ - sequence
1438
+ - arrival_time
1439
+ - departure_time
1440
+ is_canceled:
1441
+ type: boolean
1442
+ nullable: true
1443
+ description: True, if the trip was canceled. Other fields about the position have non-defined values in case this value is true
1444
+ example: false
1445
+ origin_timestamp:
1446
+ type: string
1447
+ description: Time at which the position was sent from the vehicle (UTC)
1448
+ example: "2019-03-18T11:00:00.000Z"
1449
+ speed:
1450
+ type: number
1451
+ format: int64
1452
+ nullable: true
1453
+ description: Current speed of the vehicle (kilometers per hour)
1454
+ example: 34
1455
+ shape_dist_traveled:
1456
+ type: string
1457
+ nullable: true
1458
+ description: Number of kilometers traveled on the route
1459
+ example: "12.3"
1460
+ tracking:
1461
+ type: boolean
1462
+ description: True if trip is tracked, meaning that trip is on its track.
1463
+ example: false
1464
+ required:
1465
+ - bearing
1466
+ - is_canceled
1467
+ - origin_timestamp
1468
+ - tracking
1469
+
1470
+ PIDDepartureBoard:
1471
+ title: PID Departure Board
1472
+ type: object
1473
+ properties:
1474
+ stops:
1475
+ type: array
1476
+ description: List of stops in the requested set and their properties.
1477
+ items:
1478
+ $ref: "#/components/schemas/PIDDepartureBoardStop"
1479
+ departures:
1480
+ type: array
1481
+ description: List of departures.
1482
+ items:
1483
+ $ref: "#/components/schemas/PIDDepartureBoardDeparture"
1484
+ infotexts:
1485
+ type: array
1486
+ description: List of active infotexts for selected stops.
1487
+ items:
1488
+ $ref: "#/components/schemas/PIDDepartureBoardInfotext"
1489
+
1490
+ PIDDepartureBoardDeparture:
1491
+ title: PID Departure Board Departure
1492
+ type: object
1493
+ properties:
1494
+ arrival_timestamp:
1495
+ $ref: "#/components/schemas/PIDDepartureBoardStopTime"
1496
+ delay:
1497
+ $ref: "#/components/schemas/PIDDepartureBoardDelay"
1498
+ departure_timestamp:
1499
+ $ref: "#/components/schemas/PIDDepartureBoardStopTime"
1500
+ last_stop:
1501
+ $ref: "#/components/schemas/PIDDepartureBoardLastStop"
1502
+ route:
1503
+ $ref: "#/components/schemas/PIDDepartureBoardRoute"
1504
+ stop:
1505
+ $ref: "#/components/schemas/PIDDepartureBoardStopReference"
1506
+ trip:
1507
+ $ref: "#/components/schemas/PIDDepartureBoardTrip"
1508
+
1509
+ PIDDepartureBoardInfotext:
1510
+ title: PID Departure Board Infotext
1511
+ type: object
1512
+ properties:
1513
+ valid_from:
1514
+ type: string
1515
+ description: Intended time of infotext publishing in ISO String (UTC). Does not have to represent the time the reported event starts.
1516
+ nullable: true
1517
+ example: "2019-05-18T07:38:00.000Z"
1518
+ valid_to:
1519
+ type: string
1520
+ description: Intended time of infotext removal in ISO String (UTC). Does not have to represent the time the reported event ends.
1521
+ nullable: true
1522
+ example: "2019-05-19T07:38:00.000Z"
1523
+ text:
1524
+ type: string
1525
+ description: Information text in Czech.
1526
+ example: "Nehoda na trase, odklon linek mimo tuto stanici."
1527
+ text_en:
1528
+ type: string
1529
+ description: Information text in English.
1530
+ nullable: true
1531
+ example: "Trips are cancelled due to accident on route."
1532
+ display_type:
1533
+ type: string
1534
+ description: Type of display on board by the intended form of presentation (where applicable). Enumerating `inline` (to be presented along with departures, usually in a marquee), `general` (to be displayed full screen instead of departures), `general-alternate` (full screen alternates with departures).
1535
+ example: "inline"
1536
+ related_stops:
1537
+ type: array
1538
+ description: Type of display on board by the intended form of presentation (where applicable). Enumerating `inline` (to be presented along with departures, usually in a marquee), `general` (to be displayed full screen instead of departures), `general-alternate` (full screen alternates with departures).
1539
+ items:
1540
+ type: string
1541
+ example: "U118S1"
1542
+ description: GTFS station IDs for which the infotexts apply.
1543
+ required:
1544
+ - valid_from
1545
+ - valid_to
1546
+ - text
1547
+ - text_en
1548
+ - display_type
1549
+
1550
+ PIDDepartureBoardTrip:
1551
+ title: PID Departure Board Trip
1552
+ type: object
1553
+ properties:
1554
+ direction:
1555
+ type: string
1556
+ description: >-
1557
+ The equivalent of arrows that are printed on stop signs. Indicates the direction the vehicle will continue at stops where routes split up relative to the direction of motion of the vehicle. Valid values: `null` (do not display the arrow), `top`, `top-right`, `right`, `bottom-right`, `bottom`, `bottom-left`, `left`, `top-left`.
1558
+ example: "top-left"
1559
+ headsign:
1560
+ type: string
1561
+ description: Trip headsign (usually the final stop).
1562
+ example: "Chodov"
1563
+ id:
1564
+ type: string
1565
+ description: GTFS trip ID.
1566
+ example: "140_224_200302"
1567
+ is_at_stop:
1568
+ type: boolean
1569
+ description: True if vehicle is physically present in the stop. Applicable only to connections with delay available.
1570
+ example: true
1571
+ is_canceled:
1572
+ type: boolean
1573
+ description: True if the trip is canceled.
1574
+ example: false
1575
+ is_wheelchair_accessible:
1576
+ type: boolean
1577
+ description: True if the vehicle is wheelchair accessible.
1578
+ example: false
1579
+ short_name:
1580
+ type: string
1581
+ description: The number of a particular train, otherwise `null`.
1582
+ example: "Os 9327"
1583
+ required:
1584
+ - direction
1585
+ - headsign
1586
+ - id
1587
+ - is_at_stop
1588
+ - is_canceled
1589
+ - is_wheelchair_accessible
1590
+ - short_name
1591
+
1592
+ PIDDepartureBoardLastStop:
1593
+ title: PID Departure Board Last Stop
1594
+ type: object
1595
+ properties:
1596
+ name:
1597
+ type: string
1598
+ description: Name of the last stop the vehicle reported from.
1599
+ example: "Proseckรก"
1600
+ id:
1601
+ type: string
1602
+ description: GTFS ID of the stop.
1603
+ example: "U754Z1P"
1604
+ required:
1605
+ - name
1606
+ - id
1607
+
1608
+ PIDDepartureBoardStop:
1609
+ title: PID Departure Board Stop
1610
+ type: object
1611
+ properties:
1612
+ level_id:
1613
+ type: string
1614
+ description: Level of metro stops.
1615
+ example: "U118L2"
1616
+ location_type:
1617
+ type: number
1618
+ description: Describes the type of stop, is always `0`.
1619
+ example: 0
1620
+ parent_station:
1621
+ type: string
1622
+ description: A GTFS identifier of the parent station for metro platforms.
1623
+ example: "U118S1"
1624
+ platform_code:
1625
+ type: string
1626
+ description: Human-friendly code used to distinguish a stop inside a node. Multiple GTFS codes can share a platform code.
1627
+ example: "A"
1628
+ stop_lat:
1629
+ type: number
1630
+ format: float
1631
+ description: Latitude of the stop marker or the center of metro or train station platform.
1632
+ example: 50.4
1633
+ stop_lon:
1634
+ type: number
1635
+ format: float
1636
+ description: Longitude of the stop marker or the center of metro or train station platform.
1637
+ example: 50.4
1638
+ asw_id:
1639
+ allOf:
1640
+ - $ref: "#/components/schemas/ASWid"
1641
+ description: ASW ID of the stop.
1642
+ nullable: true
1643
+ stop_id:
1644
+ type: string
1645
+ description: GTFS ID of the stop. Stops that will be valid in the future have the date of the start of their validity appended, i.e. `U476Z51P_210401`.
1646
+ example: "U118Z101P"
1647
+ stop_name:
1648
+ type: string
1649
+ description: Name of the stop.
1650
+ example: "Flora"
1651
+ wheelchair_boarding:
1652
+ type: number
1653
+ description: Indicates accessibility of the stop by wheelchairs. `0` โ€“ unknown, `1` โ€“ accessible, `2` โ€“ inaccessible
1654
+ example: 2
1655
+ zone_id:
1656
+ type: string
1657
+ description: PID fare zone. Multiple zones are separated by a comma.
1658
+ example: "P"
1659
+ required:
1660
+ - level_id
1661
+ - location_type
1662
+ - parent_station
1663
+ - platform_code
1664
+ - stop_lat
1665
+ - stop_lon
1666
+ - asw_id
1667
+ - stop_id
1668
+ - stop_name
1669
+ - wheelchair_boarding
1670
+ - zone_id
1671
+
1672
+ ASWid:
1673
+ title: ASW id
1674
+ type: object
1675
+ properties:
1676
+ node:
1677
+ type: number
1678
+ description: ASW ID of node
1679
+ example: 100
1680
+ stop:
1681
+ type: number
1682
+ description: Identification of the stop within the node.
1683
+ example: 2
1684
+ required:
1685
+ - node
1686
+ - stop
1687
+
1688
+ PIDDepartureBoardStopReference:
1689
+ title: PID Departure Board Stop Reference
1690
+ type: object
1691
+ properties:
1692
+ id:
1693
+ type: string
1694
+ description: GTFS ID of the stop the vehicle is stopping at.
1695
+ example: "U754Z1P"
1696
+ platform_code:
1697
+ type: string
1698
+ description: For trains it is the platform number the train is stopping at. Is `null` if not known. For other modes of transport, returns the platform code from `stops[]`.
1699
+ example: "B"
1700
+ required:
1701
+ - id
1702
+ - platform_code
1703
+
1704
+ PIDDepartureBoardDelay:
1705
+ title: PID Departure Board Delay
1706
+ type: object
1707
+ properties:
1708
+ is_available:
1709
+ type: boolean
1710
+ description: True if information about trip's delay is available.
1711
+ example: false
1712
+ minutes:
1713
+ type: string
1714
+ description: Delay rounded down to minutes.
1715
+ example: "3"
1716
+ seconds:
1717
+ type: string
1718
+ description: Delay in seconds.
1719
+ example: "176"
1720
+ required:
1721
+ - is_available
1722
+
1723
+ PIDDepartureBoardStopTime:
1724
+ title: PID Departure Board Stop Time
1725
+ type: object
1726
+ properties:
1727
+ predicted:
1728
+ type: string
1729
+ description: Time of arrival/departure including realtime delay as an ISO String (UTC). Is `null` on start/end stops. Is same as scheduled time when no delay is available. Is `null` on first/last stops.
1730
+ example: "2019-05-18T07:38:20.000Z"
1731
+ scheduled:
1732
+ type: string
1733
+ description: Time of arrival/departure as ISO string (UTC).
1734
+ example: "2019-05-18T07:38:00.000Z"
1735
+ minutes:
1736
+ type: string
1737
+ description: Number of minutes till departure. If it is less than 30 second it returns value "<1".
1738
+ example: "<1"
1739
+ required:
1740
+ - predicted
1741
+ - scheduled
1742
+
1743
+ PIDDepartureBoardRoute:
1744
+ title: PID Departure Board Route
1745
+ type: object
1746
+ properties:
1747
+ short_name:
1748
+ type: string
1749
+ description: Route designation used by PID.
1750
+ example: "140"
1751
+ type:
1752
+ type: string
1753
+ description: GTFS route type. `0` โ€“ tram, `1` โ€“ metro, `2` โ€“ train, `3` โ€“ bus, `4` โ€“ ferry, `7` โ€“ funicular, `11` โ€“ trolleybus
1754
+ example: "3"
1755
+ is_night:
1756
+ type: boolean
1757
+ description: True if route is a designated night route.
1758
+ example: true
1759
+ is_regional:
1760
+ type: boolean
1761
+ description: True if route serves areas outside Prague boundaries.
1762
+ example: true
1763
+ is_substitute_transport:
1764
+ type: boolean
1765
+ description: True if route provides substitute service for another route.
1766
+ example: true
1767
+ required:
1768
+ - short_name
1769
+ - type
1770
+ - is_night
1771
+ - is_regional
1772
+ - is_substitute_transport