forked from AndreasFischer1985/eco-visio-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
308 lines (286 loc) · 10.7 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
openapi: "3.0.0"
info:
title: "Eco-Counter: Eco-Visio-API"
description: |
API zum [Eco-Visio-Dashboard](https://data.eco-counter.com/ParcPublic/?id=4586) von Eco-Counter. Eco-Counter ist ein Technologieunternehmen mit Hauptsitz in Lannion, in der Bretagne. Zum Unternehmen zählen Filialen in Montreal (Kanada) und in Köln. Das Untenehmen betreibt u.a. Fahrrad- und Fußgängerzähler in unterschiedlichen Ländern, die in zahlreichen deutschen Städten z.B. Angaben wie "Radfahrende heute" oder "Radfahrende dieses Jahr" ausweisen. Teilweise sind die Zähler auch vollständig unterirdisch verlegt worden (z.B. zahlreiche Fahrradzählstellen in Hessen, vgl. https://data.eco-counter.com/ParcPublic/?id=8080).
Generell findet man in Deutschland überwiegend Fahrradzähler. In Rostock gibt es daneben auch Fußgängerzähler (https://data.eco-counter.com/ParcPublic/?id=888), ebenso in Schwerin (https://data.eco-counter.com/ParcPublic/?id=6116), in Greifswald (https://data.eco-counter.com/ParcPublic/?id=6997) oder in Böblingen (https://data.eco-counter.com/ParcPublic/?id=6811). In Ludwigsburg gibt es sogar separat ausgewiesene Autozähler von Eco-Counter (https://data.eco-counter.com/ParcPublic/?id=6011).
Eco-Visio ist ein Analysetool zur Auswertung der Daten. Die Daten zahlreicher (aber nicht aller) Zähler sind öffentlich einsehbar (Option 'publicwebpage'), teilweise gruppiert nach Träger/Organisation/Domäne (Option 'publicwebpageplus'). Der Zugriff auf nicht-öffentlich einsehbare Zähler erfolgt über die [Eco-Counter API](https://raw.githubusercontent.com/bundesAPI/eco-visio-api/main/openapi_Eco-Counter_v1.1.yaml) auf die auf [https://developers.eco-counter.com/](https://developers.eco-counter.com/) beschriebene Weise.
version: "1.0.0"
servers:
- url: "https://www.eco-visio.net/api/aladdin/1.0.0"
paths:
/pbl/publicwebpageplus/{idOrganisme}:
get:
summary: publicwebpageplus
description: |
Alle Zähler eines Trägers mit ID idOrganisme (z.B. 4586, 20 oder 8080). Eine Übersicht über gültige Ausprägungen des Parameters idOrganisme und deren Bedeutung gibt die Tabelle [hier](https://github.com/bundesAPI/eco-visiSo-api/blob/main/eco-visio-api.csv) (Stand: 18.05.2023). Einige idOrganisme sind deutschen Bundesländern und Städten zugeordnet: 8080=Hessen, 6365=Mecklenburg-Vorpommern, 4728=Berlin, 677=Köln, 4701=Bonn, 6011=Ludwigsburg, 4206=Heidelberg, 607=Stuttgart, 4702=Rhein-Sieg-Kreis, 857=Düsseldorf, 888=Rostock, 5417=Augsburg, 5972=Leipzig, 7119=Bielefeld, 4197=Mannheim, 7581=Reutlingen, 7224=Hürth, 4729=Würzburg, 7241=Norderstedt, 751=Freiburg, 6109=Oberbergischer Kreis und Rheinisch-Bergischer Kreis, 4699=Rheinisch-Bergischer Kreis und Oberbergischer Kreis, 6076=Oberhausen, 6116=Schwerin, 7642=Leverkusen, 6135=Goslar, 6997=Greifswald, 6471=Ludwigshafen, 7058=Siegen, 4626=Essen, 6603=Bochum, 6481=Aschaffenburg, 6811=Böblingen, 6150=Dortmund.
Außerdem sind Zähler in deutschen Städten ausgewiesen unter idOrganisme 4586 (='Bike Count Display Interactive Map') und 5024 (='National Database Demo').
operationId: zaehler
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AllCounter'
parameters:
- in: path
name: idOrganisme
schema:
type: integer
enum:
- 4586
- 5024
- 8080
- 6365
- 4728
- 677
- 4701
- 6011
- 4206
- 607
- 4702
- 857
- 888
- 5417
- 5972
- 7119
- 4197
- 7581
- 7224
- 4729
- 7241
- 751
- 6109
- 4699
- 6076
- 6116
- 7642
- 6135
- 6997
- 6471
- 7058
- 4626
- 6603
- 6481
- 6811
- 6150
default: 4586
description: Träger ID
required: true
- in: query
name: withNull
schema:
type: boolean
description: Parameter ohne bekannten/dokumentierten Effekt.
example: true
required: false
- in: query
name: end
schema:
type: string
description: Spätestes interessierendes Datum (z.B. 26/05/2022).
example: 26/05/2022
required: false
- in: query
name: begin
schema:
type: string
description: Frühestes interessierendes Datum (z.B. 01/01/2021).
example: 01/01/2021
required: false
- in: query
name: pratique
schema:
type: integer
description: pratique i.S.v. interessierende Zählerart (z.B. 1=Fußgänger,2=Fahrräder, oder 12=Sternchen)
example: 1
required: false
/pbl/publicwebpageplus/data/1:
#/pbl/publicwebpageplus/data/{idPdc}:
get:
summary: Zählerdaten
description: Werte für einen spezifischen Fahrradzählers mit ID idPdc (z.B. 100125116) der als GET-Parameter zu spezifizieren ist (optional auch ergänzend als Pfad-Parameter statt der 1).
operationId: zaehlerdaten
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: string
example: ["01/01/2022", "5020"]
parameters:
# - in: path
# name: idPdc
# required: true
# schema:
# type: integer
# description: ID des Fahrradzählers
# example: 100125116
- in: query
name: idOrganisme
schema:
type: integer
enum:
- 4586
- 5024
- 8080
- 6365
- 4728
- 677
- 4701
- 6011
- 4206
- 607
- 4702
- 857
- 888
- 5417
- 5972
- 7119
- 4197
- 7581
- 7224
- 4729
- 7241
- 751
- 6109
- 4699
- 6076
- 6116
- 7642
- 6135
- 6997
- 6471
- 7058
- 4626
- 6603
- 6481
- 6811
- 6150
default: 4586
description: Träger ID
required: true
- in: query
name: idPdc
schema:
type: integer
description: ID des Fahrradzählers
example: 100125116
required: true
- in: query
name: interval
schema:
type: integer
enum:
- 1
- 2
- 3
- 4
- 5
- 6
description: Aggregationsintervall (6=Monate, 5=Wochen, 4=Tage, 3=Stunden, 2=Viertelstunden, 1=?).
example: 4
required: true
- in: query
name: flowIds
schema:
type: string
example: 101125116;102125116;353247560;353247561
description: pratique-ID mit Semikolon getrennt
required: true
- in: query
name: fin
schema:
$ref: '#/components/schemas/Date'
description: Spätestes interessierendes Datum (z.B. '26/05/2022').
example: 26/05/2022
required: false
- in: query
name: debut
schema:
$ref: '#/components/schemas/Date'
description: Frühestes interessierendes Datum (z.B. '01/01/2021').
example: 26/04/2021
required: false
components:
schemas:
AllCounter:
type: array
items:
type: object
properties:
id_pdc_img:
type: integer
example: 100023462
idPdc:
type: integer
example: 100125116
description: ID des Zählers
lat:
type: number
format: float
example: 49.448765
lon:
type: number
format: float
example: 11.082456
nom:
type: string
example: Nuremberg (DE)
photo:
type: array
items:
type: object
properties:
lien:
type: string
example: 'https://filer.eco-counter-tools.com/file/36/abbffb1981cff24c155d40cda72890efbd4b5dfeedf05131025d2ed36128a736/14404315699570.jpg'
description: Foto des Zählers
pratique:
type: array
items:
type: object
properties:
pratique:
type: integer
example: 2
description: pratique i.S.v. interessierende Zählerart (z.B. 1=Fußgänger,2=Fahrräder, oder 12=Sternchen)
id:
type: integer
example: 101125116
description: pratique-ID
mainPratique:
type: integer
example: 2
description: default pratique
debut:
$ref: '#/components/schemas/Date'
debutPeriode:
$ref: '#/components/schemas/Date'
current_year_default:
type: integer
example: 1
description: Berichte alle Daten ab Jahresbeginn, wenn 1.
today:
$ref: '#/components/schemas/Date'
total:
type: integer
example: 270438
description: Anzahl Fahrräder die jemals am Zähler vorbeigefahren sind
lastDay:
type: integer
example: 3455
description: Anzahl Fahrräder die gestern (in Relation zu 'today') am Zähler vorbeigefahren sind
moyD:
type: integer
example: 1865
description: Täglicher Durchschnitt der Anzahl Fahrräder die am Zähler vorbeigefahren sind
Date:
type: string
description: Datum im Format TAG/MONAT/JAHR
example: 26/05/2022
pattern: '^(0[1-9]|[12][0-9]|3[01])\/(0[1-9]|1[012])\/(\d{4})$'