-
Notifications
You must be signed in to change notification settings - Fork 18
/
openapi.yaml
648 lines (635 loc) · 19.3 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
openapi: "3.0.0"
info:
description: "Die größte Stellendatenbank Deutschlands durchsuchen, Details zu Stellenanzeigen und Informationen über Arbeitgeber abrufen. <br><br>Die Authentifizierung funktioniert über die clientId:<br><br>clientId: jobboerse-jobsuche<br><br>Bei folgenden GET-requests ist die clientId als Header-Parameter 'X-API-Key' zu übergeben."
version: "2.0.2"
title: "Arbeitsagentur Jobsuche API"
servers:
- url: "https://rest.arbeitsagentur.de/jobboerse/jobsuche-service"
paths:
/pc/v4/jobs:
get:
summary: Jobsuche
description: "Die Jobsuche ermöglicht verfügbare Jobangebote mit verschiedenen get Parametern zu filtern."
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/JobSearchResponse'
parameters:
- in: query
name: was
schema:
type: string
description: Freitext suche Jobtitel
example: Referatsleiter
required: false
- in: query
name: wo
schema:
type: string
description: Freitext suche Beschäftigungsort
example: Berlin
required: false
- in: query
name: berufsfeld
schema:
type: string
description: Freitext suche Berufsfeld
example: Informatik
required: false
- in: query
name: page
schema:
type: integer
description: Ergebnissseite
example: 1
required: false
- in: query
name: size
schema:
type: integer
example: 50
description: Anzahl von Ergebnissen
required: false
- in: query
name: arbeitgeber
schema:
type: string
example: Deutsche%20Bahn%20AG
description: Arbeitgeber der Stelle
required: false
- in: query
name: veroeffentlichtseit
schema:
type: integer
example: 30
description: Anzahl der Tage, seit der Job veröffentlicht wurde. Kann zwischen 0 und 100 Tagen liegen.
required: false
- in: query
name: zeitarbeit
schema:
type: boolean
example: true
description: Gibt an, ob Jobs von Zeitarbeitsfirmen in die Suchergebnisse einbezogen werden sollen (default true).
required: false
- in: query
name: angebotsart
schema:
type: integer
enum:
- 1
- 2
- 4
- 34
example: 1
description: 1=ARBEIT; 2=SELBSTAENDIGKEIT, 4=AUSBILDUNG/Duales Studium, 34=Praktikum/Trainee
required: false
- in: query
name: befristung
schema:
type: integer
enum:
- 1
- 2
example: 1
required: false
description: Semikolon-separierte mehrere Werte möglich (z.B. befristung=1;2) 1 = befristet; 2 = unbefristet
- in: query
name: arbeitszeit
schema:
type: string
enum:
- vz
- tz
- snw
- ho
- mj
description: Semikolon-separierte mehrere Werte möglich (z.B. arbeitszeit=vz;tz) vz=VOLLZEIT, tz=TEILZEIT, snw=SCHICHT_NACHTARBEIT_WOCHENENDE, ho=HEIM_TELEARBEIT, mj=MINIJOB
example: vz
required: false
- in: query
name: behinderung
schema:
type: boolean
example: true
required: false
- in: query
name: corona
schema:
type: boolean
example: true
description: Wenn true, werden nur Jobs die im Kontext von Corona angeboten werden angezeigt.
required: false
- in: query
name: umkreis
schema:
type: integer
description: Umkreis in Kilometern von Wo-Parameter. (z.B. 25 oder 200)
example: 25
required: false
/pc/v4/app/jobs:
get:
summary: Jobsuche via App
description: "Die Jobsuche via App ermöglicht verfügbare Jobangebote mit verschiedenen get Parametern zu filtern."
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/JobSearchResponse'
parameters:
- in: query
name: was
schema:
type: string
description: Freitext suche Jobtitel
example: Referatsleiter
required: false
- in: query
name: wo
schema:
type: string
description: Freitext suche Beschäftigungsort
example: Berlin
required: false
- in: query
name: berufsfeld
schema:
type: string
description: Freitext suche Berufsfeld
example: Informatik
required: false
- in: query
name: page
schema:
type: integer
description: Ergebnissseite
example: 1
required: false
- in: query
name: size
schema:
type: integer
example: 50
description: Anzahl von Ergebnissen
required: false
- in: query
name: arbeitgeber
schema:
type: string
example: Deutsche%20Bahn%20AG
description: Arbeitgeber der Stelle
required: false
- in: query
name: veroeffentlichtseit
schema:
type: integer
example: 30
description: Anzahl der Tage, seit der Job veröffentlicht wurde. Kann zwischen 0 und 100 Tagen liegen.
required: false
- in: query
name: zeitarbeit
schema:
type: boolean
example: true
description: Gibt an, ob Jobs von Zeitarbeitsfirmen in die Suchergebnisse einbezogen werden sollen (default true).
required: false
- in: query
name: angebotsart
schema:
type: integer
enum:
- 1
- 2
- 4
- 34
example: 1
description: 1=ARBEIT; 2=SELBSTAENDIGKEIT, 4=AUSBILDUNG/Duales Studium, 34=Praktikum/Trainee
required: false
- in: query
name: befristung
schema:
type: integer
enum:
- 1
- 2
example: 1
required: false
description: Semikolon-separierte mehrere Werte möglich (z.B. befristung=1;2) 1 = befristet; 2 = unbefristet
- in: query
name: arbeitszeit
schema:
type: string
enum:
- vz
- tz
- snw
- ho
- mj
description: Semikolon-separierte mehrere Werte möglich (z.B. arbeitszeit=vz;tz) vz=VOLLZEIT, tz=TEILZEIT, snw=SCHICHT_NACHTARBEIT_WOCHENENDE, ho=HEIM_TELEARBEIT, mj=MINIJOB
example: vz
required: false
- in: query
name: behinderung
schema:
type: boolean
example: true
required: false
- in: query
name: corona
schema:
type: boolean
example: true
description: Wenn true, werden nur Jobs die im Kontext von Corona angeboten werden angezeigt.
required: false
- in: query
name: umkreis
schema:
type: integer
description: Umkreis in Kilometern von Wo-Parameter. (z.B. 25 oder 200)
example: 25
required: false
/ed/v1/arbeitgeberlogo/{hashID}:
get:
summary: Unternehmen Logo
description: "Abrufen des Logos eines Unternehmens"
parameters:
- name: hashID
in: path
required: true
schema:
type: string
example: VK2qoXBe0s-UAdH_qxLDRrZrY5iY8a1PJt3MjJCXsdo=
responses:
'200':
description: OK
content:
image/png:
schema:
type: string
format: binary
security:
- APIKeyHeaders: []
components:
securitySchemes:
APIKeyHeaders:
type: apiKey
in: header
name: X-API-Key
description: "X-API-Key ist die clientId jobboerse-jobsuche"
schemas:
JobSearchResponse:
type: "object"
properties:
stellenangebote:
type: array
items:
type: object
properties:
hashId:
type: string
example: WBTAiM10b25rJgZqiLhVIHzAF9e0rnV_DXdsRZtlb54=
beruf:
type: string
example: Elektroinstallateur/in
refnr:
type: string
example: 10000-1184867112-S
arbeitgeber:
type: string
example: Gröger & Oltermann Sicherheits- und Elektrotechnik GmbH
aktuelleVeroeffentlichungsdatum:
type: string
format: date
example: 2021-07-25
eintrittsdatum:
type: string
format: date
example: 2021-07-26
arbeitsort:
type: object
properties:
plz:
type: integer
example: 90537
ort:
type: string
example: Berlin
strasse:
type: string
example: Altdorfer Straße
region:
type: string
example: Berlin
land:
type: string
example: Deutschland
koordinaten:
type: object
properties:
lat:
type: number
example: 52.4926832
lon:
type: number
example: 13.4025753
modifikationsTimestamp:
type: string
maxErgebnisse:
type: string
page:
type: string
size:
type: string
facetten:
type: array
items:
type: object
properties:
befristung:
type: object
properties:
counts:
type: object
maxCount:
type: integer
behinderung:
type: object
properties:
counts:
type: object
maxCount:
type: integer
pav:
type: object
properties:
counts:
type: object
maxCount:
type: integer
berufsfeld:
type: object
properties:
counts:
type: object
maxCount:
type: integer
arbeitsort:
type: object
properties:
counts:
type: object
maxCount:
type: integer
ausbildungsart:
type: object
properties:
counts:
type: object
maxCount:
type: integer
veroeffentlichtseit:
type: object
properties:
counts:
type: object
maxCount:
type: integer
schulbildung:
type: object
properties:
counts:
type: object
maxCount:
type: integer
arbeitsort_plz:
type: object
properties:
counts:
type: object
maxCount:
type: integer
arbeitgeber:
type: object
properties:
counts:
type: object
maxCount:
type: integer
beruf:
type: object
properties:
counts:
type: object
maxCount:
type: integer
branche:
type: object
properties:
counts:
type: object
maxCount:
type: integer
arbeitszeit:
type: object
properties:
counts:
type: object
maxCount:
type: integer
eintrittsdatum:
type: object
properties:
counts:
type: object
maxCount:
type: integer
zeitarbeit:
type: object
properties:
counts:
type: object
maxCount:
type: integer
corona:
type: object
properties:
counts:
type: object
maxCount:
type: integer
JobDetails:
type: object
properties:
aktuelleVeroeffentlichungsdatum:
type: string
format: date
example: 2021-07-25
angebotsart:
type: string
example: ARBEIT
arbeitgeber:
type: string
example: Kerstin Nickel Frisör
branchengruppe:
type: string
example: IT, Computer, Telekommunikation
branche:
type: string
example: Sonstige Softwareentwicklung
arbeitgeberHashId:
type: string
example: dj32HpGiU3tdrYi6ohcMOtUhtBLPvwGIRiRlcvDsebg=
arbeitsorte:
type: array
items:
type: object
properties:
land:
type: string
example: Deutschland
region:
type: string
example: Berlin
plz:
type: string
example: "13597"
ort:
type: string
example: Berlin
strasse:
type: string
example: Jüdenstr. 31
koordinaten:
type: object
properties:
lat:
type: number
example: 52.5383857
lon:
type: number
example: 13.2029692
arbeitszeitmodelle:
type: array
items:
type: string
example: TEILZEIT
befristung:
type: string
example: UNBEFRISTET
uebernahme:
type: boolean
example: false
betriebsgroesse:
type: string
example: '2'
eintrittsdatum:
type: string
format: date
example: 2021-07-25
ersteVeroeffentlichungsdatum:
type: string
format: date
example: 2021-05-23
allianzpartner:
type: string
example: arbeitsagentur.de
allianzpartnerUrl:
type: string
example: http://www.arbeitsagentur.de
titel:
type: string
example: Wissenschaftlicher Mitarbeiter (m/w/d)
hashId:
type: string
example: VK2qoXBe0s-UAdH_qxLDRrZrY5iY8a1PJt3MjJCXsdo=
beruf:
type: string
example: Wissenschaftliche/r Mitarbeiter/in (Hochschule)
modifikationsTimestamp:
type: string
example: 2021-07-25T13:12:33.913
stellenbeschreibung:
type: string
refnr:
type: string
example: 10000-1183999289-S
fuerFluechtlingeGeeignet:
type: boolean
example: false
nurFuerSchwerbehinderte:
type: boolean
example: false
anzahlOffeneStellen:
type: integer
format: int32
example: 1
arbeitgeberAdresse:
type: object
properties:
land:
type: string
example: Deutschland
region:
type: string
example: Berlin
plz:
type: string
example: "13597"
ort:
type: string
example: Berlin
strasse:
type: string
example: Jüdenstr. 31
strasseHausnummer:
type: string
example: Jüdenstr. 31
fertigkeiten:
type: array
items:
type: object
properties:
hierarchieName:
type: string
example: Soziales, Erziehung, Gesundheit, Sport
auspraegungen:
type: object
mobilitaet:
type: object
properties:
reisebereitschaft:
type: string
example: '1'
fuehrungskompetenzen:
type: object
properties:
hatVollmacht:
type: boolean
example: false
hatBudgetverantwortung:
type: boolean
example: false
verguetung:
type: string
example: Entgeltgruppe 13 TV-L
arbeitgeberdarstellungUrl:
type: string
example: http://www.friseur-nickel.de
arbeitgeberdarstellung:
type: string
hauptDkz:
type: string
example: "9907"
istBetreut:
type: boolean
istGoogleJobsRelevant:
type: boolean
anzeigeAnonym:
type: boolean
externalDocs:
description: "Weiterführende Dokumentation"
url: "https://github.com/bundesAPI/jobsuche-api"