Borgerindsats.BorgerindsatsStatusService (Version 1 [UDV], 2025-2)

A-kasse

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

GetBorgerindsatsStatusResponseDto

1

Borgerindsats status

-    rehabiliteringsforloeb

RehabiliteringsforloebInfoDto

0 - 1

Information om borgerens eventuelle rehabiliteringsforløb.

-    -    rehabiliteringsforloebListe

RehabiliteringsforloebDtoCollection

1

Liste af borgerens igangværende og afsluttede Rehabiliteringsforløb.Indeholder også forløb markeret som fejloprettet.

-    -    -    RehabiliteringsforloebDto

RehabiliteringsforloebDto

0 - *

-    -    -    -    rehabiliteringsforloebId

uuid

1

Nøgle på forløbet.

-    -    -    -    rehabiliteringsforloebStatus

RehabiliteringsforloebStatusCodeList

1

-    -    -    -    oprettelsesdato

date-time

1

Oprettelsesdato i DFDG

-    -    -    -    senesteOpdateringsdato

date-time

1

Seneste opdateringsdato i DFDG

-    aktiviteter

AktiviteterDto

0 - 1

Information om borgerens eventuelle aktiviteter. Incl. historiske data.

-    -    aktiviteter

AktivitetDtoCollection

1

Liste af borgerens igangværende og afsluttede aktiviteter.

-    -    -    AktivitetDto

AktivitetDto

0 - *

-    -    -    -    aktivitetIdentifier

uuid

1

Entydig identifikation af aktiviteten.

-    -    -    -    startDato

date-time

1

Startdato for den pågældende aktivitet. Det er forretningsmæssigt en dato og der skal ses bort fra tidsangivelse.

-    -    -    -    slutDato

date-time

0 - 1

Slutdato for den pågældende aktivitet. Det er forretningsmæssigt en dato og der skal ses bort fra tidsangivelse.

-    -    -    -    aktivitetType

AktivitetsTypeCodeList

1

-    -    -    -    aktivitetsstatusType

AktivitetsStatusTypeCodeList

1

-    -    -    -    ansvarligMyndighed

AnsvarligMyndighedDto

1

Ansvarlig myndighed.

-    -    -    -    -    myndighed

MyndighedDto

1

Angivelse af den ansvarlige myndighed.

-    -    -    -    -    -    organisationskode

string

MinLength: 1

1

Myndighedskode.

-    -    -    -    -    -    organisationType

OrganisationTypeCodeList

0 - 1

-    minPlan

MinPlanDto

1

Status der indikerer om MinPlan er i en valid eller invalid tilstand. Hvis status er i en Invalid tilstand, vil der forekomme en dato for, hvornår planen blev invalideret samt en årsagskode - f.eks. kontaktgruppeskift eller afmelding.

-    -    minPlanVersion

MinPlanVersionDto

1

Indeholder metainformationer om pågældende version af Min Plan.

-    -    -    versionId

uuid

1

Objekt ID´et for MyPlanVersionType objektet.

-    -    -    oprettelsestidspunkt

date-time

1

Datotid for hvornår MyPlanVersionen er blevet dannet.

-    -    -    planVersionHaendelsestyper

PlanVersionHaendelsesTypeCodeListCollection

1

Indeholder liste af handlingstyper, der er foretaget på en plan inklusiv aktiveringer.

-    -    -    -    PlanVersionHaendelsesTypeCodeList

PlanVersionHaendelsesTypeCodeList

0 - *

-    -    -    status

MinPlanStatusDto

1

Status der indikerer om MinPlan er i en valid eller invalid tilstand. Hvis status er i en Invalid tilstand, vil der forekomme en dato for, hvornår planen blev invalideret samt en årsagskode - f.eks. kontaktgruppeskift eller afmelding.

-    -    -    -    erValid

boolean

1

If true: MyPlan is valid in context of the state of the citizen If false: The citizen has changed state and the MyPlan is no longer valid.

-    -    -    -    invalidAarsagsType

InvalidAarsagsTypeCodeList

0 - 1

-    integrationslovsdata

IntegrationslovsdataDto

0 - 1

Information om borgerens eventuelle seneste integrationskontrakt.

-    -    integrationslovsdataIdentifier

uuid

1

Unik identifikation for den hentede udgave af borgerens integrationskontakt.

-    -    kontraktvarighed

KontraktvarighedDto

0 - 1

Varighed.

-    -    -    foersteUnderskriftsdato

date-time

0 - 1

Dato for underskrift af første kontrakt er samtidig startdato for integrationskontrakten.

-    -    -    programStartdato

date-time

0 - 1

Startdato for integrationsprogrammet.

-    -    -    programSlutdato

date-time

0 - 1

Slutdato for integrationsprogrammet.

-    -    -    kontraktSlutdato

date-time

0 - 1

Slutdato for integrationskontrakten.

- udbAbonnement

 UdbAbonnementDto

Borger abonnement til UDB (ungedatabasen)

-    - harAbonnement

(IsSubscriber)

boolean

1

Angiver om borgeren er tilmeldt Ungedatabasen (UDB)

-    - abonnementsstarttidspunkt

(SubscriptionStartDate)

dateTime

0 - 1

Angiver startdatoen for hvornår DFDG ønsker at modtage hændelser fra UDB

-    - dfdgRegistreringstidspunkt

(SubscribeRegistrationDate)

dateTime

0 - 1

Angiver tidspunktet, hvor DFDG har registreret tilmelding til UDB

-    - udbRegistreringstidspunkt

(UdbSubscribeDate)

dateTime

0 - 1

Angiver det tidspunkt, hvor borgeren rent faktisk er blevet tilmeldt UDB. Dette sker i et asynkront kald, hvorfor der typisk vil være forskel på dfdgregistreringstidspunkt og udbregistreringstidspunkt

-    - dfdgAfregistreringstidspunkt

(UnsubscribeRegistrationDate)

dateTime

0 - 1

Angiver tidspunktet, hvor DFDG har registreret en afmelding fra UDB

-    - Afregistreringstidspunkt

(UdbUnsubscribeDate)

dateTime

0 - 1

Angiver det faktiske tidspunkt, hvor afmeldingen fra UDB har fundet sted

-    - abonnementOphoersAarsagType

(SubscriptionCancellationCauseIdentifier)

Borgerindsats.AbonnementOphoersAarsagTypeCodeList

(gl DFDG EducationSubscriptionCancellationCauseType)

0 - 1

Angiver årsagen til ophør.

110001

Person findes ikke for det angivne CPR-nummer

Person findes ikke for det angivne CPR-nummer

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