Versions Compared

Key

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

...

Table of Contents
maxLevel2

CreateText (POST /v1/DynamicTexts/create)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

star.dynamictext.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-requestId [Header]string1Unikt 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
requestBodyCreateDynamicTextDto1
-    textstringMinLength: 11
-    displayTextstringMinLength: 11
-    groupExternalIdentifieruuid0 - 1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseuuid1

Fejlkoder

Ingen fejlkoder

DeleteText (DELETE /v1/DynamicTexts/{externalIdentifier})

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

star.dynamictext.write

Input

ElementTypeDetaljerForekomstBeskrivelse
externalIdentifier [Path]uuid1
x-requestId [Header]string1Unikt 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

Output

ElementTypeDetaljerForekomstBeskrivelse
responseActionResult1

Fejlkoder

Ingen fejlkoder

GetText (GET /v1/DynamicTexts/{externalIdentifier})

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

star.dynamictext.read

Input

ElementTypeDetaljerForekomstBeskrivelse
externalIdentifier [Path]uuid1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetDynamicTextDto1
-    externalIdentifieruuid1
-    textstringMinLength: 11
-    displayTextstringMinLength: 11
-    groupGetDynamicTextGroupDto0 - 1
-    -    externalIdentifieruuid1
-    -    namestringMinLength: 11

Fejlkoder

Ingen fejlkoder

GetTexts (GET /v1/DynamicTexts)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

star.dynamictext.read

Input

ElementTypeDetaljerForekomstBeskrivelse
externalGroupIdentifier [Query]uuid0 - 1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetDynamicTextDtoCollection1
-    GetDynamicTextDtoGetDynamicTextDto0 - *
-    -    externalIdentifieruuid1
-    -    textstringMinLength: 11
-    -    displayTextstringMinLength: 11
-    -    groupGetDynamicTextGroupDto0 - 1
-    -    -    externalIdentifieruuid1
-    -    -    namestringMinLength: 11

Fejlkoder

Ingen fejlkoder

GetAllGroups (GET /v1/DynamicTexts/groups)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

star.dynamictext.read

Input

ElementTypeDetaljerForekomstBeskrivelse

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetDynamicTextGroupDtoCollection1
-    GetDynamicTextGroupDtoGetDynamicTextGroupDto0 - *
-    -    externalIdentifieruuid1
-    -    namestringMinLength: 11

Fejlkoder

Ingen fejlkoder

UpdateText (PUT /v1/DynamicTexts/update/{externalIdentifier})

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

star.dynamictext.write

Input

ElementTypeDetaljerForekomstBeskrivelse
externalIdentifier [Path]string1
x-requestId [Header]string1Unikt 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
requestBodyUpdateDynamicTextDto1
-    externalIdentifieruuid1
-    textstringMinLength: 11
-    displayTextstringMinLength: 11
-    groupExternalIdentifieruuid0 - 1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseActionResult1

Fejlkoder

Ingen fejlkoder

CreatePlanMedId (POST /v2/Plan/{planversionIdentifier})

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseX
JobCenterXX
STARX

Scope

borgerindsats.plan.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
planversionIdentifier [Path]uuid1
x-requestId [Header]string1Unikt 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
requestBodyCreatePlanRequestDto1
-    planTypePlanTypeCodeList1
-    planmaalCreatePlanmaalDto1
-    -    planBeskrivelsestringLength: 1-40500 - 1Beskrivelse af indsatsen i planen som vises for borger. Det anbefales at holde sig til en kort, klar og entydig beskrivelse
-    -    ansvarligMyndighedAnsvarligMyndighedDto0 - 1Angivelse af den ansvarlige sagsbehandler.
-    -    -    myndighedMyndighedDto1Detaljer på myndigheden.
-    -    -    -    myndighedskodestringPattern: [-][1]|[0-9]{1,8}
MinLength: 1
1Myndighedskode
-    -    -    -    organisationTypeOrganisationTypeCodeList1
-    -    -    sagsbehandlerSagsbehandlerDto1Detaljer på sagsbehandleren.
-    -    -    -    fornavnstringLength: 1-501Sagsbehandlerens fornavne.
-    -    -    -    mellemnavnstringLength: 1-400 - 1Sagsbehandlerens mellemnavn.
-    -    -    -    efternavnstringLength: 1-401Sagsbehandlerens efternavn.
-    -    -    -    telefonnummerstringPattern: (\+)?[0-9]{3,20}0 - 1Sagsbehandlerens telefonnummer.
-    -    -    -    emailadresseemail0 - 1Sagsbehandlerens emailadresse.
-    -    -    -    sagsbehandlerIdstringLength: 1-2551Sagsbehandlerens id.
-    -    opfoelgningsDatodate0 - 1Opfølgningsdato for sagsbehandler.
-    -    maalCreateMaalDtoCollection1Collection indeholdende de mål, der er tilknyttet planen.
-    -    -    CreateMaalDtoCreateMaalDto0 - *
-    -    -    -    maalKodeTypeMaalKodeTypeCodeList1
-    -    -    -    maalKodestringLength: 1-2560 - 1Kode 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.
-    -    -    -    maalBeskrivelsestringLength: 1-40500 - 1Er typen Custom 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.
-    -    -    -    aliasIdentifieruuid0 - 1Hvis målet er af typen ESCO STAR, så kan der være et alias tilknyttet
-    -    -    -    sorteringsRaekkefoelgeint321Angiver rækkefølgen for hvorledes de enkelte mål på skal fremvises for borgeren. sorteringsorder skal være unikt for den liste af mål der findes på borgerens planversion - planmaal.maal.
-    -    -    -    maalIduuid0 - 1Id for pågældende mål. Kan sættes hvis uddannelsesplan henviser til dette.
-    uddannelsesPlanUddannelsesplanDto0 - 1
-    -    uddannelsesplanIduuid0 - 1Objekt ID'en for uddannelsesplan objektet.
-    -    udannelsesplanTrinTypeUddannelsesplanTrinTypeCodeList1
-    -    uddannelserUddannelseDtoCollection1En samling af uddannelser.
-    -    -    UddannelseDtoUddannelseDto0 - *
-    -    -    -    uddannelsesIduuid0 - 1Indeholder en samling uddannelsesønsker for trin 1. Indeholder en samling af uddannelsessteder for de øvrige trin.
-    -    -    -    uddannelsesoenskestringLength: 0-5000 - 1Dette er borgerens uddannelsesønske, som registreret af sagsbehandleren.
-    -    -    -    maalIduuid0 - 1Dette er en relation til et af planens hovedmål – planmaal.maal. Skal sættes på trin 2+3.
-    -    -    -    uddannelsesnavnstringLength: 0-5000 - 1Navnet på uddannelsen Fx: Maskinsnedker.
-    -    -    -    lokationsnavnstringLength: 0-5000 - 1Uddannelses lokationsnavn Fx: Københavns Tekniske Skole.
-    -    -    -    lokationsadresseLokationsadresseDto0 - 1
-    -    -    -    -    adressestringLength: 0-10000 - 1Adresse.
-    -    -    -    -    postnummerstringLength: 0-40 - 1Postnummer.
-    -    -    -    -    postdistriktstringLength: 0-2000 - 1By.
-    -    -    -    ansoegningsfristdate-time0 - 1Ansøgningsfrist.
-    -    -    -    startdatodate-time0 - 1Uddannelsesstartdato.
-    -    -    -    uddannelsesstatusTypeUddannelsesansoegningsstatusTypeCodeList1
-    -    -    -    sorteringsorderint321Angiver rækkefølgen for hvorledes de enkelte mål på Jobnet skal fremvises for borgeren.
-    -    -    -    cvrEnhedsIdstringLength: 1-80 - 1CVR nummer for uddannelsesstedet.
-    -    -    -    pNummerstringLength: 1-100 - 1P-nummer for uddannelsesstedet.
-    -    sagsbehandlerkommentarstringLength: 0-30000 - 1Kommentar sagsbehandleren kan Feltet bruges ikke mere. Blev tidligere brugt til kommentar som sagsbehandleren kunne videregive til uddannelsesinstitutioner omkring borgerens situation ved trin 3.
-    -    medJobmaalboolean1Uddannelsesplan med Jobmål eller uden Jobmål.Hvis med jobmål er denne også kaldet en kombiplan.
-    -    stoettebehovStoettebehovTypeCodeListCollection1Indeholder en samling af støttebehov m.v. for at den unge kan fastholdes i at gennemføre uddannelsen.
-    -    -    StoettebehovTypeCodeListStoettebehovTypeCodeList0 - *
-    -    fristdatodate-time0 - 1Dato for den frist borgeren er blevet pålagt for pågældende uddannelsesplan trin.

Output

ElementTypeDetaljerForekomstBeskrivelse
responseuuid1

Fejlkoder

FejlkodeFejltekstBeskrivelse
110001Person findes ikke for det angivne CPR-nummerPerson findes ikke for det angivne CPR-nummer
8018FristDato for uddannelsesplanen må ikke være dags dato eller førFristDato for uddannelsesplanen må ikke være dags dato eller før
8021Den angivne plantype er ikke gyldigDen angivne plantype er ikke gyldig
8044Uddannelsesplanstypen er ikke tilladt for borgere over 30 årUddannelsesplanstypen er ikke tilladt for borgere over 30 år
8053Det specificerede mål findes ikke i uddannelsesplanenDet specificerede mål findes ikke i uddannelsesplanen
8060Operationen er ikke tilladt når borger ikke har en aktiv kontaktgruppeOperationen er ikke tilladt når borger ikke har en aktiv kontaktgruppe
8061Jobplanens mål skal være en gyldig stillingsbetegnelseJobplanens mål skal være en gyldig stillingsbetegnelse
8062En gyldig kombination af kontaktgruppe og personkategori er nødvendigEn gyldig kombination af kontaktgruppe og personkategori er nødvendig
8074Uddannelsesplanstypen er ikke tilladt for borgere over 25 årUddannelsesplanstypen er ikke tilladt for borgere over 25 år
8078Når du gemmer UddannelsesPlan i trin 4, skal der være uddannelser til stedeNår du gemmer UddannelsesPlan i trin 4, skal der være uddannelser til stede
8116En jobplan må maksimalt indeholde et målEn jobplan må maksimalt indeholde et mål
8281ConceptUriDa findes ikkeConceptUriDa findes ikke
8282ConceptUriDa er udløbetConceptUriDa er udløbet
8285Mindst 1 uddannelsesmål skal være angivetMindst 1 uddannelsesmål skal være angivet
8289UddannelsesPlan med jobmål ikke tilladtUddannelsesPlan med jobmål ikke tilladt
9117Borgere, der er DPM og under 25 år med en UddannelsesPlan, skal have MedJobmaal angivetBorgere, der er DPM og under 25 år med en UddannelsesPlan, skal have MedJobmaal angivet
9129En jobplan skal have mindst et målEn jobplan skal have mindst et mål
9369Kombinationen af borgers kontaktgruppe og personkategori kræver mindst en stillingsbetegnelseKombinationen af borgers kontaktgruppe og personkategori kræver mindst en stillingsbetegnelse
9371Kombinationen af borgers kontaktgruppe og personkategori er kun en stillingsbetegnelse tilladtKombinationen af borgers kontaktgruppe og personkategori er kun en stillingsbetegnelse tilladt
9428Målkode er ikke gyldigMålkode er ikke gyldig
9435Når du vælger Stoettebehov id 1, så er id2 og/eller id 3 ikke tilladtNår du vælger Stoettebehov id 1, så er id2 og/eller id 3 ikke tilladt
9436Når du vælger Stoettebehov id 4, så skal id2 og/eller id 3 være til stedeNår du vælger Stoettebehov id 4, så skal id2 og/eller id 3 være til stede
9437Når du gemmer UddannelsesPlan i trin 4, skal uddannelses Støttebehov være til stedeNår du gemmer UddannelsesPlan i trin 4, skal uddannelses Støttebehov være til stede
9439En borger kan ikke registreres med samme ConceptUriDa mere end en gangEn borger kan ikke registreres med samme ConceptUriDa mere end en gang
8055Ansvarlig sagsbehandler skal være angivetAnsvarlig sagsbehandler skal være angivet
9358Planbeskrivelse er ikke tilladt med kombinationen af borgerkontaktgruppe og personkategoriPlanbeskrivelse er ikke tilladt med kombinationen af borgerkontaktgruppe og personkategori
4575You are not authorized to execute the operationYou are not authorized to execute the operation
9463JobCenter må ikke oprette planer for dagpengemodtagere med aktivt kontaktforløb i a-kasseJobCenter må ikke oprette planer for dagpengemodtagere med aktivt kontaktforløb i a-kasse
110005Uddannelsesplan skal have plan type uddannelsesplanUddannelsesplan skal have plan type uddannelsesplan
110006Hvis uddannelse har mål, skal planen også have et målHvis uddannelse har mål, skal planen også have et mål
110007Plan med plan type Uddannelsesplan skal have uddannelsesplan populeretPlan med plan type Uddannelsesplan skal have uddannelsesplan populeret
110009Plan med plan type Uddannelsesplan skal have fristdato satPlan med plan type Uddannelsesplan skal have fristdato sat
110010Uddannelsesplan med flaget 'MedJobMaal' skal have job mål tilkoblet planen.Uddannelsesplan med flaget 'MedJobMaal' skal have job mål tilkoblet planen.

GetPlan (GET /v2/Plan/{planversionIdentifier})

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseXX
JobCenterXXXX
STARX

Scope

borgerindsats.plan.read

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
planversionIdentifier [Path]uuid1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetPlanResponseDto1
-    planPlanDto1
-    -    planVersionPlanVersionDto1
-    -    -    planVersionIduuid1Id for planversionen.
-    -    -    planTypePlanTypeCodeList1
-    -    -    versionint321Versionsnummer for den pågældende plan.
-    -    -    dfdgRegistreringsTidspunktdate-time1Dato for hvornår elementet er blevet oprettet.
-    -    -    opdateretTidspunktdate-time1Dato for hvornår elementet er blevet opdateret.
-    -    planMaalGetPlanmaalDto1
-    -    -    planBeskrivelsestringLength: 1-40500 - 1Beskrivelse af indsatsen i planen som vises for borger. Det anbefales at holde sig til en kort, klar og entydig beskrivelse
-    -    -    ansvarligMyndighedAnsvarligMyndighedDto0 - 1Angivelse af den ansvarlige sagsbehandler.
-    -    -    -    myndighedMyndighedDto1Detaljer på myndigheden.
-    -    -    -    -    myndighedskodestringPattern: [-][1]|[0-9]{1,8}
MinLength: 1
1Myndighedskode
-    -    -    -    -    organisationTypeOrganisationTypeCodeList1
-    -    -    -    sagsbehandlerSagsbehandlerDto1Detaljer på sagsbehandleren.
-    -    -    -    -    fornavnstringLength: 1-501Sagsbehandlerens fornavne.
-    -    -    -    -    mellemnavnstringLength: 1-400 - 1Sagsbehandlerens mellemnavn.
-    -    -    -    -    efternavnstringLength: 1-401Sagsbehandlerens efternavn.
-    -    -    -    -    telefonnummerstringPattern: (\+)?[0-9]{3,20}0 - 1Sagsbehandlerens telefonnummer.
-    -    -    -    -    emailadresseemail0 - 1Sagsbehandlerens emailadresse.
-    -    -    -    -    sagsbehandlerIdstringLength: 1-2551Sagsbehandlerens id.
-    -    -    opfoelgningsDatodate0 - 1Opfølgningsdato for sagsbehandler.
-    -    -    maalGetMaalDtoCollection1Collection indeholdende de mål, der er tilknyttet planen.
-    -    -    -    GetMaalDtoGetMaalDto0 - *
-    -    -    -    -    maalKodeTypeMaalKodeTypeCodeList1
-    -    -    -    -    maalKodestringLength: 1-2560 - 1Kode 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.
-    -    -    -    -    maalBeskrivelsestringLength: 1-40500 - 1Er typen Custom 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.
-    -    -    -    -    aliasIdentifieruuid0 - 1Hvis målet er af typen ESCO STAR, så kan der være et alias tilknyttet
-    -    -    -    -    sorteringsRaekkefoelgeint321Angiver rækkefølgen for hvorledes de enkelte mål på skal fremvises for borgeren. sorteringsorder skal være unikt for den liste af mål der findes på borgerens planversion - planmaal.maal.
-    -    -    -    -    maalIduuid1Id for pågældende mål. Sættes af DFDG.
-    -    -    oprettetTidspunktdate-time0 - 1Dato for oprettelse af elementet. Ved servicekald hvor dette planmål anvendes som argument skal planmaalId elementet fjernes
-    -    -    opdateretTidspunktdate-time0 - 1Dato for hvornår elementet er blevet opdateret. Ved servicekald hvor dette planmål anvendes som argument skal planmaalId elementet fjernes
-    uddannelsesPlanUddannelsesplanDto0 - 1
-    -    uddannelsesplanIduuid0 - 1Objekt ID'en for uddannelsesplan objektet.
-    -    udannelsesplanTrinTypeUddannelsesplanTrinTypeCodeList1
-    -    uddannelserUddannelseDtoCollection1En samling af uddannelser.
-    -    -    UddannelseDtoUddannelseDto0 - *
-    -    -    -    uddannelsesIduuid0 - 1Indeholder en samling uddannelsesønsker for trin 1. Indeholder en samling af uddannelsessteder for de øvrige trin.
-    -    -    -    uddannelsesoenskestringLength: 0-5000 - 1Dette er borgerens uddannelsesønske, som registreret af sagsbehandleren.
-    -    -    -    maalIduuid0 - 1Dette er en relation til et af planens hovedmål – planmaal.maal. Skal sættes på trin 2+3.
-    -    -    -    uddannelsesnavnstringLength: 0-5000 - 1Navnet på uddannelsen Fx: Maskinsnedker.
-    -    -    -    lokationsnavnstringLength: 0-5000 - 1Uddannelses lokationsnavn Fx: Københavns Tekniske Skole.
-    -    -    -    lokationsadresseLokationsadresseDto0 - 1
-    -    -    -    -    adressestringLength: 0-10000 - 1Adresse.
-    -    -    -    -    postnummerstringLength: 0-40 - 1Postnummer.
-    -    -    -    -    postdistriktstringLength: 0-2000 - 1By.
-    -    -    -    ansoegningsfristdate-time0 - 1Ansøgningsfrist.
-    -    -    -    startdatodate-time0 - 1Uddannelsesstartdato.
-    -    -    -    uddannelsesstatusTypeUddannelsesansoegningsstatusTypeCodeList1
-    -    -    -    sorteringsorderint321Angiver rækkefølgen for hvorledes de enkelte mål på Jobnet skal fremvises for borgeren.
-    -    -    -    cvrEnhedsIdstringLength: 1-80 - 1CVR nummer for uddannelsesstedet.
-    -    -    -    pNummerstringLength: 1-100 - 1P-nummer for uddannelsesstedet.
-    -    sagsbehandlerkommentarstringLength: 0-30000 - 1Kommentar sagsbehandleren kan Feltet bruges ikke mere. Blev tidligere brugt til kommentar som sagsbehandleren kunne videregive til uddannelsesinstitutioner omkring borgerens situation ved trin 3.
-    -    medJobmaalboolean1Uddannelsesplan med Jobmål eller uden Jobmål.Hvis med jobmål er denne også kaldet en kombiplan.
-    -    stoettebehovStoettebehovTypeCodeListCollection1Indeholder en samling af støttebehov m.v. for at den unge kan fastholdes i at gennemføre uddannelsen.
-    -    -    StoettebehovTypeCodeListStoettebehovTypeCodeList0 - *
-    -    fristdatodate-time0 - 1Dato for den frist borgeren er blevet pålagt for pågældende uddannelsesplan trin.

Fejlkoder

FejlkodeFejltekstBeskrivelse
110001Person findes ikke for det angivne CPR-nummerPerson findes ikke for det angivne CPR-nummer
8001En plan med det angivne versionIdentifier kan ikke findesEn plan med det angivne versionIdentifier kan ikke findes
9203A-kassen må ikke tilgå planenA-kassen må ikke tilgå planen

CreatePlan (POST /v2/Plan)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseX
JobCenterXX
STARX

Scope

borgerindsats.plan.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
x-requestId [Header]string1Unikt 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
requestBodyCreatePlanRequestDto1
-    planTypePlanTypeCodeList1
-    planmaalCreatePlanmaalDto1
-    -    planBeskrivelsestringLength: 1-40500 - 1Beskrivelse af indsatsen i planen som vises for borger. Det anbefales at holde sig til en kort, klar og entydig beskrivelse
-    -    ansvarligMyndighedAnsvarligMyndighedDto0 - 1Angivelse af den ansvarlige sagsbehandler.
-    -    -    myndighedMyndighedDto1Detaljer på myndigheden.
-    -    -    -    myndighedskodestringPattern: [-][1]|[0-9]{1,8}
MinLength: 1
1Myndighedskode
-    -    -    -    organisationTypeOrganisationTypeCodeList1
-    -    -    sagsbehandlerSagsbehandlerDto1Detaljer på sagsbehandleren.
-    -    -    -    fornavnstringLength: 1-501Sagsbehandlerens fornavne.
-    -    -    -    mellemnavnstringLength: 1-400 - 1Sagsbehandlerens mellemnavn.
-    -    -    -    efternavnstringLength: 1-401Sagsbehandlerens efternavn.
-    -    -    -    telefonnummerstringPattern: (\+)?[0-9]{3,20}0 - 1Sagsbehandlerens telefonnummer.
-    -    -    -    emailadresseemail0 - 1Sagsbehandlerens emailadresse.
-    -    -    -    sagsbehandlerIdstringLength: 1-2551Sagsbehandlerens id.
-    -    opfoelgningsDatodate0 - 1Opfølgningsdato for sagsbehandler.
-    -    maalCreateMaalDtoCollection1Collection indeholdende de mål, der er tilknyttet planen.
-    -    -    CreateMaalDtoCreateMaalDto0 - *
-    -    -    -    maalKodeTypeMaalKodeTypeCodeList1
-    -    -    -    maalKodestringLength: 1-2560 - 1Kode 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.
-    -    -    -    maalBeskrivelsestringLength: 1-40500 - 1Er typen Custom 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.
-    -    -    -    aliasIdentifieruuid0 - 1Hvis målet er af typen ESCO STAR, så kan der være et alias tilknyttet
-    -    -    -    sorteringsRaekkefoelgeint321Angiver rækkefølgen for hvorledes de enkelte mål på skal fremvises for borgeren. sorteringsorder skal være unikt for den liste af mål der findes på borgerens planversion - planmaal.maal.
-    -    -    -    maalIduuid0 - 1Id for pågældende mål. Kan sættes hvis uddannelsesplan henviser til dette.
-    uddannelsesPlanUddannelsesplanDto0 - 1
-    -    uddannelsesplanIduuid0 - 1Objekt ID'en for uddannelsesplan objektet.
-    -    udannelsesplanTrinTypeUddannelsesplanTrinTypeCodeList1
-    -    uddannelserUddannelseDtoCollection1En samling af uddannelser.
-    -    -    UddannelseDtoUddannelseDto0 - *
-    -    -    -    uddannelsesIduuid0 - 1Indeholder en samling uddannelsesønsker for trin 1. Indeholder en samling af uddannelsessteder for de øvrige trin.
-    -    -    -    uddannelsesoenskestringLength: 0-5000 - 1Dette er borgerens uddannelsesønske, som registreret af sagsbehandleren.
-    -    -    -    maalIduuid0 - 1Dette er en relation til et af planens hovedmål – planmaal.maal. Skal sættes på trin 2+3.
-    -    -    -    uddannelsesnavnstringLength: 0-5000 - 1Navnet på uddannelsen Fx: Maskinsnedker.
-    -    -    -    lokationsnavnstringLength: 0-5000 - 1Uddannelses lokationsnavn Fx: Københavns Tekniske Skole.
-    -    -    -    lokationsadresseLokationsadresseDto0 - 1
-    -    -    -    -    adressestringLength: 0-10000 - 1Adresse.
-    -    -    -    -    postnummerstringLength: 0-40 - 1Postnummer.
-    -    -    -    -    postdistriktstringLength: 0-2000 - 1By.
-    -    -    -    ansoegningsfristdate-time0 - 1Ansøgningsfrist.
-    -    -    -    startdatodate-time0 - 1Uddannelsesstartdato.
-    -    -    -    uddannelsesstatusTypeUddannelsesansoegningsstatusTypeCodeList1
-    -    -    -    sorteringsorderint321Angiver rækkefølgen for hvorledes de enkelte mål på Jobnet skal fremvises for borgeren.
-    -    -    -    cvrEnhedsIdstringLength: 1-80 - 1CVR nummer for uddannelsesstedet.
-    -    -    -    pNummerstringLength: 1-100 - 1P-nummer for uddannelsesstedet.
-    -    sagsbehandlerkommentarstringLength: 0-30000 - 1Kommentar sagsbehandleren kan Feltet bruges ikke mere. Blev tidligere brugt til kommentar som sagsbehandleren kunne videregive til uddannelsesinstitutioner omkring borgerens situation ved trin 3.
-    -    medJobmaalboolean1Uddannelsesplan med Jobmål eller uden Jobmål.Hvis med jobmål er denne også kaldet en kombiplan.
-    -    stoettebehovStoettebehovTypeCodeListCollection1Indeholder en samling af støttebehov m.v. for at den unge kan fastholdes i at gennemføre uddannelsen.
-    -    -    StoettebehovTypeCodeListStoettebehovTypeCodeList0 - *
-    -    fristdatodate-time0 - 1Dato for den frist borgeren er blevet pålagt for pågældende uddannelsesplan trin.

Output

ElementTypeDetaljerForekomstBeskrivelse
responseuuid1

Fejlkoder

FejlkodeFejltekstBeskrivelse
110001Person findes ikke for det angivne CPR-nummerPerson findes ikke for det angivne CPR-nummer
8018FristDato for uddannelsesplanen må ikke være dags dato eller førFristDato for uddannelsesplanen må ikke være dags dato eller før
8021Den angivne plantype er ikke gyldigDen angivne plantype er ikke gyldig
8044Uddannelsesplanstypen er ikke tilladt for borgere over 30 årUddannelsesplanstypen er ikke tilladt for borgere over 30 år
8053Det specificerede mål findes ikke i uddannelsesplanenDet specificerede mål findes ikke i uddannelsesplanen
8060Operationen er ikke tilladt når borger ikke har en aktiv kontaktgruppeOperationen er ikke tilladt når borger ikke har en aktiv kontaktgruppe
8061Jobplanens mål skal være en gyldig stillingsbetegnelseJobplanens mål skal være en gyldig stillingsbetegnelse
8062En gyldig kombination af kontaktgruppe og personkategori er nødvendigEn gyldig kombination af kontaktgruppe og personkategori er nødvendig
8074Uddannelsesplanstypen er ikke tilladt for borgere over 25 årUddannelsesplanstypen er ikke tilladt for borgere over 25 år
8078Når du gemmer UddannelsesPlan i trin 4, skal der være uddannelser til stedeNår du gemmer UddannelsesPlan i trin 4, skal der være uddannelser til stede
8116En jobplan må maksimalt indeholde et målEn jobplan må maksimalt indeholde et mål
8281ConceptUriDa findes ikkeConceptUriDa findes ikke
8282ConceptUriDa er udløbetConceptUriDa er udløbet
8285Mindst 1 uddannelsesmål skal være angivetMindst 1 uddannelsesmål skal være angivet
8289UddannelsesPlan med jobmål ikke tilladtUddannelsesPlan med jobmål ikke tilladt
9117Borgere, der er DPM og under 25 år med en UddannelsesPlan, skal have MedJobmaal angivetBorgere, der er DPM og under 25 år med en UddannelsesPlan, skal have MedJobmaal angivet
9129En jobplan skal have mindst et målEn jobplan skal have mindst et mål
9369Kombinationen af borgers kontaktgruppe og personkategori kræver mindst en stillingsbetegnelseKombinationen af borgers kontaktgruppe og personkategori kræver mindst en stillingsbetegnelse
9371Kombinationen af borgers kontaktgruppe og personkategori er kun en stillingsbetegnelse tilladtKombinationen af borgers kontaktgruppe og personkategori er kun en stillingsbetegnelse tilladt
9428Målkode er ikke gyldigMålkode er ikke gyldig
9435Når du vælger Stoettebehov id 1, så er id2 og/eller id 3 ikke tilladtNår du vælger Stoettebehov id 1, så er id2 og/eller id 3 ikke tilladt
9436Når du vælger Stoettebehov id 4, så skal id2 og/eller id 3 være til stedeNår du vælger Stoettebehov id 4, så skal id2 og/eller id 3 være til stede
9437Når du gemmer UddannelsesPlan i trin 4, skal uddannelses Støttebehov være til stedeNår du gemmer UddannelsesPlan i trin 4, skal uddannelses Støttebehov være til stede
9439En borger kan ikke registreres med samme ConceptUriDa mere end en gangEn borger kan ikke registreres med samme ConceptUriDa mere end en gang
8055Ansvarlig sagsbehandler skal være angivetAnsvarlig sagsbehandler skal være angivet
9358Planbeskrivelse er ikke tilladt med kombinationen af borgerkontaktgruppe og personkategoriPlanbeskrivelse er ikke tilladt med kombinationen af borgerkontaktgruppe og personkategori
4575You are not authorized to execute the operationYou are not authorized to execute the operation
9463JobCenter må ikke oprette planer for dagpengemodtagere med aktivt kontaktforløb i a-kasseJobCenter må ikke oprette planer for dagpengemodtagere med aktivt kontaktforløb i a-kasse
110005Uddannelsesplan skal have plan type uddannelsesplanUddannelsesplan skal have plan type uddannelsesplan
110006Hvis uddannelse har mål, skal planen også have et målHvis uddannelse har mål, skal planen også have et mål
110007Plan med plan type Uddannelsesplan skal have uddannelsesplan populeretPlan med plan type Uddannelsesplan skal have uddannelsesplan populeret
110009Plan med plan type Uddannelsesplan skal have fristdato satPlan med plan type Uddannelsesplan skal have fristdato sat
110010Uddannelsesplan med flaget 'MedJobMaal' skal have job mål tilkoblet planen.Uddannelsesplan med flaget 'MedJobMaal' skal have job mål tilkoblet planen.

GetSenestePlan (GET /v2/Plan)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseXX
JobCenterXXXX
STARX

Scope

borgerindsats.plan.read

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetPlanResponseDto1
-    planPlanDto1
-    -    planVersionPlanVersionDto1
-    -    -    planVersionIduuid1Id for planversionen.
-    -    -    planTypePlanTypeCodeList1
-    -    -    versionint321Versionsnummer for den pågældende plan.
-    -    -    dfdgRegistreringsTidspunktdate-time1Dato for hvornår elementet er blevet oprettet.
-    -    -    opdateretTidspunktdate-time1Dato for hvornår elementet er blevet opdateret.
-    -    planMaalGetPlanmaalDto1
-    -    -    planBeskrivelsestringLength: 1-40500 - 1Beskrivelse af indsatsen i planen som vises for borger. Det anbefales at holde sig til en kort, klar og entydig beskrivelse
-    -    -    ansvarligMyndighedAnsvarligMyndighedDto0 - 1Angivelse af den ansvarlige sagsbehandler.
-    -    -    -    myndighedMyndighedDto1Detaljer på myndigheden.
-    -    -    -    -    myndighedskodestringPattern: [-][1]|[0-9]{1,8}
MinLength: 1
1Myndighedskode
-    -    -    -    -    organisationTypeOrganisationTypeCodeList1
-    -    -    -    sagsbehandlerSagsbehandlerDto1Detaljer på sagsbehandleren.
-    -    -    -    -    fornavnstringLength: 1-501Sagsbehandlerens fornavne.
-    -    -    -    -    mellemnavnstringLength: 1-400 - 1Sagsbehandlerens mellemnavn.
-    -    -    -    -    efternavnstringLength: 1-401Sagsbehandlerens efternavn.
-    -    -    -    -    telefonnummerstringPattern: (\+)?[0-9]{3,20}0 - 1Sagsbehandlerens telefonnummer.
-    -    -    -    -    emailadresseemail0 - 1Sagsbehandlerens emailadresse.
-    -    -    -    -    sagsbehandlerIdstringLength: 1-2551Sagsbehandlerens id.
-    -    -    opfoelgningsDatodate0 - 1Opfølgningsdato for sagsbehandler.
-    -    -    maalGetMaalDtoCollection1Collection indeholdende de mål, der er tilknyttet planen.
-    -    -    -    GetMaalDtoGetMaalDto0 - *
-    -    -    -    -    maalKodeTypeMaalKodeTypeCodeList1
-    -    -    -    -    maalKodestringLength: 1-2560 - 1Kode 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.
-    -    -    -    -    maalBeskrivelsestringLength: 1-40500 - 1Er typen Custom 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.
-    -    -    -    -    aliasIdentifieruuid0 - 1Hvis målet er af typen ESCO STAR, så kan der være et alias tilknyttet
-    -    -    -    -    sorteringsRaekkefoelgeint321Angiver rækkefølgen for hvorledes de enkelte mål på skal fremvises for borgeren. sorteringsorder skal være unikt for den liste af mål der findes på borgerens planversion - planmaal.maal.
-    -    -    -    -    maalIduuid1Id for pågældende mål. Sættes af DFDG.
-    -    -    oprettetTidspunktdate-time0 - 1Dato for oprettelse af elementet. Ved servicekald hvor dette planmål anvendes som argument skal planmaalId elementet fjernes
-    -    -    opdateretTidspunktdate-time0 - 1Dato for hvornår elementet er blevet opdateret. Ved servicekald hvor dette planmål anvendes som argument skal planmaalId elementet fjernes
-    uddannelsesPlanUddannelsesplanDto0 - 1
-    -    uddannelsesplanIduuid0 - 1Objekt ID'en for uddannelsesplan objektet.
-    -    udannelsesplanTrinTypeUddannelsesplanTrinTypeCodeList1
-    -    uddannelserUddannelseDtoCollection1En samling af uddannelser.
-    -    -    UddannelseDtoUddannelseDto0 - *
-    -    -    -    uddannelsesIduuid0 - 1Indeholder en samling uddannelsesønsker for trin 1. Indeholder en samling af uddannelsessteder for de øvrige trin.
-    -    -    -    uddannelsesoenskestringLength: 0-5000 - 1Dette er borgerens uddannelsesønske, som registreret af sagsbehandleren.
-    -    -    -    maalIduuid0 - 1Dette er en relation til et af planens hovedmål – planmaal.maal. Skal sættes på trin 2+3.
-    -    -    -    uddannelsesnavnstringLength: 0-5000 - 1Navnet på uddannelsen Fx: Maskinsnedker.
-    -    -    -    lokationsnavnstringLength: 0-5000 - 1Uddannelses lokationsnavn Fx: Københavns Tekniske Skole.
-    -    -    -    lokationsadresseLokationsadresseDto0 - 1
-    -    -    -    -    adressestringLength: 0-10000 - 1Adresse.
-    -    -    -    -    postnummerstringLength: 0-40 - 1Postnummer.
-    -    -    -    -    postdistriktstringLength: 0-2000 - 1By.
-    -    -    -    ansoegningsfristdate-time0 - 1Ansøgningsfrist.
-    -    -    -    startdatodate-time0 - 1Uddannelsesstartdato.
-    -    -    -    uddannelsesstatusTypeUddannelsesansoegningsstatusTypeCodeList1
-    -    -    -    sorteringsorderint321Angiver rækkefølgen for hvorledes de enkelte mål på Jobnet skal fremvises for borgeren.
-    -    -    -    cvrEnhedsIdstringLength: 1-80 - 1CVR nummer for uddannelsesstedet.
-    -    -    -    pNummerstringLength: 1-100 - 1P-nummer for uddannelsesstedet.
-    -    sagsbehandlerkommentarstringLength: 0-30000 - 1Kommentar sagsbehandleren kan Feltet bruges ikke mere. Blev tidligere brugt til kommentar som sagsbehandleren kunne videregive til uddannelsesinstitutioner omkring borgerens situation ved trin 3.
-    -    medJobmaalboolean1Uddannelsesplan med Jobmål eller uden Jobmål.Hvis med jobmål er denne også kaldet en kombiplan.
-    -    stoettebehovStoettebehovTypeCodeListCollection1Indeholder en samling af støttebehov m.v. for at den unge kan fastholdes i at gennemføre uddannelsen.
-    -    -    StoettebehovTypeCodeListStoettebehovTypeCodeList0 - *
-    -    fristdatodate-time0 - 1Dato for den frist borgeren er blevet pålagt for pågældende uddannelsesplan trin.

Fejlkoder

FejlkodeFejltekstBeskrivelse
110001Person findes ikke for det angivne CPR-nummerPerson findes ikke for det angivne CPR-nummer
8001En plan med det angivne versionIdentifier kan ikke findesEn plan med det angivne versionIdentifier kan ikke findes
9203A-kassen må ikke tilgå planenA-kassen må ikke tilgå planen

GetPlanVersioner (GET /v2/Plan/versioner)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseXX
JobCenterXXXX
STARX

Scope

borgerindsats.plan.read

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetPlanVersionerResponseDto1
-    planVersionerPlanVersionDtoCollection1
-    -    PlanVersionDtoPlanVersionDto0 - *
-    -    -    planVersionIduuid1Id for planversionen.
-    -    -    planTypePlanTypeCodeList1
-    -    -    versionint321Versionsnummer for den pågældende plan.
-    -    -    dfdgRegistreringsTidspunktdate-time1Dato for hvornår elementet er blevet oprettet.
-    -    -    opdateretTidspunktdate-time1Dato for hvornår elementet er blevet opdateret.

Fejlkoder

FejlkodeFejltekstBeskrivelse
110001Person findes ikke for det angivne CPR-nummerPerson findes ikke for det angivne CPR-nummer

UpdatePlanbeskrivelse (PUT /v2/Plan/{planVersionId}/PlanBeskrivelse)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
JobCenterXX
STARX

Scope

borgerindsats.plan.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
planVersionId [Path]uuid1
x-requestId [Header]string1Unikt 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
requestBodyUpdatePlanbeskrivelseRequestDto1
-    planBeskrivelsestringMinLength: 11Beskrivelse af indsatsen i planen som vises for borger. Det anbefales at holde sig til en kort, klar og entydig beskrivelse

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
9429Planen blev ikke fundetPlanen blev ikke fundet
9433Plan beskrivelsen er tom og kan derfor ikke blive opdateretPlan beskrivelsen er tom og kan derfor ikke blive opdateret

UpdateMaalbeskrivelse (PUT /v2/Plan/{planVersionId}/maal/{maalId}/maalbeskrivelse)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
JobCenterXX
STARX

Scope

borgerindsats.plan.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
planVersionId [Path]uuid1
maalId [Path]uuid1
x-requestId [Header]string1Unikt 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
requestBodyUpdateMaalbeskrivelseRequestDto1
-    maalbeskrivelsestringMinLength: 11

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
9429Planen blev ikke fundetPlanen blev ikke fundet
9432Plan mål beskrivelse kan kun opdateres på custom målPlan mål beskrivelse kan kun opdateres på custom mål