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

Version 1 Next »

Siden opdateres automatisk til at afspejle koden.

Metoder

CreatePlan (POST /v1/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
-    planmaalPlanmaalDto1
-    -    planmaalIduuid0 - 1Objekt id'en for planmål. Ved servicekald hvor dette planmål anvendes som argument skal planmaalId elementet fjernes
-    -    planBeskrivelsestring0 - 1Beskrivelse 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
-    -    maalListeMaalDtoCollection1Collection indeholdende de mål, der er tilknyttet planen.
-    -    -    MaalDtoMaalDto0 - *
-    -    -    -    maalIduuid0 - 1Id for pågældende mål. Sættes af DFDG.
-    -    -    -    maalKodeTypeMaalKodeTypeCodeList1
-    -    -    -    maalKodestring0 - 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.
-    -    -    -    maalBeskrivelsestring0 - 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.
-    -    -    -    aliasIdentiieruuid0 - 1Hvis målet er af typen ESCO STAR, så kan der være et alias tilknyttet
-    -    -    -    sorteringsOrdenint321Angiver 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.
-    -    ansvarligMyndighedAnsvarligMyndighedDto0 - 1Angivelse af den ansvarlige sagsbehandler.
-    -    -    myndighedMyndighedDto1Detaljer på myndigheden.
-    -    -    -    myndighedskodestringPattern: [-][1]|[0-9]{1,8}
MinLength: 1		1Myndighedskode
-    -    -    -    myndighedsnavnstringLength: 1-201
-    -    -    -    organisationTypeOrganisationTypeCodeList0 - 1
-    -    -    sagsbehandlerSagsbehandlerDto1Detaljer på sagsbehandleren.
-    -    -    -    fornavnestringLength: 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.
-    -    opfoelgningstidspunktdate-time0 - 1Opfølgningsdato for sagsbehandler.
-    -    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

Output

ElementTypeDetaljerForekomstBeskrivelse
responsePublishPlanResponseDto1Kvittering som indeholder den unikke identifikation for den oprettede entitet
-    planVersionIduuid0 - 1Unik identifikation for den oprettede entitet.

Fejlkoder

FejlkodeFejltekstBeskrivelse
1001Den indsendte CPR-nummer er enten for langt eller kort eller indeholder data, der ikke kan fortolkes som en datoDen indsendte CPR-nummer er enten for langt eller kort eller indeholder data, der ikke kan fortolkes som en dato
1009Systemet er forkert konfigureretSystemet er forkert konfigureret
1010Det indsendte CPR-nummer er ukendt i systemetDet indsendte CPR-nummer er ukendt i systemet
4013Ukendt klientdestinationUkendt klientdestination
4385Klienten har ikke en a-kasseregistreringKlienten har ikke en a-kasseregistrering
4575You are not authorized to execute the operationYou are not authorized to execute the operation
4695Det angivne jobcenter findes ikkeDet angivne jobcenter findes ikke
6005Personen med det angivne CPR-nummer tilhører ikke det jobcenter, der er angivet i ActiveOrganisationHeaderPersonen med det angivne CPR-nummer tilhører ikke det jobcenter, der er angivet i ActiveOrganisationHeader
8002Den angivne borger har ingen aktiv planDen angivne borger har ingen aktiv plan
8005Aktiviteten kunne ikke findesAktiviteten kunne ikke findes
8006Den angivne borger har ingen plankladdeDen angivne borger har ingen plankladde
8008Det er kun muligt at læse planmålDet er kun muligt at læse planmål
8012Det er kun muligt at læse oprettetTidspunktDet er kun muligt at læse oprettetTidspunkt
8013Det er kun muligt at læse opdateretTidspunktDet er kun muligt at læse opdateretTidspunkt
8015Mål skal angives ved publisering af denne plantypeMål skal angives ved publisering af denne plantype
8021Den angivne plantype er ikke gyldigDen angivne plantype er ikke gyldig
8043Forkert plantypeForkert plantype
8051Det angivne planmaalId findes ikkeDet angivne planmaalId findes ikke
8052Det angivne maalKode findes ikkeDet angivne maalKode findes ikke
8055Ansvarlig sagsbehandler skal være angivetAnsvarlig sagsbehandler skal være angivet
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
8077Ved publisering i trin 4 kræves ResponsibleCaseWorker telefon og e-mailVed publisering i trin 4 kræves ResponsibleCaseWorker telefon og e-mail
8075Planbeskrivelse overskrider maksimalt antal tegnPlanbeskrivelse overskrider maksimalt antal tegn
8116En jobplan må maksimalt indeholde et målEn jobplan må maksimalt indeholde et mål
8281Beskæftigelsesid findes ikkeBeskæftigelsesid findes ikke
8282Beskæftigelsesid er udløbetBeskæftigelsesid er udløbet
8284Præcist 1 jobmål skal være angivetPræcist 1 jobmål skal være angivet
8285Mindst 1 jobmål skal være angivetMindst 1 jobmål skal være angivet
9129En jobplan skal have mindst et målEn jobplan skal have mindst et mål
9131Ugyldig CodeListItemIdentifierUgyldig CodeListItemIdentifier
9358Planbeskrivelse er ikke tilladt med kombinationen af borgerkontaktgruppe og personkategoriPlanbeskrivelse er ikke tilladt med kombinationen af borgerkontaktgruppe og personkategori
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
9429Planen blev ikke fundetPlanen blev ikke fundet
9430Betjening er kun tilladt for planversionerBetjening er kun tilladt for planversioner
9472
9428Målkode er ikke gyldigMålkode er ikke gyldig
9439Borgeren kan ikke registreres med samme ConceptUriDa flere gangeBorgeren kan ikke registreres med samme ConceptUriDa flere gange
  • No labels

Tilgængelighed: https://starwiki.atlassian.net/was