Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Siden opdateres automatisk til at afspejle koden. CodeFirst.

Metoder

CreatePlan (POST /v1/Plan/{planversionId?})

Opretter en kerneplan.

(Erstatter Gl. DFDG metode CreateDraftPlan, SavePlanObjective, PublishPlan)

Tilladte organisationer

 

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

A-kasse

 

X

 

 

 

 

JobCenter

 

X

 

 

X

 

STAR

X

 

 

 

 

 

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

xxxObjectiveRequest

xxxObjectiveRequestType

 

1

 

- x-civilRegistrationIdentifier [Header]

(PersonCivilRegistrationIdentifier)

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

- planversionId [From Route]

guid
Base: string

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

0 - 1

Unik identifikation for den oprettede entitet.

CreatePlanDto

- plantype

(PlanTypeIdentifier)

Borgerindsats.PlanTypeCodeList

(Gl. DFDG PlanTypeIdentifierType)

 

1

Type af plan f.eks. Generel, Jobplan, Uddannelsesplan m.f..

- planmaal

(PlanObjective)

planmaalDto

 

1

Planmål omfatter den genereske del af alle planer, hvor planbeskrivelse og planen hovedmål defineres.

- - planmaalId

(PlanObjectiveIdentifier)

guid
Base: string

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

0 - 1

Objekt id'en for planmål. Ved servicekald hvor dette planmål anvendes som argument skal planmaalId elementet fjernes

- - planbeskrivelse

(PlanDescription)

string

 Length: 1-4050

0 - 1

Beskrivelse af indsatsen i planen som vises for borger. Der er ingen tekstmæssige begrænsning for dette felt, men det anbefales dog at holde sig til en kort, klar og entydig beskrivelse

- - maalListe

(GoalCollection)

MaalListeDto

 

1

Collection indeholdende de mål, der er tilknyttet planen. Bemærk at hvis planen er af typen jobplan må der kun være 1 mål af typen ESCO STAR eller fritekst.

- -    - maal

(GoalType)

maalDto

 

0 - *

Måltype

- -    -    - maalId

(GoalIdentifier)

guid
Base: string

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

0 - 1

Id for pågældende mål. Sættes af DFDG.

- -    -    - maalKodeType

(GoalCodeTypeIdentifier)

Borgerindsats.MaalKodeTypeCodeList

(Gl. DFDG GoalCodeTypeIdentifierType)

 Length: 1-4050

1

Type der specificere om måltypen er ESCO STAR, AMU, DUN eller fritekst.

- -    -    - maalKode

(GoalCode)

string

 Length: 1-256

0 - 1

Kode for henholdsvis ESCO STAR AMU, DUN. EX: Hvis feltet maalKodeType indeholder ESCO STAR, vil feltet maalKode indeholde værdien for et beskæftigelsesmål som stillingsbetegnelse. Er typen ESCO STAR, AMU eller DUN specificeret er feltet påkrævet.

- -    -    - maalbeskrivelse

(GoalDescription)

string

 Length: 1-4050

0 - 1

Er typen fritekst specificeret er feltet påkrævet.Ved læsning: Er målet af typen ESCO STAR, AMU eller DUN vil DFDG sikre, at maalbeskrivelse er udfyldt med typenavnet for den specifikke ESCO STAR -, AMU - eller DUN - kode.

- -    -    - AliasIdentifier

guid
Base: string

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

0 - 1

Hvis målet er af typen ESCO STAR, så kan der være et alias tilknyttet

- -    -    - sorteringsnoegle

(SortOrder)

int

 

1

Angiver rækkefølgen for hvorledes de enkelte mål på Jobnet skal fremvises for borgeren. sorteringsorder skal være unikt for den liste af mål der findes på borgerens planversion - planmaal.maal.

- - ansvarligMyndighed

(ResponsibleAuthority)

AnsvarligMyndighedDto

 

0 - 1

Angivelse af den ansvarlige sagsbehandler.

- -    - myndighed

(AuthorityStructure)

MyndighedDto

 

1

Detaljer på myndigheden.

- -    -    - myndighedskode

(AuthorityCode)

string

Pattern: [-][1]|[0-9]{1,8}

1

Myndighedskode.

- -    -    - myndighedsnavn

(AuthorityName)

string

Length: 1-20

1

Myndighedsnavn.

- -    -    - organisationType

(OrganisationType)

OrganisationTypeIdentifierType

 

1

Myndighedstype.

- -    - sagsbehandler

(CaseWorker)

sagsbehandlerDto

 

1

Detaljer på sagsbehandleren.

- -    -    - 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 email.

- -    -    - sagsbehandlerId

(CaseWorkerIdentifier)

string

Length: 1-255

1

Sagsbehandlerens id.

- - opfoelgningstidspunkt

(FollowupDeadline)

date

 

0 - 1

Opfølgningsdato for sagsbehandler.

- - oprettetTidspunkt

(CreateDate)

dateTime

 

0 - 1

Dato for oprettelse af elementet.Ved servicekald hvor dette planmål anvendes som argument skal planmaalId elementet fjernes

- - opdateretTidspunkt

(LastModifiedDate)

dateTime

 

0 - 1

Dato for hvornår elementet er blevet opdateret. Ved servicekald hvor dette planmål anvendes som argument skal planmaalId elementet fjernes

- uddannelsesplan

(EducationPlan)

UddannelsesplanDto

 

0- 1

Uddannelsesplan. Meddtages kun hvis planentypen er uddannelsesplan

-    - uddannelsesplanId

(EducationPlanIdentifier)

guid
Base: string

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

0 - 1

Objekt ID'en for uddannelsesplan objektet.

-    - fristdato

(DeadlineDate)

dateTime

 

0 - 1

Dato for den frist borgeren er blevet pålagt.

-    - uddannelsesplanTrinType (EducationPlanStepTypeIdentifier)

Borgerindsats.UddannelsesplanTrinTypeCodeList

(Gl DFDG EducationPlanStepTypeIdentifierType)

 

1

Pålægs trin 1-3.

-    - borgerkommentar

(CitizenComment)

string

 

0 - 1

Borgerens kommentar til trinnet.

-    - uddannelser

(EducationCollection)

UddannelserDto

 

1

Indeholder en samling uddannelsesønsker for trin 1. Indeholder en samling af uddannelsessteder for de øvrige trin.

-    -    - uddannelse

(EducationType)

UddannelseDto

 

0 - *

En uddannelse

-    -    -    - uddannelsesId

(EducationIdentifier)

guid
Base: string

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

0 - 1

Dette er objekt id'en for pågældende uddannelse. Ved servicekald hvor uddannelse anvendes som argument og elementet uddannelsesId ikke er medtaget, vil DFDG oprettet et nyt uddannelsesobjekt.

-    -    -    - uddannelsesoenske

(EducationWish)

string

 

0 - 1

Dette er borgerens uddannelsesønske

-    -    -    - maalId

(GoalIdentifier)

guid
Base: string

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

0 - 1

Dette er en relation til et af planens hovedmål – planmaal.maal. Skal sættes på trin 2+3.

-    -    -    - uddannelsesnavn

(EducationName)

string

 

0 - 1

Navnet på uddannelsen Fx: Maskinsnedker

-    -    -    - lokationsnavn

(EducationLocationName)

string

 

0 - 1

Uddannelses lokationsnavn Fx: Københavns Tekniske Skole.

-    -    -    - lokationsadresse (EducationLocationAddress)

LokationsadresseDto

 

0 - 1

Adresse for uddannelsessted.

-    -    -    -    - adresse

(Address)

string

 

0 - 1

Adresse.

-    -    -    -    - postnummer

(Postal)

string

 

0 - 1

Postnummer.

-    -    -    -    - postdistrikt

(City)

string

 

0 - 1

By.

-    -    -    - ansoegningsfrist

(ApplicationDeadlineDate)

dateTime

 

0 - 1

Ansøgningsfrist.

-    -    -    - startdato

(EducationStartDate)

dateTime

 

0 - 1

Uddannelsesstartdato.

-    -    -    - uddannelsesstatusType

(EducationStatusTypeIdentifier)

Borgerindsats.UddannelsesstatusTypeCodeList

(gl. DFDG EducationStatusTypeIdentifierType)

 

1

Uddannelsesforløbsstatus

-    -    -    - sorteringsorder

(SortOrder)

int

 

1

Angiver rækkefølgen for hvorledes de enkelte mål på Jobnet skal fremvises for borgeren.

-    -    -    - cvrEnhedsid

(CVRnumberIdentifier)

string

Length: 8

0 - 1

CVR nummer for uddannelsesstedet.

-    -    -    - pNummer

(ProductionUnitIdentifier)

string

Length: 10

0 - 1

P-nummer for uddannelsesstedet.

  • -    sendtTilSagsbehandlerDato

(ReportToCaseworkerDate)

dateTime

 

0 - 1

Dato for hvornår borgeren har sendt uddannelsesplanen til sagsbehandleren.

-    - sagsbehandlerkommentar

(CaseWorkerComment)

string

 

0 - 1

Kommentar sagsbehandleren kan videregive til uddannelsesinstitutioner omkring borgerens situation ved trin 3.

-    - medJobmaal

(WithJobGoal)

boolean

 

1

Uddannelsesplan med Jobmål eller uden Jobmål. Hvis med jobmål er denne også kaldet en kombiplan

-    - stoettebehov

(EducationRetentionCollection)

StoettebehovDto

 

1

Indeholder en samling af støttebehov m.v. for at den unge kan fastholdes i at gennemføre uddannelsen

-    -    - stoettebehovType

(EducationRetentionTypeIdentifierType)

Borgerindsats.StoettebehovTypeCodeList

(Gl. DFDG EducationRetentionTypeIdentifierType)

 

0 - *

Typen af støttebehov

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

PublishPlanResponse

CreatedResponseType

 

1

Kvittering som indeholder den unikke identifikation for den oprettede entitet

- planversionId

guid
Base: string

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

0 - 1

Unik identifikation for den oprettede entitet.

 

Fejlkoder (lysegrøn er allereder oversat til dansk)

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1001

Invalid cpr

The submitted cpr is either to long or short or contains data not interpretable as a date

1009

Configuration error

System incorrectly configured

1010

Unknown cpr

The submitted cpr is unknown to the system

4013

Unknown Client Destination

Unknown Client Destination

4385

Borger er ikke medlem af en a-kasse

(The client does not have an unemploymentfund registration)

Borger er ikke medlem af en a-kasse

(The client does not have an unemploymentfund registration)

4695

The jobcenter does not exist

The jobcenter does not exist

4971

The ministerial department type identifier is unknown

The ministerial department type identifier is unknown

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

8006

The specified citizen has no draft plan

The specified citizen has no draft plan

8008

Det er kun muligt at læse planmål

(The PlanObjectiveIdentifier is readonly)

Det er kun muligt at læse planmål

(The PlanObjectiveIdentifier is readonly)

8012

Det er kun muligt at læse oprettetTidspunkt

(The CreateDate is readonly)

Det er kun muligt at læse oprettetTidspunkt

(The CreateDate is readonly)

8013

Det er kun muligt at læse opdateretTidspunkt

The LastModified is readonly

Det er kun muligt at læse opdateretTidspunkt

The LastModified is readonly

8015

Goal has to be specified when publishing this plan type

Goal has to be specified when publishing a jobplan or an education plan in step 2 or step 3

8018

The EducationPlanType.DeadlineDate (pålægsfrist) has to be greater than todays date

The EducationPlanType.DeadlineDate (pålægsfrist) has to be greater than todays date

8021

Den angivne plantype er ikke valid

(The specified plan type identifier is not valid)

Den angivne plantype er ikke valid

(The specified plan type identifier is not valid)

8043

Forkert plantype

(Wrong plantype)

Service kan ikke anvendes da forkert plantype er angivet

 

8044

Education plan type is not allowed for citizen above age 30

Education plan type is not allowed for citizen above age 30

8051

Det angivne planmaalId findes ikke

(The specified goal identifier does not exist)

Det angivne planmaalId findes ikke

(The specified goal identifier does not exist)

8052

Det angivne maalKode findes ikke

(The specified goal identifier is in use and cannot be deleted)

Det angivne maalKode findes ikke

(The specified goal identifier is in use and cannot be deleted)

8053

The specified goal does not exist on the education plan

The specified goal does not exist on the education plan

8055

Ansvarlig sagsbehandler skal være angivet

(Responsible caseworker needs to be specified)

Ansvarlig sagsbehandler skal være angivet

(Responsible caseworker needs to be specified)

8060

Operationen er ikke tilladt når borger ikke har en aktiv kontaktgruppe

(Operation is not allowed when citizen has no active contact group)

Operationen er ikke tilladt når borger ikke har en aktiv kontaktgruppe

(Operation is not allowed when citizen has no active contact group)

8061

Jobplanens mål skal være valide en stillingsbetegnelse

(Jobplan goal has to be specified as a valid occupationcode)

Jonplanens mål skal være valide en stillingsbetegnelse

(Jobplan goal has to be specified as a valid occupationcode)

8062

En valid kombination af kontaktgruppe og personkategori er nødvendig.

(A valid combination of contact group and person category is required for publish)

En valid kombination af kontaktgruppe og personkategori er nødvendig.

(A valid combination of contact group and person category is required for publish)

8069

Cancel subscription is not possible. Citizen does not have an education event subscription

Subscription not possible. Citizen does not have an education event subscription

8074

Education plan type is not allowed for citizen above age 25

Education plan type is not allowed for citizen above age 25

8075

Planbeskrivelse overskrider maksimal antal tegn

(Plan description exceeds limit of characters)

Planbeskrivelse overskrider maksimal antal tegn

(Plan description exceeds limit of characters)

8077

When publishing in Step 4, ResponsibleCaseWorker Telephone and Email required

When publishing in Step 4, ResponsibleCaseWorker Telephone and Email required

8116

En jobplan må maksimalt indeholde et mål

(A jobplan must max contain one goal.)

En jobplan må maksimalt indeholde et mål

(A jobplan must max contain one goal.)

8281

Occupation key does not exist

Occupation key does not exist

8282

Occupation key is out of date

Occupation key is out of date

8284

Præcist 1 jobmål skal være angivet

(Exactly one job goal needs to be specified)

Præcist 1 jobmål skal være angivet

(Exactly one job goal needs to be specified)

8285

Mindst 1 jobmål skal være angivet

(At least one education goal needs to be specified)

Mindst 1 jobmål skal være angivet

(At least one education goal needs to be specified)

8287

Job goals not allowed for this plantype

Job goals not allowed for this plantype

8289

Education Plan with job goal not allowed

Education Plan with job goal not allowed

9129

En jobplan skal have mindst et mål

(A Jobplan must contain at least one goal)

En jobplan skal have mindst et mål

(A Jobplan must contain at least one goal)

9131

Invalid CodeListItemIdentifier

Invalid CodeListItemIdentifier

9368

 

 

9369

Kombinationen af borgers kontaktgruppe og personkategori kræver mindst en stillingsbetegnelse

(With citizens combination of ContactGroup and PersonCategory at least one occupationcode is required)

Kombinationen af borgers kontaktgruppe og personkategori kræver mindst en stillingsbetegnelse

(With citizens combination of ContactGroup and PersonCategory at least one occupationcode is required)

9371

Kombinationen af borgers kontaktgruppe og personkategori er kun en stillingsbetegnelse tilladt

With citizens combination of ContactGroup and PersonCategory only an occupation goal is allowed

Kombinationen af borgers kontaktgruppe og personkategori er kun en stillingsbetegnelse tilladt

With citizens combination of ContactGroup and PersonCategory only an occupation goal is allowed

9372

 

 

9428

Målkode er ikke valid

(GoalCodeType is not valid. If EscoStarCode is used in version 4 or DiscoCode is used in version v5)

Målkode er ikke valid

(GoalCodeType is not valid. If EscoStarCode is used in version 4 or DiscoCode is used in version v5)

9439

The person can not be registered with the same ConceptUriDa more than one time

The person can not be registered with the same ConceptUriDa more than one time

GetPlan (Get /v1/Plan/{planversionId})

(Erstatter GL. GetActivePlan, GetDraftPlan, GetPlan)

Henter den ønskede planversion.

Tilladte organisationer

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

A-kasse

X

X

JobCenter

X

X

X

X

STAR

X

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPlanRequest

GetPlanRequestType

1

-    x-civilRegistrationIdentifier [Header]

(PersonCivilRegistrationIdentifier)

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

-    planversionId

(PlanVersionIdentifier)

guid

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

0 - 1

Id for planversionen.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPlanResponse

GetPlanResponseType

1

-    plan

(PlanType)

PlanDto

1

Information om plantypen.

-    -    planversion

(PlanVersion)

PlanversionDto

1

Indeholder plantype, versionsnummer, hvorpå borgeren har kvitteret etc.

-    -    -    planversionId

(PlanVersionIdentifier)

guid

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

1

Id for planversionen.

-    -    -  aktiv

(IsActive)

boolean

1

Dette felt indikerer om borgerens planversion skal være aktiv på Jobnet eller ej. Hvis planAkitv er False vil borgeren ikke kunne editere i planen på Jobnet og modsat hvis planAkitv er True. Logikken styres udfra borgerens kontaktgruppe. Er kombinationen (PlanTypen og Kontaktgruppen imellem) lovlig, vil planAkitv være sat til True. For en udd.plan, trin 3, hvor deadline date er overskedet, vil planAkitv flaget altid være False

-    -    -    plantype

(PlanTypeIdentifier)

Borgerindsats.PlanTypeCodeList

(Gl. DFDG PlanTypeIdentifierType)

1

Type af plan f.eks. Generel, Jobplan, Uddannelsesplan m.f..

-    -    -    version

(VersionNumber)

int

1

Versionsnummer for den pågældende plan.

-    -    - versionOprettelsestidspunkt

(VersionCreateDate)

dateTime

1

Oprettelsesdato for pågældende instans af planversionen

-    -    -    dfdgRegistreringstidspunkt

(CreateDate)

dateTime

1

Dato for hvornår elementet er blevet oprettet.

-    -    -    opdateretTidspunkt

(LastModifiedDate)

dateTime

1

Dato for hvornår elementet er blevet opdateret.

-    -    -    planversiontype

(PlanVersionTypeIdentifier)

Borgerindsats.PlanVersionTypeCodeList

(Gl. DFDG PlanVersionTypeIdentifierType)

1

Kodeliste over mulige typer af planversioner.

-    -    -    haendelser

(PlanVersionEventTypes)

haendelserDto

1

Liste for de events der genereres når en ny planversion

-    -    -    -    haendelsesType

(PlanVersionEventTypeIdentifierType)

Borgerindsats.MinPlanVersionHaendelsesTypeCodeList

(Gl. DFDG PlanVersionEventTypeIdentifierType)

0 - *

Anledning til planversion

-    -    -    publiceringMuligIMinPlan (PublishingPossibleInContextOfMyPlan)

boolean

0 - 1

Angiver om planbeskrivelse, mål og aktiviteter er inaktive.

-    -    planmaal

(PlanObjective)

planmaalDto

1

Beskriver målsætningen for borgeren.

-    -    -    planmaalId

(PlanObjectiveIdentifier)

guid
Base: string

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

0 - 1

Objekt id'en for planmål. Ved servicekald hvor dette planmål anvendes som argument skal planmaalId elementet fjernes

-    -    -    planbeskrivelse

(PlanDescription)

string

Length: 1-4050

0 - 1

Beskrivelse af indsatsen i planen som vises for borger. Der er ingen tekstmæssige begrænsning for dette felt, men det anbefales dog at holde sig til en kort, klar og entydig beskrivelse

-    -    -    MaalListe

(GoalCollection)

MaalListeDto

1

Collection indeholdende de mål, der er tilknyttet planen. Bemærk at hvis planen er af typen jobplan må der kun være 1 mål af typen ESCO STAR eller fritekst.

-    -    -    -    maal

(GoalType)

maalDto

0 - *

Måltype

-    -    -    -    -    maalId

(GoalIdentifier)

guid
Base: string

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

0 - 1

Id for pågældende mål. Sættes af DFDG.

-    -    -    -    -    maalKodeType

(GoalCodeTypeIdentifier)

Borgerindsats.MaalKodeTypeCodeList

(Gl. DFDG GoalCodeTypeIdentifierType)

1

Type der specificere om måltypen er ESCO STAR, AMU, DUN eller fritekst.

-    -    -    -    -    maalKode

(GoalCode)

string

Length: 1-256

0 - 1

Kode for henholdsvis ESCO STAR AMU, DUN. EX: Hvis feltet maalKodeType indeholder ESCO STAR, vil feltet maalKode indeholde værdien for et beskæftigelsesmål som stillingsbetegnelse. Er typen ESCO STAR, AMU eller DUN specificeret er feltet påkrævet.

-    -    -    -    -    maalbeskrivelse

(GoalDescription)

string

Length: 1-4050

0 - 1

Er typen fritekst specificeret er feltet påkrævet.Ved læsning: Er målet af typen ESCO STAR, AMU eller DUN vil DFDG sikre, at maalbeskrivelse er udfyldt med typenavnet for den specifikke ESCO STAR -, AMU - eller DUN - kode.

-    -    -    -    -    aliasIdentifier

guid
Base: string

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

0 - 1

Hvis målet er af typen ESCO STAR, så kan der være et alias tilknyttet

-    -    -    -    -    sorteringsnoegle

(SortOrder)

int

1

Angiver rækkefølgen for hvorledes de enkelte mål på Jobnet skal fremvises for borgeren. sorteringsorder skal være unikt for den liste af mål der findes på borgerens planversion - planmaal.maal.

-    -    -    ansvarligMyndighed

(ResponsibleAuthority)

AnsvarligMyndighedDto

0 - 1

Angivelse af den ansvarlige sagsbehandler.

-    -    -    -    myndighed

(AuthorityStructure)

MyndighedDto

1

Detaljer på myndigheden.

-    -    -    -    -    myndighedskode

(AuthorityCode)

string

Pattern: [-][1]|[0-9]{1,8}

1

Myndighedskode.

-    -    -    -    -    myndighedsnavn

(AuthorityName)

string

Length: 1-20

1

Myndighedsnavn.

-    -    -    -    -    organisationType

(OrganisationType)

OrganisationTypeIdentifierType

1

Myndighedstype.

-    -    -    -    sagsbehandler

(CaseWorker)

sagsbehandlerDto

1

Detaljer på sagsbehandleren.

-    -    -    -    -    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 email.

-    -    -    -    -    sagsbehandlerId

(CaseWorkerIdentifier)

string

Length: 1-255

1

Sagsbehandlerens id.

-    -    -    opfoelgningstidspunkt

(FollowupDeadline)

date

0 - 1

Opfølgningsdato for sagsbehandler.

-    -    -    dfdgRegistreringstidspunkt

(CreateDate)

dateTime

0 - 1

Dato for oprettelse af elementet.Ved servicekald hvor dette planmål anvendes som argument skal planmaalId elementet fjernes

-    -    -    opdateretTidspunkt

(LastModifiedDate)

dateTime

0 - 1

Dato for hvornår elementet er blevet opdateret. Ved servicekald hvor dette planmål anvendes som argument skal planmaalId elementet fjernes

-    uddannelsesplan

(EducationPlan)

UddannelsesplanDto

0 - 1

Benyttes til uddannelsespålæg. Hvis plantypen er uddannelsespålæg vil denne være udfyldt.

-    -    uddannelsesplanId

(EducationPlanIdentifier)

guid
Base: string

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

0 - 1

Objekt ID'en for uddannelsesplan objektet. .

-    -    fristdato

(DeadlineDate)

date

0 - 1

Dato for den frist borgeren er blevet pålagt.

-    -    uddannelsesplanTrinType

(EducationPlanStepTypeIdentifier)

Borgerindsats.UddannelsesplanTrinTypeCodeList

(Gl DFDG EducationPlanStepTypeIdentifierType)

1

Pålægs trin 1-3. Trin 1: Tillader borger i kun at tilføje uddannelsesønsker og kommentar. Trin 2a: Tillader borger i at tilføje og ændre uddannelsessteder og kommentar. Trin 2b: Tillader borger i at opdatere optagelsesstatus for den/de enkelte uddannelsessteder.

-    -    borgerkommentar

(CitizenComment)

string

0 - 1

Borgerens kommentar til trinnet.

-    -    uddannelser

(EducationCollection)

UddannelserDto

1

Indeholder en samling uddannelsesønsker for trin 1. Indeholder en samling af uddannelsessteder for de øvrige trin.

-    -    -    uddannelse

(EducationType)

UddannelseDto

0 - *

En uddannelse

-    -    -    -    uddannelsesId

(EducationIdentifier)

guid
Base: string

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

0 - 1

Dette er objekt id'en for pågældende uddannelse.

-    -    -    -    uddannelsesoenske

(EducationWish)

string

0 - 1

Dette er borgerens uddannelsesønske der indtastes på trin1.

-    -    -    -    maalId

(GoalIdentifier)

guid
Base: string

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

0 - 1

Dette er en relation til et af planens hovedmål – planmaal.maal. Skal sættes på trin 2+3.

-    -    -    -    uddannelsesnavn

(EducationName)

string

0 - 1

Navnet på uddannelsen Fx: Maskinsnedker

-    -    -    -    lokationsnavn

(EducationLocationName)

string

0 - 1

Uddannelses lokationsnavn Fx: Københavns Tekniske Skole.

-    -    -    -    lokationsadresse

(EducationLocationAddress)

LokationsadresseDto

0 - 1

Adresse for uddannelsessted.

-    -    -    -    -    adresse

(Address)

string

0 - 1

Adresse.

-    -    -    -    -    postnummer

(Postal)

string

0 - 1

Postnummer.

-    -    -    -    -    postdistrikt

(City)

string

0 - 1

By.

-    -    -    -    Ansoegningsfrist

(ApplicationDeadlineDate)

dateTime

0 - 1

Ansøgningsfrist.

-    -    -    -    startdato

(EducationStartDate)

dateTime

0 - 1

Uddannelsesstartdato.

-    -    -    -    uddannelsesstatusType

(EducationStatusTypeIdentifier)

Borgerindsats.UddannelsesstatusTypeCodeList

(gl. DFDG EducationStatusTypeIdentifierType)

1

Uddannelsesforløbsstatus

-    -    -    -    sorteringsorder

(SortOrder)

int

1

Angiver rækkefølgen for hvorledes de enkelte mål på Jobnet skal fremvises for borgeren.

-    -    -    -    cvrEnhedsid

(CVRnumberIdentifier)

string

Length: 8

0 - 1

CVR nummer for uddannelsesstedet.

-    -    -    -    pNummer

(ProductionUnitIdentifier)

string

Length: 10

0 - 1

P-nummer for uddannelsesstedet.

-    -    sendtTilSagsbehandlerDato

(ReportToCaseworkerDate)

dateTime

0 - 1

Dato for hvornår borgeren har sendt uddannelsesplanen til sagsbehandleren.

-    -    sagsbehandlerkommentar

(CaseWorkerComment)

string

0 - 1

Kommentar sagsbehandleren kan videregive til uddannelsesinstitutioner omkring borgerens situation ved trin 3.

-    -    medJobmaal

(WithJobGoal)

boolean

1

Uddannelsesplan med Jobmål eller uden Jobmål.

-    -    stoettebehov

(EducationRetentionCollection)

StoettebehovDto

1

Indeholder en samling af støttebehov m.v. for at den unge kan gennemføre uddannelsen

-    -    -    stoettebehovType

(EducationRetentionTypeIdentifierType)

Borgerindsats.StoettebehovTypeCodeList

(Gl. DFDG EducationRetentionTypeIdentifierType)

0 - *

Typen af støttebehov

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1010

Unknown cpr

The submitted cpr is unknown to the system

4385

Borger er ikke medlem af en a-kasse

(The client does not have an unemploymentfund registration)

Borger er ikke medlem af en a-kasse

(The client does not have an unemploymentfund registration)

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

8001

En plan med det angivne versionsid kan ikke findes

(A plan with the specified plan version identifier could not be found)

En plan med det angivne versionsid kan ikke findes

(A plan with the specified plan version identifier could not be found)

9203

A-kasse har ikke adgang til at tilgå plan

(UnemploymentFund is not allowed to access plan)

A-kasse har ikke adgang til at tilgå plan

(UnemploymentFund is not allowed to access plan)

GetPlanVersioner (Get /v1/PlanVersioner) Knud de Place (STAR) BEHØVES DENNE???

(erstatter GetPlanVersions)

Henter en list over planversioner

Tilladte organisationer

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

A-kasse

X

X

JobCenter

X

X

X

X

STAR

X

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPlanVersionsRequest

GetPlanVersionsRequestType

1

-    x-civilRegistrationIdentifier [Header]

(PersonCivilRegistrationIdentifier)

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

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPlanVersionsResponse

GetPlanVersionsResponseType

1

-    planversioner

(PlanVersionCollection)

PlanversionerDto

1

En liste af planversioner.

-    -    planversion

(PlanVersionType)

PlanversionDto

0 - *

En planversion

-    -    -    planversionId

(PlanVersionIdentifier)

guid

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

1

Id for planversionen.

-    -    -  planAkitv  

(IsActive)

boolean

1

Dette felt indikerer om borgerens planversion skal være aktiv på Jobnet eller ej. Hvis planAkitv er False vil borgeren ikke kunne editere i planen på Jobnet og modsat hvis planAkitv er True. Logikken styres udfra borgerens kontaktgruppe. Er kombinationen (PlanTypen og Kontaktgruppen imellem) lovlig, vil planAkitv være sat til True. For en udd.plan, trin 3, hvor deadline date er overskedet, vil planAkitv flaget altid være False

-    -    -    plantype

(PlanTypeIdentifier)

Borgerindsats.PlanTypeCodeList

(Gl. DFDG PlanTypeIdentifierType)

1

Type af plan f.eks. Generel, Jobplan, Uddannelsesplan m.f..

-    -    -    version

(VersionNumber)

int

1

Versionsnummer for den pågældende plan.

-    -    -    versionOprettelsestidspunkt (VersionCreateDate)

dateTime

1

Oprettelsesdato for pågældende instans af planversionen

-    -    -    dfdgRegistreringstidspunkt

(CreateDate)

dateTime

1

Dato for hvornår elementet er blevet oprettet.

-    -    -    opdateretTidspunkt

(LastModifiedDate)

dateTime

1

Dato for hvornår elementet er blevet opdateret.

-    -    -    planversiontype

(PlanVersionTypeIdentifier)

Borgerindsats.PlanVersionTypeCodeList

(Gl. DFDG PlanVersionTypeIdentifierType)

1

Kodeliste over mulige typer af planversioner.

-    -    -    haendelser (PlanVersionEventTypes)

HaendelserDto

1

Liste for de events der genereres når en ny planversion

-    -    -    -    haendelsesType

(PlanVersionEventTypeIdentifierType)

Borgerindsats.MinPlanVersionHaendelsesTypeCodeList

(Gl. DFDG PlanVersionEventTypeIdentifierType)

0 - *

Anledning til planversion

-    -    -    publiceringMuligIMinPlan (PublishingPossibleInContextOfMyPlan)

boolean

0 - 1

Angiver om planbeskrivelse, mål og aktiviteter er inaktive.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1010

Unknown cpr

The submitted cpr is unknown to the system

4385

Borger er ikke medlem af en a-kasse

(The client does not have an unemploymentfund registration)

Borger er ikke medlem af en a-kasse

(The client does not have an unemploymentfund registration)

UpdatePlanbeskrivelse (PUT /v1/Plan/{planversionId}/planbeskrivelse/)

(Erstatter RectifyPlanDescription)

Anvendes til berigtigelse af planbeskrivelse

Tilladte organisationer

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

JobCenter

X

X

STAR

X

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

RectifyPlanDescriptionRequest

RectifyPlanDescriptionRequestType

1

-    x-civilRegistrationIdentifier [Header]

(PersonCivilRegistrationIdentifier)

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

-    planversionId [From route]

(PlanVersionIdentifier)

guid

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

1

Id for planversionen, der ønskes berigtiget

UpdatePlanbeskrivelseDto

-    planbeskrivelse

(PlanDescription)

string

Length: 1-4050

1

Berigtigede beskrivelse af indsatsen i planen som vises for borger. Der er ingen tekstmæssige begrænsninger for dette felt, men det anbefales dog at holde sig til en kort, klar og entydig beskrivelse

Output

Kun statuskode.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

9429

Plan ikke fundet

(Plan not found)

Plan ikke fundet

(Plan not found)

9430

Operation only allowed for legal plan versions

Operation only allowed for legal plan versions

9433

Planbeskrivelsen er tom og kan derfor ikke berigtiges

(Plan description is empty and therefore cannot be rectified)

Planbeskrivelsen er tom og kan derfor ikke berigtiges

(Plan description is empty and therefore cannot be rectified)

UpdateMaalbeskrivelse (PUT /v1/Plan/{planversionId}/maal/{maalId}/maalbeskrivelse/)

(Erstatter RectifyGoalDescription)

Anvendes til berigtigelse af målbeskrivelse på fritekstmål

Tilladte organisationer

 

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

A-kasse

 

X

 

 

 

 

JobCenter

 

X

 

 

X

 

STAR

X

 

 

 

 

 

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

RectifyGoalDescriptionRequest

RectifyGoalDescriptionRequestType

1

-    x-civilRegistrationIdentifier [Header]

(PersonCivilRegistrationId)entifier

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

-    planversionId [From route]

(PlanVersionIdentifier)

string

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

1

Id for planversionen, der ønskes berigtiget

-    maalId [From route]

(GoalIdentifier)

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

Id for pågældende fritekst-mål, der ønskes berigtiget. Kan kun være af type fritekst

UpdateMaalbeskrivelseDto

- -    maalbeskrivelse

(GoalDescription)

string

Length: 1-4050

1

Er typen fritekst specificeret, er feltet påkrævet.

Output

Kun statuskode.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

9429

Plan ikke fundet

(Plan not found)

Plan ikke fundet

(Plan not found)

9430

Operation only allowed for legal plan versions

Operation only allowed for legal plan versions

9431

Mål ikke fundet

(Goal not found)

Mål ikke fundet

(Goal not found)

9432

Operationen er lovlig på et fritekstmål

(Operation only allowed for custom goals)

Operationen er lovlig på et fritekstmål

(Operation only allowed for custom goals)

  • No labels