Borgerindsats.RehabiliteringsindstillingService (Version 1, 2024-2)

Siden opdateres automatisk til at afspejle koden.

Metoder

CreateText (POST /v1/DynamicTexts/create)

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

STAR

X

 

 

 

 

 

 

 

Scope

star.dynamictext.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

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

CreateDynamicTextDto

 

1

 

-    text

string

MinLength: 1

1

 

-    displayText

string

MinLength: 1

1

 

-    groupExternalIdentifier

uuid

 

0 - 1

 

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

uuid

 

1

 

Fejlkoder

Ingen fejlkoder

DeleteText (DELETE /v1/DynamicTexts/{externalIdentifier})

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

STAR

X

 

 

 

 

 

 

 

Scope

star.dynamictext.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

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

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

ActionResult

 

1

 

Fejlkoder

Ingen fejlkoder

GetText (GET /v1/DynamicTexts/{externalIdentifier})

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

STAR

X

 

 

 

 

 

 

 

Scope

star.dynamictext.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

externalIdentifier [Path]

uuid

 

1

 

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetDynamicTextDto

 

1

 

-    externalIdentifier

uuid

 

1

 

-    text

string

MinLength: 1

1

 

-    displayText

string

MinLength: 1

1

 

-    group

GetDynamicTextGroupDto

 

0 - 1

 

-    -    externalIdentifier

uuid

 

1

 

-    -    name

string

MinLength: 1

1

 

Fejlkoder

Ingen fejlkoder

GetTexts (GET /v1/DynamicTexts)

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

STAR

X

 

 

 

 

 

 

 

Scope

star.dynamictext.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

externalGroupIdentifier [Query]

uuid

 

0 - 1

 

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetDynamicTextDtoCollection

 

1

 

-    GetDynamicTextDto

GetDynamicTextDto

 

0 - *

 

-    -    externalIdentifier

uuid

 

1

 

-    -    text

string

MinLength: 1

1

 

-    -    displayText

string

MinLength: 1

1

 

-    -    group

GetDynamicTextGroupDto

 

0 - 1

 

-    -    -    externalIdentifier

uuid

 

1

 

-    -    -    name

string

MinLength: 1

1

 

Fejlkoder

Ingen fejlkoder

GetAllGroups (GET /v1/DynamicTexts/groups)

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

STAR

X

 

 

 

 

 

 

 

Scope

star.dynamictext.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetDynamicTextGroupDtoCollection

 

1

 

-    GetDynamicTextGroupDto

GetDynamicTextGroupDto

 

0 - *

 

-    -    externalIdentifier

uuid

 

1

 

-    -    name

string

MinLength: 1

1

 

Fejlkoder

Ingen fejlkoder

UpdateText (PUT /v1/DynamicTexts/update/{externalIdentifier})

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

STAR

X

 

 

 

 

 

 

 

Scope

star.dynamictext.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

externalIdentifier [Path]

string

 

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

UpdateDynamicTextDto

 

1

 

-    externalIdentifier

uuid

 

1

 

-    text

string

MinLength: 1

1

 

-    displayText

string

MinLength: 1

1

 

-    groupExternalIdentifier

uuid

 

0 - 1

 

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

ActionResult

 

1

 

Fejlkoder

Ingen fejlkoder

CreateRehabiliteringsindstillingMedId (POST /v1/Rehabiliteringsindstilling/{rehabiliteringsindstillingId})

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

 

 

 

Kommune

 

X

 

 

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerindsats.rehabilitering.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

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

CreateRehabiliteringsindstillingDto

 

1

 

-    rehabiliteringsindstillingResultatType

RehabiliteringsindstillingResultatTypeCodeList

 

1

 

-    indstillingsdato

date-time

 

1

Indstillingsdato for indstilling fra rehabiliteringsteamet.

-    varighedIMaaneder

int32

 

0 - 1

Forløbets varighed i måneder.

-    formaal

string

Length: 1-4000

0 - 1

Forløbet og dets formål.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

uuid

 

1

 

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

9350

Det angivne RehabiliteringsindstillingId findes allerede i systemet

Det angivne RehabiliteringsindstillingId findes allerede i systemet

UpdateRehabiliteringsindstilling (PUT /v1/Rehabiliteringsindstilling/{rehabiliteringsindstillingId})

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

 

 

 

Kommune

 

X

 

 

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerindsats.rehabilitering.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

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

UpdateRehabiliteringsindstillingRequestDto

 

1

 

-    rehabiliteringsindstillingResultatType

RehabiliteringsindstillingResultatTypeCodeList

 

1

 

-    indstillingsdato

date-time

 

1

Indstillingsdato for indstilling fra rehabiliteringsteamet.

-    varighedIMaaneder

int32

 

0 - 1

Forløbets varighed i måneder.

-    formaal

string

Length: 1-4000

0 - 1

Forløbet og dets formål.

-    berigtigelseskommentar

string

Length: 1-1500

0 - 1

Kommentar.

Output

Intet output

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

4589

Id ikke fundet

Id ikke fundet

GetRehabiliteringsindstilling (GET /v1/Rehabiliteringsindstilling/{rehabiliteringsindstillingId})

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

 

 

 

Kommune

 

X

 

 

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerindsats.rehabilitering.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

rehabiliteringsindstillingId [Path]

uuid

 

1

 

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetRehabiliteringsindstillingResponseDto

 

1

 

-    rehabiliteringsindstilling

RehabiliteringsindstillingDto

 

0 - 1

 

-    -    rehabiliteringsindstilling

uuid

 

1

Nøgle på indstillingen.

-    -    rehabiliteringsindstillingResultatType

RehabiliteringsindstillingResultatTypeCodeList

 

1

 

-    -    indstillingsdato

date-time

 

1

Indstillingsdato for indstilling fra rehabiliteringsteamet.

-    -    varighedIMaaneder

int32

 

0 - 1

Forløbets varighed i måneder.

-    -    formaal

string

Length: 1-4000

0 - 1

Forløbet og dets formål.

-    -    berigtigelseskommentar

string

Length: 1-1500

0 - 1

Kommentar.

-    -    dfdgRegistreringstidspunkt

date-time

 

1

Oprettelsesdato for indstilling i DFDG.

-    -    senesteOpdateringsdato

date-time

 

1

Seneste opdateringsdato for indstilling i DFDG.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

4589

Id ikke fundet

Id ikke fundet

CreateRehabiliteringsindstilling (POST /v1/Rehabiliteringsindstilling)

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

 

 

 

Kommune

 

X

 

 

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerindsats.rehabilitering.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

CreateRehabiliteringsindstillingDto

 

1

 

-    rehabiliteringsindstillingResultatType

RehabiliteringsindstillingResultatTypeCodeList

 

1

 

-    indstillingsdato

date-time

 

1

Indstillingsdato for indstilling fra rehabiliteringsteamet.

-    varighedIMaaneder

int32

 

0 - 1

Forløbets varighed i måneder.

-    formaal

string

Length: 1-4000

0 - 1

Forløbet og dets formål.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

uuid

 

1

 

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

9350

Det angivne RehabiliteringsindstillingId findes allerede i systemet

Det angivne RehabiliteringsindstillingId findes allerede i systemet