Siden opdateres automatisk til at afspejle koden.
Metoder
CreatePlan (POST /v1/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 | PlanmaalDto | 1 | ||
| - - planmaalId | uuid | 0 - 1 | Objekt id'en for planmål. Ved servicekald hvor dette planmål anvendes som argument skal planmaalId elementet fjernes | |
| - - planBeskrivelse | string | 0 - 1 | Beskrivelse af indsatsen i planen som vises for borger. Beskrivelsen skal være under 4050 tegn. Det anbefales at holde sig til en kort, klar og entydig beskrivelse | |
| - - maalListe | MaalDtoCollection | 1 | Collection indeholdende de mål, der er tilknyttet planen. | |
| - - - MaalDto | MaalDto | 0 - * | ||
| - - - - maalId | uuid | 0 - 1 | Id for pågældende mål. Sættes af DFDG. | |
| - - - - maalKodeType | MaalKodeTypeCodeList | 1 | ||
| - - - - maalKode | string | 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 | 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. | |
| - - - - aliasIdentiier | uuid | 0 - 1 | Hvis målet er af typen ESCO STAR, så kan der være et alias tilknyttet | |
| - - - - sorteringsOrden | 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. | |
| - - 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 |
| - - - - myndighedsnavn | string | Length: 1-20 | 1 | |
| - - - - organisationType | OrganisationTypeCodeList | 0 - 1 | ||
| - - - sagsbehandler | SagsbehandlerDto | 1 | Detaljer på sagsbehandleren. | |
| - - - - fornavne | string | Length: 1-50 | 1 | Sagsbehandlerens fornavne. |
| - - - - mellemnavn | string | Length: 1-40 | 0 - 1 | Sagsbehandlerens mellemnavn. |
| - - - - efternavn | string | Length: 1-40 | 1 | Sagsbehandlerens efternavn. |
| - - - - telefonnummer | string | Pattern: (\+)?[0-9]{3,20} | 0 - 1 | Sagsbehandlerens telefonnummer. |
| - - - - emailadresse | 0 - 1 | Sagsbehandlerens emailadresse. | ||
| - - - - sagsbehandlerId | string | Length: 1-255 | 1 | Sagsbehandlerens id. |
| - - opfoelgningstidspunkt | date-time | 0 - 1 | Opfølgningsdato for sagsbehandler. | |
| - - 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 |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | PublishPlanResponseDto | 1 | Kvittering som indeholder den unikke identifikation for den oprettede entitet | |
| - planVersionId | uuid | 0 - 1 | Unik identifikation for den oprettede entitet. |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
| 1001 | Ugyldigt cpr-nummer | Ugyldigt cpr-nummer |
| 1009 | Systemet er forkert konfigureret | Systemet er forkert konfigureret |
| 1010 | Unknown cpr | Unknown cpr |
| 4013 | Ukendt klientdestination | Ukendt klientdestination |
| 4385 | The client does not have an unemploymentfund registration | The client does not have an unemploymentfund registration |
| 4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
| 4695 | Det angivne jobcenter findes ikke | Det angivne jobcenter findes ikke |
| 6005 | Personen med det angivne CPR-nummer tilhører ikke det jobcenter, der er angivet i ActiveOrganisationHeader | Personen med det angivne CPR-nummer tilhører ikke det jobcenter, der er angivet i ActiveOrganisationHeader |
| 8002 | Den angivne borger har ingen aktiv plan | Den angivne borger har ingen aktiv plan |
| 8005 | Aktiviteten kunne ikke findes | Aktiviteten kunne ikke findes |
| 8006 | Den angivne borger har ingen plankladde | Den angivne borger har ingen plankladde |
| 8008 | Det er kun muligt at læse planmål | Det er kun muligt at læse planmål |
| 8012 | Det er kun muligt at læse oprettetTidspunkt | Det er kun muligt at læse oprettetTidspunkt |
| 8013 | Det er kun muligt at læse opdateretTidspunkt | Det er kun muligt at læse opdateretTidspunkt |
| 8015 | ||
| 8021 | Den angivne plantype er ikke gyldig | Den angivne plantype er ikke gyldig |
| 8043 | Forkert plantype | Forkert plantype |
| 8051 | Det angivne planmaalId findes ikke | Det angivne planmaalId findes ikke |
| 8052 | Det angivne maalKode findes ikke | Det angivne maalKode findes ikke |
| 8055 | Ansvarlig sagsbehandler skal være angivet | Ansvarlig sagsbehandler skal være angivet |
| 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 |
| 8077 | Ved publisering i trin 4 kræves ResponsibleCaseWorker telefon og e-mail | Ved publisering i trin 4 kræves ResponsibleCaseWorker telefon og e-mail |
| 8075 | Planbeskrivelse overskrider maksimalt antal tegn | Planbeskrivelse overskrider maksimalt antal tegn |
| 8116 | En jobplan må maksimalt indeholde et mål | En jobplan må maksimalt indeholde et mål |
| 8281 | ConceptUriDa findes ikke | ConceptUriDa findes ikke |
| 8282 | ConceptUriDa er udløbet | ConceptUriDa er udløbet |
| 8284 | Præcist 1 jobmål skal være angivet | Præcist 1 jobmål skal være angivet |
| 8285 | Mindst 1 uddannelsesmål skal være angivet | Mindst 1 uddannelsesmål skal være angivet |
| 9129 | En jobplan skal have mindst et mål | En jobplan skal have mindst et mål |
| 9131 | Ugyldig CodeListItemIdentifier | Ugyldig CodeListItemIdentifier |
| 9358 | Planbeskrivelse er ikke tilladt med kombinationen af borgerkontaktgruppe og personkategori | Planbeskrivelse er ikke tilladt med kombinationen af borgerkontaktgruppe og personkategori |
| 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 |
| 9429 | Planen blev ikke fundet | Planen blev ikke fundet |
| 9430 | Betjening er kun tilladt for planversioner | Betjening er kun tilladt for planversioner |
| 9472 | ||
| 9428 | Målkode er ikke gyldig | Målkode er ikke gyldig |
| 9439 | En borger kan ikke registreres med samme ConceptUriDa mere end en gang | En borger kan ikke registreres med samme ConceptUriDa mere end en gang |