generated from bundesAPI/api-doc-template
-
Notifications
You must be signed in to change notification settings - Fork 2
/
openapi_en.yaml
546 lines (529 loc) · 16.6 KB
/
openapi_en.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
openapi: "3.0.0"
info:
description: "The Bundes-Klinik-Atlas API provides information about German clinics and their facilities."
version: "1.0.0"
title: "Bundes-Klinik-Atlas API"
x-office: "Federal Ministry of Health"
contact:
name: "Federal Ministry of Health"
email: poststelle@bmg.bund.de
url: https://bundes-klinik-atlas.de
servers:
- url: https://bundes-klinik-atlas.de
paths:
/fileadmin/json/locations.json:
get:
summary: Retrieve a list of German clinics
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
properties:
name:
type: string
street:
type: string
city:
type: string
zip:
type: integer
phone:
type: string
mail:
type: string
beds_number:
type: integer
latitude:
type: string
longitude:
type: string
link:
type: string
/fileadmin/json/states.json:
get:
summary: Retrieve a list of German states
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
properties:
name:
type: string
cases_number:
type: integer
caregivers_number:
type: integer
doctors_number:
type: integer
location_number:
type: integer
/fileadmin/json/german-states.json:
get:
summary: Retrieve a list of German states with coordinates
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
properties:
state:
type: string
lat:
type: string
lon:
type: string
/fileadmin/json/icd_codes.json:
get:
summary: Retrieve a list of ICD codes
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
properties:
icdcode:
type: string
description:
type: string
/fileadmin/json/ops_codes.json:
get:
summary: Retrieve a list of OPS codes
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
properties:
opscode:
type: string
description:
type: string
/fileadmin/json/german-places.json:
get:
summary: Retrieve a list of German places
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
properties:
p:
type: string
c:
type: string
m:
type: string
ct:
type: integer
d:
type: string
lt:
type: string
ln:
type: string
openapi: "3.0.0"
info:
description: "The Bundes-Klinik-Atlas API provides information about German clinics and their facilities."
version: "1.0.0"
title: "Bundes-Klinik-Atlas API"
x-office: "Federal Ministry of Health"
contact:
name: "Federal Ministry of Health"
email: poststelle@bmg.bund.de
url: https://bundes-klinik-atlas.de
servers:
- url: https://bundes-klinik-atlas.de
paths:
/fileadmin/json/locations.json:
get:
summary: Retrieve a list of German clinics
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
properties:
name:
type: string
street:
type: string
city:
type: string
zip:
type: integer
phone:
type: string
mail:
type: string
beds_number:
type: integer
latitude:
type: string
longitude:
type: string
link:
type: string
/fileadmin/json/states.json:
get:
summary: Retrieve a list of German states
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
properties:
name:
type: string
cases_number:
type: integer
caregivers_number:
type: integer
doctors_number:
type: integer
location_number:
type: integer
/fileadmin/json/german-states.json:
get:
summary: Retrieve a list of German states with coordinates
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
properties:
state:
type: string
lat:
type: string
lon:
type: string
/fileadmin/json/icd_codes.json:
get:
summary: Retrieve a list of ICD codes
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
properties:
icdcode:
type: string
description:
type: string
/fileadmin/json/ops_codes.json:
get:
summary: Retrieve a list of OPS codes
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
properties:
opscode:
type: string
description:
type: string
/fileadmin/json/german-places.json:
get:
summary: Retrieve a list of German places
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
properties:
p:
type: string
c:
type: string
m:
type: string
ct:
type: integer
d:
type: string
lt:
type: string
ln:
type: string
/searchresults/:
get:
summary: Search for hospitals based on specific criteria
parameters:
- name: tx_solr[rows]
in: query
schema:
type: integer
description: Number of rows to return (must be a positive integer)
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: object
properties:
results:
type: array
items:
type: object
properties:
id:
type: integer
header:
type: string
address:
type: string
distance:
type: number
detailLink:
type: string
content:
type: object
properties:
items:
type: array
items:
type: object
properties:
header:
type: string
icon:
type: string
tooltip:
type: string
infoData:
type: array
items:
type: object
filters:
type: object
properties:
fields:
type: array
items:
type: object
properties:
template:
type: string
label:
type: string
extraClass:
type: string
tooltip:
type: string
id:
type: string
name:
type: string
value:
type: string
showValue:
type: integer
appendUnit:
type: string
showRangeLabel:
type: boolean
sliderOptions:
type: array
items:
type: object
properties:
key:
type: string
value:
type: string
labelClass:
type: string
options:
type: array
items:
type: object
properties:
label:
type: string
id:
type: string
value:
type: string
icon:
type: string
selected:
type: boolean
tooltip:
type: string
isAccordion:
type: boolean
tagName:
type: string
headingClass:
type: string
isHorizontal:
type: boolean
sortings:
type: object
properties:
fields:
type: array
items:
type: object
properties:
template:
type: string
isHorizontal:
type: boolean
label:
type: string
id:
type: string
options:
type: array
items:
type: object
properties:
label:
type: string
id:
type: string
value:
type: string
selected:
type: boolean
metaInfos:
type: object
properties:
searchArguments:
type: object
properties:
rows:
type: integer
geolabel:
type: string
latlon:
type: string
ops:
type: string
searchlabel:
type: string
start:
type: integer
quantile:
type: string
department:
type: string
searchResultCount:
type: integer
maxSearchResultsFoundLabel:
type: string
loadMore:
type: boolean
"503":
description: Service Unavailable
content:
text/html:
schema:
type: string
/krankenhaussuche/krankenhaus/{id}/:
get:
summary: Retrieve details of a specific hospital
parameters:
- name: id
in: path
required: true
schema:
type: integer
description: Unique identifier of the hospital
- name: tx_tverzhospitaldata_show[department]
in: query
schema:
type: string
description: Department filter
- name: tx_tverzhospitaldata_show[geolabel]
in: query
schema:
type: string
description: Geographical label filter
- name: tx_tverzhospitaldata_show[quantile]
in: query
schema:
type: string
description: Quantile filter
- name: tx_tverzhospitaldata_show[searchlabel]
in: query
schema:
type: string
description: Search label filter
- name: cHash
in: query
schema:
type: string
description: Cache hash
responses:
"200":
description: Successful response
content:
text/html:
schema:
type: string
"404":
description: Not Found
content:
text/html:
schema:
type: string
"503":
description: Service Unavailable
content:
text/html:
schema:
type: string