forked from AndreasFischer1985/berufssprachkurssuche-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
620 lines (598 loc) · 22.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
openapi: "3.0.0"
info:
title: "Arbeitsagentur Berufssprachkurssuche API"
description: |
Eine der größten Berufssprachförderungsdatenbanken Deutschlands durchsuchen.
Die Authentifizierung funktioniert per OAuth 2 Client Credentials mit JWTs. Folgende Client-Credentials können dafür verwendet werden:
**ClientID:** bd24f42e-ad0b-4005-b834-23bb6800dc6c
**ClientSecret:** 6776b89e-5728-4643-8cd5-c93aefb5314b
**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.1"
contact:
name: "AndreasFischer1985"
email: "[email protected]"
url: "https://github.com/AndreasFischer1985/berufssprachkurssuche-api"
servers:
- url: "https://rest.arbeitsagentur.de/infosysbub/sprachfoerderung"
paths:
/pc/v1/bildungsangebot:
get:
summary: Berufssprachkurssuche
description: "Die Berufssprachkurssuche ermöglicht verfügbare Berufssprachkursangebote mit verschiedenen GET-Parametern zu filtern."
operationId: berufssprachkurssuche
tags:
- berufssprachkurse
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
parameters:
- in: query
name: systematiken
schema:
type: string
enum:
- 'MC'
- 'MB'
- 'A8'
- 'MQ'
description: Kursart - MC=Berufssprachkurse; MB=Integrationskurse; A8 = Bildungsangebote Migration; MQ = Anerkennung ausländischer Berufsabschlüsse.
example: "MC"
required: false
- in: query
name: suchworte
schema:
type: string
description: "Suchworte (z.B. Deutschsprachf%25C3%25B6rderung,Berufsbezogener%2520Englischkurs). Mehrere Komma-getrennte Angaben möglich."
example: "Deutschsprachf%25C3%25B6rderung"
required: false
- in: query
name: orte
schema:
type: string
description: "Ortsangabe nebst Postleitzahl und Koordinaten (longitude und latitude) jeweils durch Unterstriche getrennt (z.B. Feucht_90537_11.224918_49.376701,N%C3%BCrnberg;%20Mittelfranken_11.0753_49.4508). Mehrere Komma-getrennte Angaben möglich."
example: "Feucht_90537_11.224918_49.376701"
required: false
- in: query
name: page
schema:
type: integer
description: Seite (beginnend mit 0 für die erste Seite).
example: 1
required: false
- in: query
name: umkreis
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: sprachniveau
schema:
type: string
enum:
- MC%2001%201
- MC%2001%202
- MC%2001%203
- MC%2001%204
- MC%2001%205
- MC%2002
- MC%2003
description: "Sprachzielniveau - MC%2001%201=A2, MC%2001%202=B1, MC%2001%203=B2, MC%2001%204=C1, MC%2001%205=C2, MC%2002=Spezialberufskurs, MC%2003=Berufsanerkennung. Mehrere Komma-getrennte Angaben möglich."
example: "MC%2001%201"
required: false
- in: query
name: beginntermine
schema:
type: integer
enum:
- 1
- 2
- 3
- 4
- 5
- 6
example: 1
required: false
description: "Beginntermin - 0=regelmäßiger Start, 1=diesen Monat, 2=nächster Monat, 3=übernächster Monat, 4=überübernächster Monat, 5=spätere Termine, 6=frühere Termine. Mehrere Komma-getrennte Angaben möglich."
- in: query
name: unterrichtsformen
schema:
type: integer
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 0
description: "Lernform - 1=Vollzeit, 2=Teilzeit, 3=Wochenendveranstaltung, 4=Fernunterricht, 5=E-Learning, 6=Blockunterricht, 0=Auf Anfrage. Mehrere Komma-getrennte Angaben möglich."
example: 0
required: false
- in: query
name: anbieter
schema:
type: integer
description: Anbieter-ID - numerische ID (z.B. 16574). Mehrere Komma-getrennte Angaben möglich. Bei größeren Treffermengen ist für die Verwendung des Filters nach Anbietern eine Einschränkung auf Ort, Suchbegriff oder Umkreis erforderlich.
example: 16574
required: false
security:
- APIKeyHeaders: []
components:
securitySchemes:
APIKeyHeaders:
type: apiKey
in: header
name: X-API-Key
description: "X-API-Key ist die Client-ID bd24f42e-ad0b-4005-b834-23bb6800dc6c"
schemas:
Response:
type: object
properties:
_embedded:
type: object
properties:
termine:
type: array
items:
type: object
properties:
id:
type: integer
example: 134023869
unterrichtsform:
type: object
properties:
id:
type: integer
example: 1
bezeichnung:
type: string
example: "Vor-Ort-Vollzeit"
foerderung:
type: boolean
example: false
kostenWert:
type: string
kostenWaehrung:
type: string
example: EUR
beginn:
type: integer
example: 1649109600000
ende:
type: integer
example: 1665007200000
dauer:
type: object
properties:
id:
type: integer
example: 5
bezeichnung:
type: string
example: mehr als 3 Monate bis 6 Monate
kostenBemerkung:
type: string
teilnehmerMin:
type: integer
example: 3
teilnehmerMax:
type: integer
example: 6
aktualisierungsdatum:
type: string
example: '1647990000000'
bemerkung:
type: string
link:
type: string
example: https://maskzentrum.de/deutsch-als-fremdsprache/b2---pflege/
individuellerEinstieg:
type: boolean
example: false
anmeldeschluss:
type: string
example: '1649109600000'
unterrichtszeiten:
type: string
example: "<p>Montag - Freitag<br/>08:30 - 12:35 Uhr<br/>5 UE/Tag<br/>25 UE/Woche<br/>600 UE</p>"
bemerkungZeit:
type: string
example: '<p>Präsenzunterricht </p><p>Anmeldung: <br/>Bitte vereinbaren Sie telefonisch einen Termin.</p>'
eigeneAngebotsnummer:
type: string
pruefendeStelle:
type: string
angebot:
type: object
properties:
id:
type: integer
example: 8004554
titel:
type: string
example: "Berufsbezogene Deutschsprachförderung DeuFöV - B2 - nichtakademische Gesundheitsberufe (Gesundheits-, Kranken-, Altenpfleger)"
inhalt:
type: string
abschlussart:
type: string
abschlussbezeichnung:
type: string
example: '- B2 Pflege'
foerderung:
type: string
example: 'Jobcenter, Agentur für Arbeit, BAMF Die Kurse werden aus Mitteln des Bundeshaushalts finanziert. Eine Teilnahme ist kostenfrei. Ausnahme: Beschäftigte müssen einen Kostenbeitrag i.H.v. 50% des Kostenerstattungssatzes leisten.'
zugang:
type: string
anrechnung:
type: string
berechtigungen:
type: string
zusatzqualifikationen:
type: string
link:
type: string
zielgruppe:
type: string
bildungsanbieter:
type: object
properties:
id:
type: integer
example: 192753
name:
type: string
example: MASK Zentrum (AkadRe GmbH)
telefonVorwahl:
type: string
example: '0911'
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: 2676464
bezeichnung:
type: string
strasse:
type: string
hinweise:
type: string
dienstleistungen:
type: string
ortStrasse:
type: object
properties:
id:
type: integer
example: 38287
plz:
type: string
example: '90439'
name:
type: string
example: "Nürnberg, Mittelfranken"
land:
type: object
properties:
id:
type: integer
example: 2
name:
type: string
example: Bayern
laenderCode:
type: string
example: D
bundeslandCode:
type: string
example: BAY
code:
type: string
example: BAY
koordinaten:
type: object
properties:
lat:
type: number
example: 19.440563
lon:
type: number
example: 41.038883
logo:
type: string
bildungsart:
type: object
properties:
id:
type: integer
example: 110
bezeichnung:
type: string
example: Berufssprachkurse
systematiken:
type: array
items:
type: object
properties:
id:
type: integer
example: 130174
codeNr:
type: string
example: MC 03
kurzbezeichnung:
type: string
schulart:
type: object
properties:
id:
type: integer
example: 105
bezeichnung:
type: string
example: 'Einrichtung der beruflichen Weiterbildung'
behinderungen:
type: array
items:
type: object
zertifizierer:
type: array
items:
type: object
traeger:
type: string
suchworte:
type: array
items:
type: object
properties:
suchwort:
type: string
example: Deutschsprachförderung
veranstaltungsablaeufe:
type: array
items:
type: object
adresse:
type: object
properties:
id:
type: integer
example: 2676464
bezeichnung:
type: string
strasse:
type: string
hinweise:
type: string
dienstleistungen:
type: string
ortStrasse:
type: object
properties:
id:
type: integer
example: 38287
plz:
type: string
example: '90439'
name:
type: string
example: "Nürnberg, Mittelfranken"
land:
type: object
properties:
id:
type: integer
example: 2
name:
type: string
example: Bayern
laenderCode:
type: string
example: D
bundeslandCode:
type: string
example: BAY
code:
type: string
example: BAY
koordinaten:
type: object
properties:
lat:
type: number
example: 19.440563
lon:
type: number
example: 41.03888
azubiGeeignet:
type: boolean
example: false
ansprechpartner:
type: array
items:
type: object
abstaende:
type: array
items:
type: object
properties:
ort:
type: object
properties:
name:
type: string
example: Feucht
postleitzahl:
type: string
laengengrad:
type: number
example: 11.2147
breitengrad:
type: number
example: 11.2147
abstandInKm:
type: number
example: 2.975638573076752
_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
example: 20
totalElements:
type: integer
example: 3
totalPages:
type: integer
example: 1
number:
type: integer
example: 0
aggregations:
type: object
properties:
ANZAHL_AUSGEFILTERT:
type: object
properties:
COUNT:
type: integer
example: 15592
KURSART:
type: array
items:
type: object
SPRACHKURSE:
type: array
items:
type: object
properties:
id:
type: string
example: 'MC 03'
anzahl:
type: integer
example: 3
name:
type: string
MIGRATIONSKURSE:
type: array
items:
type: object
ANBIETER:
type: array
items:
type: object
properties:
id:
type: integer
example: 192753
anzahl:
type: integer
example: 3
name:
type: string
UNTERRICHTSFORMEN:
type: array
items:
type: object
properties:
id:
type: integer
example: 1
anzahl:
type: integer
example: 2
name:
type: string
BERUFSBEREICH:
type: array
items:
type: object
BEGINNTERMIN:
type: array
items:
type: object
properties:
id:
type: integer
example: 0
anzahl:
type: integer
example: 2
name:
type: string
REGIONEN:
type: array
items:
type: object
properties:
id:
type: string
example: 'BAY'
anzahl:
type: integer
example: 2
name:
type: string
ANZAHL_GESAMT:
type: object
properties:
COUNT:
type: integer
example: 3
externalDocs:
description: "Weiterführende Dokumentation"
url: "https://github.com/AndreasFischer1985/berufssprachkurssuche-api"