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

CreateRehabiliteringsforloebMedId (POST /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId})

Opretter et rehabiliteringsforløb, som er en paraply over den forberedende del og indstillingen

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
rehabiliteringsforloebId [Path]uuid1Nøgle på forløbet. Hvis den ikke er angivet sætter DFDG en automatisk.
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
responseuuid1

Fejlkoder

FejlkodeFejltekstBeskrivelse
9323Kun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladtKun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladt
9348Det angivne RehabiliteringsforloebId findes allerede i systemetDet angivne RehabiliteringsforloebId findes allerede i systemet

...

Opdaterer et rehabiliteringsforløb

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
rehabiliteringsforloebId [Path]uuid1Nøgle på forløbet.
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
requestBodyUpdateRehabiliteringsforloebRequestDto1
-    rehabiliteringsforloebStatusRehabiliteringsforloebStatusCodeList1
-    indstillingIduuid0 - 1Reference til indstilling. Kan hentes via RecommendeInitiativeService
-    berigtigelseskommentarstringLength: 1-15000 - 1Kommentar, bruges primært ved lukning af forløb uden afgørelse. Feltet er obligatorisk ved status fejloprettet.

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
4589Id ikke fundetId ikke fundet

...

Henter et rehabiliteringsforløb

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
rehabiliteringsforloebId [Path]uuid1Nøgle på forløbet. Hvis den ikke er angivet hentes den seneste ud fra oprettelsestidpunkt.

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetRehabiliteringsforloebResponseDto1
-    rehabiliteringsforloebRehabiliteringsforloebDto0 - 1
-    -    rehabiliteringsforloebIduuid1Nøgle på forløbet.
-    -    rehabiliteringsforloebStatusRehabiliteringsforloebStatusCodeList1
-    -    indstillingIduuid0 - 1Reference til indstillingen. Kan hentes via RecommendedInitiativeService.orløbet.
-    -    screeningIduuid0 - 1Reference til borgers Min situation, som teknisk er en Screening, der kan hentes via Screeningsservice.
-    -    berigtigelseskommentarstringLength: 1-15000 - 1Kommentar, bruges primært ved lukning af forløb uden afgørelse. Feltet er obligatorisk ved status fejloprettet.
-    -    oprettelsesdatodate-time1Oprettelsesdato i DFDG
-    -    senesteOpdateringsdatodate-time1Seneste opdateringsdato i DFDG
-    -    dokumenterRehabiliteringsdokumentMetadataDtoCollection1Metadata for alle dokumenter der er knyttet til forløbet.
-    -    -    RehabiliteringsdokumentMetadataDtoRehabiliteringsdokumentMetadataDto0 - *
-    -    -    -    dokumentIduuid1ID på dokument.
-    -    -    -    dokumentTitelstringLength: 1-2501Titlen på dokument.
-    -    -    -    rehabiliteringsdokumentTypeRehabiliteringsdokumentTypeCodeList1
-    -    -    -    dokumentExtensionTypeDokumentTypeCodeList1
-    -    -    -    dokumentStatusTypeDokumentStatusCodeList1
-    -    -    -    dfdgRegistreringstidspunktdate-time1Tidspunkt for registering af dokumentet. Er sat af DFDG.
-    -    -    -    senesteOpdateringstidspunktdate-time1Tidspunkt for opdatering af dokumentet. Er sat af DFDG.
-    -    -    -    slettetTidspunktdate-time0 - 1Tidspunkt for hvornår dokumentet er slettet. Er sat af DFDG.
-    -    -    -    berigtigelseskommentarstringLength: 1-15000 - 1Kommentar, bruges primært ved lukning af forløb uden afgørelse. Feltet er obligatorisk ved status fejloprettet.

Fejlkoder

FejlkodeFejltekstBeskrivelse
4589Id ikke fundetId ikke fundet
9322Berigtigelseskommentar er påkrævet for rehabiliteringsforløb med status fejloprettetBerigtigelseskommentar er påkrævet for rehabiliteringsforløb med status fejloprettet
9332En indstilling er påkrævet for RehabiliteringsforloebStatus 3 og 4En indstilling er påkrævet for RehabiliteringsforloebStatus 3 og 4
9330Et rehabiliteringsforløb med RehabiliteringsforloebStatus 1, 2, eller 7, kan ikke have en indstilling.Et rehabiliteringsforløb med RehabiliteringsforloebStatus 1, 2, eller 7, kan ikke have en indstilling.
9323Kun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladtKun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladt
9324Kun et rehabiliteringsforløb med RehabiliteringsforloebStatus 4 er tilladtKun et rehabiliteringsforløb med RehabiliteringsforloebStatus 4 er tilladt

...

Opretter et rehabiliteringsforløb, som er en paraply over den forberedende del og indstillingen

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

Output

ElementTypeDetaljerForekomstBeskrivelse
responseuuid1

Fejlkoder

FejlkodeFejltekstBeskrivelse
9323Kun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladtKun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladt
9348Det angivne RehabiliteringsforloebId findes allerede i systemetDet angivne RehabiliteringsforloebId findes allerede i systemet

...

Henter et rehabiliteringsforløb

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

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetRehabiliteringsforloebResponseDto1
-    rehabiliteringsforloebRehabiliteringsforloebDto0 - 1
-    -    rehabiliteringsforloebIduuid1Nøgle på forløbet.
-    -    rehabiliteringsforloebStatusRehabiliteringsforloebStatusCodeList1
-    -    indstillingIduuid0 - 1Reference til indstillingen. Kan hentes via RecommendedInitiativeService.orløbet.
-    -    screeningIduuid0 - 1Reference til borgers Min situation, som teknisk er en Screening, der kan hentes via Screeningsservice.
-    -    berigtigelseskommentarstringLength: 1-15000 - 1Kommentar, bruges primært ved lukning af forløb uden afgørelse. Feltet er obligatorisk ved status fejloprettet.
-    -    oprettelsesdatodate-time1Oprettelsesdato i DFDG
-    -    senesteOpdateringsdatodate-time1Seneste opdateringsdato i DFDG
-    -    dokumenterRehabiliteringsdokumentMetadataDtoCollection1Metadata for alle dokumenter der er knyttet til forløbet.
-    -    -    RehabiliteringsdokumentMetadataDtoRehabiliteringsdokumentMetadataDto0 - *
-    -    -    -    dokumentIduuid1ID på dokument.
-    -    -    -    dokumentTitelstringLength: 1-2501Titlen på dokument.
-    -    -    -    rehabiliteringsdokumentTypeRehabiliteringsdokumentTypeCodeList1
-    -    -    -    dokumentExtensionTypeDokumentTypeCodeList1
-    -    -    -    dokumentStatusTypeDokumentStatusCodeList1
-    -    -    -    dfdgRegistreringstidspunktdate-time1Tidspunkt for registering af dokumentet. Er sat af DFDG.
-    -    -    -    senesteOpdateringstidspunktdate-time1Tidspunkt for opdatering af dokumentet. Er sat af DFDG.
-    -    -    -    slettetTidspunktdate-time0 - 1Tidspunkt for hvornår dokumentet er slettet. Er sat af DFDG.
-    -    -    -    berigtigelseskommentarstringLength: 1-15000 - 1Kommentar, bruges primært ved lukning af forløb uden afgørelse. Feltet er obligatorisk ved status fejloprettet.

Fejlkoder

FejlkodeFejltekstBeskrivelse
4589Id ikke fundetId ikke fundet
9322Berigtigelseskommentar er påkrævet for rehabiliteringsforløb med status fejloprettetBerigtigelseskommentar er påkrævet for rehabiliteringsforløb med status fejloprettet
9332En indstilling er påkrævet for RehabiliteringsforloebStatus 3 og 4En indstilling er påkrævet for RehabiliteringsforloebStatus 3 og 4
9330Et rehabiliteringsforløb med RehabiliteringsforloebStatus 1, 2, eller 7, kan ikke have en indstilling.Et rehabiliteringsforløb med RehabiliteringsforloebStatus 1, 2, eller 7, kan ikke have en indstilling.
9323Kun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladtKun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladt
9324Kun et rehabiliteringsforløb med RehabiliteringsforloebStatus 4 er tilladtKun et rehabiliteringsforløb med RehabiliteringsforloebStatus 4 er tilladt

...

Opretter et dokument i forbindelse med et rehabliteringsforløbs forberedende eller indstillende del.

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
rehabiliteringsforloebId [Path]uuid1Nøgle på forløbet.
dokumentId [Path]uuid1ID på dokument. Hvis ikke angivet sætter DFDG en GUID.
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
requestBodyCreateRehabiliteringsdokumentRequestDto1
-    titelstringLength: 1-2501Titlen på dokumentet.
-    rehabiliteringsdokumentTypeRehabiliteringsdokumentTypeCodeList1
-    dokumentExtensionTypeDokumentTypeCodeList1
-    dokumentdatabase64BinaryMinLength: 11Indholdet af rehabiliteringsforløbsdokumentet i binær form.

Output

ElementTypeDetaljerForekomstBeskrivelse
responseuuid1

Fejlkoder

FejlkodeFejltekstBeskrivelse
4589Id ikke fundetId ikke fundet
9325I regi af rehabiliteringsforløbet er kun PDF lovligI regi af rehabiliteringsforløbet er kun PDF lovlig
9349Det angivne DokumentId findes allerede i systemetDet angivne DokumentId findes allerede i systemet

GetRehabiliteringsdokument (GET /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId}/dokument/{dokumentId})

Henter et dokument.

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
rehabiliteringsforloebId [Path]uuid1Nøgle på forløbet.
dokumentId [Path]uuid1ID på dokument.

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetRehabiliteringsdokumentResponseDto1
-    dokumentdatabase64Binary1Indholdet af rehabiliteringsforløbsdokumentet i binær form.
-    dokumentTitelstringMinLength: 11Titlen på dokumentet.
-    rehabiliteringsdokumentTypeRehabiliteringsdokumentTypeCodeList1
-    dokumentExtensionTypeDokumentTypeCodeList1
-    dokumentStatusTypeDokumentStatusCodeList1

Fejlkoder

FejlkodeFejltekstBeskrivelse
4589Id ikke fundetId ikke fundet
8103Dokumentet findes ikkeDokumentet findes ikke

...

Opdaterer et dokument og metadata i forbindelse med en rehabliteringsforløbs forberedende eller indstillende del.

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
rehabiliteringsforloebId [Path]uuid1Nøgle på forløbet.
dokumentId [Path]uuid1ID på dokument.
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
requestBodyUpdateRehabiliteringsdokumentRequestDto1
-    titelstringLength: 1-2501Titlen på dokumentet.
-    rehabiliteringsdokumentTypeRehabiliteringsdokumentTypeCodeList1
-    dokumentExtensionTypeDokumentTypeCodeList1
-    dokumentdatabase64Binary0 - 1Indholdet af rehabiliteringsforløbsdokumentet i binær form. Hvis dokumentet ikke medsendes opdateres alene metadata vedr. dokumentet.
-    berigtigelseskommentarstringLength: 1-15000 - 1Kommentar, bruges primært ved inaktivering og sletning af dokument.

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
4589Id ikke fundetId ikke fundet
9325I regi af rehabiliteringsforløbet er kun PDF lovligI regi af rehabiliteringsforløbet er kun PDF lovlig
8103Dokumentet findes ikkeDokumentet findes ikke

...

Slettemarkerer et dokument. Dokumentet vil fremover ikke fremgå af dokumentlisten i GetRehabiliteringsforloeb og det er ikke længere muligt for serviceaftagere at hente det. Dokumentet slettes først fysisk i forbindelse med oprydning af forældede data.

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
rehabiliteringsforloebId [Path]uuid1Nøgle på forløbet.
dokumentId [Path]uuid1ID på dokument.
berigtigelseskommentar [Query]stringMaxLength: 15000 - 1Kommentar, bruges primært ved inaktivering og sletning af dokument.
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

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
4589Id ikke fundetId ikke fundet
8103Dokumentet findes ikkeDokumentet findes ikke

...

Opretter et dokument i forbindelse med et rehabliteringsforløbs forberedende eller indstillende del.

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
rehabiliteringsforloebId [Path]uuid1Nøgle på forløbet.
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
requestBodyCreateRehabiliteringsdokumentRequestDto1
-    titelstringLength: 1-2501Titlen på dokumentet.
-    rehabiliteringsdokumentTypeRehabiliteringsdokumentTypeCodeList1
-    dokumentExtensionTypeDokumentTypeCodeList1
-    dokumentdatabase64BinaryMinLength: 11Indholdet af rehabiliteringsforløbsdokumentet i binær form.

Output

ElementTypeDetaljerForekomstBeskrivelse
responseuuid1

Fejlkoder

FejlkodeFejltekstBeskrivelse
4589Id ikke fundetId ikke fundet
9325I regi af rehabiliteringsforløbet er kun PDF lovligI regi af rehabiliteringsforløbet er kun PDF lovlig
9349Det angivne DokumentId findes allerede i systemetDet angivne DokumentId findes allerede i systemet