Borgerindsats.RehabiliteringsforloebService (Version 1, 2024-2)

STAR

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

response

uuid

1

STAR

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

response

ActionResult

1

STAR

externalIdentifier [Path]

uuid

1

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

STAR

externalGroupIdentifier [Query]

uuid

0 - 1

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

STAR

response

GetDynamicTextGroupDtoCollection

1

-    GetDynamicTextGroupDto

GetDynamicTextGroupDto

0 - *

-    -    externalIdentifier

uuid

1

-    -    name

string

MinLength: 1

1

STAR

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

response

ActionResult

1

JobCenter

Kommune

STAR

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

response

uuid

1

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

JobCenter

Kommune

STAR

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

RehabiliteringsforloebStatusCodeList

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.

4589

Id ikke fundet

Id ikke fundet

JobCenter

Kommune

STAR

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.

response

GetRehabiliteringsforloebResponseDto

1

-    rehabiliteringsforloeb

RehabiliteringsforloebDto

0 - 1

-    -    rehabiliteringsforloebId

uuid

1

Nøgle på forløbet.

-    -    rehabiliteringsforloebStatus

RehabiliteringsforloebStatusCodeList

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

RehabiliteringsdokumentTypeCodeList

1

-    -    -    -    dokumentExtensionType

DokumentTypeCodeList

1

-    -    -    -    dokumentStatusType

DokumentStatusCodeList

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.

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

JobCenter

Kommune

STAR

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

response

uuid

1

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

JobCenter

Kommune

STAR

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

response

GetRehabiliteringsforloebResponseDto

1

-    rehabiliteringsforloeb

RehabiliteringsforloebDto

0 - 1

-    -    rehabiliteringsforloebId

uuid

1

Nøgle på forløbet.

-    -    rehabiliteringsforloebStatus

RehabiliteringsforloebStatusCodeList

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

RehabiliteringsdokumentTypeCodeList

1

-    -    -    -    dokumentExtensionType

DokumentTypeCodeList

1

-    -    -    -    dokumentStatusType

DokumentStatusCodeList

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.

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

JobCenter

Kommune

STAR

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

RehabiliteringsdokumentTypeCodeList

1

-    dokumentExtensionType

DokumentTypeCodeList

1

-    dokumentdata

base64Binary

MinLength: 1

1

Indholdet af rehabiliteringsforløbsdokumentet i binær form.

response

uuid

1

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

JobCenter

Kommune

STAR

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.

response

GetRehabiliteringsdokumentResponseDto

1

-    dokumentdata

base64Binary

1

Indholdet af rehabiliteringsforløbsdokumentet i binær form.

-    dokumentTitel

string

MinLength: 1

1

Titlen på dokumentet.

-    rehabiliteringsdokumentType

RehabiliteringsdokumentTypeCodeList

1

-    dokumentExtensionType

DokumentTypeCodeList

1

-    dokumentStatusType

DokumentStatusCodeList

1

4589

Id ikke fundet

Id ikke fundet

8103

Dokumentet findes ikke

Dokumentet findes ikke

JobCenter

Kommune

STAR

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

RehabiliteringsdokumentTypeCodeList

1

-    dokumentExtensionType

DokumentTypeCodeList

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.

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

JobCenter

Kommune

STAR

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.