Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Siden opdateres af FA i forbindelse med HOI

...

(Erstatter GetLegalMyPlan, GetCitizenDraftMyPlanGetMyPlan)

Returnerer seneste version eller den ønskede version af borgerens gældende Min plan

...

Element

Type

Detaljer

Forekomst

Beskrivelse

GetMyPlanVersionsResponse

GetMyPlanVersionsResponseType


1


-    minPlan

(PlanVersions)

MinPlanDto


1

Indholder list af MyPlanVersionType

-    -    minPlanVersion

(MyPlanVersionType)

MyPlanVersionDto


0 - *

Min plan version

-    -    -    minPlanVersionId (MyPlanVersionIdentifier)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Objekt ID´en for minPlanVersion objektet.

-    -    -    minPlanoprettelsesTidspunkt (MyPlanVersionCreatedDate)

dateTime


1

Datotid for hvornår MyPlanVersionen er blevet dannet

-    -    - oprettendeSagsbehandler

(CreatedBy)

sagsbehandlerDto

1

Angivelse af den sagsbehandler der har været ansvarlig for at en ny version MinPlan er blevet dannet.

-    -    -    - fornavne

(CaseWorkerGivenName)

string

Length: 1-50

1

Sagsbehandlerens fornavn.

-    -    -    - mellemnavn (CaseWorkerMiddleName)

string

Length: 1-40

0 - 1

Sagsbehandlerens mellemnavn.

-    -    - - efternavn

(CaseWorkerSurname)

string

Length: 1-40

1

Sagsbehandlerens efternavn.

- -    -    -    telefonnummer

(TelephoneNumberIdentifier)

string

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

0 - 1

Sagsbehandlerens telefonnummer

- -    -    -    emailadresse (EmailAddressIdentifier)

string

Pattern: ([^>\(\)\[\]\\,;:@\s]{0,191}@[^>\(\)\[\]\\,;:@\s]{1,64})

0 - 1

Sagsbehandlerens e-mailadresse

- -    -    -    sagsbehandlerId (CaseWorkerIdentifier)

string

Length: 1-255

1

Sagsbehandlerens ID.

-    -    - handlingstyper

(Events)

handlingstyperDto

0 - 1

Indholder list af de handlingstyper der er fortaget på en plan inklusiv aktiveringer

-    -    -    - planversionHaendelsesType

(PlanVersionEventTypeIdentifierType)

Borgerindsats.PlanVersionHaendelsesTypeCodeList

(Gl. DFDG PlanVersionEventTypeIdentifierType)

0 - *

Anledning til planversion

-    -    -    Acknowledgement

AcknowledgeType


1

Indeholder information omkring kvittering

-    -    -    kvitteringsTidspunkt

(AcknowledgeDate)

dateTime

0 - 1

Dato hvor der er kvitteret

-    -    -    -    DeadlineForAcknowledge

date


0 - 1

Frist for kvittering. Er null hvis planen ikke er valid.

-    -    -    -    AcknowledgeByCaseworker

AcknowledgeByCaseworkerType


0 - 1

Hvis planen er kvitteret af sagsbehandler på vegne af borger, vil dette element indeholde detaljer.Hvis dette element er null samtidig med at AcknowledgeDate er sat ==>planen er kvitteret af borgeren selv

-    -    -    -    -    AcknowledgeCause

string

Length: 1-1000

1

Årsagsbeskrivelse for hvor sagsbehandler har kvitteret på vegne af borger

-    -    -    -    -    ResponsibleCaseWorkerStructureType

ResponsibleCaseWorkerStructureType


1

Hvis en sagsbehandler har kvitteret for MinPlan (på vegne af borger)

-    -    -    -    -    -    CaseWorkerGivenName

string

Length: 1-50

1

Sagsbehandlerens fornavn.

-    -    -    -    -    -    CaseWorkerMiddleName

string

Length: 1-40

0 - 1

Sagsbehandlerens mellemnavn.

-    -    -    -    -    -    CaseWorkerSurname

string

Length: 1-40

1

Sagsbehandlerens efternavn.

-    -    -    -    -    -    TelephoneNumberIdentifier

TelephoneNumberIdentifierType
Base: string

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

0 - 1

Sagsbehandlerens telefonnummer

-    -    -    -    -    -    EmailAddressIdentifier

EmailAddressIdentifierType
Base: string

Pattern: ([^>\(\)\[\]\\,;:@\s]{0,191}@[^>\(\)\[\]\\,;:@\s]{1,64})

0 - 1

Sagsbehandlerens e-mailadresse

-    -    -    -    -    -    CaseWorkerIdentifier

string

Length: 1-255

1

Sagsbehandlerens ID.

-    -    - versionsnummer

(VersionNumber)

int

1

Versionsnummer for den pågældende plan.

-    -    - minPlanStatus (MyPlanValidationStatus)

MinPlanStatusDto

1

Statussen 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 

(IsValid)

boolean

1

Hvis sand er planen valid i forhold til den kontekststatus borger har. Hvis falsk har borger skiftet status og min plan er dermed ikke i en valid tilstand

-    -    -    - invalidAarsagsType

(MyPlanInvalidCauseIdentifier)

Borgerindsats.MinplanStatusAarsag

(Gl. DFDG MyPlanInvalidCauseIdentifierType)

0 - 1

Hvis Min plan status er invalid indeholdes årsagen her

- -    -    -    kommentar (MarkedAsValidCorrectionComment)

string

0 - 1

Kommentar ifm. at plannen sættes valid

- -    -    -    aendringstidspunkt (ChangedDateTime)

dateTime

0 - 1

Dette felt indikerer hvornår planen sidst er markeret valid eller invalid.

- -    -    kontaktgruppeType

(ContactGroupTypeIdentifier)

ContactGroupTypeIdentifierType

0 - 1

Fortæller hvilken kontaktgruppe borgeren havde på det tidpunkt versionen af MinPlan blev dannet.

...

Fejlkode

Fejltekst

Beskrivelse

1010

Unknown cpr

The submitted cpr is unknown to the system

6005

The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader

The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader

UpdateMinPlan (PUT /v1/Minplan/{minplanversionId}/action/SetMinPlanSet)

(Erstatter AcknowledgeMyPlan)

Denne metode gør det muligt marker at borgeren har set Min plan.

Tilladte organisationer

 

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

STAR

X

 

 

 

 

 

A-kasse

X

JobCenter

X

X

Kommune

X

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

MarkMyPlanAsValidRequest

MarkMyPlanAsValidRequestType

1

- x-civilRegistrationIdentifier [Header]

(CvCustomerIdentifier)

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

Personnummer

- minPlanVersionId

(MyPlanVersionIdentifier)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Objekt ID´en for minPlanVersion objektet.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

AcknowledgeMyPlanResponse

EmptyResponseType

 

1

Tom kvittering

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1010

Unknown cpr

The submitted cpr is unknown to the system

4400

CV Customer Number is unknown

The supplied CV Customer Number is unknown to the system

8302

Kun seneste version af Min plan kan markeres set

(Only current MyPlan can be acknowledged)

Kun seneste version af Min plan kan markeres set

(Only current MyPlan can be acknowledged)

8303

Seneste version af Min plan er allerede markeret set

(Current MyPlan has already been acknowledged)

Seneste version af Min plan er allerede markeret set

(Current MyPlan has already been acknowledged)

8306

Min plan findes ikke

(My plan does not exists)

Min plan findes ikke

(My plan does not exists)

8308

Det er ikke muligt markere Min plan set, da den er invalid

(Unable to acknowledge Myplan because Myplan is invalid)

Det er ikke muligt markere Min plan set, da den er invalid

(Unable to acknowledge Myplan because Myplan is invalid)


Metoder der udgår

GetCitizenDraftMyPlan

...