JobSearch.JoboenskeService (Version 2, [UDV] 2024-2)
- Jan Nyman
- Mads Krøll Didriksen
Siden opdateres automatisk til at afspejle koden.
Metoder
- 1 CreateJoboensker (POST /v2/Joboenske)
- 2 GetJoboensker (GET /v2/Joboenske)
- 3 GetJoboenske (GET /v2/Joboenske/{jobTargetIdentifier})
- 4 CreateJoboenske (POST /v2/Joboenske/CreateJoboenske)
- 5 Getjoboenskehistorik (GET /v2/Joboenske/historik)
- 6 DeleteJoboenske (DELETE /v2/Joboenske/{joboenskeIdentifier})
- 7 UpdateJoboenske (PUT /v2/Joboenske/{joboenskeIdentifier})
CreateJoboensker (POST /v2/Joboenske)
Metoden benyttes til at opdatere borgers kollektion af jobønsker/'Jeg søger job som'.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
A-kasse |
| X |
|
|
|
|
|
|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
x-civilRegistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr |
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
requestBody | JoboenskerDto |
| 1 |
|
- joboensker | JoboenskeDtoCollection |
| 1 | Liste af de enkelte jobønsker (stillingsbetegnelse og evt alias). |
- - JoboenskeDto | JoboenskeDto |
| 0 - * |
|
- - - conceptUriDa | string | MinLength: 1 | 1 | Unik ESCO STAR identifikation på stillingsbetegnelse. |
- - - aliasIdentifier | uuid |
| 0 - 1 | Unik ESCO STAR identifikation på alias. |
- - - harUddannelse | boolean |
| 1 | Om borgeren har uddannelse indenfor stillingsbetegnelsen |
- - - aarSidstBrugt | int32 |
| 0 - 1 | Årstal hvor stillingsbetegnelsen senest var aktiv |
- - - maanederMedErfaring | int32 |
| 0 - 1 | Erfaring i måneder indenfor stillingsbetegnelsen |
- - - jobTargetIdentifier | uuid |
| 1 | Unik identifier på jobønsket |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
4318 | Kaldet indeholder en eller flere ugyldige jobønsker | Kaldet indeholder en eller flere ugyldige jobønsker |
4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
4698 | En parameter er ulovligt negativ | En parameter er ulovligt negativ |
4710 | AarSidstBrugt er ikke et lovligt år | AarSidstBrugt er ikke et lovligt år |
8281 | ConceptUriDa findes ikke | ConceptUriDa findes ikke |
8282 | ConceptUriDa er udløbet | ConceptUriDa er udløbet |
9439 | En borger kan ikke registreres med samme ConceptUriDa mere end en gang | En borger kan ikke registreres med samme ConceptUriDa mere end en gang |
30035 | Person does not exist for given cpr number. | Person does not exist for given cpr number. |
GetJoboensker (GET /v2/Joboenske)
Metoden benyttes til at hente borgeres aktuelle, dvs. seneste sæt af registrerede jobønsker/'Jeg søger job som'
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
A-kasse |
| X | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | X |
|
|
|
|
JobCenter | X |
|
|
| X |
|
|
|
Kommune | X |
|
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
x-civilRegistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | JoboenskerDto |
| 1 |
|
- joboensker | JoboenskeDtoCollection |
| 1 | Liste af de enkelte jobønsker (stillingsbetegnelse og evt alias). |
- - JoboenskeDto | JoboenskeDto |
| 0 - * |
|
- - - conceptUriDa | string | MinLength: 1 | 1 | Unik ESCO STAR identifikation på stillingsbetegnelse. |
- - - aliasIdentifier | uuid |
| 0 - 1 | Unik ESCO STAR identifikation på alias. |
- - - harUddannelse | boolean |
| 1 | Om borgeren har uddannelse indenfor stillingsbetegnelsen |
- - - aarSidstBrugt | int32 |
| 0 - 1 | Årstal hvor stillingsbetegnelsen senest var aktiv |
- - - maanederMedErfaring | int32 |
| 0 - 1 | Erfaring i måneder indenfor stillingsbetegnelsen |
- - - jobTargetIdentifier | uuid |
| 1 | Unik identifier på jobønsket |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
30035 | Person does not exist for given cpr number. | Person does not exist for given cpr number. |
GetJoboenske (GET /v2/Joboenske/{jobTargetIdentifier})
Metoden benyttes til at hente borgeres aktuelle, dvs. seneste sæt af registrerede jobønsker/'Jeg søger job som'
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
A-kasse |
| X | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | X |
|
|
|
|
JobCenter | X |
|
|
| X |
|
|
|
Kommune | X |
|
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
x-civilRegistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr |
jobTargetIdentifier | uuid |
| 1 | Unik identifier på jobønsket |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | JoboenskerDto |
| 1 |
|
| JoboenskeDtoCollection |
| 1 | Liste af de enkelte jobønsker (stillingsbetegnelse og evt alias). |
| JoboenskeDto |
| 0 - * |
|
| string | MinLength: 1 | 1 | Unik ESCO STAR identifikation på stillingsbetegnelse. |
| uuid |
| 0 - 1 | Unik ESCO STAR identifikation på alias. |
| boolean |
| 1 | Om borgeren har uddannelse indenfor stillingsbetegnelsen |
| int32 |
| 0 - 1 | Årstal hvor stillingsbetegnelsen senest var aktiv |
| int32 |
| 0 - 1 | Erfaring i måneder indenfor stillingsbetegnelsen |
| uuid |
| 1 | Unik identifier på jobønsket |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
30035 | Person does not exist for given cpr number. | Person does not exist for given cpr number. |
30077 | JoboenskeIdentifier findes ikke. | JoboenskeIdentifier findes ikke. |
CreateJoboenske (POST /v2/Joboenske/CreateJoboenske)
Metoden benyttes til at opdatere et enkelt borgers jobønsker/'Jeg søger job som'.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
A-kasse |
| X |
|
|
|
|
|
|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
x-civilRegistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr |
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
requestBody | JoboenskeDtoBase |
| 1 |
|
- conceptUriDa | string | MinLength: 1 | 1 | Unik ESCO STAR identifikation på stillingsbetegnelse. |
- aliasIdentifier | uuid |
| 0 - 1 | Unik ESCO STAR identifikation på alias. |
- harUddannelse | boolean |
| 1 | Om borgeren har uddannelse indenfor stillingsbetegnelsen |
- aarSidstBrugt | int32 |
| 0 - 1 | Årstal hvor stillingsbetegnelsen senest var aktiv |
- maanederMedErfaring | int32 |
| 0 - 1 | Erfaring i måneder indenfor stillingsbetegnelsen |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | uuid |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
4318 | Kaldet indeholder en eller flere ugyldige jobønsker | Kaldet indeholder en eller flere ugyldige jobønsker |
4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
4698 | En parameter er ulovligt negativ | En parameter er ulovligt negativ |
4710 | AarSidstBrugt er ikke et lovligt år | AarSidstBrugt er ikke et lovligt år |
8281 | ConceptUriDa findes ikke | ConceptUriDa findes ikke |
8282 | ConceptUriDa er udløbet | ConceptUriDa er udløbet |
9439 | En borger kan ikke registreres med samme ConceptUriDa mere end en gang | En borger kan ikke registreres med samme ConceptUriDa mere end en gang |
30035 | Person does not exist for given cpr number. | Person does not exist for given cpr number. |
Getjoboenskehistorik (GET /v2/Joboenske/historik)
Metoden benyttes til at hente borgeres aktuelle og historiske sæt af registrerede jobønsker/'Jeg søger job som'
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
A-kasse |
| X | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | X |
|
|
|
|
JobCenter | X |
|
|
| X |
|
|
|
Kommune | X |
|
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
x-civilRegistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | JoboenskehistorikResponseDto |
| 1 |
|
- joboenskehistorik | JoboenskehistorikDtoCollection |
| 1 | Liste af borgers historiske og aktuelle jobønsker |
- - JoboenskehistorikDto | JoboenskehistorikDto |
| 0 - * |
|
- - - registrerendeMyndighed | RegistrerendeMyndighedDto |
| 1 | Organisation der har oprettet jobønskerne |
- - - - organisationType |
| 1 |
| |
- - - - organisationskode | string | Pattern: [-][1]|[0-9]{1,8} | 0 - 1 | Organisationskode. Hvis Organisationstype er STAR er det borger der via Jobnet har oprettet. |
- - - oprettetTidspunkt | date-time |
| 1 | Oprettelsesdato for jobønskerne |
- - - joboensker | JoboenskeDtoBaseCollection |
| 1 | Liste af de enkelte jobønsker (stillingsbetegnelse og evt alias) |
- - - - JoboenskeDtoBase | JoboenskeDtoBase |
| 0 - * |
|
- - - - - conceptUriDa | string | MinLength: 1 | 1 | Unik ESCO STAR identifikation på stillingsbetegnelse. |
- - - - - aliasIdentifier | uuid |
| 0 - 1 | Unik ESCO STAR identifikation på alias. |
- - - - - harUddannelse | boolean |
| 1 | Om borgeren har uddannelse indenfor stillingsbetegnelsen |
- - - - - aarSidstBrugt | int32 |
| 0 - 1 | Årstal hvor stillingsbetegnelsen senest var aktiv |
- - - - - maanederMedErfaring | int32 |
| 0 - 1 | Erfaring i måneder indenfor stillingsbetegnelsen |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
30035 | Person does not exist for given cpr number. | Person does not exist for given cpr number. |
DeleteJoboenske (DELETE /v2/Joboenske/{joboenskeIdentifier})
Metoden benyttes til at slette et enkelt af jobønsker/'Jeg søger job som'.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
A-kasse |
| X |
|
|
|
|
|
|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
x-civilRegistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr |
joboenskeIdentifier [Path] | uuid |
| 1 |
|
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
30076 | Tilmeldte må ikke slette før der er mindst én aktiv stillingsbetegnelse eller alias. | Tilmeldte må ikke slette før der er mindst én aktiv stillingsbetegnelse eller alias. |
30077 | JoboenskeIdentifier findes ikke. | JoboenskeIdentifier findes ikke. |
4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
30035 | Person does not exist for given cpr number. | Person does not exist for given cpr number. |
UpdateJoboenske (PUT /v2/Joboenske/{joboenskeIdentifier})
Metoden benyttes til at editere et enkelt af jobønsker/'Jeg søger job som'.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
A-kasse |
| X |
|
|
|
|
|
|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
x-civilRegistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr |
joboenskeIdentifier [Path] | uuid |
| 1 |
|
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
requestBody | JoboenskeUpdateDto |
| 1 |
|
- harUddannelse | boolean |
| 1 | Om borgeren har uddannelse indenfor stillingsbetegnelsen |
- aarSidstBrugt | int32 |
| 0 - 1 | Årstal hvor stillingsbetegnelsen senest var aktiv |
- maanederMedErfaring | int32 |
| 0 - 1 | Erfaring i måneder indenfor stillingsbetegnelsen |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
4710 | AarSidstBrugt er ikke et lovligt år | AarSidstBrugt er ikke et lovligt år |
4698 | En parameter er ulovligt negativ | En parameter er ulovligt negativ |
30077 | JoboenskeIdentifier findes ikke. | JoboenskeIdentifier findes ikke. |
4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
30035 | Person does not exist for given cpr number. | Person does not exist for given cpr number. |