forked from AndreasFischer1985/coachingangebote-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
671 lines (646 loc) · 24.5 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
openapi: "3.0.0"
info:
description: |
Eine der größten Datenbanken zu Coaching-/Aktivierungsangeboten Deutschlands durchsuchen.
Die Authentifizierung funktioniert per OAuth 2 Client Credentials mit JWTs. Folgende Client-Credentials können dafür verwendet werden:
**ClientID:** ee971dcb-96fa-47b3-b2be-00863e4fc88b
**ClientSecret:** 1050e0b7-6db8-49e8-aff9-0e58e556681f
**Achtung**: der generierte Token muss bei folgenden GET-requests im header als *'OAuthAccessToken'* inkludiert werden. Alternativ kann man bei folgenden GET-requests auch direkt die *client_id* als Header-Parameter *'X-API-Key'* übergeben - *'OAuthAccessToken'* ist in diesem Fall nicht erforderlich. 🚀
version: "1.0.0"
title: "Bundesagentur für Arbeit: Coachingangebote API"
contact:
name: "AndreasFischer1985"
email: "[email protected]"
url: "https://github.com/AndreasFischer1985/coachingangebote-api"
servers:
- url: "https://rest.arbeitsagentur.de/infosysbub/avgs"
paths:
/pc/v1/aktivierungsangebote:
get:
summary: Coaching-/Aktivierungsangebote
description: "Die Suche nach Coaching-/Aktivierungsangeboten ermöglicht verfügbare Weiterbildungsangebote mit verschiedenen GET-Parametern zu filtern."
operationId: aktivierungsangebote
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
parameters:
- in: query
name: mz
schema:
type: string
enum:
- SA%2001
- SA%2004
- SA%2005
description: Maßnahmenziel - SA%2001 = Heranführung an den Ausbildungs- und Arbeitsmarkt sowie Feststellung, Verringerung und Beseitigung von Vermittlungshemmnissen; SA%2004 = Heranführung an eine selbständige Arbeit; SA%2005 = Stabilisierung einer Beschäftigungsaufnahme.
example: SA%2001
required: true
- in: query
name: sw
schema:
type: string
description: Suchwort
example: Vermittlungshemmnisse
required: false
- in: query
name: ort
schema:
type: string
description: Ortsangabe nebst Postleitzahl und Koordinaten (longitude und latitude) jeweils durch Unterstriche getrennt.
example: Feucht_90537_11.224918_49.376701
required: false
- in: query
name: pg
schema:
type: integer
description: Ergebnissseite (beginnend mit 0)
example: 1
required: false
- in: query
name: re
schema:
type: string
enum:
- BW
- BY
- BE
- BB
- HB
- HH
- HE
- MV
- NI
- NW
- RP
- SL
- SN
- ST
- SH
- TH
description: Region/Bundesland - BW=Baden-Württemberg; BY=Bayern; BE=Berlin; BB=Brandenburg; HB=Bremen; HH=Hamburg; HE=Hessen; MV=Mecklenburg-Vorpommern; NI=Niedersachsen; NW=Nordrhei-Westfalen; RP=Rheinland-Pfalz; SL=Saarland; SN=Sachsen; ST=Sachsen-Anhalt; SH=Schleswig-Holstein; TH=Thüringen. Mehrere Komma-getrennte Angaben möglich.
example: BY
required: false
- in: query
name: ban
schema:
type: integer
description: Anbieter-ID
example: 229563
required: false
- in: query
name: uk
schema:
type: string
enum:
- 'Bundesweit'
- '25'
- '50'
- '100'
- '150'
- '200'
description: Umkreis - Bundesweit=Bundesweit; 25=25 km; 50=50 km; 100=100 km; 150=150 km; 200=200 km.
example: "Bundesweit"
required: false
- in: query
name: mna
schema:
type: integer
enum:
- 0
- 1
description: Maßnahmenart - 0=Einzelmaßnahme; 1=Gruppenmaßnahme. Komma-separierte Angaben möglich.
example: 0
required: false
- in: query
name: deufoev
schema:
type: boolean
enum:
- true
- false
description: DEUFOEV - true = (nur) Anbieter berufsbezogener Sprachförderung Deutsch (DeuFöV) anzeigen.
example: true
required: false
- in: query
name: sort
schema:
type: string
enum:
- ta
- tz
description: Sortierungskriterium - ta = Maßnahmetitel A-Z; tz = Maßnahmetitel Z-A.
example: ta
required: false
security:
- APIKeyHeaders: []
components:
securitySchemes:
APIKeyHeaders:
type: apiKey
in: header
name: X-API-Key
description: "X-API-Key ist die Client-ID ee971dcb-96fa-47b3-b2be-00863e4fc88b"
schemas:
Response:
type: object
properties:
_embedded:
type: object
properties:
termine:
type: array
items:
type: object
properties:
id:
type: integer
example: 130945910
massnahmeNummer:
type: string
example: M-20-24100
angebot:
type: object
properties:
id:
type: integer
example: 11302952
titel:
type: string
example: Jobcoaching, Bewerbungs- und Soft Skills Training (Einzel, intensiv)
inhalt:
type: string
anbieter:
type: object
properties:
id:
type: integer
example: 250563
name:
type: string
deuFoeV:
type: string
telefonVorwahl:
type: string
example: '02241'
telefonDurchwahl:
type: string
mobilVorwahl:
type: string
mobilDurchwahl:
type: string
faxVorwahl:
type: string
faxDurchwahl:
type: string
homepage:
type: string
email:
type: string
adresse:
type: object
properties:
id:
type: integer
example: 3516303
bezeichnung:
type: string
hinweise:
type: string
strasse:
type: string
ortStrasse:
type: object
properties:
id:
type: integer
example: 21248
plz:
type: string
example: '53757'
name:
type: string
example: Sankt Augustin
laengengrad:
type: number
example: 17.1853
breitengrad:
type: number
example: 40.7733
koordinaten:
type: object
properties:
lat:
type: number
example: 17.1853
lon:
type: number
example: 40.7733
land:
type: object
properties:
id:
type: integer
name:
type: string
example: Bayern
laenderCode:
type: string
example: D
bundeslandCode:
type: string
example: BAY
code:
type: string
example: BAY
dienstleistungen:
type: string
telefonVorwahl:
type: string
telefonDurchwahl:
type: string
mobilVorwahl:
type: string
mobilDurchwahl:
type: string
faxVorwahl:
type: string
faxDurchwahl:
type: string
email:
type: string
homepage:
type: string
logo:
type: object
properties:
id:
type: integer
example: 38803
url:
type: string
externalURL:
type: string
zertifizierer:
type: array
items:
type: object
properties:
id:
type: integer
example: 25
suchworte:
type: array
items:
type: object
properties:
suchwort:
type: string
example: Aktivierung (§ 45 SGB III)
systematiken:
type: array
items:
type: object
properties:
id:
type: integer
example: 131172
codeNr:
type: string
example: SA 01
bezeichnung:
type: string
example: '§ 45 Abs. 1 Nr. 1 SGB III: Heranführung an den Ausbildungs- und Arbeitsmarkt sowie Feststellung, Verringerung oder Beseitigung von Vermittlungshemmnissen'
suchworte:
type: array
items:
type: string
adresse:
type: object
properties:
id:
type: integer
example: 3699675
bezeichnung:
type: string
example: Nürnberg
hinweise:
type: string
strasse:
type: string
ortStrasse:
type: object
properties:
id:
type: integer
example: 21248
plz:
type: string
example: '53757'
name:
type: string
example: Sankt Augustin
laengengrad:
type: number
example: 17.1853
breitengrad:
type: number
example: 40.7733
koordinaten:
type: object
properties:
lat:
type: number
example: 17.1853
lon:
type: number
example: 40.7733
land:
type: object
properties:
id:
type: integer
name:
type: string
example: Bayern
laenderCode:
type: string
example: D
bundeslandCode:
type: string
example: BAY
code:
type: string
example: BAY
dienstleistungen:
type: string
telefonVorwahl:
type: string
telefonDurchwahl:
type: string
mobilVorwahl:
type: string
mobilDurchwahl:
type: string
faxVorwahl:
type: string
faxDurchwahl:
type: string
email:
type: string
homepage:
type: string
unterrichtsform:
type: object
properties:
id:
type: integer
example: 0
bezeichnung:
type: string
example: Einzelmaßnahme
gueltigVon:
type: integer
example: 1599688800000
gueltigBis:
type: integer
example: 1694210400000
massnahmeZeiten:
type: string
example: '<p>Dauer: bis zu 4 Wochen<br/>Umfang: bis zu 60 Einheiten a 45 Minuten,<br/>Maßnahmezeiten individuell zwischen Mo.-Fr. zw. 9-17 Uhr</p>'
individuellerEinstieg:
type: boolean
example: true
bemerkungZeit:
type: string
example: <p>Maßnahme wird auch online angeboten; bitte den Bildungsträger hierauf direkt ansprechen</p>
zusatzlink:
type: string
ansprechpartner:
type: array
items:
type: object
properties:
id:
type: integer
example: 1102726
anrede:
type: string
example: m
titel:
type: string
nachname:
type: string
example: Heuser
vorname:
type: string
example: Martin
bemerkungen:
type: string
telefonVorwahl:
type: string
example: '02241'
telefonDurchwahl:
type: string
example: '2344760'
email:
type: string
rollen:
type: array
items:
type: object
properties:
id:
type: integer
example: 2
bezeichnung:
type: string
example: Gesamtansprechpartner
aktualisierungsdatum:
type: integer
example: 1636066800000
abstaende:
type: array
items:
type: object
properties:
ort:
type: object
properties:
name:
type: string
example: Feucht
postleitzahl:
type: integer
laengengrad:
type: number
example: 21.2147
breitengrad:
type: number
example: 29.375
abstandInKm:
type: number
example: 13.143151025302
_links:
type: object
properties:
first:
type: object
properties:
href:
type: string
self:
type: object
properties:
href:
type: string
next:
type: object
properties:
href:
type: string
last:
type: object
properties:
href:
type: string
page:
type: object
properties:
size:
type: integer
format: int32
example: 20
totalElements:
type: integer
format: int32
example: 10000
totalPages:
type: integer
format: int32
example: 500
number:
type: integer
format: int32
example: 0
aggregations:
type: object
properties:
ANZAHL_AUSGEFILTERT:
type: object
properties:
COUNT:
type: integer
example: 406
UNTERRICHSFORMEN:
type: object
properties:
'0':
type: integer
example: 308
'1':
type: integer
example: 406
ANBIETER:
type: object
description: ANBIETER enthält eine lange Liste an Objekten - ein Objekt je Anbieter--ID. Für jede Anbieter-ID (z.B. 1371) sind als integer anzahlErgebnisse und als string name ausgewiesen.
DEUFOEV:
type: string
example: DEUFOEV
AKTIVIERUNGSANGEBOTIDS:
type: array
items:
type: integer
example: 134134448
REGIONEN:
type: object
properties:
MBV:
type: integer
description: Mecklenburg-Vorpommern
example: 9098
SAN:
type: integer
description: Sachsen-Anhalt
example: 9098
RPF:
type: integer
description: Rheinland-Pfalz
example: 9098
THÜ:
type: integer
description: Thüringen
example: 9098
-:
type: integer
description: überregionale Angebote
example: 9098
SLH:
type: integer
description: Schleswig-Holstein
example: 9098
BER:
type: integer
description: Berlin
example: 9098
iCH:
type: integer
description: internationale Angebote aus der Schweiz
example: 9098
BRA:
type: integer
description: Brandenburg
example: 9098
NRW:
type: integer
description: Nordrhein-Westfalen
example: 9098
SAA:
type: integer
description: Sachsen-Anhalt
example: 9098
SAC:
type: integer
description: Sachsen
example: 9098
BRE:
type: integer
description: Bremen
example: 9098
HAM:
type: integer
description: Hamburg
example: 9098
HES:
type: integer
description: Hessen
example: 9098
BAW:
type: integer
description: Baden-Württemberg
example: 9098
iA:
type: integer
description: internationale Angebote aus Österreich
example: 9098
BAY:
type: integer
description: Bayern
example: 9098
NDS:
type: integer
description: Niedersachsen
example: 9098
ANZAHL_GESAMT:
type: object
properties:
COUNT:
type: integer
description: Anzahl gesamt
example: 308
externalDocs:
description: "Weiterführende Dokumentation"
url: "https://github.com/AndreasFischer1985/coachingangebote-api"