Borgerindsats.RehabiliteringsforloebService (Version 1, 2024-2)
- WikiUploader
Siden opdateres automatisk til at afspejle koden.
Metoder
- 1 CreateRehabiliteringsforloebMedId (POST /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId})
- 2 UpdateRehabiliteringsforloeb (PUT /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId})
- 3 GetRehabiliteringsforloeb (GET /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId})
- 4 CreateRehabiliteringsforloeb (POST /v1/Rehabiliteringsforloeb)
- 5 GetSenesteRehabiliteringsforloeb (GET /v1/Rehabiliteringsforloeb)
- 6 CreateRehabiliteringsdokumentMedId (POST /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId}/dokument/{dokumentId})
- 7 GetRehabiliteringsdokument (GET /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId}/dokument/{dokumentId})
- 8 UpdateRehabiliteringsdokument (PUT /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId}/dokument/{dokumentId})
- 9 DeleteRehabiliteringsdokument (DELETE /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId}/dokument/{dokumentId})
- 10 CreateRehabiliteringsdokument (POST /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId}/dokument)
CreateRehabiliteringsforloebMedId (POST /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId})
Opretter et rehabiliteringsforløb, som er en paraply over den forberedende del og indstillingen
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 |
|---|---|---|---|---|---|---|---|---|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
borgerindsats.rehabilitering.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 |
rehabiliteringsforloebId [Path] | uuid |
| 1 | Nøgle på forløbet. Hvis den ikke er angivet sætter DFDG en automatisk. |
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 |
|---|---|---|---|---|
response | uuid |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
9323 | Kun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladt | Kun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladt |
9348 | Det angivne RehabiliteringsforloebId findes allerede i systemet | Det angivne RehabiliteringsforloebId findes allerede i systemet |
UpdateRehabiliteringsforloeb (PUT /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId})
Opdaterer et rehabiliteringsforløb
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 |
|---|---|---|---|---|---|---|---|---|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
borgerindsats.rehabilitering.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 |
rehabiliteringsforloebId [Path] | uuid |
| 1 | Nøgle på forløbet. |
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 | UpdateRehabiliteringsforloebRequestDto |
| 1 |
|
- rehabiliteringsforloebStatus |
| 1 |
| |
- indstillingId | uuid |
| 0 - 1 | Reference til indstilling. Kan hentes via RecommendeInitiativeService |
- berigtigelseskommentar | string | Length: 1-1500 | 0 - 1 | Kommentar, bruges primært ved lukning af forløb uden afgørelse. Feltet er obligatorisk ved status fejloprettet. |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
4589 | Id ikke fundet | Id ikke fundet |
GetRehabiliteringsforloeb (GET /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId})
Henter et rehabiliteringsforløb
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 |
|---|---|---|---|---|---|---|---|---|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
borgerindsats.rehabilitering.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 |
rehabiliteringsforloebId [Path] | uuid |
| 1 | Nøgle på forløbet. Hvis den ikke er angivet hentes den seneste ud fra oprettelsestidpunkt. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetRehabiliteringsforloebResponseDto |
| 1 |
|
- rehabiliteringsforloeb | RehabiliteringsforloebDto |
| 0 - 1 |
|
- - rehabiliteringsforloebId | uuid |
| 1 | Nøgle på forløbet. |
- - rehabiliteringsforloebStatus |
| 1 |
| |
- - indstillingId | uuid |
| 0 - 1 | Reference til indstillingen. Kan hentes via RecommendedInitiativeService.orløbet. |
- - screeningId | uuid |
| 0 - 1 | Reference til borgers Min situation, som teknisk er en Screening, der kan hentes via Screeningsservice. |
- - berigtigelseskommentar | string | Length: 1-1500 | 0 - 1 | Kommentar, bruges primært ved lukning af forløb uden afgørelse. Feltet er obligatorisk ved status fejloprettet. |
- - oprettelsesdato | date-time |
| 1 | Oprettelsesdato i DFDG |
- - senesteOpdateringsdato | date-time |
| 1 | Seneste opdateringsdato i DFDG |
- - dokumenter | RehabiliteringsdokumentMetadataDtoCollection |
| 1 | Metadata for alle dokumenter der er knyttet til forløbet. |
- - - RehabiliteringsdokumentMetadataDto | RehabiliteringsdokumentMetadataDto |
| 0 - * |
|
- - - - dokumentId | uuid |
| 1 | ID på dokument. |
- - - - dokumentTitel | string | Length: 1-250 | 1 | Titlen på dokument. |
- - - - rehabiliteringsdokumentType |
| 1 |
| |
- - - - dokumentExtensionType |
| 1 |
| |
- - - - dokumentStatusType |
| 1 |
| |
- - - - dfdgRegistreringstidspunkt | date-time |
| 1 | Tidspunkt for registering af dokumentet. Er sat af DFDG. |
- - - - senesteOpdateringstidspunkt | date-time |
| 1 | Tidspunkt for opdatering af dokumentet. Er sat af DFDG. |
- - - - slettetTidspunkt | date-time |
| 0 - 1 | Tidspunkt for hvornår dokumentet er slettet. Er sat af DFDG. |
- - - - berigtigelseskommentar | string | Length: 1-1500 | 0 - 1 | Kommentar, bruges primært ved lukning af forløb uden afgørelse. Feltet er obligatorisk ved status fejloprettet. |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
4589 | Id ikke fundet | Id ikke fundet |
9322 | Berigtigelseskommentar er påkrævet for rehabiliteringsforløb med status fejloprettet | Berigtigelseskommentar er påkrævet for rehabiliteringsforløb med status fejloprettet |
9332 | En indstilling er påkrævet for RehabiliteringsforloebStatus 3 og 4 | En indstilling er påkrævet for RehabiliteringsforloebStatus 3 og 4 |
9330 | Et 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. |
9323 | Kun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladt | Kun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladt |
9324 | Kun et rehabiliteringsforløb med RehabiliteringsforloebStatus 4 er tilladt | Kun et rehabiliteringsforløb med RehabiliteringsforloebStatus 4 er tilladt |
CreateRehabiliteringsforloeb (POST /v1/Rehabiliteringsforloeb)
Opretter et rehabiliteringsforløb, som er en paraply over den forberedende del og indstillingen
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 |
|---|---|---|---|---|---|---|---|---|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
borgerindsats.rehabilitering.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 |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | uuid |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
9323 | Kun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladt | Kun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladt |
9348 | Det angivne RehabiliteringsforloebId findes allerede i systemet | Det angivne RehabiliteringsforloebId findes allerede i systemet |
GetSenesteRehabiliteringsforloeb (GET /v1/Rehabiliteringsforloeb)
Henter et rehabiliteringsforløb
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 |
|---|---|---|---|---|---|---|---|---|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
borgerindsats.rehabilitering.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 |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetRehabiliteringsforloebResponseDto |
| 1 |
|
- rehabiliteringsforloeb | RehabiliteringsforloebDto |
| 0 - 1 |
|
- - rehabiliteringsforloebId | uuid |
| 1 | Nøgle på forløbet. |
- - rehabiliteringsforloebStatus |
| 1 |
| |
- - indstillingId | uuid |
| 0 - 1 | Reference til indstillingen. Kan hentes via RecommendedInitiativeService.orløbet. |
- - screeningId | uuid |
| 0 - 1 | Reference til borgers Min situation, som teknisk er en Screening, der kan hentes via Screeningsservice. |
- - berigtigelseskommentar | string | Length: 1-1500 | 0 - 1 | Kommentar, bruges primært ved lukning af forløb uden afgørelse. Feltet er obligatorisk ved status fejloprettet. |
- - oprettelsesdato | date-time |
| 1 | Oprettelsesdato i DFDG |
- - senesteOpdateringsdato | date-time |
| 1 | Seneste opdateringsdato i DFDG |
- - dokumenter | RehabiliteringsdokumentMetadataDtoCollection |
| 1 | Metadata for alle dokumenter der er knyttet til forløbet. |
- - - RehabiliteringsdokumentMetadataDto | RehabiliteringsdokumentMetadataDto |
| 0 - * |
|
- - - - dokumentId | uuid |
| 1 | ID på dokument. |
- - - - dokumentTitel | string | Length: 1-250 | 1 | Titlen på dokument. |
- - - - rehabiliteringsdokumentType |
| 1 |
| |
- - - - dokumentExtensionType |
| 1 |
| |
- - - - dokumentStatusType |
| 1 |
| |
- - - - dfdgRegistreringstidspunkt | date-time |
| 1 | Tidspunkt for registering af dokumentet. Er sat af DFDG. |
- - - - senesteOpdateringstidspunkt | date-time |
| 1 | Tidspunkt for opdatering af dokumentet. Er sat af DFDG. |
- - - - slettetTidspunkt | date-time |
| 0 - 1 | Tidspunkt for hvornår dokumentet er slettet. Er sat af DFDG. |
- - - - berigtigelseskommentar | string | Length: 1-1500 | 0 - 1 | Kommentar, bruges primært ved lukning af forløb uden afgørelse. Feltet er obligatorisk ved status fejloprettet. |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
4589 | Id ikke fundet | Id ikke fundet |
9322 | Berigtigelseskommentar er påkrævet for rehabiliteringsforløb med status fejloprettet | Berigtigelseskommentar er påkrævet for rehabiliteringsforløb med status fejloprettet |
9332 | En indstilling er påkrævet for RehabiliteringsforloebStatus 3 og 4 | En indstilling er påkrævet for RehabiliteringsforloebStatus 3 og 4 |
9330 | Et 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. |
9323 | Kun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladt | Kun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladt |
9324 | Kun et rehabiliteringsforløb med RehabiliteringsforloebStatus 4 er tilladt | Kun et rehabiliteringsforløb med RehabiliteringsforloebStatus 4 er tilladt |
CreateRehabiliteringsdokumentMedId (POST /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId}/dokument/{dokumentId})
Opretter et dokument i forbindelse med et rehabliteringsforløbs forberedende eller indstillende del.
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 |
|---|---|---|---|---|---|---|---|---|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
borgerindsats.rehabilitering.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 |
rehabiliteringsforloebId [Path] | uuid |
| 1 | Nøgle på forløbet. |
dokumentId [Path] | uuid |
| 1 | ID på dokument. Hvis ikke angivet sætter DFDG en GUID. |
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 | CreateRehabiliteringsdokumentRequestDto |
| 1 |
|
- titel | string | Length: 1-250 | 1 | Titlen på dokumentet. |
- rehabiliteringsdokumentType |
| 1 |
| |
- dokumentExtensionType |
| 1 |
| |
- dokumentdata | base64Binary | MinLength: 1 | 1 | Indholdet af rehabiliteringsforløbsdokumentet i binær form. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | uuid |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
4589 | Id ikke fundet | Id ikke fundet |
9325 | I regi af rehabiliteringsforløbet er kun PDF lovlig | I regi af rehabiliteringsforløbet er kun PDF lovlig |
9349 | Det angivne DokumentId findes allerede i systemet | Det angivne DokumentId findes allerede i systemet |
GetRehabiliteringsdokument (GET /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId}/dokument/{dokumentId})
Henter et dokument.
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 |
|---|---|---|---|---|---|---|---|---|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
borgerindsats.rehabilitering.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 |
rehabiliteringsforloebId [Path] | uuid |
| 1 | Nøgle på forløbet. |
dokumentId [Path] | uuid |
| 1 | ID på dokument. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetRehabiliteringsdokumentResponseDto |
| 1 |
|
- dokumentdata | base64Binary |
| 1 | Indholdet af rehabiliteringsforløbsdokumentet i binær form. |
- dokumentTitel | string | MinLength: 1 | 1 | Titlen på dokumentet. |
- rehabiliteringsdokumentType |
| 1 |
| |
- dokumentExtensionType |
| 1 |
| |
- dokumentStatusType |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
4589 | Id ikke fundet | Id ikke fundet |
8103 | Dokumentet findes ikke | Dokumentet findes ikke |
UpdateRehabiliteringsdokument (PUT /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId}/dokument/{dokumentId})
Opdaterer et dokument og metadata i forbindelse med en rehabliteringsforløbs forberedende eller indstillende del.
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 |
|---|---|---|---|---|---|---|---|---|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
borgerindsats.rehabilitering.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 |
rehabiliteringsforloebId [Path] | uuid |
| 1 | Nøgle på forløbet. |
dokumentId [Path] | uuid |
| 1 | ID på dokument. |
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 | UpdateRehabiliteringsdokumentRequestDto |
| 1 |
|
- titel | string | Length: 1-250 | 1 | Titlen på dokumentet. |
- rehabiliteringsdokumentType |
| 1 |
| |
- dokumentExtensionType |
| 1 |
| |
- dokumentdata | base64Binary |
| 0 - 1 | Indholdet af rehabiliteringsforløbsdokumentet i binær form. Hvis dokumentet ikke medsendes opdateres alene metadata vedr. dokumentet. |
- berigtigelseskommentar | string | Length: 1-1500 | 0 - 1 | Kommentar, bruges primært ved inaktivering og sletning af dokument. |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
4589 | Id ikke fundet | Id ikke fundet |
9325 | I regi af rehabiliteringsforløbet er kun PDF lovlig | I regi af rehabiliteringsforløbet er kun PDF lovlig |
8103 | Dokumentet findes ikke | Dokumentet findes ikke |
DeleteRehabiliteringsdokument (DELETE /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId}/dokument/{dokumentId})
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 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 |
|---|---|---|---|---|
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 |
rehabiliteringsforloebId [Path] | uuid |
| 1 | Nøgle på forløbet. |
dokumentId [Path] | uuid |
| 1 | ID på dokument. |
berigtigelseskommentar [Query] | string | MaxLength: 1500 | 0 - 1 | Kommentar, bruges primært ved inaktivering og sletning af dokument. |
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 |
|---|---|---|
4589 | Id ikke fundet | Id ikke fundet |
8103 | Dokumentet findes ikke | Dokumentet findes ikke |
CreateRehabiliteringsdokument (POST /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId}/dokument)
Opretter et dokument i forbindelse med et rehabliteringsforløbs forberedende eller indstillende del.
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 |
|---|---|---|---|---|---|---|---|---|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
borgerindsats.rehabilitering.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 |
rehabiliteringsforloebId [Path] | uuid |
| 1 | Nøgle på forløbet. |
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 | CreateRehabiliteringsdokumentRequestDto |
| 1 |
|
- titel | string | Length: 1-250 | 1 | Titlen på dokumentet. |
- rehabiliteringsdokumentType |
| 1 |
| |
- dokumentExtensionType |
| 1 |
| |
- dokumentdata | base64Binary | MinLength: 1 | 1 | Indholdet af rehabiliteringsforløbsdokumentet i binær form. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | uuid |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
4589 | Id ikke fundet | Id ikke fundet |
9325 | I regi af rehabiliteringsforløbet er kun PDF lovlig | I regi af rehabiliteringsforløbet er kun PDF lovlig |
9349 | Det angivne DokumentId findes allerede i systemet | Det angivne DokumentId findes allerede i systemet |