Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel2

CreateText (POST /v1/DynamicTexts/create)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

star.dynamictext.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-requestId [Header]string1Unikt 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
requestBodyCreateDynamicTextDto1
-    textstringMinLength: 11
-    displayTextstringMinLength: 11
-    groupExternalIdentifieruuid0 - 1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseuuid1

Fejlkoder

Ingen fejlkoder

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

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

star.dynamictext.write

Input

ElementTypeDetaljerForekomstBeskrivelse
externalIdentifier [Path]uuid1
x-requestId [Header]string1Unikt 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

ElementTypeDetaljerForekomstBeskrivelse
responseActionResult1

Fejlkoder

Ingen fejlkoder

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

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

star.dynamictext.read

Input

ElementTypeDetaljerForekomstBeskrivelse
externalIdentifier [Path]uuid1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetDynamicTextDto1
-    externalIdentifieruuid1
-    textstringMinLength: 11
-    displayTextstringMinLength: 11
-    groupGetDynamicTextGroupDto0 - 1
-    -    externalIdentifieruuid1
-    -    namestringMinLength: 11

Fejlkoder

Ingen fejlkoder

GetTexts (GET /v1/DynamicTexts)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

star.dynamictext.read

Input

ElementTypeDetaljerForekomstBeskrivelse
externalGroupIdentifier [Query]uuid0 - 1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetDynamicTextDtoCollection1
-    GetDynamicTextDtoGetDynamicTextDto0 - *
-    -    externalIdentifieruuid1
-    -    textstringMinLength: 11
-    -    displayTextstringMinLength: 11
-    -    groupGetDynamicTextGroupDto0 - 1
-    -    -    externalIdentifieruuid1
-    -    -    namestringMinLength: 11

Fejlkoder

Ingen fejlkoder

GetAllGroups (GET /v1/DynamicTexts/groups)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

star.dynamictext.read

Input

ElementTypeDetaljerForekomstBeskrivelse

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetDynamicTextGroupDtoCollection1
-    GetDynamicTextGroupDtoGetDynamicTextGroupDto0 - *
-    -    externalIdentifieruuid1
-    -    namestringMinLength: 11

Fejlkoder

Ingen fejlkoder

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

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

star.dynamictext.write

Input

ElementTypeDetaljerForekomstBeskrivelse
externalIdentifier [Path]string1
x-requestId [Header]string1Unikt 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
requestBodyUpdateDynamicTextDto1
-    externalIdentifieruuid1
-    textstringMinLength: 11
-    displayTextstringMinLength: 11
-    groupExternalIdentifieruuid0 - 1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseActionResult1

Fejlkoder

Ingen fejlkoder

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

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
JobCenterXX
KommuneX
STARX

Scope

borgerindsats.rehabilitering.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
rehabiliteringsindstillingId [Path]uuid1
x-requestId [Header]string1Unikt 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
requestBodyCreateRehabiliteringsindstillingDto1
-    rehabiliteringsindstillingResultatTypeRehabiliteringsindstillingResultatTypeCodeList1
-    indstillingsdatodate-time1Indstillingsdato for indstilling fra rehabiliteringsteamet.
-    varighedIMaanederint320 - 1Forløbets varighed i måneder.
-    formaalstringLength: 1-40000 - 1Forløbet og dets formål.

Output

ElementTypeDetaljerForekomstBeskrivelse
responseuuid1

Fejlkoder

FejlkodeFejltekstBeskrivelse
9350Det angivne RehabiliteringsindstillingId findes allerede i systemetDet angivne RehabiliteringsindstillingId findes allerede i systemet

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

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
JobCenterXX
KommuneX
STARX

Scope

borgerindsats.rehabilitering.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
rehabiliteringsindstillingId [Path]uuid1
x-requestId [Header]string1Unikt 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
requestBodyUpdateRehabiliteringsindstillingRequestDto1
-    rehabiliteringsindstillingResultatTypeRehabiliteringsindstillingResultatTypeCodeList1
-    indstillingsdatodate-time1Indstillingsdato for indstilling fra rehabiliteringsteamet.
-    varighedIMaanederint320 - 1Forløbets varighed i måneder.
-    formaalstringLength: 1-40000 - 1Forløbet og dets formål.
-    berigtigelseskommentarstringLength: 1-15000 - 1Kommentar.

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
4589Id ikke fundetId ikke fundet

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

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
JobCenterXX
KommuneX
STARX

Scope

borgerindsats.rehabilitering.read

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
rehabiliteringsindstillingId [Path]uuid1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetRehabiliteringsindstillingResponseDto1
-    rehabiliteringsindstillingRehabiliteringsindstillingDto0 - 1
-    -    rehabiliteringsindstillinguuid1Nøgle på indstillingen.
-    -    rehabiliteringsindstillingResultatTypeRehabiliteringsindstillingResultatTypeCodeList1
-    -    indstillingsdatodate-time1Indstillingsdato for indstilling fra rehabiliteringsteamet.
-    -    varighedIMaanederint320 - 1Forløbets varighed i måneder.
-    -    formaalstringLength: 1-40000 - 1Forløbet og dets formål.
-    -    berigtigelseskommentarstringLength: 1-15000 - 1Kommentar.
-    -    dfdgRegistreringstidspunktdate-time1Oprettelsesdato for indstilling i DFDG.
-    -    senesteOpdateringsdatodate-time1Seneste opdateringsdato for indstilling i DFDG.

Fejlkoder

FejlkodeFejltekstBeskrivelse
4589Id ikke fundetId ikke fundet

CreateRehabiliteringsindstilling (POST /v1/Rehabiliteringsindstilling)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
JobCenterXX
KommuneX
STARX

Scope

borgerindsats.rehabilitering.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
x-requestId [Header]string1Unikt 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
requestBodyCreateRehabiliteringsindstillingDto1
-    rehabiliteringsindstillingResultatTypeRehabiliteringsindstillingResultatTypeCodeList1
-    indstillingsdatodate-time1Indstillingsdato for indstilling fra rehabiliteringsteamet.
-    varighedIMaanederint320 - 1Forløbets varighed i måneder.
-    formaalstringLength: 1-40000 - 1Forløbet og dets formål.

Output

ElementTypeDetaljerForekomstBeskrivelse
responseuuid1

Fejlkoder

FejlkodeFejltekstBeskrivelse
9350Det angivne RehabiliteringsindstillingId findes allerede i systemetDet angivne RehabiliteringsindstillingId findes allerede i systemet