Borgerindsats.MinPlanService (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

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

minPlanVersionId [Path]

uuid

1

response

GetMinPlanResponseDto

1

-    minPlanVersion

MinPlanVersionDto

1

-    -    versionId

uuid

1

Id på versionen af Min Plan

-    -    oprettelsestidspunkt

date-time

1

Tidspunkt for oprettelse af versionen af Min Plan

-    -    oprettendeSagsbehandler

SagsbehandlerDto

1

-    -    -    fornavne

string

Length: 1-50

1

Sagsbehandlerens fornavne.

-    -    -    mellemnavn

string

Length: 1-40

0 - 1

Sagsbehandlerens mellemnavn.

-    -    -    efternavn

string

Length: 1-40

1

Sagsbehandlerens efternavn.

-    -    -    telefonnummer

string

Pattern: (\+)?[0-9]{3,20}

0 - 1

Sagsbehandlerens telefonnummer.

-    -    -    emailadresse

email

0 - 1

Sagsbehandlerens emailadresse.

-    -    -    sagsbehandlerId

string

Length: 1-255

1

Sagsbehandlerens id.

-    -    planVersionHaendelsestyper

PlanVersionHaendelsesTypeCodeListCollection

1

Liste af hændelsestyper der er foretaget på versionen af Min Plan inklusiv aktiveringer

-    -    -    PlanVersionHaendelsesTypeCodeList

PlanVersionHaendelsesTypeCodeList

0 - *

-    -    senestSetAfBorgerTidspunkt

date-time

0 - 1

Tidspunkt hvor borger senest har set versionen af Min Plan

-    -    erDerTidligerePlanerBorgerIkkeHarSet

boolean

1

Indikerer om der er tidligere planer borger ikke har set

-    -    versionsnummer

int32

1

Versionsnummer for versionen af Min Plan

-    -    status

MinPlanStatusDto

1

-    -    -    erValid

boolean

1

Hvis sand (True): MinPlan er valid og aktiv i forhold til borgeren.
Hvis falsk (false): Borgeren har skiftet tilstand således at Min Plan ikke længere er valid / aktiv.

-    -    -    invalidAarsagsType

InvalidAarsagsTypeCodeList

0 - 1

-    -    -    kommentar

string

0 - 1

Kommentar ifm. at plannen sættes valid

-    -    -    aendringstidspunkt

date-time

0 - 1

Tidspunkt for hvornår planen sidst er markeret valid eller invalid

-    -    kontaktgruppeType

ContactGroupTypeCodeList

0 - 1

-    minPlan

MinPlanDto

1

-    -    planVersion

PlanVersionDto

0 - 1

-    -    -    planVersionId

uuid

1

Id for planversionen.

-    -    -    planTypeIdentifier

PlanTypeCodeList

1

-    -    uddannelsesplanId

uuid

0 - 1

Id på uddannelsesplan.

-    -    aktiviteter

AktivitetDtoCollection

1

Samling af aktiviteter.

-    -    -    AktivitetDto

AktivitetDto

0 - *

-    -    -    -    aktivitetId

uuid

1

Id på aktiviteten

-    -    -    -    aktivitetType

AktivitetsTypeCodeList

1

-    -    kravTilJobsoegningId

uuid

0 - 1

Id på det hentede "Krav til jobsøgning".

-    -    afholdtSamtaleJobcenterId

uuid

0 - 1

Id på samtalen afholdt med jobcenter.

-    -    afholdtSamtaleAkasseId

uuid

0 - 1

Id på samtalen afholdt med a-kasse.

-    -    vejledningstekst

string

0 - 1

Indeholder vejledningsteksten til borgerens plan. Kun for borgere med integrationskontrakt.

-    -    integrationslovsdataId

uuid

0 - 1

Id på den hentede udgave af borgerens integrationslovsdata

110001

Person findes ikke for det angivne CPR-nummer

Person findes ikke for det angivne CPR-nummer

8306

MinPlan findes ikke

MinPlan findes ikke

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

GetMinPlanResponseDto

1

-    minPlanVersion

MinPlanVersionDto

1

-    -    versionId

uuid

1

Id på versionen af Min Plan

-    -    oprettelsestidspunkt

date-time

1

Tidspunkt for oprettelse af versionen af Min Plan

-    -    oprettendeSagsbehandler

SagsbehandlerDto

1

-    -    -    fornavne

string

Length: 1-50

1

Sagsbehandlerens fornavne.

-    -    -    mellemnavn

string

Length: 1-40

0 - 1

Sagsbehandlerens mellemnavn.

-    -    -    efternavn

string

Length: 1-40

1

Sagsbehandlerens efternavn.

-    -    -    telefonnummer

string

Pattern: (\+)?[0-9]{3,20}

0 - 1

Sagsbehandlerens telefonnummer.

-    -    -    emailadresse

email

0 - 1

Sagsbehandlerens emailadresse.

-    -    -    sagsbehandlerId

string

Length: 1-255

1

Sagsbehandlerens id.

-    -    planVersionHaendelsestyper

PlanVersionHaendelsesTypeCodeListCollection

1

Liste af hændelsestyper der er foretaget på versionen af Min Plan inklusiv aktiveringer

-    -    -    PlanVersionHaendelsesTypeCodeList

PlanVersionHaendelsesTypeCodeList

0 - *

-    -    senestSetAfBorgerTidspunkt

date-time

0 - 1

Tidspunkt hvor borger senest har set versionen af Min Plan

-    -    erDerTidligerePlanerBorgerIkkeHarSet

boolean

1

Indikerer om der er tidligere planer borger ikke har set

-    -    versionsnummer

int32

1

Versionsnummer for versionen af Min Plan

-    -    status

MinPlanStatusDto

1

-    -    -    erValid

boolean

1

Hvis sand (True): MinPlan er valid og aktiv i forhold til borgeren.
Hvis falsk (false): Borgeren har skiftet tilstand således at Min Plan ikke længere er valid / aktiv.

-    -    -    invalidAarsagsType

InvalidAarsagsTypeCodeList

0 - 1

-    -    -    kommentar

string

0 - 1

Kommentar ifm. at plannen sættes valid

-    -    -    aendringstidspunkt

date-time

0 - 1

Tidspunkt for hvornår planen sidst er markeret valid eller invalid

-    -    kontaktgruppeType

ContactGroupTypeCodeList

0 - 1

-    minPlan

MinPlanDto

1

-    -    planVersion

PlanVersionDto

0 - 1

-    -    -    planVersionId

uuid

1

Id for planversionen.

-    -    -    planTypeIdentifier

PlanTypeCodeList

1

-    -    uddannelsesplanId

uuid

0 - 1

Id på uddannelsesplan.

-    -    aktiviteter

AktivitetDtoCollection

1

Samling af aktiviteter.

-    -    -    AktivitetDto

AktivitetDto

0 - *

-    -    -    -    aktivitetId

uuid

1

Id på aktiviteten

-    -    -    -    aktivitetType

AktivitetsTypeCodeList

1

-    -    kravTilJobsoegningId

uuid

0 - 1

Id på det hentede "Krav til jobsøgning".

-    -    afholdtSamtaleJobcenterId

uuid

0 - 1

Id på samtalen afholdt med jobcenter.

-    -    afholdtSamtaleAkasseId

uuid

0 - 1

Id på samtalen afholdt med a-kasse.

-    -    vejledningstekst

string

0 - 1

Indeholder vejledningsteksten til borgerens plan. Kun for borgere med integrationskontrakt.

-    -    integrationslovsdataId

uuid

0 - 1

Id på den hentede udgave af borgerens integrationslovsdata

110001

Person findes ikke for det angivne CPR-nummer

Person findes ikke for det angivne CPR-nummer

8306

MinPlan findes ikke

MinPlan findes ikke

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

GetMinPlanVersionerResponseDto

1

-    minPlanVersioner

MinPlanVersionBaseDtoCollection

1

Liste af versioner af Min Plan

-    -    MinPlanVersionBaseDto

MinPlanVersionBaseDto

0 - *

-    -    -    versionId

uuid

1

Id på versionen af Min Plan

-    -    -    oprettelsestidspunkt

date-time

1

Tidspunkt for oprettelse af versionen af Min Plan

-    -    -    oprettendeSagsbehandler

SagsbehandlerDto

1

-    -    -    -    fornavne

string

Length: 1-50

1

Sagsbehandlerens fornavne.

-    -    -    -    mellemnavn

string

Length: 1-40

0 - 1

Sagsbehandlerens mellemnavn.

-    -    -    -    efternavn

string

Length: 1-40

1

Sagsbehandlerens efternavn.

-    -    -    -    telefonnummer

string

Pattern: (\+)?[0-9]{3,20}

0 - 1

Sagsbehandlerens telefonnummer.

-    -    -    -    emailadresse

email

0 - 1

Sagsbehandlerens emailadresse.

-    -    -    -    sagsbehandlerId

string

Length: 1-255

1

Sagsbehandlerens id.

-    -    -    planVersionHaendelsestyper

PlanVersionHaendelsesTypeCodeListCollection

1

Liste af hændelsestyper der er foretaget på versionen af Min Plan inklusiv aktiveringer

-    -    -    -    PlanVersionHaendelsesTypeCodeList

PlanVersionHaendelsesTypeCodeList

0 - *

-    -    -    senestSetAfBorgerTidspunkt

date-time

0 - 1

Tidspunkt hvor borger senest har set versionen af Min Plan

-    -    -    erDerTidligerePlanerBorgerIkkeHarSet

boolean

1

Indikerer om der er tidligere planer borger ikke har set

-    -    -    versionsnummer

int32

1

Versionsnummer for versionen af Min Plan

-    -    -    status

MinPlanStatusDto

1

-    -    -    -    erValid

boolean

1

Hvis sand (True): MinPlan er valid og aktiv i forhold til borgeren.
Hvis falsk (false): Borgeren har skiftet tilstand således at Min Plan ikke længere er valid / aktiv.

-    -    -    -    invalidAarsagsType

InvalidAarsagsTypeCodeList

0 - 1

-    -    -    -    kommentar

string

0 - 1

Kommentar ifm. at plannen sættes valid

-    -    -    -    aendringstidspunkt

date-time

0 - 1

Tidspunkt for hvornår planen sidst er markeret valid eller invalid

-    -    -    kontaktgruppeType

ContactGroupTypeCodeList

0 - 1

110001

Person findes ikke for det angivne CPR-nummer

Person findes ikke for det angivne CPR-nummer

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

minPlanVersionId [Path]

uuid

1

aendringskommentar [Query]

string

0 - 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

110001

Person findes ikke for det angivne CPR-nummer

Person findes ikke for det angivne CPR-nummer

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

minPlanVersionId [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

110001

Person findes ikke for det angivne CPR-nummer

Person findes ikke for det angivne CPR-nummer

8306

MinPlan findes ikke

MinPlan findes ikke

8302

Kun nuvaerende MinPlan kan markeres som set

Kun nuvaerende MinPlan kan markeres som set

8303

Nuvaerende MinPlan er allerede markeret som set

Nuvaerende MinPlan er allerede markeret som set

8308

Kan ikke markere MinPlan som set da denne er invalid

Kan ikke markere MinPlan som set da denne er invalid