You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 2
Next »
Siden opdateres automatisk til at afspejle koden.
Metoder
CreateTilmelding (POST /v1/Tilmelding)
Tilmelding af ledige for Jobcenter og A-kasse hvis borger i forvejen har jobønsker.
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 |
|---|
| STAR | X | | | | | | | |
Scope
visiteringogstatus.write
| 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 | CreateTilmeldingRequestDto | | 1 | |
| - tilmeldingIdentifier | uuid | | 0 - 1 | Id som medsendes i de tilfælde hvor ekstern aftager har et lokalt id ved oprettelsen |
| - klientkategori | TilmeldekategoriTypeCodeList | | 1 | |
| - tilmeldingsdato | date-time | | 1 | Tilmeldedatoen hvor det angivne tilmeldeforhold starter. Dette er datoen, hvor den ledige har henvendt sig enten gennem Jobnet eller Jobcentret. |
| - ledighedsgrad | LedighedsgradTypeCodeList | | 1 | |
| - haendelsesdato | date-time | | 0 - 1 | Forretningsmæssig hændelsesdato for tilmeldingen hvis den ikke er registreret på hændelsesdatoen |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| response | CreateTilmeldingResponseDto | | 1 | |
| - tilmeldinger | uuid | | 1 | |
| - borgerkvitteringstekst | string | MaxLength: 3000 | 0 - 1 | |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 1001 | Ugyldigt cpr-nummer | Ugyldigt cpr-nummer |
| 1010 | Unknown cpr | Unknown cpr |
| 1014 | The submitted message is not valid | The submitted message is not valid |
| 4404 | Person med det angivne CPR-nummer findes ikke | Person med det angivne CPR-nummer findes ikke |
| 4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
| 4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
| 4977 | Det angivne id findes allerede | Det angivne id findes allerede |
| 9299 | Klientkategorien kan ikke anvendes af a-kasser | Klientkategorien kan ikke anvendes af a-kasser |
| 9300 | Ledighedsgraden kan ikke anvendes af a-kasser | Ledighedsgraden kan ikke anvendes af a-kasser |
| 4749 | Tilmeldingsdato skal være dags dato | Tilmeldingsdato skal være dags dato |
| 4339 | Ledighedsgraden 'Ikke ledig' kan kun anvendes med klientkategorien 'Tilmeldt uden ydelse' | Ledighedsgraden 'Ikke ledig' kan kun anvendes med klientkategorien 'Tilmeldt uden ydelse' |
| 6014 | Tilmelding er ikke tilladt pga. ugyldig kombination af klientkategori og ledighedsgrad | Tilmelding er ikke tilladt pga. ugyldig kombination af klientkategori og ledighedsgrad |
| 4314 | Ugyldig ledighedsgrad | Ugyldig ledighedsgrad |
| 4417 | Borger skal være medlem af en a-kasse for at modtage dagpenge | Borger skal være medlem af en a-kasse for at modtage dagpenge |
| 4641 | Borgers personkategori tillader ikke tilmelding | Borgers personkategori tillader ikke tilmelding |
| 4720 | En udrejst borger eller borger uden fast adresse kan ikke tilmeldes via Jobnet | En udrejst borger eller borger uden fast adresse kan ikke tilmeldes via Jobnet |
| 4750 | Borger har fravær der ikke tillader tilmelding | Borger har fravær der ikke tillader tilmelding |
| 100045 | Ledighedsgraden kan ikke anvendes af jobcentre | Ledighedsgraden kan ikke anvendes af jobcentre |
GetTilmeldinger (GET /v1/Tilmelding)
Metode til at hente alle borgers tilmeldinger
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
visiteringogstatus.read
| 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 | GetTilmeldingResponseDto | | 1 | |
| - tilmeldinger | TilmeldingDtoCollection | | 1 | Samlende element med alle borgers tilmeldinger |
| - - TilmeldingDto | TilmeldingDto | | 0 - * | |
| - - - tilmeldingIdentifier | uuid | | 1 | Guid for tilmeldingen |
| - - - klientkategori | TilmeldekategoriTypeCodeList | | 1 | |
| - - - tilmeldingsdato | date-time | | 1 | Tilmeldedatoen hvor det angivne tilmeldeforhold starter. Dette er datoen, hvor den ledige har henvendt sig enten gennem Jobnet eller Jobcentret. |
| - - - ledighedsgrad | LedighedsgradTypeCodeList | | 1 | |
| - - - afmelding | AfmeldingDto | | 0 - 1 | |
| - - - - afmeldedato | date-time | | 1 | Afmeldingsdato. |
| - - - - afmeldingsaarsag | AfmeldingsaarsagTypeCodeList | | 1 | |
| - - - haendelsesdato | date-time | | 0 - 1 | Forretningsmæssig hændelsesdato for tilmeldingen hvis den ikke er registreret på hændelsesdatoen |
| - - - jobnetFlag | boolean | | 0 - 1 | Status på om vedkommende har tilmeldt sig via Jobnet |
| - - - berigtigelseskommentar | string | Length: 1-1500 | 0 - 1 | Berigtigelseskommentar som kan sættes ved især ændring af hændelsesdato og fremtidig afmelding |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 1001 | Ugyldigt cpr-nummer | Ugyldigt cpr-nummer |
| 1014 | The submitted message is not valid | The submitted message is not valid |
| 4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
| 4404 | Person med det angivne CPR-nummer findes ikke | Person med det angivne CPR-nummer findes ikke |
UpdateTilmelding (PUT /v1/Tilmelding/{tilmeldingIdentifier})
Metode til at opdatere en tilmelding herunder sætte afmeldedato på en tilmelding og dermed afmelde en borger.
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
visiteringogstatus.write
| 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 |
| tilmeldingIdentifier [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 | UpdateTilmeldingRequestDto | | 1 | |
| - ledighedsgrad | LedighedsgradTypeCodeList | | 0 - 1 | |
| - afmelding | AfmeldingDto | | 0 - 1 | |
| - - afmeldedato | date-time | | 1 | Afmeldingsdato. |
| - - afmeldingsaarsag | AfmeldingsaarsagTypeCodeList | | 1 | |
| - haendelsesdato | date-time | | 0 - 1 | Forretningsmæssig hændelsesdato for tilmeldingen hvis den ikke er registreret på hændelsesdatoen |
| - berigtigelseskommentar | string | Length: 1-1500 | 0 - 1 | Berigtigelseskommentar som kan sættes ved især ændring af hændelsesdato og fremtidig afmelding |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| response | CancelTilmeldingResponseDto | | 1 | |
| - borgerkvitteringstekst | string | | 0 - 1 | |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 1001 | Ugyldigt cpr-nummer | Ugyldigt cpr-nummer |
| 1010 | Unknown cpr | Unknown cpr |
| 1014 | The submitted message is not valid | The submitted message is not valid |
| 4404 | Person med det angivne CPR-nummer findes ikke | Person med det angivne CPR-nummer findes ikke |
| 4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
| 4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
| 4589 | Id ikke fundet | Id ikke fundet |
| 100030 | Når afmeldedato er i fortiden må kun hændelsesdato og berigtigelseskommentar opdateres | Når afmeldedato er i fortiden må kun hændelsesdato og berigtigelseskommentar opdateres |
| 6052 | Kodelisteværdien er kun til intern brug | Kodelisteværdien er kun til intern brug |
| 9298 | Afmeldingsårsagen kan ikke anvendes af a-kasser | Afmeldingsårsagen kan ikke anvendes af a-kasser |
| 9118 | Afmeldingsårsagen kan kun anvendes af a-kasser | Afmeldingsårsagen kan kun anvendes af a-kasser |
| 4367 | Borgeren er ikke tilmeldt | Borgeren er ikke tilmeldt |
| 4322 | Afmeldedatoen skal tidligst være i dag, dog maksimalt 30 dage frem, eller 60 dage frem ved særlige fravær | Afmeldedatoen skal tidligst være i dag, dog maksimalt 30 dage frem, eller 60 dage frem ved særlige fravær |
| 100032 | Det er ikke lovligt at opdatere øvrige felter ifm.en afmelding | Det er ikke lovligt at opdatere øvrige felter ifm.en afmelding |
| 100034 | Hændelsesdato må ikke ligge i foregående tilmeldeperiode | Hændelsesdato må ikke ligge i foregående tilmeldeperiode |
| 9300 | Ledighedsgraden kan ikke anvendes af a-kasser | Ledighedsgraden kan ikke anvendes af a-kasser |
| 100045 | Ledighedsgraden kan ikke anvendes af jobcentre | Ledighedsgraden kan ikke anvendes af jobcentre |
| 100046 | Hændelses dato kan kun sættes/ændres af A-kasser og STAR | Hændelses dato kan kun sættes/ændres af A-kasser og STAR |
GetTilmelding (GET /v1/Tilmelding/{tilmeldingIdentifier})
Metode til at hente en specifik tilmelding for en borger
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
visiteringogstatus.read
| 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 |
| tilmeldingIdentifier [Path] | uuid | | 1 | |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| response | GetTilmeldingResponseDto | | 1 | |
| - tilmeldinger | TilmeldingDtoCollection | | 1 | Samlende element med alle borgers tilmeldinger |
| - - TilmeldingDto | TilmeldingDto | | 0 - * | |
| - - - tilmeldingIdentifier | uuid | | 1 | Guid for tilmeldingen |
| - - - klientkategori | TilmeldekategoriTypeCodeList | | 1 | |
| - - - tilmeldingsdato | date-time | | 1 | Tilmeldedatoen hvor det angivne tilmeldeforhold starter. Dette er datoen, hvor den ledige har henvendt sig enten gennem Jobnet eller Jobcentret. |
| - - - ledighedsgrad | LedighedsgradTypeCodeList | | 1 | |
| - - - afmelding | AfmeldingDto | | 0 - 1 | |
| - - - - afmeldedato | date-time | | 1 | Afmeldingsdato. |
| - - - - afmeldingsaarsag | AfmeldingsaarsagTypeCodeList | | 1 | |
| - - - haendelsesdato | date-time | | 0 - 1 | Forretningsmæssig hændelsesdato for tilmeldingen hvis den ikke er registreret på hændelsesdatoen |
| - - - jobnetFlag | boolean | | 0 - 1 | Status på om vedkommende har tilmeldt sig via Jobnet |
| - - - berigtigelseskommentar | string | Length: 1-1500 | 0 - 1 | Berigtigelseskommentar som kan sættes ved især ændring af hændelsesdato og fremtidig afmelding |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 1001 | Ugyldigt cpr-nummer | Ugyldigt cpr-nummer |
| 1014 | The submitted message is not valid | The submitted message is not valid |
| 4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
| 4404 | Person med det angivne CPR-nummer findes ikke | Person med det angivne CPR-nummer findes ikke |
| 4589 | Id ikke fundet | Id ikke fundet |
GetTilmeldingshistorik (GET /v1/Tilmelding/historik)
Metode til at hente alle borgers tilmeldinger (incl. historik)
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
visiteringogstatus.read
| 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 | GetTilmeldingsHistorikResponseDto | | 1 | |
| - tilmeldinger | TilmeldingCollection | | 1 | Samlende element med alle borgers tilmeldinger |
| - - Tilmelding | Tilmelding | | 0 - * | |
| - - - tilmeldingIdentifier | uuid | | 1 | Id for objektet |
| - - - klientkategori | TilmeldekategoriTypeCodeList | | 1 | |
| - - - tilmeldingsdato | date-time | | 1 | Tilmeldedatoen hvor det angivne tilmeldeforhold starter. Dette er datoen, hvor den ledige har henvendt sig enten gennem Jobnet eller jobcentret/// |
| - - - ledighedsgrad | LedighedsgradTypeCodeList | | 1 | |
| - - - afmeldedato | date-time | | 0 - 1 | Afmeldingsdato |
| - - - afmeldingsaarsag | AfmeldingsaarsagTypeCodeList | | 0 - 1 | |
| - - - haendelsesdato | date-time | | 0 - 1 | Forretningsmæssig hændelsesdato for tilmeldingen hvis den ikke er registreret på hændelsesdatoen |
| - - - jobnetFlag | boolean | | 1 | Indikation af om tilmelding er sket på Jobnet og skal bekræftes i jobcenter |
| - - - berigtigelseskommentar | string | Length: 1-1500 | 0 - 1 | Berigtigelseskommentar som kan sættes ved især ændring af hændelsesdato og fremtidig afmelding |
| - - - registreringsmetadata | RegistreringsmetadataDto | | 1 | |
| - - - - erSlettet | boolean | | 1 | Angiver om registreringen er en sletning |
| - - - - erAktuel | boolean | | 1 | Det er en række som er aktuel (kan typisk også ses i PSS). |
| - - - - registrerendeMyndighed | RegistrerendeMyndighedDto | | 0 - 1 | |
| - - - - - organisationType | OrganisationTypeCodeList | | 1 | |
| - - - - - organisationskode | string | Length: 1-20 | 1 | Identifikation af organisation / myndighed |
| - - - - kaldendeBruger | KaldendeBrugerDto | | 0 - 1 | |
| - - - - - brugerFuldtNavn | string | Length: 1-140 | 1 | Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her. |
| - - - - - brugerType | RequestUserTypeCodeList | | 1 | |
| - - - - - brugerId | string | Length: 1-255 | 1 | Unik identifikation af brugeren, f.eks. en GUID, et medarbejder ID, system ID, bruger ID, certifikat ID, cpr-nummer, email (hvis den er unik) o.l. |
| - - - - - brugerEmail | email | | 0 - 1 | Brugers e-mail. |
| - - - - - brugerOrganisation | BrugerOrganisationDto | | 1 | |
| - - - - - - organisationType | OrganisationTypeCodeList | | 1 | |
| - - - - - - organisationskode | string | Pattern: [-][1]|[0-9]{1,8}
MinLength: 1 | 1 | Organisationskode for den registrerende bruger. |
| - - - - - dfdgRegistreringstidspunkt | date-time | | 1 | Kaldende systems registreringstidspunkt. |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
| 1014 | The submitted message is not valid | The submitted message is not valid |
| 4404 | Person med det angivne CPR-nummer findes ikke | Person med det angivne CPR-nummer findes ikke |
| 1001 | Ugyldigt cpr-nummer | Ugyldigt cpr-nummer |