VisiteringOgStatus.SanktionService (Version 1, 2024-3)
- WikiUploader
Siden opdateres automatisk til at afspejle koden.
Metoder
CreateSanktion (POST /v1/Sanktion)
Metoden bruges til at indberette en sanktion med relation til svar på en underretning eller til at oprette en fritflyver sanktion.
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 |
|
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
visiteringogstatus.underretning.akasse.write
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 | CreateSanktionRequestDto |
| 1 |
|
- indberettendeAkasse | int32 |
| 1 | Indberettende a-kasse |
- sanktionType |
| 1 |
| |
- sanktionAarsagType |
| 0 - 1 |
| |
- virkningFraDato | date-time |
| 1 | Dato som sanktionen gælder fra |
- foraeldelsesdato | date-time |
| 0 - 1 | Dato hvor sanktionen forældes. |
- gentagelsesvirkningsdato | date-time |
| 0 - 1 | Ikrafttrædelsesdato for gentagelsesvirkning |
- udstaaelsesdato | date-time |
| 0 - 1 | Dato hvor sanktionen er udstået. Registreres senere. Eventuel af ny a-kasse. |
- sanktionIdentifier | uuid |
| 0 - 1 | Unik id for sanktionen |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | uuid |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
100006 | Forældelsesdato skal være angivet for denne type | Forældelsesdato skal være angivet for denne type |
100007 | Dato for gentagelsesvirkning skal være udfyldt for denne type | Dato for gentagelsesvirkning skal være udfyldt for denne type |
100008 | Sanktionstype og sanktionsårsag kan ikke anvende i denne kombination | Sanktionstype og sanktionsårsag kan ikke anvende i denne kombination |
100009 | SanktionIdentifier findes allerede i systemet | SanktionIdentifier findes allerede i systemet |
4404 | Person med det angivne CPR-nummer findes ikke | Person med det angivne CPR-nummer findes ikke |
GetSanktioner (GET /v1/Sanktion)
Metoden bruges til at hente sanktioner
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 |
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
visiteringogstatus.underretning.akasse.read
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 |
skaeringsdato [Query] | date-time |
| 0 - 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetSanktionResponseDto |
| 1 |
|
- sanktioner | SanktionDtoCollection |
| 1 | List af sanktioner |
- - SanktionDto | SanktionDto |
| 0 - * |
|
- - - indberettendeAkasse | int32 |
| 1 | Indberettende a-kasse |
- - - sanktionType |
| 1 |
| |
- - - sanktionAarsagType |
| 0 - 1 |
| |
- - - virkningFraDato | date-time |
| 1 | Dato som sanktionen gælder fra |
- - - foraeldelsesdato | date-time |
| 0 - 1 | Dato hvor sanktionen forældes. |
- - - gentagelsesvirkningsdato | date-time |
| 0 - 1 | Ikrafttrædelsesdato for gentagelsesvirkning |
- - - udstaaelsesdato | date-time |
| 0 - 1 | Dato hvor sanktionen er udstået. Registreres senere. Eventuel af ny a-kasse. |
- - - sanktionIdentifier | uuid |
| 1 | Unik id for sanktionen |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
4404 | Person med det angivne CPR-nummer findes ikke | Person med det angivne CPR-nummer findes ikke |
UpdateSanktion (PUT /v1/Sanktion/{sanktionIdentifier})
Metoden bruges til opdatere en tidligere indberettet sanktion. Der kan fx være behov for at opdatere en tidligere indberettet sanktion med oplysninger om hvornår en sanktion er udstået.
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 |
|
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
visiteringogstatus.underretning.akasse.write
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 |
sanktionIdentifier [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 | UpdateSanktionRequestDto |
| 1 |
|
- indberettendeAkasse | int32 |
| 1 | Indberettende a-kasse |
- sanktionType |
| 1 |
| |
- sanktionAarsagType |
| 0 - 1 |
| |
- virkningFraDato | date-time |
| 1 | Dato som sanktionen gælder fra |
- foraeldelsesdato | date-time |
| 0 - 1 | Dato hvor sanktionen forældes. |
- gentagelsesvirkningsdato | date-time |
| 0 - 1 | Ikrafttrædelsesdato for gentagelsesvirkning |
- udstaaelsesdato | date-time |
| 0 - 1 | Dato hvor sanktionen er udstået. Registreres senere. Eventuel af ny a-kasse. |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
100005 | Sanktionstypen kan ikke opdateres | Sanktionstypen kan ikke opdateres |
100006 | Forældelsesdato skal være angivet for denne type | Forældelsesdato skal være angivet for denne type |
100007 | Dato for gentagelsesvirkning skal være udfyldt for denne type | Dato for gentagelsesvirkning skal være udfyldt for denne type |
100008 | Sanktionstype og sanktionsårsag kan ikke anvende i denne kombination | Sanktionstype og sanktionsårsag kan ikke anvende i denne kombination |
4589 | Id ikke fundet | Id ikke fundet |
4404 | Person med det angivne CPR-nummer findes ikke | Person med det angivne CPR-nummer findes ikke |
DeleteSanktion (DELETE /v1/Sanktion/{sanktionIdentifier})
Metoden bruges til at tilbagekalde en sanktion i situationer, hvor sanktionen er fejlregistreret.
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 |
|
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
visiteringogstatus.underretning.akasse.write
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 |
sanktionIdentifier [Path] | uuid |
| 1 |
|
berigtigelseskommentar [Query] | string | Length: 20-5000 | 1 | Berigtigelseskommentar |
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 |
|---|---|---|
4404 | Person med det angivne CPR-nummer findes ikke | Person med det angivne CPR-nummer findes ikke |
4589 | Id ikke fundet | Id ikke fundet |
GetSanktion (GET /v1/Sanktion/{sanktionIdentifier})
Metoden bruges til at hente en sanktion med en specifik sanktionIdentifier.
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 |
|
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
visiteringogstatus.underretning.akasse.read
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 |
sanktionIdentifier [Path] | uuid |
| 1 |
|
skaeringsdato [Query] | date-time |
| 0 - 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetSanktionResponseDto |
| 1 |
|
- sanktioner | SanktionDtoCollection |
| 1 | List af sanktioner |
- - SanktionDto | SanktionDto |
| 0 - * |
|
- - - indberettendeAkasse | int32 |
| 1 | Indberettende a-kasse |
- - - sanktionType |
| 1 |
| |
- - - sanktionAarsagType |
| 0 - 1 |
| |
- - - virkningFraDato | date-time |
| 1 | Dato som sanktionen gælder fra |
- - - foraeldelsesdato | date-time |
| 0 - 1 | Dato hvor sanktionen forældes. |
- - - gentagelsesvirkningsdato | date-time |
| 0 - 1 | Ikrafttrædelsesdato for gentagelsesvirkning |
- - - udstaaelsesdato | date-time |
| 0 - 1 | Dato hvor sanktionen er udstået. Registreres senere. Eventuel af ny a-kasse. |
- - - sanktionIdentifier | uuid |
| 1 | Unik id for sanktionen |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
4589 | Id ikke fundet | Id ikke fundet |
4404 | Person med det angivne CPR-nummer findes ikke | Person med det angivne CPR-nummer findes ikke |