forked from AndreasFischer1985/berufenet-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
106 lines (92 loc) · 3.8 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
openapi: "3.0.0"
info:
title: "Arbeitsagentur Berufenet API"
description: |
Die Bundesagentur für Arbeit verfügt mit BERUFENET über das umfangreichste Lexikon der Berufe in Deutschland.
Die Authentifizierung funktioniert über die *clientId* von Berufenet, die einem GET-request an https://web.arbeitsagentur.de/berufenet/ergebnisseite/berufe-a-z entnommen werden kann:
*clientId*: infosysbub-berufenet
Bei folgenden GET-requests ist die clientId als Header-Parameter 'X-API-Key' zu übergeben.
version: "1.0.1"
contact:
name: "AndreasFischer1985"
email: "andreasfischer1985@web.de"
url: "https://github.com/AndreasFischer1985/berufenet-api"
servers:
- url: "https://rest.arbeitsagentur.de/infosysbub/bnet/pc/v1"
paths:
/berufe:
get:
summary: BERUFENET-Berufeliste
description: "Berufenet ermöglicht die Abfrage von Berufs-ID und Kurzbezeichnung zu einer spezifizierten Teilmenge aller auf BERUFENET gelisteten Berufe. Die Spezifikation GET-Parameter, wobei maximal 20 Einträge pro Seite ausgegeben werden (siehe Parameter page)."
operationId: berufeliste
responses:
'200':
description: OK
parameters:
- in: query
name: page
schema:
type: integer
description: Seite (beginnend mit 0). Es werden maximal 20 Einträge pro Seite ausgegeben.
example: 0
required: false
- in: query
name: suchwoerter
schema:
type: string
description: |
Suchwörter: Eine Zeichenkette, die in den Informationen zu den angefragten Berufen auftauchen sollten. Ein Sternchen-Symbol ermöglicht die Abfrage aller Berufe.
example: "*"
required: false
- in: query
name: buchstabe
schema:
type: string
description: |
Buchstabe: Anfangsbuchstabe der angefragten Berufe. Hinweis: Neben Berufen, die mit Buchstaben von A-Z beginnen gibt es zwei Einträge, die auf diese Weise nicht angefragt werden können da sie mit einer Zahl beginnen.
example: a
required: false
- in: query
name: berufecluster
schema:
type: string
description: |
Berufecluster: "TC 0201" = reglementierte Berufe; "TC 101" = Mathematik; "TC 0102" = Informatik; "TC 0103" = Naturwissenschaft; "TC 104" = Technik. Mehrere Komma-separierte Einträge möglich, z.B. "TC 0101,TC 0102,TC 0103,TC 0104" für alle MINT-Berufe.
example: "TC 0201"
required: false
- in: query
name: bg
schema:
type: string
description: |
Berufsgruppe: 100, 102, 105 (= Ausbildungsberufe); 200, 201, 203, 204 (= Weiterbildungsberufe); 300, 301, 302 (= Studienfächer); 400, 401, 402 (=Hochschulberufe); 500, 503 (=Beamtenlaufbahn), 700 (=Berufliche Einsatzmöglichkeiten). Mehrere Komma-separierte Einträge möglich.
example: "100, 102, 105"
required: false
/berufe{Berufs-ID}:
get:
summary: BERUFENET-Berufsinformationen
description: "Detailinformationen zu einem spezifischen Ausbildungsangebot."
operationId: ausbildungsdetails
responses:
'200':
description: OK
parameters:
- in: path
name: Berufs-ID
required: true
schema:
type: integer
description: |
Berufenet ermöglicht die Abfrage von umfangreichen Informationen zu einer Berufs-ID (z.B: 129987).
security:
- ApiKeyAuth:
- "read"
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
externalDocs:
description: "Weiterführende Dokumentation"
url: "https://github.com/AndreasFischer1985/berufenet-api"