Siden opdateres automatisk til at afspejle koden.
Metoder
CreatePlanMedId (POST /v2/Plan/{planversionIdentifier})
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere | |
|---|---|---|---|---|---|---|---|---|
| A-kasse | X | |||||||
| JobCenter | X | X | ||||||
| STAR | X |
Scope
Input
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| 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 |
| planversionIdentifier [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 | |
| requestBody | CreatePlanRequestDto | 1 | ||
| - planType | PlanTypeCodeList | 1 | ||
| - planmaal | CreatePlanmaalDto | 1 | ||
| - - planBeskrivelse | string | Length: 1-4050 | 0 - 1 | Beskrivelse af indsatsen i planen som vises for borger. Det anbefales at holde sig til en kort, klar og entydig beskrivelse |
| - - ansvarligMyndighed | AnsvarligMyndighedDto | 0 - 1 | Angivelse af den ansvarlige sagsbehandler. | |
| - - - myndighed | MyndighedDto | 1 | Detaljer på myndigheden. | |
| - - - - myndighedskode | string | Pattern: [-][1]|[0-9]{1,8} MinLength: 1 | 1 | Myndighedskode |
| - - - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - - sagsbehandler | SagsbehandlerDto | 1 | Detaljer på sagsbehandleren. | |
| - - - - fornavn | 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 | 0 - 1 | Sagsbehandlerens emailadresse. | ||
| - - - - sagsbehandlerId | string | Length: 1-255 | 1 | Sagsbehandlerens id. |
| - - opfoelgningsDato | date | 0 - 1 | Opfølgningsdato for sagsbehandler. | |
| - - maal | CreateMaalDtoCollection | 1 | Collection indeholdende de mål, der er tilknyttet planen. | |
| - - - CreateMaalDto | CreateMaalDto | 0 - * | ||
| - - - - maalKodeType | MaalKodeTypeCodeList | 1 | ||
| - - - - maalKode | 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 | string | Length: 1-4050 | 0 - 1 | Er 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. |
| - - - - aliasIdentifier | uuid | 0 - 1 | Hvis målet er af typen ESCO STAR, så kan der være et alias tilknyttet | |
| - - - - sorteringsRaekkefoelge | int32 | 1 | Angiver 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. | |
| - - - - maalId | uuid | 0 - 1 | Id for pågældende mål. Kan sættes hvis uddannelsesplan henviser til dette. | |
| - uddannelsesPlan | UddannelsesplanDto | 0 - 1 | ||
| - - uddannelsesplanId | uuid | 0 - 1 | Objekt ID'en for uddannelsesplan objektet. | |
| - - udannelsesplanTrinType | UddannelsesplanTrinTypeCodeList | 1 | ||
| - - uddannelser | UddannelseDtoCollection | 1 | En samling af uddannelser. | |
| - - - UddannelseDto | UddannelseDto | 0 - * | ||
| - - - - uddannelsesId | uuid | 0 - 1 | Indeholder en samling uddannelsesønsker for trin 1. Indeholder en samling af uddannelsessteder for de øvrige trin. | |
| - - - - uddannelsesoenske | string | Length: 0-500 | 0 - 1 | Dette er borgerens uddannelsesønske, som registreret af sagsbehandleren. |
| - - - - maalId | uuid | 0 - 1 | Dette er en relation til et af planens hovedmål – planmaal.maal. Skal sættes på trin 2+3. | |
| - - - - uddannelsesnavn | string | Length: 0-500 | 0 - 1 | Navnet på uddannelsen Fx: Maskinsnedker. |
| - - - - lokationsnavn | string | Length: 0-500 | 0 - 1 | Uddannelses lokationsnavn Fx: Københavns Tekniske Skole. |
| - - - - lokationsadresse | LokationsadresseDto | 0 - 1 | ||
| - - - - - adresse | string | Length: 0-1000 | 0 - 1 | Adresse. |
| - - - - - postnummer | string | Length: 0-4 | 0 - 1 | Postnummer. |
| - - - - - postdistrikt | string | Length: 0-200 | 0 - 1 | By. |
| - - - - ansoegningsfrist | date-time | 0 - 1 | Ansøgningsfrist. | |
| - - - - startdato | date-time | 0 - 1 | Uddannelsesstartdato. | |
| - - - - uddannelsesstatusType | UddannelsesansoegningsstatusTypeCodeList | 1 | ||
| - - - - sorteringsorder | int32 | 1 | Angiver rækkefølgen for hvorledes de enkelte mål på Jobnet skal fremvises for borgeren. | |
| - - - - cvrEnhedsId | string | Length: 1-8 | 0 - 1 | CVR nummer for uddannelsesstedet. |
| - - - - pNummer | string | Length: 1-10 | 0 - 1 | P-nummer for uddannelsesstedet. |
| - - sagsbehandlerkommentar | string | Length: 0-3000 | 0 - 1 | Kommentar sagsbehandleren kan videregive til uddannelsesinstitutioner omkring borgerens situation ved trin 3. |
| - - medJobmaal | boolean | 1 | Uddannelsesplan med Jobmål eller uden Jobmål.Hvis med jobmål er denne også kaldet en kombiplan. | |
| - - stoettebehov | StoettebehovTypeCodeListCollection | 1 | Indeholder en samling af støttebehov m.v. for at den unge kan fastholdes i at gennemføre uddannelsen. | |
| - - - StoettebehovTypeCodeList | StoettebehovTypeCodeList | 0 - * | ||
| - - fristdato | date-time | 0 - 1 | Dato for den frist borgeren er blevet pålagt for pågældende uddannelsesplan trin. |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | uuid | 1 |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
| 110001 | Person findes ikke for det angivne CPR-nummer | Person findes ikke for det angivne CPR-nummer |
| 8018 | FristDato for uddannelsesplanen må ikke være dags dato eller før | FristDato for uddannelsesplanen må ikke være dags dato eller før |
| 8021 | Den angivne plantype er ikke gyldig | Den angivne plantype er ikke gyldig |
| 8044 | Uddannelsesplanstypen er ikke tilladt for borgere over 30 år | Uddannelsesplanstypen er ikke tilladt for borgere over 30 år |
| 8053 | Det specificerede mål findes ikke i uddannelsesplanen | Det specificerede mål findes ikke i uddannelsesplanen |
| 8060 | Operationen er ikke tilladt når borger ikke har en aktiv kontaktgruppe | Operationen er ikke tilladt når borger ikke har en aktiv kontaktgruppe |
| 8061 | Jobplanens mål skal være en gyldig stillingsbetegnelse | Jobplanens mål skal være en gyldig stillingsbetegnelse |
| 8062 | En gyldig kombination af kontaktgruppe og personkategori er nødvendig | En gyldig kombination af kontaktgruppe og personkategori er nødvendig |
| 8074 | Uddannelsesplanstypen er ikke tilladt for borgere over 25 år | Uddannelsesplanstypen er ikke tilladt for borgere over 25 år |
| 8078 | Når du gemmer UddannelsesPlan i trin 4, skal der være uddannelser til stede | Når du gemmer UddannelsesPlan i trin 4, skal der være uddannelser til stede |
| 8116 | En jobplan må maksimalt indeholde et mål | En jobplan må maksimalt indeholde et mål |
| 8281 | Beskæftigelsesid findes ikke | Beskæftigelsesid findes ikke |
| 8282 | Beskæftigelsesid er udløbet | Beskæftigelsesid er udløbet |
| 8285 | Mindst 1 uddannelsesmål skal være angivet | Mindst 1 uddannelsesmål skal være angivet |
| 8289 | UddannelsesPlan med jobmål ikke tilladt | UddannelsesPlan med jobmål ikke tilladt |
| 9117 | Borgere, der er DPM og under 25 år med en UddannelsesPlan, skal have MedJobmaal angivet | Borgere, der er DPM og under 25 år med en UddannelsesPlan, skal have MedJobmaal angivet |
| 9129 | En jobplan skal have mindst et mål | En jobplan skal have mindst et mål |
| 9369 | Kombinationen af borgers kontaktgruppe og personkategori kræver mindst en stillingsbetegnelse | Kombinationen af borgers kontaktgruppe og personkategori kræver mindst en stillingsbetegnelse |
| 9371 | Kombinationen af borgers kontaktgruppe og personkategori er kun en stillingsbetegnelse tilladt | Kombinationen af borgers kontaktgruppe og personkategori er kun en stillingsbetegnelse tilladt |
| 9428 | Målkode er ikke gyldig | Målkode er ikke gyldig |
| 9435 | Når du vælger Stoettebehov id 1, så er id2 og/eller id 3 ikke tilladt | Når du vælger Stoettebehov id 1, så er id2 og/eller id 3 ikke tilladt |
| 9436 | Når du vælger Stoettebehov id 4, så skal id2 og/eller id 3 være til stede | Når du vælger Stoettebehov id 4, så skal id2 og/eller id 3 være til stede |
| 9437 | Når du gemmer UddannelsesPlan i trin 4, skal uddannelses Støttebehov være til stede | Når du gemmer UddannelsesPlan i trin 4, skal uddannelses Støttebehov være til stede |
| 9439 | Borgeren kan ikke registreres med samme ConceptUriDa flere gange | Borgeren kan ikke registreres med samme ConceptUriDa flere gange |
| 8055 | Ansvarlig sagsbehandler skal være angivet | Ansvarlig sagsbehandler skal være angivet |
| 9358 | Planbeskrivelse er ikke tilladt med kombinationen af borgerkontaktgruppe og personkategori | Planbeskrivelse er ikke tilladt med kombinationen af borgerkontaktgruppe og personkategori |
| 4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
| 9463 | JobCenter må ikke oprette planer for dagpengemodtagere med aktivt kontaktforløb i a-kasse | JobCenter må ikke oprette planer for dagpengemodtagere med aktivt kontaktforløb i a-kasse |
| 110005 | Uddannelsesplan skal have plan type uddannelsesplan | Uddannelsesplan skal have plan type uddannelsesplan |
| 110006 | Hvis uddannelse har mål, skal planen også have et mål | Hvis uddannelse har mål, skal planen også have et mål |
| 110007 | Plan med plan type Uddannelsesplan skal have uddannelsesplan populeret | Plan med plan type Uddannelsesplan skal have uddannelsesplan populeret |
| 110009 | Plan med plan type Uddannelsesplan skal have fristdato sat | Plan med plan type Uddannelsesplan skal have fristdato sat |
| 110010 | Uddannelsesplan 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 borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere | |
|---|---|---|---|---|---|---|---|---|
| A-kasse | X | X | ||||||
| JobCenter | X | X | X | X | ||||
| STAR | X |
Scope
Input
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| 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 |
| planversionIdentifier [Path] | uuid | 1 |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | GetPlanResponseDto | 1 | ||
| - plan | PlanDto | 1 | ||
| - - planVersion | PlanVersionDto | 1 | ||
| - - - planVersionId | uuid | 1 | Id for planversionen. | |
| - - - planType | PlanTypeCodeList | 1 | ||
| - - - version | int32 | 1 | Versionsnummer for den pågældende plan. | |
| - - - dfdgRegistreringsTidspunkt | date-time | 1 | Dato for hvornår elementet er blevet oprettet. | |
| - - - opdateretTidspunkt | date-time | 1 | Dato for hvornår elementet er blevet opdateret. | |
| - - planMaal | GetPlanmaalDto | 1 | ||
| - - - planBeskrivelse | string | Length: 1-4050 | 0 - 1 | Beskrivelse af indsatsen i planen som vises for borger. Det anbefales at holde sig til en kort, klar og entydig beskrivelse |
| - - - ansvarligMyndighed | AnsvarligMyndighedDto | 0 - 1 | Angivelse af den ansvarlige sagsbehandler. | |
| - - - - myndighed | MyndighedDto | 1 | Detaljer på myndigheden. | |
| - - - - - myndighedskode | string | Pattern: [-][1]|[0-9]{1,8} MinLength: 1 | 1 | Myndighedskode |
| - - - - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - - - sagsbehandler | SagsbehandlerDto | 1 | Detaljer på sagsbehandleren. | |
| - - - - - fornavn | 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 | 0 - 1 | Sagsbehandlerens emailadresse. | ||
| - - - - - sagsbehandlerId | string | Length: 1-255 | 1 | Sagsbehandlerens id. |
| - - - opfoelgningsDato | date | 0 - 1 | Opfølgningsdato for sagsbehandler. | |
| - - - maal | GetMaalDtoCollection | 1 | Collection indeholdende de mål, der er tilknyttet planen. | |
| - - - - GetMaalDto | GetMaalDto | 0 - * | ||
| - - - - - maalKodeType | MaalKodeTypeCodeList | 1 | ||
| - - - - - maalKode | 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 | string | Length: 1-4050 | 0 - 1 | Er 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. |
| - - - - - aliasIdentifier | uuid | 0 - 1 | Hvis målet er af typen ESCO STAR, så kan der være et alias tilknyttet | |
| - - - - - sorteringsRaekkefoelge | int32 | 1 | Angiver 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. | |
| - - - - - maalId | uuid | 1 | Id for pågældende mål. Sættes af DFDG. | |
| - - - oprettetTidspunkt | date-time | 0 - 1 | Dato for oprettelse af elementet. Ved servicekald hvor dette planmål anvendes som argument skal planmaalId elementet fjernes | |
| - - - opdateretTidspunkt | date-time | 0 - 1 | Dato for hvornår elementet er blevet opdateret. Ved servicekald hvor dette planmål anvendes som argument skal planmaalId elementet fjernes | |
| - uddannelsesPlan | UddannelsesplanDto | 0 - 1 | ||
| - - uddannelsesplanId | uuid | 0 - 1 | Objekt ID'en for uddannelsesplan objektet. | |
| - - udannelsesplanTrinType | UddannelsesplanTrinTypeCodeList | 1 | ||
| - - uddannelser | UddannelseDtoCollection | 1 | En samling af uddannelser. | |
| - - - UddannelseDto | UddannelseDto | 0 - * | ||
| - - - - uddannelsesId | uuid | 0 - 1 | Indeholder en samling uddannelsesønsker for trin 1. Indeholder en samling af uddannelsessteder for de øvrige trin. | |
| - - - - uddannelsesoenske | string | Length: 0-500 | 0 - 1 | Dette er borgerens uddannelsesønske, som registreret af sagsbehandleren. |
| - - - - maalId | uuid | 0 - 1 | Dette er en relation til et af planens hovedmål – planmaal.maal. Skal sættes på trin 2+3. | |
| - - - - uddannelsesnavn | string | Length: 0-500 | 0 - 1 | Navnet på uddannelsen Fx: Maskinsnedker. |
| - - - - lokationsnavn | string | Length: 0-500 | 0 - 1 | Uddannelses lokationsnavn Fx: Københavns Tekniske Skole. |
| - - - - lokationsadresse | LokationsadresseDto | 0 - 1 | ||
| - - - - - adresse | string | Length: 0-1000 | 0 - 1 | Adresse. |
| - - - - - postnummer | string | Length: 0-4 | 0 - 1 | Postnummer. |
| - - - - - postdistrikt | string | Length: 0-200 | 0 - 1 | By. |
| - - - - ansoegningsfrist | date-time | 0 - 1 | Ansøgningsfrist. | |
| - - - - startdato | date-time | 0 - 1 | Uddannelsesstartdato. | |
| - - - - uddannelsesstatusType | UddannelsesansoegningsstatusTypeCodeList | 1 | ||
| - - - - sorteringsorder | int32 | 1 | Angiver rækkefølgen for hvorledes de enkelte mål på Jobnet skal fremvises for borgeren. | |
| - - - - cvrEnhedsId | string | Length: 1-8 | 0 - 1 | CVR nummer for uddannelsesstedet. |
| - - - - pNummer | string | Length: 1-10 | 0 - 1 | P-nummer for uddannelsesstedet. |
| - - sagsbehandlerkommentar | string | Length: 0-3000 | 0 - 1 | Kommentar sagsbehandleren kan videregive til uddannelsesinstitutioner omkring borgerens situation ved trin 3. |
| - - medJobmaal | boolean | 1 | Uddannelsesplan med Jobmål eller uden Jobmål.Hvis med jobmål er denne også kaldet en kombiplan. | |
| - - stoettebehov | StoettebehovTypeCodeListCollection | 1 | Indeholder en samling af støttebehov m.v. for at den unge kan fastholdes i at gennemføre uddannelsen. | |
| - - - StoettebehovTypeCodeList | StoettebehovTypeCodeList | 0 - * | ||
| - - fristdato | date-time | 0 - 1 | Dato for den frist borgeren er blevet pålagt for pågældende uddannelsesplan trin. |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
| 110001 | Person findes ikke for det angivne CPR-nummer | Person findes ikke for det angivne CPR-nummer |
| 8001 | En plan med det angivne versionIdentifier kan ikke findes | En plan med det angivne versionIdentifier kan ikke findes |
| 9203 | A-kassen må ikke tilgå planen | A-kassen må ikke tilgå planen |
CreatePlan (POST /v2/Plan)
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere | |
|---|---|---|---|---|---|---|---|---|
| A-kasse | X | |||||||
| JobCenter | X | X | ||||||
| STAR | X |
Scope
Input
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| 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 |
| 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 | CreatePlanRequestDto | 1 | ||
| - planType | PlanTypeCodeList | 1 | ||
| - planmaal | CreatePlanmaalDto | 1 | ||
| - - planBeskrivelse | string | Length: 1-4050 | 0 - 1 | Beskrivelse af indsatsen i planen som vises for borger. Det anbefales at holde sig til en kort, klar og entydig beskrivelse |
| - - ansvarligMyndighed | AnsvarligMyndighedDto | 0 - 1 | Angivelse af den ansvarlige sagsbehandler. | |
| - - - myndighed | MyndighedDto | 1 | Detaljer på myndigheden. | |
| - - - - myndighedskode | string | Pattern: [-][1]|[0-9]{1,8} MinLength: 1 | 1 | Myndighedskode |
| - - - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - - sagsbehandler | SagsbehandlerDto | 1 | Detaljer på sagsbehandleren. | |
| - - - - fornavn | 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 | 0 - 1 | Sagsbehandlerens emailadresse. | ||
| - - - - sagsbehandlerId | string | Length: 1-255 | 1 | Sagsbehandlerens id. |
| - - opfoelgningsDato | date | 0 - 1 | Opfølgningsdato for sagsbehandler. | |
| - - maal | CreateMaalDtoCollection | 1 | Collection indeholdende de mål, der er tilknyttet planen. | |
| - - - CreateMaalDto | CreateMaalDto | 0 - * | ||
| - - - - maalKodeType | MaalKodeTypeCodeList | 1 | ||
| - - - - maalKode | 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 | string | Length: 1-4050 | 0 - 1 | Er 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. |
| - - - - aliasIdentifier | uuid | 0 - 1 | Hvis målet er af typen ESCO STAR, så kan der være et alias tilknyttet | |
| - - - - sorteringsRaekkefoelge | int32 | 1 | Angiver 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. | |
| - - - - maalId | uuid | 0 - 1 | Id for pågældende mål. Kan sættes hvis uddannelsesplan henviser til dette. | |
| - uddannelsesPlan | UddannelsesplanDto | 0 - 1 | ||
| - - uddannelsesplanId | uuid | 0 - 1 | Objekt ID'en for uddannelsesplan objektet. | |
| - - udannelsesplanTrinType | UddannelsesplanTrinTypeCodeList | 1 | ||
| - - uddannelser | UddannelseDtoCollection | 1 | En samling af uddannelser. | |
| - - - UddannelseDto | UddannelseDto | 0 - * | ||
| - - - - uddannelsesId | uuid | 0 - 1 | Indeholder en samling uddannelsesønsker for trin 1. Indeholder en samling af uddannelsessteder for de øvrige trin. | |
| - - - - uddannelsesoenske | string | Length: 0-500 | 0 - 1 | Dette er borgerens uddannelsesønske, som registreret af sagsbehandleren. |
| - - - - maalId | uuid | 0 - 1 | Dette er en relation til et af planens hovedmål – planmaal.maal. Skal sættes på trin 2+3. | |
| - - - - uddannelsesnavn | string | Length: 0-500 | 0 - 1 | Navnet på uddannelsen Fx: Maskinsnedker. |
| - - - - lokationsnavn | string | Length: 0-500 | 0 - 1 | Uddannelses lokationsnavn Fx: Københavns Tekniske Skole. |
| - - - - lokationsadresse | LokationsadresseDto | 0 - 1 | ||
| - - - - - adresse | string | Length: 0-1000 | 0 - 1 | Adresse. |
| - - - - - postnummer | string | Length: 0-4 | 0 - 1 | Postnummer. |
| - - - - - postdistrikt | string | Length: 0-200 | 0 - 1 | By. |
| - - - - ansoegningsfrist | date-time | 0 - 1 | Ansøgningsfrist. | |
| - - - - startdato | date-time | 0 - 1 | Uddannelsesstartdato. | |
| - - - - uddannelsesstatusType | UddannelsesansoegningsstatusTypeCodeList | 1 | ||
| - - - - sorteringsorder | int32 | 1 | Angiver rækkefølgen for hvorledes de enkelte mål på Jobnet skal fremvises for borgeren. | |
| - - - - cvrEnhedsId | string | Length: 1-8 | 0 - 1 | CVR nummer for uddannelsesstedet. |
| - - - - pNummer | string | Length: 1-10 | 0 - 1 | P-nummer for uddannelsesstedet. |
| - - sagsbehandlerkommentar | string | Length: 0-3000 | 0 - 1 | Kommentar sagsbehandleren kan videregive til uddannelsesinstitutioner omkring borgerens situation ved trin 3. |
| - - medJobmaal | boolean | 1 | Uddannelsesplan med Jobmål eller uden Jobmål.Hvis med jobmål er denne også kaldet en kombiplan. | |
| - - stoettebehov | StoettebehovTypeCodeListCollection | 1 | Indeholder en samling af støttebehov m.v. for at den unge kan fastholdes i at gennemføre uddannelsen. | |
| - - - StoettebehovTypeCodeList | StoettebehovTypeCodeList | 0 - * | ||
| - - fristdato | date-time | 0 - 1 | Dato for den frist borgeren er blevet pålagt for pågældende uddannelsesplan trin. |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | uuid | 1 |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
| 110001 | Person findes ikke for det angivne CPR-nummer | Person findes ikke for det angivne CPR-nummer |
| 8018 | FristDato for uddannelsesplanen må ikke være dags dato eller før | FristDato for uddannelsesplanen må ikke være dags dato eller før |
| 8021 | Den angivne plantype er ikke gyldig | Den angivne plantype er ikke gyldig |
| 8044 | Uddannelsesplanstypen er ikke tilladt for borgere over 30 år | Uddannelsesplanstypen er ikke tilladt for borgere over 30 år |
| 8053 | Det specificerede mål findes ikke i uddannelsesplanen | Det specificerede mål findes ikke i uddannelsesplanen |
| 8060 | Operationen er ikke tilladt når borger ikke har en aktiv kontaktgruppe | Operationen er ikke tilladt når borger ikke har en aktiv kontaktgruppe |
| 8061 | Jobplanens mål skal være en gyldig stillingsbetegnelse | Jobplanens mål skal være en gyldig stillingsbetegnelse |
| 8062 | En gyldig kombination af kontaktgruppe og personkategori er nødvendig | En gyldig kombination af kontaktgruppe og personkategori er nødvendig |
| 8074 | Uddannelsesplanstypen er ikke tilladt for borgere over 25 år | Uddannelsesplanstypen er ikke tilladt for borgere over 25 år |
| 8078 | Når du gemmer UddannelsesPlan i trin 4, skal der være uddannelser til stede | Når du gemmer UddannelsesPlan i trin 4, skal der være uddannelser til stede |
| 8116 | En jobplan må maksimalt indeholde et mål | En jobplan må maksimalt indeholde et mål |
| 8281 | Beskæftigelsesid findes ikke | Beskæftigelsesid findes ikke |
| 8282 | Beskæftigelsesid er udløbet | Beskæftigelsesid er udløbet |
| 8285 | Mindst 1 uddannelsesmål skal være angivet | Mindst 1 uddannelsesmål skal være angivet |
| 8289 | UddannelsesPlan med jobmål ikke tilladt | UddannelsesPlan med jobmål ikke tilladt |
| 9117 | Borgere, der er DPM og under 25 år med en UddannelsesPlan, skal have MedJobmaal angivet | Borgere, der er DPM og under 25 år med en UddannelsesPlan, skal have MedJobmaal angivet |
| 9129 | En jobplan skal have mindst et mål | En jobplan skal have mindst et mål |
| 9369 | Kombinationen af borgers kontaktgruppe og personkategori kræver mindst en stillingsbetegnelse | Kombinationen af borgers kontaktgruppe og personkategori kræver mindst en stillingsbetegnelse |
| 9371 | Kombinationen af borgers kontaktgruppe og personkategori er kun en stillingsbetegnelse tilladt | Kombinationen af borgers kontaktgruppe og personkategori er kun en stillingsbetegnelse tilladt |
| 9428 | Målkode er ikke gyldig | Målkode er ikke gyldig |
| 9435 | Når du vælger Stoettebehov id 1, så er id2 og/eller id 3 ikke tilladt | Når du vælger Stoettebehov id 1, så er id2 og/eller id 3 ikke tilladt |
| 9436 | Når du vælger Stoettebehov id 4, så skal id2 og/eller id 3 være til stede | Når du vælger Stoettebehov id 4, så skal id2 og/eller id 3 være til stede |
| 9437 | Når du gemmer UddannelsesPlan i trin 4, skal uddannelses Støttebehov være til stede | Når du gemmer UddannelsesPlan i trin 4, skal uddannelses Støttebehov være til stede |
| 9439 | Borgeren kan ikke registreres med samme ConceptUriDa flere gange | Borgeren kan ikke registreres med samme ConceptUriDa flere gange |
| 8055 | Ansvarlig sagsbehandler skal være angivet | Ansvarlig sagsbehandler skal være angivet |
| 9358 | Planbeskrivelse er ikke tilladt med kombinationen af borgerkontaktgruppe og personkategori | Planbeskrivelse er ikke tilladt med kombinationen af borgerkontaktgruppe og personkategori |
| 4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
| 9463 | JobCenter må ikke oprette planer for dagpengemodtagere med aktivt kontaktforløb i a-kasse | JobCenter må ikke oprette planer for dagpengemodtagere med aktivt kontaktforløb i a-kasse |
| 110005 | Uddannelsesplan skal have plan type uddannelsesplan | Uddannelsesplan skal have plan type uddannelsesplan |
| 110006 | Hvis uddannelse har mål, skal planen også have et mål | Hvis uddannelse har mål, skal planen også have et mål |
| 110007 | Plan med plan type Uddannelsesplan skal have uddannelsesplan populeret | Plan med plan type Uddannelsesplan skal have uddannelsesplan populeret |
| 110009 | Plan med plan type Uddannelsesplan skal have fristdato sat | Plan med plan type Uddannelsesplan skal have fristdato sat |
| 110010 | Uddannelsesplan 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 borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere | |
|---|---|---|---|---|---|---|---|---|
| A-kasse | X | X | ||||||
| JobCenter | X | X | X | X | ||||
| STAR | X |
Scope
Input
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| 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 |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | GetPlanResponseDto | 1 | ||
| - plan | PlanDto | 1 | ||
| - - planVersion | PlanVersionDto | 1 | ||
| - - - planVersionId | uuid | 1 | Id for planversionen. | |
| - - - planType | PlanTypeCodeList | 1 | ||
| - - - version | int32 | 1 | Versionsnummer for den pågældende plan. | |
| - - - dfdgRegistreringsTidspunkt | date-time | 1 | Dato for hvornår elementet er blevet oprettet. | |
| - - - opdateretTidspunkt | date-time | 1 | Dato for hvornår elementet er blevet opdateret. | |
| - - planMaal | GetPlanmaalDto | 1 | ||
| - - - planBeskrivelse | string | Length: 1-4050 | 0 - 1 | Beskrivelse af indsatsen i planen som vises for borger. Det anbefales at holde sig til en kort, klar og entydig beskrivelse |
| - - - ansvarligMyndighed | AnsvarligMyndighedDto | 0 - 1 | Angivelse af den ansvarlige sagsbehandler. | |
| - - - - myndighed | MyndighedDto | 1 | Detaljer på myndigheden. | |
| - - - - - myndighedskode | string | Pattern: [-][1]|[0-9]{1,8} MinLength: 1 | 1 | Myndighedskode |
| - - - - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - - - sagsbehandler | SagsbehandlerDto | 1 | Detaljer på sagsbehandleren. | |
| - - - - - fornavn | 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 | 0 - 1 | Sagsbehandlerens emailadresse. | ||
| - - - - - sagsbehandlerId | string | Length: 1-255 | 1 | Sagsbehandlerens id. |
| - - - opfoelgningsDato | date | 0 - 1 | Opfølgningsdato for sagsbehandler. | |
| - - - maal | GetMaalDtoCollection | 1 | Collection indeholdende de mål, der er tilknyttet planen. | |
| - - - - GetMaalDto | GetMaalDto | 0 - * | ||
| - - - - - maalKodeType | MaalKodeTypeCodeList | 1 | ||
| - - - - - maalKode | 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 | string | Length: 1-4050 | 0 - 1 | Er 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. |
| - - - - - aliasIdentifier | uuid | 0 - 1 | Hvis målet er af typen ESCO STAR, så kan der være et alias tilknyttet | |
| - - - - - sorteringsRaekkefoelge | int32 | 1 | Angiver 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. | |
| - - - - - maalId | uuid | 1 | Id for pågældende mål. Sættes af DFDG. | |
| - - - oprettetTidspunkt | date-time | 0 - 1 | Dato for oprettelse af elementet. Ved servicekald hvor dette planmål anvendes som argument skal planmaalId elementet fjernes | |
| - - - opdateretTidspunkt | date-time | 0 - 1 | Dato for hvornår elementet er blevet opdateret. Ved servicekald hvor dette planmål anvendes som argument skal planmaalId elementet fjernes | |
| - uddannelsesPlan | UddannelsesplanDto | 0 - 1 | ||
| - - uddannelsesplanId | uuid | 0 - 1 | Objekt ID'en for uddannelsesplan objektet. | |
| - - udannelsesplanTrinType | UddannelsesplanTrinTypeCodeList | 1 | ||
| - - uddannelser | UddannelseDtoCollection | 1 | En samling af uddannelser. | |
| - - - UddannelseDto | UddannelseDto | 0 - * | ||
| - - - - uddannelsesId | uuid | 0 - 1 | Indeholder en samling uddannelsesønsker for trin 1. Indeholder en samling af uddannelsessteder for de øvrige trin. | |
| - - - - uddannelsesoenske | string | Length: 0-500 | 0 - 1 | Dette er borgerens uddannelsesønske, som registreret af sagsbehandleren. |
| - - - - maalId | uuid | 0 - 1 | Dette er en relation til et af planens hovedmål – planmaal.maal. Skal sættes på trin 2+3. | |
| - - - - uddannelsesnavn | string | Length: 0-500 | 0 - 1 | Navnet på uddannelsen Fx: Maskinsnedker. |
| - - - - lokationsnavn | string | Length: 0-500 | 0 - 1 | Uddannelses lokationsnavn Fx: Københavns Tekniske Skole. |
| - - - - lokationsadresse | LokationsadresseDto | 0 - 1 | ||
| - - - - - adresse | string | Length: 0-1000 | 0 - 1 | Adresse. |
| - - - - - postnummer | string | Length: 0-4 | 0 - 1 | Postnummer. |
| - - - - - postdistrikt | string | Length: 0-200 | 0 - 1 | By. |
| - - - - ansoegningsfrist | date-time | 0 - 1 | Ansøgningsfrist. | |
| - - - - startdato | date-time | 0 - 1 | Uddannelsesstartdato. | |
| - - - - uddannelsesstatusType | UddannelsesansoegningsstatusTypeCodeList | 1 | ||
| - - - - sorteringsorder | int32 | 1 | Angiver rækkefølgen for hvorledes de enkelte mål på Jobnet skal fremvises for borgeren. | |
| - - - - cvrEnhedsId | string | Length: 1-8 | 0 - 1 | CVR nummer for uddannelsesstedet. |
| - - - - pNummer | string | Length: 1-10 | 0 - 1 | P-nummer for uddannelsesstedet. |
| - - sagsbehandlerkommentar | string | Length: 0-3000 | 0 - 1 | Kommentar sagsbehandleren kan videregive til uddannelsesinstitutioner omkring borgerens situation ved trin 3. |
| - - medJobmaal | boolean | 1 | Uddannelsesplan med Jobmål eller uden Jobmål.Hvis med jobmål er denne også kaldet en kombiplan. | |
| - - stoettebehov | StoettebehovTypeCodeListCollection | 1 | Indeholder en samling af støttebehov m.v. for at den unge kan fastholdes i at gennemføre uddannelsen. | |
| - - - StoettebehovTypeCodeList | StoettebehovTypeCodeList | 0 - * | ||
| - - fristdato | date-time | 0 - 1 | Dato for den frist borgeren er blevet pålagt for pågældende uddannelsesplan trin. |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
| 110001 | Person findes ikke for det angivne CPR-nummer | Person findes ikke for det angivne CPR-nummer |
| 8001 | En plan med det angivne versionIdentifier kan ikke findes | En plan med det angivne versionIdentifier kan ikke findes |
| 9203 | A-kassen må ikke tilgå planen | A-kassen må ikke tilgå planen |
GetPlanVersioner (GET /v2/Plan/versioner)
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere | |
|---|---|---|---|---|---|---|---|---|
| A-kasse | X | X | ||||||
| JobCenter | X | X | X | X | ||||
| STAR | X |
Scope
Input
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| 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 |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | GetPlanVersionerResponseDto | 1 | ||
| - planVersioner | PlanVersionDtoCollection | 1 | ||
| - - PlanVersionDto | PlanVersionDto | 0 - * | ||
| - - - planVersionId | uuid | 1 | Id for planversionen. | |
| - - - planType | PlanTypeCodeList | 1 | ||
| - - - version | int32 | 1 | Versionsnummer for den pågældende plan. | |
| - - - dfdgRegistreringsTidspunkt | date-time | 1 | Dato for hvornår elementet er blevet oprettet. | |
| - - - opdateretTidspunkt | date-time | 1 | Dato for hvornår elementet er blevet opdateret. |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
| 110001 | Person findes ikke for det angivne CPR-nummer | Person findes ikke for det angivne CPR-nummer |
UpdatePlanbeskrivelse (PUT /v2/Plan/{planVersionId}/PlanBeskrivelse)
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere | |
|---|---|---|---|---|---|---|---|---|
| JobCenter | X | X | ||||||
| STAR | X |
Scope
Input
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| 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 |
| planVersionId [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 | |
| requestBody | UpdatePlanbeskrivelseRequestDto | 1 | ||
| - planBeskrivelse | string | MinLength: 1 | 1 | Beskrivelse af indsatsen i planen som vises for borger. Det anbefales at holde sig til en kort, klar og entydig beskrivelse |
Output
Intet output
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
| 9429 | Planen blev ikke fundet | Planen blev ikke fundet |
| 9433 | Plan beskrivelsen er tom og kan derfor ikke blive opdateret | Plan beskrivelsen er tom og kan derfor ikke blive opdateret |
UpdateMaalbeskrivelse (PUT /v2/Plan/{planVersionId}/maal/{maalId}/maalbeskrivelse)
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere | |
|---|---|---|---|---|---|---|---|---|
| JobCenter | X | X | ||||||
| STAR | X |
Scope
Input
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| 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 |
| planVersionId [Path] | uuid | 1 | ||
| maalId [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 | |
| requestBody | UpdateMaalbeskrivelseRequestDto | 1 | ||
| - maalbeskrivelse | string | MinLength: 1 | 1 |
Output
Intet output
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
| 9429 | Planen blev ikke fundet | Planen blev ikke fundet |
| 9432 | Plan mål beskrivelse kan kun opdateres på custom mål | Plan mål beskrivelse kan kun opdateres på custom mål |