forked from AndreasFischer1985/studiensuche-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
420 lines (398 loc) · 13.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
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
openapi: "3.0.0"
info:
title: "Arbeitsagentur Studiensuche API"
description: |
Eine der größten Datenbanken für Studienangebote in Deutschland durchsuchen.
Die Authentifizierung funktioniert per OAuth 2 Client Credentials mit JWTs. Folgende Client-Credentials können dafür verwendet werden:
**ClientID:** 5aee2cfe-1709-48a9-951d-eb48f8f73a74
**ClientSecret:** 3309a57a-9214-40db-9abe-28b1bb30c08c
**Achtung**: der generierte Token muss bei folgenden GET-requests an https://rest.arbeitsagentur.de/infosysbub/studisu/pc/v1/studienangebote im header als 'OAuthAccessToken' inkludiert werden.
version: "1.0.0"
contact:
name: "AndreasFischer1985"
email: "andreasfischer1985@web.de"
url: "https://github.com/AndreasFischer1985/studiensuche-api"
servers:
- url: "https://rest.arbeitsagentur.de/infosysbub/studisu"
paths:
/pc/v1/studienangebote:
get:
summary: Studiensuche
description: "Die Studiensuche ermöglicht, verfügbare Studienangebote mit verschiedenen GET-Parametern zu filtern. In der Regel ist dabei die Angabe mindestens eines Suchwortes (sw), Studienfeldes (sfe) oder eines Studienfachs (sfa) erforderlich. Eine Ausnahme von dieser Regel besteht beispielsweise darin, den Filter zum Studienmodell (smo) auf 5 (für Duales Studium) zu setzen."
operationId: studiensuche
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
parameters:
- in: query
name: sw
schema:
type: string
description: Suchwort
example: "Informatikberufe"
required: false
- in: query
name: sfa
schema:
type: integer
description: Studienfach-ID
example: 93683
required: false
- in: query
name: sfe
schema:
type: string
description: dkzIds einer Studienfeld(gruppe), idR. zwei Semikolon-getrennte Werte je Studienfeld(gruppe).
example: "94175;94350"
required: false
- in: query
name: orte
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
example: 1
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: re
schema:
type: string
enum:
- BW
- BY
- BE
- BB
- HB
- HH
- HE
- MV
- NI
- NW
- RP
- SL
- SN
- ST
- SH
- TH
- iA
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, iA=Österreich. Mehrere Semikolon-getrennte Angaben möglich.
example: "BW"
required: false
- in: query
name: sfo
schema:
type: integer
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
example: 1
description: Studienform - 0=Auf Anfrage, 1=Vollzeitstudium, 2=Teilzeitstudium, 3=Wochenendveranstaltung, 4=Fernstudium, 5=Selbststudium, 6=Blockstudium. Mehrere Semikolon-getrennte Angaben möglich.
required: false
- in: query
name: st
schema:
type: integer
enum:
- 0
- 1
example: 1
required: false
description: Studientyp - 0=Studiengang grundständig, 1=Studiengang weiterführend.
- in: query
name: smo
schema:
type: integer
enum:
- 1
- 2
- 3
- 4
- 5
description: Studiengangmodell - 1=ausbildungsintegrierend, 2=berufsintegrierend, 3=berufsbegleitend, 4=praxisintegrierend, 5=Duales Studium allgemein. Mehrere Semikolon-getrennte Angaben möglich.
example: 5
required: false
- in: query
name: abg
schema:
type: integer
enum:
- 0
- 1
- 2
- 3
- 4
- 10
- 12
description: Studiengangsabschlussgrad - 0=ohne Angabe, 1=Abschlussprüfung, 2=Bachelor, 3=Diplom, 4=Diplom(FH), 10=Master, 12=Staatsexamen
example: 0
required: false
- in: query
name: hsa
schema:
type: integer
enum:
- 101
- 106
- 107
- 108
- 113
- 114
description: Hochschulart - 101=Berufsakademie/Duale Hochschule, 106=FH/FAW, 107=Kunst- und Musikhochschule, 108=Universität, 111=Verwaltungshochschule, 113=Private Hochschule. 114=Hochschule eigenen Typs. Mehrere Semikolon-getrennte Angaben möglich.
example: 108
required: false
- in: query
name: san
schema:
type: integer
description: Studienanbieter-ID
example: 26218
required: false
- in: query
name: ffst
schema:
type: integer
enum:
- 1
- 2
description: Eignungstest - 1=Studiencheck, 2=OSA. Mehrere Semikolon-getrennte Angaben möglich.
example: 1
required: false
security:
- APIKeyHeaders: []
components:
securitySchemes:
APIKeyHeaders:
type: apiKey
in: header
name: X-API-Key
description: "X-API-Key ist die Client-ID 5aee2cfe-1709-48a9-951d-eb48f8f73a74"
schemas:
Response:
type: object
properties:
items:
type: array
items:
type: object
properties:
studienangebot:
type: object
properties:
studienanbieter:
type: object
properties:
banId:
type: integer
example: 196684
name:
type: string
example: Duale Hochschule Gera Eisenach
logo:
type: object
properties:
id:
type: integer
example: 7110
url:
type: string
example: http://prod-server.infosysbub-kursnet-rest-dmz.svc.cluster.local:8080/ct/v1/bildungsanbieter/196684/logos/7110
externalURL:
type: string
example: https://rest.arbeitsagentur.de/infosysbub/kursnet-rest/ct/v1/bildungsanbieter/196684/logos/7110
studiBezeichnung:
type: string
example: Wirtschaftsingenieurwesen/Digitale Industrie Bachelor
studiInhalt:
type: string
example: <p>Inhalte bitte bei der Hochschule erfragen</p>
studiBeginn:
type: string
example: Auf Anfrage
studienort:
type: object
properties:
strasse:
type: string
example: Am Testweg 2
ort:
type: string
example: Feucht, Bayern
postleitzahl:
type: string
example: '90537'
bundesland:
type: string
example: Bayern
staat:
type: string
example: Deutschland
postfach:
type: string
postfachOrt:
type: string
postfachPostleitzahl:
type: string
postfachBundesland:
type: string
postfachStaat:
type: string
location:
type: object
properties:
lat:
type: number
example: 40.9906
lon:
type: number
example: 7.3825
studienfaecher:
type: array
items:
type: string
example: Wirtschaftsingenieurwesen (grundständig)
fitFuerStudiumFacettenOptions:
type: array
items:
type: string
abschlussgrad:
type: object
properties:
id:
type: integer
example: 2
label:
type: string
example: Bachelor/Bakkalaureus
region:
type: object
properties:
id:
type: integer
example: 15
Key:
type: string
example: TH
label:
type: string
example: Thüringen
studienmodelle:
type: array
items:
type: object
properties:
id:
type: integer
example: 4
label:
type: string
example: praxis­integrierend
id:
type: integer
example: 114959298
externalLinks:
type: array
items:
type: string
hochschulart:
type: object
properties:
id:
type: integer
example: 114
label:
type: string
example: Hochschule eigenen Typs
studienform:
type: object
properties:
id:
type: integer
example: 1
label:
type: string
example: Vollzeitstudium
studientyp:
type: object
properties:
id:
type: integer
example: 0
label:
type: string
example: Studiengang grundständig
abstaende:
type: array
items:
type: string
example: '[]'
maxErgebnisse:
type: integer
example: 3369
filteredOutErgebnisse:
type: integer
example: 14625
facetten:
type: array
items:
type: object
properties:
id:
type: string
example: st
typ:
type: string
example: MULTI
auswahl:
type: array
items:
type: object
properties:
trefferAnzahl:
type: integer
example: 2163
preset:
type: boolean
example: false
id:
type: integer
example: 0
label:
type: string
example: Studiengang grundständig
studienangeboteIds:
type: array
items:
type: string
example: "73435153"
externalDocs:
description: "Weiterführende Dokumentation"
url: "https://github.com/AndreasFischer1985/studiensuche-api"