/
openapi.yaml
756 lines (710 loc) · 22.4 KB
/
openapi.yaml
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
openapi: "3.0.0"
info:
version: 1.0.1
title: Autobahn App API
contact:
url: https://www.autobahn.de/datenschutz/
email: kontakt@autobahn.de
name: Die Autobahn GmbH des Bundes
x-office: Bundesministerium für Digitales und Verkehr
description: |
Was passiert auf Deutschlands Bundesstraßen? API für aktuelle Verwaltungsdaten zu Baustellen, Staus und Ladestationen. Außerdem Zugang zu Verkehrsüberwachungskameras und vielen weiteren Datensätzen.
servers:
- url: https://verkehr.autobahn.de/o/autobahn
paths:
/:
get:
operationId: list-autobahnen
summary: Liste verfügbarer Autobahnen
description: Gibt eine Liste der verfügbaren Autobahnen zurück.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/Roads"
/{roadId}/services/roadworks:
get:
operationId: list-roadworks
summary: Liste aktueller Baustellen
description: Gibt eine Liste der aktuellen Baustellen zu einer Autobahn zurück.
parameters:
- name: roadId
in: path
required: true
schema:
$ref: "#/components/schemas/RoadId"
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/Roadworks"
"204":
description: Not found.
"400":
description: Internal server error.
"404":
description: Not found.
/details/roadworks/{roadworkId}:
get:
operationId: get-roadwork
summary: Details einer Baustelle
description: Gibt Details zu einer konkreten Baustelle zurück.
parameters:
- name: roadworkId
in: path
required: true
schema:
type: string
format: byte
example: "Uk9BRFdPUktTX19tZG0ubndfXzAyLTgwMDAwIEQgNzEgMTkgMDkvS0xCV1JO"
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/Roadwork"
"204":
description: Not found.
"400":
description: Internal server error.
"404":
description: Not found.
/{roadId}/services/webcam:
get:
operationId: list-webcams
summary: Liste verfügbarer Webcams
description: Gibt eine Liste der Webcams zu einer Autobahn zurück.
parameters:
- name: roadId
in: path
required: true
schema:
$ref: "#/components/schemas/RoadId"
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/Webcams"
"204":
description: Not found.
"400":
description: Internal server error.
"404":
description: Not found.
# https://verkehr.autobahn.de/o/autobahn/details/webcam/%5BID%5D
/details/webcam/{webcamId}:
get:
operationId: get-webcam
summary: Details einer Webcam
description: Gibt Details einer konkreten Webcam zurück.
parameters:
- name: webcamId
in: path
required: true
schema:
type: string
format: byte
example: "V0VCQ0FNX19OUldfU2lsYS1TaWduYWxiYXVfMTAxMDgxNDE3MjM4ODYzOTk5MTU="
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/Webcam"
"204":
description: Not found.
"400":
description: Internal server error.
"404":
description: Not found.
/{roadId}/services/parking_lorry:
get:
operationId: list-parking-lorries
summary: Liste verfügbarer Rastplätze
description: Gibt eine Liste der Rastplätze zu einer Autobahn zurück.
parameters:
- name: roadId
in: path
required: true
schema:
$ref: "#/components/schemas/RoadId"
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ParkingLorries"
"204":
description: Not found.
"400":
description: Internal server error.
"404":
description: Not found.
/details/parking_lorry/{lorryId}:
get:
operationId: get-parking-lorry
summary: Details eines Rastplatzes
description: Gibt Details eines konkreten Rastplatzes zurück.
parameters:
- name: lorryId
in: path
required: true
schema:
type: string
format: byte
example: "UEFSS0lOR19fbWRtLmxvcnJ5LnBhcmtpbmdfX0RFLVNILTAwMTEwOA=="
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ParkingLorry"
"204":
description: Not found.
"400":
description: Internal server error.
"404":
description: Not found.
/{roadId}/services/warning:
get:
operationId: list-warnings
summary: Liste aktueller Verkehrsmeldungen
description: Gibt eine Liste der Verkehrsmeldungen zu einer Autobahn zurück.
parameters:
- name: roadId
in: path
required: true
schema:
$ref: "#/components/schemas/RoadId"
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/Warnings"
"204":
description: Not found.
"400":
description: Internal server error.
"404":
description: Not found.
/details/warning/{warningId}:
get:
operationId: get-warning
summary: Details zu einer Verkehrsmeldung
description: Gibt Details zu einer konkreten Verkehrsmeldung zurück.
parameters:
- name: warningId
in: path
required: true
schema:
type: string
format: byte
example: "V0FSTklOR19fbWRtLnZpel9fTE1TLU5XL3JfTE1TLU5XLzMyNDE3OV9EICBOVyBMTVMtTlcuMA=="
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/Warning"
"204":
description: Not found.
"400":
description: Internal server error.
"404":
description: Not found.
/{roadId}/services/closure:
get:
operationId: list-closures
summary: Liste aktueller Sperrungen
description: Gibt eine Liste der Sperrungen zu einer Autobahn zurück.
parameters:
- name: roadId
in: path
required: true
schema:
$ref: "#/components/schemas/RoadId"
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/Closures"
"204":
description: Not found.
"400":
description: Internal server error.
"404":
description: Not found.
/details/closure/{closureId}:
get:
operationId: get-closure
summary: Details zu einer Sperrung
description: Gibt Details zu einer konkreten Sperrung zurück.
parameters:
- name: closureId
in: path
required: true
schema:
type: string
format: byte
example: "Q0xPU1VSRV9fbWRtLnZpel9fTE1TLU5XL3JfVElDLU5SV0JMSy8zOS9OUldCTEsvMTAgMzUgMjEgRCAwOTI0Mi0wMV9EICBOVyBMTVMtTlcuMA=="
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/Closure"
"204":
description: Not found.
"400":
description: Internal server error.
"404":
description: Not found.
/{roadId}/services/electric_charging_station:
get:
operationId: list-charging-stations
summary: Liste aktueller Ladestationen
description: Gibt eine Liste der Ladestationen zu einer Autobahn zurück.
parameters:
- name: roadId
in: path
required: true
schema:
$ref: "#/components/schemas/RoadId"
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ElectricChargingStations"
"204":
description: Not found.
"400":
description: Internal server error.
"404":
description: Not found.
/details/electric_charging_station/{stationId}:
get:
operationId: get-charging-station
summary: Details zu einer Ladestation
description: Gibt Details zu einer konkreten Ladestation zurück.
parameters:
- name: stationId
in: path
required: true
schema:
type: string
format: byte
example: "RUxFQ1RSSUNfQ0hBUkdJTkdfU1RBVElPTl9fMTczMzM="
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ElectricChargingStation"
"204":
description: Not found.
"400":
description: Internal server error.
"404":
description: Not found.
components:
schemas:
Roads:
type: object
properties:
roads:
type: array
items:
$ref: '#/components/schemas/RoadId'
RoadId:
type: string
pattern: '[A-Z][A-Za-z]*[1-9]([0-9]{1,3})?(\/[A-Z][A-Za-z]*[1-9]([0-9]{1,3})?)?'
description: |
Kann jede gültige Straßenbezeichnung sein (nicht auf Autobahnen beschränkt). Die Gültigkeit wird nicht überprüft: Abfragen mit nicht existierenden Straßenbezeichnungen liefern einen leeren Datensatz zurück. Die Schreibweise kann von der sonst üblichen Form abweichen (z.B. S1234 statt St1234 für Staatsstraßen).
example: "A1"
Extent:
type: string
pattern: '-?\d+(?:\.\d+)?,\s*-?\d+(?:\.\d+)?,\s*-?\d+(?:\.\d+)?,\s*-?\d+(?:\.\d+)?'
description: Rechteck (in WGS84-Koordinaten), das den betroffenen Streckenabschnitt umschließt.
example: "10.728384054665147,54.00605746113356,10.775848767524598,54.09436740278899"
Point:
type: string
pattern: '-?\d+(?:\.\d+)?,\s*-?\d+(?:\.\d+)?'
description: Beginn des betroffenen Streckenabschnitts (Längengrad und Breitengrad in WGS84). Identisch zu Coordinate, jedoch sind rundungsbedingte Abweichungen möglich.
example: "10.729057,54.006057"
Coordinate:
type: object
description: Beginn des betroffenen Streckenabschnitts (Koordinaten in WGS84). Identisch zu Point, jedoch sind rundungsbedingte Abweichungen möglich.
example: {
"lat": "54.006057",
"long": "10.729057"
}
properties:
lat:
$ref: '#/components/schemas/LatLongValue'
long:
$ref: '#/components/schemas/LatLongValue'
LatLongValue:
type: string
pattern: '-?\d+(?:\.\d+)?'
Identifier:
type: string
format: byte
MultilineText:
type: array
example: [
"Beginn: 29.06.2021 09:00",
"Ende: 28.11.2021 17:00",
"",
"Art der Maßnahme:Asphaltdeckenerneuerung",
"Einschränkungen:Es steht nur 1 Fahrstreifen zur Verfügung.\n\nVollsperrung der AS Eutin Ostseite vom 17.07.2021 - 15.09.2021.\n\nVollsperrung der AS Scharbeutz Ostseite vom 16.09.2021 - 17.11.2021.",
"Maximale Durchfahrsbreite: 3.25\n"
]
items:
type: string
IconRef:
type: string
description: |
Sinnbild, das die Art des Eintrags beschreibt. Größtenteils sind diese dem offiziellen Verkehrszeichenkatalog entnommen, teilweise allerdings mit abweichender Bedeutung und/oder nicht offiziellen Unternummern. Wo kein passendes Verkehrszeichen existiert, werden nicht-numerische Werte verwendet:
<ul>
<li>101: Gefahr</li>
<li>123: Bauarbeiten</li>
<li>250: Sperrung</li>
<li>262-2: Max. 3,5t</li>
<li>314-50: Park-/Rastplatz (Pkw/Lkw)</li>
<li>314-50-2: Park-/Rastplatz (nur Pkw)</li>
<li>448: Anschlussstelle gesperrt</li>
<li>charging_plug_strong: Schnellladestation für E-Fahrzeuge</li>
<li>warnkegel: Kurzzeitbaustelle</li>
</ul>
DisplayType:
type: string
enum:
- ROADWORKS
- WEBCAM
- PARKING
- WARNING
- WEIGHT_LIMIT_35
- CLOSURE
- CLOSURE_ENTRY_EXIT
- STRONG_ELECTRIC_CHARGING_STATION
- SHORT_TERM_ROADWORKS
- ELECTRIC_CHARGING_STATION
LorryParkingFeatureIcon:
type: object
example: {
"icon": "almofont almo-picnic_facility",
"description": "Picknickmöglichkeiten",
"style": ""
}
properties:
icon:
type: string
description:
type: string
style:
type: string
RoadItem:
type: object
properties:
extent:
$ref: '#/components/schemas/Extent'
identifier:
$ref: '#/components/schemas/Identifier'
routeRecommendation:
type: array
items:
# ???
type: object
coordinate:
$ref: '#/components/schemas/Coordinate'
footer:
$ref: '#/components/schemas/MultilineText'
icon:
$ref: '#/components/schemas/IconRef'
isBlocked:
type: string
description:
$ref: '#/components/schemas/MultilineText'
title:
type: string
point:
$ref: '#/components/schemas/Point'
display_type:
$ref: '#/components/schemas/DisplayType'
lorryParkingFeatureIcons:
type: array
items:
$ref: '#/components/schemas/LorryParkingFeatureIcon'
future:
type: boolean
subtitle:
type: string
RoadEvent:
allOf:
- $ref: '#/components/schemas/RoadItem'
- type: object
properties:
startTimestamp:
type: string
format: date-time
Roadworks:
type: object
properties:
roadworks:
type: array
items:
$ref: '#/components/schemas/Roadwork'
Roadwork:
example: {
"extent": "10.728384054665147,54.00605746113356,10.775848767524598,54.09436740278899",
"identifier": "Uk9BRFdPUktTX19tZG0uc2hfXzYzMTU=",
"routeRecommendation": [],
"coordinate": {
"lat": "54.006057",
"long": "10.729057"
},
"footer": [],
"icon": "123",
"isBlocked": "false",
"description": [
"Beginn: 29.06.2021 09:00",
"Ende: 28.11.2021 17:00",
"",
"Art der Maßnahme:Asphaltdeckenerneuerung",
"Einschränkungen:Es steht nur 1 Fahrstreifen zur Verfügung.\n\nVollsperrung der AS Eutin Ostseite vom 17.07.2021 - 15.09.2021.\n\nVollsperrung der AS Scharbeutz Ostseite vom 16.09.2021 - 17.11.2021.",
"Maximale Durchfahrsbreite: 3.25\n"
],
"title": "A1 | AS Pansdorf (17) - AS Neustadt-Mitte (14)",
"point": "10.729057,54.006057",
"display_type": "ROADWORKS",
"lorryParkingFeatureIcons": [],
"future": false,
"subtitle": "Lübeck Richtung Fehmarn",
"startTimestamp": "2021-06-29T09:00:00.000+0200"
}
allOf:
- $ref: '#/components/schemas/RoadEvent'
Webcams:
type: object
properties:
webcam:
type: array
items:
$ref: '#/components/schemas/Webcam'
Webcam:
example: {
"extent": "6.861151,50.987423,6.861151,50.987423",
"identifier": "V0VCQ0FNX19OUldfU2lsYS1TaWduYWxiYXVfMTAxMDgxMDk4ODE2NDgyOTQ4NTQ=",
"routeRecommendation": [],
"coordinate": {
"lat": "50.987423",
"long": "6.861151"
},
"footer": [
"ID: WEBCAM__NRW_Sila-Signalbau_10108109881648294854"
],
"icon": "webcam",
"isBlocked": "false",
"description": [],
"title": "A1 | ID005 AK Köln-Nord",
"operator": "NRW",
"point": "6.861151,50.987423",
"display_type": "WEBCAM",
"lorryParkingFeatureIcons": [],
"future": false,
"imageurl": "https://www.verkehr.nrw/webcams/10108109881648294854.jpg",
"subtitle": "Blickrichtung Dortmund",
"linkurl": "https://www.blitzvideoserver.de/player_strassennrw.html?serverip=62.113.210.7&serverapp=strassennrw-rtplive&streamname=10108109881648294854"
}
allOf:
- $ref: '#/components/schemas/RoadItem'
- type: object
properties:
operator:
type: string
imageurl:
type: string
format: uri
linkurl:
type: string
format: uri
ParkingLorries:
type: object
properties:
parking_lorry:
type: array
items:
$ref: '#/components/schemas/ParkingLorry'
ParkingLorry:
example: {
"extent": "10.979849815368652,54.362571716308594,10.979849815368652,54.362571716308594",
"identifier": "UEFSS0lOR19fbWRtLmxvcnJ5LnBhcmtpbmdfX0RFLVNILTAwMTEwOA==",
"routeRecommendation": [],
"coordinate": {
"lat": "54.362572",
"long": "10.979850"
},
"footer": [],
"icon": "314-50",
"isBlocked": "false",
"description": [
"PKW Stellplätze: 21 ",
"LKW Stellplätze: 20 "
],
"title": "A 1 | Richtung Puttgarden",
"point": "10.979850,54.362572",
"display_type": "PARKING",
"lorryParkingFeatureIcons": [
{
"icon": "almofont almo-picnic_facility",
"description": "Picknickmöglichkeiten",
"style": ""
},
{
"icon": "almofont almo-restroom",
"description": "Toilette vorhanden",
"style": ""
}
],
"future": false,
"subtitle": "(Ostseeblick S)"
}
allOf:
- $ref: '#/components/schemas/RoadItem'
Warnings:
type: object
properties:
warning:
type: array
items:
$ref: '#/components/schemas/Warning'
Warning:
example: {
"extent": "8.61785,52.97344,8.69904,53.00507",
"identifier": "V0FSTklOR19fbWRtLnZpel9fTE1TLU5JL3JfTE1TLU5JLzIxMjI2MF9EICBOSSBMTVMtTkkgIC4w",
"routeRecommendation": [],
"coordinate": {
"lat": "53.005070",
"long": "8.699040"
},
"footer": [],
"icon": "101",
"isBlocked": "false",
"description": [
"Beginn: 25.05.2021 00:00",
"Ende: 30.11.2021 23:59",
"",
"A1 Bremen Richtung Osnabrück",
"zwischen Dreieck Stuhr und Groß Ippener",
"Fahrbahnverengung, geänderte Verkehrsführung, Staugefahr, bis voraussichtlich 30.11.2021",
"Erweiterung PWC Kiekut."
],
"title": "A1 | AS Delmenhorst-Ost (58b) - AS Groß Ippener (59)",
"point": "8.699040,53.005070",
"display_type": "WARNING",
"lorryParkingFeatureIcons": [],
"future": false,
"subtitle": "Bremen Richtung Osnabrück",
"startTimestamp": "2021-05-25T00:00:00.000+0200"
}
allOf:
- $ref: '#/components/schemas/RoadEvent'
Closures:
type: object
properties:
closure:
type: array
items:
$ref: '#/components/schemas/Closure'
Closure:
example: {
"extent": "6.95325,51.02996,6.96491,51.03644",
"identifier": "Q0xPU1VSRV9fbWRtLnZpel9fTE1TLU5XL3JfTE1TLU5XLzMxNTEyMV9EICBOVyBMTVMtTlcuMA==",
"routeRecommendation": [],
"coordinate": {
"lat": "51.036440",
"long": "6.964910"
},
"footer": [],
"icon": "262-2",
"isBlocked": "false",
"description": [
"Beginn: 20.06.2021 14:19",
"Ende: 31.12.2025 23:59",
"",
"A1 Dortmund - Köln",
"Leverkusener Brücke",
"in beiden Richtungen gesperrt für LKW über 3,5 t, bis 31.12.2025"
],
"title": "A1 | AK Leverkusen-West (99) - AS Köln-Niehl (100)",
"point": "6.964910,51.036440",
"display_type": "WEIGHT_LIMIT_35",
"lorryParkingFeatureIcons": [],
"future": false,
"subtitle": "Dortmund Richtung Köln",
"startTimestamp": "2021-06-20T14:19:26.000+0200"
}
allOf:
- $ref: '#/components/schemas/RoadEvent'
ElectricChargingStations:
type: object
properties:
electric_charging_station:
type: array
items:
$ref: '#/components/schemas/ElectricChargingStation'
ElectricChargingStation:
example: {
"extent": "9.176298,53.090847,9.176298,53.090847",
"identifier": "RUxFQ1RSSUNfQ0hBUkdJTkdfU1RBVElPTl9fMTI2OTk=",
"routeRecommendation": [],
"coordinate": {
"lat": "53.090847",
"long": "9.176298"
},
"footer": [],
"icon": "charging_plug_strong",
"isBlocked": "false",
"description": [
"A1 | Bremen | Raststätte Grundbergsee Nord",
"27376 Sottrum",
"",
"Ladepunkt 1:",
"AC Kupplung Typ 2",
"43 kW",
"",
"Ladepunkt 2:",
"DC Kupplung Combo, DC CHAdeMO",
"50 kW"
],
"title": "A1 | Bremen | Raststätte Grundbergsee Nord",
"point": "9.176298,53.090847",
"display_type": "STRONG_ELECTRIC_CHARGING_STATION",
"lorryParkingFeatureIcons": [],
"future": false,
"subtitle": "Schnellladeeinrichtung"
}
allOf:
- $ref: '#/components/schemas/RoadItem'
externalDocs:
description: "Weiterführende Dokumentation"
url: "https://github.com/bundesAPI/autobahn-api/blob/main/README.md"