VisiteringOgStatus.AktivitetstillaegService (Version 1, 2024-1)

Siden opdateres automatisk til at afspejle koden.

Metoder

CreateAktivitetstillaeg (POST /v1/Aktivitetstillaeg)

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

 

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

JobCenter

 

X

 

 

X

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

visiteringogstatus.aktivitetstillaeg.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

CreateAktivitetstillaegRequestDto

 

1

Oplysninger om borgers anmodning om aktivitetstillæg

-    anmodningOmAktivitetstillaeg

boolean

 

1

True, borger ønsker at blive aktivereret. Ellers false.

-    haendelsesdato

date-time

 

1

Hændelsesdato for modtagelse af anmodning om aktivitetstillæg.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

uuid

 

1

 

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

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

6023

Anmodning om aktivitetstillæg er ikke gyldig ift. borgers kontaktgruppe, visitation eller alder

Anmodning om aktivitetstillæg er ikke gyldig ift. borgers kontaktgruppe, visitation eller alder

6031

Den nye hændelsesdato er før hændelses- eller slutdato for et allerede registrereret anmodning

Den nye hændelsesdato er før hændelses- eller slutdato for et allerede registrereret anmodning

GetAktivitetstillaeg (GET /v1/Aktivitetstillaeg)

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

 

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

JobCenter

 

X

 

X

X

X

 

X

STAR

X

 

 

 

 

 

 

 

Scope

visiteringogstatus.aktivitetstillaeg.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetAktivitetstillaegResponseDto

 

1

 

-    aktivitetstillaeg

AktivitetstillaegDtoCollection

 

1

Samling af aktivitetstillæg registreret på borger

-    -    AktivitetstillaegDto

AktivitetstillaegDto

 

0 - *

 

-    -    -    aktivitetstillaegId

uuid

 

1

Identifikationsnøgle for den enkelte anmodning om aktivitetstillæg

-    -    -    anmodningOmAktivitetstillaeg

boolean

 

1

Om borgeren ønsker aktivering eller ikke.

-    -    -    haendelsesdato

date-time

 

1

Hændelsesdato for modtagelse af anmoddning om aktivitetstillæg.

-    -    -    slutdato

date-time

 

0 - 1

Slutdato for aktivitetstillæg

-    -    -    berigtigelseskommentar

string

Length: 0-1500

0 - 1

Kommentar der kan angives hvis der laves ændringer.

-    -    -    dfdgRegistreringstidspunkt

date-time

 

1

Tidspunkt for registreringen i DFDG

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

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

GetAktivitetstillaegHistorik (GET /v1/Aktivitetstillaeg/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

 

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

JobCenter

 

X

 

X

X

X

 

X

STAR

X

 

 

 

 

 

 

 

Scope

visiteringogstatus.aktivitetstillaeg.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetAktivitetstillaegHistorikResponseDto

 

1

 

-    aktivitetstillaegHistorik

AktivitetstillaegHistorikDtoCollection

 

1

 

-    -    AktivitetstillaegHistorikDto

AktivitetstillaegHistorikDto

 

0 - *

 

-    -    -    aktivitetstillaegId

uuid

 

1

Identifikationsnøgle for den enkelte anmodning om aktivitetstillæg

-    -    -    anmodningOmAktivitetstillaeg

boolean

 

1

Om borgeren ønsker aktivering eller ikke.

-    -    -    haendelsesdato

date-time

 

1

Hændelsesdato for modtagelse af anmoddning om aktivitetstillæg.

-    -    -    slutdato

date-time

 

0 - 1

Slutdato for aktivitetstillæg

-    -    -    berigtigelseskommentar

string

Length: 0-1500

0 - 1

Kommentar der kan angives hvis der laves ændringer.

-    -    -    dfdgRegistreringstidspunkt

date-time

 

1

Tidspunkt for registreringen i DFDG

-    -    -    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

-    -    -    -    -    registrerendeBruger

RegistrerendeBrugerDto

 

0 - 1

 

-    -    -    -    -    -    kaldendeBruger

KaldendeBrugerDto

 

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

Tidspunkt for registrering i DFDG

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

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

UpdateAktivitetstillaeg (PUT /v1/Aktivitetstillaeg/{aktivitetstillaegId})

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

 

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

JobCenter

 

X

 

 

X

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

visiteringogstatus.aktivitetstillaeg.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

aktivitetstillaegId [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

UpdateAktivitetstillaegRequestDto

 

1

Oplysninger om borgers anmodning om aktivitetstillæg

-    anmodningOmAktivitetstillaeg

boolean

 

1

True, borger ønsker at blive aktivereret. Ellers false.

-    haendelsesdato

date-time

 

1

Hændelsesdato for modtagelse af anmodning om aktivitetstillæg.

-    slutdato

date-time

 

0 - 1

Slutdato for anmodnings gyldighed som følge af kontaktgruppe skift, skift i visitationsgruppe eller afslutning af kontaktgruppe

-    berigtigelseskommentar

string

Length: 1-1500

1

Kommentarfelt til at beskrive en berigtigelse af en registrering.

Output

Intet output

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

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

4933

Kommentaren må ikke indeholde HTML

Kommentaren må ikke indeholde HTML

6023

Anmodning om aktivitetstillæg er ikke gyldig ift. borgers kontaktgruppe, visitation eller alder

Anmodning om aktivitetstillæg er ikke gyldig ift. borgers kontaktgruppe, visitation eller alder

6030

Slutdatoen skal være senere end startdatoen

Slutdatoen skal være senere end startdatoen

6031

Den nye hændelsesdato er før hændelses- eller slutdato for et allerede registrereret anmodning

Den nye hændelsesdato er før hændelses- eller slutdato for et allerede registrereret anmodning