forked from bundesAPI/abfallnavi-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
504 lines (481 loc) · 13.3 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
openapi: 3.0.0
servers:
- url: "https://{region}-abfallapp.regioit.de/abfall-app-{region}/rest"
variables:
region: # In sync halten mit Abfallkalender #/components/schemas/Region
enum:
- "aachen" # Aachen
- "zew2" # AWA Entsorgungs GmbH
- "aw-bgl2" # Bergisch Gladbach
- "bav" # Bergischer Abfallwirtschaftverbund
- "din" # Dinslaken
- "dorsten" # Dorsten
- "gt2" # Gütersloh
- "hlv" # Halver
- "coe" # Kreis Coesfeld
- "krhs" # Kreis Heinsberg
- "pi" # Kreis Pinneberg
- "krwaf" # Kreis Warendorf
- "lindlar" # Lindlar
- "stl" # Lüdenscheid
- "nds" # Norderstedt
- "nuernberg" # Nürnberg
- "roe" # Roetgen
- "solingen" # Solingen
- "wml2" # EGW Westmünsterland
default: "nuernberg"
description: Region
info:
title: Abfallnavi API
version: "1.0.0"
description: |
Termine für Leerung des Abfalls nach Abfallart (Papier, Restmüll, ...). Beispielswerte sind für das Rathaus Nürnberg (Hauptmarkt 18, Nürnberg).
# Kommunen / Regionen
Das System ist in diverse Regionen unterteilt. Zu einer `Region` gehören ein oder mehrere Kommunen.
* `aachen`: Aachen
* `zew2`: AWA Entsorgungs GmbH
* `aw-bgl2`: Bergisch Gladbach
* `bav`: Bergischer Abfallwirtschaftverbund
* `din`: Dinslaken
* `dorsten`: Dorsten
* `gt2`: Gütersloh
* `hlv`: Halver
* `coe`: Kreis Coesfeld
* `krhs`: Kreis Heinsberg
* `pi`: Kreis Pinneberg
* `krwaf`: Kreis Warendorf
* `lindlar`: Lindlar
* `stl`: Lüdenscheid
* `nds`: Norderstedt
* `nuernberg`: Nürnberg
* `roe`: Roetgen
* `solingen`: Solingen
* `wml2`: EGW Westmünsterland
# Benutzung
Für die Abfrage von Terminen ist eine Reihe von IDs (von Orten, Straßen und/oder Hausnummern) in Erfahrung zu bringen. Vorsicht:IDs können sich mit der Zeit ändern
1. Orte aus System holen
2. Mit Ort die Straßen abfragen
3. Mit Straße die Hausnummern abfragen
4. Mit Haunummer die möglichen Fraktionen (Müllsorten) abfragen
5. Mit Hausnummer und Fraktionen alle Termine abrufen
Manchmal wird nicht nach Hausnummer unterschieden
tags:
- name: Abholpunkte
description: Orte, Straßen, Hausnummern
- name: Fraktionen
description: Papier, Restmüll, ...
- name: Termine
paths:
/orte:
get:
summary: Orte im System
description: Orte die von diesem API-Endpoint bedient werden.
operationId: orte
tags:
- "Abholpunkte"
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Ort"
/orte/{ortId}:
get:
summary: Informationen zu Ort
description: Informationen zu einem Ort
operationId: ort
tags:
- "Abholpunkte"
parameters:
- in: path
name: ortId
description: Id des Ortes
required: true
schema:
type: integer
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Ort2"
/orte/{ortId}/strassen:
get:
summary: Straßen im Ort
description: |
Straßen im Ort. Siehe id unter Pfad `/orte` für die ortId.
**Warnung**: Die Antwort dieser Anfrage ist zu groß für Anzeige innerhalb der Webseite
operationId: strassenProOrt
tags:
- "Abholpunkte"
parameters:
- in: path
name: ortId
description: Id des Ortes
required: true
schema:
type: integer
responses:
"200":
description: |
OK
**Hinweis**: Nur für die erste Straße ist `hausNrList` befüllt.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Strasse"
/strassen/{strassenId}:
get:
summary: Hausnummern in Straße
description: Hausnummern in Straße. Siehe id unter Pfad `/orte/{ortId}/strassen` für die strassenId.
operationId: hausnummernProStrasse
tags:
- "Abholpunkte"
parameters:
- in: path
name: strassenId
description: Id der Straße
required: true
schema:
type: integer
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/Strasse"
/fraktionen:
get:
summary: Müllarten im System
description: Welche Müllarten es im System gibt (z.B. Restabfall, Bioabfall, Papiertonne, Gelbe Tonne, Papiertonne 1100)
operationId: muellarten
tags:
- "Fraktionen"
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Fraktion"
/hausnummern/{hausnummernId}/fraktionen:
get:
summary: Müllarten für Hausnummer
description: Welche Müllarten es an einer Hausnummer gibt. Siehe id unter Pfad `/strassen/{strassenId}` für die hausnummernId.
operationId: muellartenProHausnummer
tags:
- "Fraktionen"
parameters:
- in: path
name: hausnummernId
description: Id der Hausnummer
required: true
schema:
type: integer
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Fraktion"
/strassen/{strassenId}/fraktionen:
get:
summary: Müllarten für Straßen
description: Welche Müllarten es in einer Straße gibt. Siehe id unter Pfad `/orte/{ortId}/strassen` für die strassenId.
operationId: muellartenProStrasse
tags:
- "Fraktionen"
parameters:
- in: path
name: strassenId
description: Id der Straße
required: true
schema:
type: integer
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Fraktion"
/strassen/{strassenId}/termine:
get:
summary: Abholtermine für Straße
description: Abholtermine für Straße. Siehe id unter Pfad `/orte/{ortId}/strassen` für die strassenId.
operationId: termineProStrasse
tags:
- "Termine"
parameters:
- in: path
name: strassenId
description: Id der Strasse
required: true
schema:
type: integer
- in: query
name: fraktion
required: true
schema:
type: array
items:
type: integer
example: [3, 4]
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Abholung"
/hausnummern/{hausnummernId}/termine:
get:
summary: Abholtermine für Hausnummer
description: Abholtermine für Hausnummer. Siehe id unter Pfad `/strassen/{strassenId}` für die hausnummernId.
operationId: termineProHaussnummer
tags:
- "Termine"
parameters:
- in: path
name: hausnummernId
description: Id der Hausnummer
required: true
schema:
type: integer
- in: query
name: fraktion
required: true
schema:
type: array
items:
type: integer
example: [3, 4]
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Abholung"
/kalender-{region}/downloadfile.jsp:
servers:
- url: https://abfallkalender.regioit.de
get:
summary: Datenexport als PDF oder ICS
description: |
Datenexport als PDF oder ICS
**Hinweis**: Aus der Webseite heraus kann diese Abfrage nicht ausgeführt werden, weil kein Access-Control-Allow-Origin Header gesetzt wird.
operationId: downloadAsFile
tags:
- "Termine"
parameters:
- in: path
name: region
description: Region
required: true
schema:
$ref: "#/components/schemas/Region"
- in: query
name: format
description: Datenformat
required: true
schema:
type: string
enum:
- pdf
- ics
- in: query
name: jahr
description: Jahr
required: true
schema:
type: integer
example: 2022
- in: query
name: ort
description: Ortsname
required: true
schema:
type: string
example: "Nürnberg"
- in: query
name: strasse
description: Id der Straße
required: true
schema:
type: integer
- in: query
name: hnr
description: Id der Hausnummer
required: true
schema:
type: integer
- in: query
name: fraktion
required: true
schema:
type: array
items:
type: integer
example: [3, 4]
responses:
"200":
description: OK
content:
application/octet-stream:
schema:
type: string
format: string
components:
schemas:
Ort:
type: array
items:
type: object
properties:
id:
type: integer
format: int64
example: 4407686
name:
type: string
example: Nürnberg
Ort2:
type: object
properties:
id:
type: integer
format: int64
example: 4407686
name:
type: string
example: Nürnberg
Strasse:
type: object
properties:
id:
type: integer
format: int64
example: 4432667
name:
type: string
example: Hauptmarkt
staticId:
type: string
example: TvxybmJlcmdkZWZhdWx0SGF1cHRtYXJrdA==
hausNrList:
type: array
items:
$ref: "#/components/schemas/Hausnummer"
plz:
type: object
#example: null # TODO Scheint immer null zu sein
ortsteilName:
type: string
example: default
ort:
$ref: "#/components/schemas/Ort"
Hausnummer:
properties:
id:
type: integer
format: int64
example: 4432679
nr:
type: string
example: "18"
plz:
type: string
example: "90403"
staticId:
type: string
example: "TvxybmJlcmc5MDQwM0hhdXB0bWFya3QxOA=="
Fraktion:
type: object
properties:
id:
type: integer
format: int64
example: 0
name:
type: string
example: Restabfall
iconNr:
type: integer
format: int64
example: 7
farbeRgb:
type: string
example: "555555"
Abholung:
properties:
id:
type: integer
format: int64
example: 4479053
bezirk:
type: array
items:
$ref: "#/components/schemas/Bezirk"
datum:
type: string
example: "2022-01-11"
#format: date # TODO Datenformat klären
Bezirk:
properties:
id:
type: integer
format: int64
example: 4407951
name:
type: string
example: "17"
gueltigAb:
type: object
#example: null # TODO Scheint immer null zu sein
fraktiionId:
type: integer
format: int64
example: 3
Region:
type: string
enum:
- "aachen" # Aachen
- "zew2" # AWA Entsorgungs GmbH
- "aw-bgl2" # Bergisch Gladbach
- "bav" # Bergischer Abfallwirtschaftverbund
- "din" # Dinslaken
- "dorsten" # Dorsten
- "gt2" # Gütersloh
- "hlv" # Halver
- "coe" # Kreis Coesfeld
- "krhs" # Kreis Heinsberg
- "pi" # Kreis Pinneberg
- "krwaf" # Kreis Warendorf
- "lindlar" # Lindlar
- "stl" # Lüdenscheid
- "nds" # Norderstedt
- "nuernberg" # Nürnberg
- "roe" # Roetgen
- "wml2" # EGW Westmünsterland
default: "nuernberg"