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
Current »
Siden opdateres automatisk til at afspejle koden.
Metoder
GetMinPlan (GET /v1/MinPlan/{minPlanVersionId})
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 | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | | | | | |
| JobCenter | | X | | X | X | X | | |
| Kommune | | X | | | | | | |
| STAR | X | | | | | | | |
Scope
borgerindsats.plan.read
| 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 |
| minPlanVersionId [Path] | uuid | | 1 | |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| response | GetMinPlanResponseDto | | 1 | |
| - minPlanVersion | MinPlanVersionDto | | 1 | |
| - - versionId | uuid | | 1 | Id på versionen af Min Plan |
| - - oprettelsestidspunkt | date-time | | 1 | Tidspunkt for oprettelse af versionen af Min Plan |
| - - oprettendeSagsbehandler | SagsbehandlerDto | | 1 | |
| - - - 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 | email | | 0 - 1 | Sagsbehandlerens emailadresse. |
| - - - sagsbehandlerId | string | Length: 1-255 | 1 | Sagsbehandlerens id. |
| - - planVersionHaendelsestyper | PlanVersionHaendelsesTypeCodeListCollection | | 1 | Liste af hændelsestyper der er foretaget på versionen af Min Plan inklusiv aktiveringer |
| - - - PlanVersionHaendelsesTypeCodeList | PlanVersionHaendelsesTypeCodeList | | 0 - * | |
| - - senestSetAfBorgerTidspunkt | date-time | | 0 - 1 | Tidspunkt hvor borger senest har set versionen af Min Plan |
| - - erDerTidligerePlanerBorgerIkkeHarSet | boolean | | 1 | Indikerer om der er tidligere planer borger ikke har set |
| - - versionsnummer | int32 | | 1 | Versionsnummer for versionen af Min Plan |
| - - status | MinPlanStatusDto | | 1 | |
| - - - erValid | boolean | | 1 | Hvis sand (True): MinPlan er valid og aktiv i forhold til borgeren.
Hvis falsk (false): Borgeren har skiftet tilstand således at Min Plan ikke længere er valid / aktiv. |
| - - - invalidAarsagsType | InvalidAarsagsTypeCodeList | | 0 - 1 | |
| - - - kommentar | string | | 0 - 1 | Kommentar ifm. at plannen sættes valid |
| - - - aendringstidspunkt | date-time | | 0 - 1 | Tidspunkt for hvornår planen sidst er markeret valid eller invalid |
| - - kontaktgruppeType | ContactGroupTypeCodeList | | 0 - 1 | |
| - minPlan | MinPlanDto | | 1 | |
| - - planVersion | PlanVersionDto | | 0 - 1 | |
| - - - planVersionId | uuid | | 1 | Id for planversionen. |
| - - - planTypeIdentifier | PlanTypeCodeList | | 1 | |
| - - uddannelsesplanId | uuid | | 0 - 1 | Id på uddannelsesplan. |
| - - aktiviteter | AktivitetDtoCollection | | 1 | Samling af aktiviteter. |
| - - - AktivitetDto | AktivitetDto | | 0 - * | |
| - - - - aktivitetId | uuid | | 1 | Id på aktiviteten |
| - - - - aktivitetType | AktivitetsTypeCodeList | | 1 | |
| - - kravTilJobsoegningId | uuid | | 0 - 1 | Id på det hentede "Krav til jobsøgning". |
| - - afholdtSamtaleJobcenterId | uuid | | 0 - 1 | Id på samtalen afholdt med jobcenter. |
| - - afholdtSamtaleAkasseId | uuid | | 0 - 1 | Id på samtalen afholdt med a-kasse. |
| - - vejledningstekst | string | | 0 - 1 | Indeholder vejledningsteksten til borgerens plan. Kun for borgere med integrationskontrakt. |
| - - integrationslovsdataId | uuid | | 0 - 1 | Id på den hentede udgave af borgerens integrationslovsdata |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 110001 | Person findes ikke for det angivne CPR-nummer | Person findes ikke for det angivne CPR-nummer |
| 8306 | MinPlan findes ikke | MinPlan findes ikke |
GetSenesteMinPlan (GET /v1/MinPlan)
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 | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | | | | | |
| JobCenter | | X | | X | X | X | | |
| Kommune | | X | | | | | | |
| STAR | X | | | | | | | |
Scope
borgerindsats.plan.read
| 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 | GetMinPlanResponseDto | | 1 | |
| - minPlanVersion | MinPlanVersionDto | | 1 | |
| - - versionId | uuid | | 1 | Id på versionen af Min Plan |
| - - oprettelsestidspunkt | date-time | | 1 | Tidspunkt for oprettelse af versionen af Min Plan |
| - - oprettendeSagsbehandler | SagsbehandlerDto | | 1 | |
| - - - 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 | email | | 0 - 1 | Sagsbehandlerens emailadresse. |
| - - - sagsbehandlerId | string | Length: 1-255 | 1 | Sagsbehandlerens id. |
| - - planVersionHaendelsestyper | PlanVersionHaendelsesTypeCodeListCollection | | 1 | Liste af hændelsestyper der er foretaget på versionen af Min Plan inklusiv aktiveringer |
| - - - PlanVersionHaendelsesTypeCodeList | PlanVersionHaendelsesTypeCodeList | | 0 - * | |
| - - senestSetAfBorgerTidspunkt | date-time | | 0 - 1 | Tidspunkt hvor borger senest har set versionen af Min Plan |
| - - erDerTidligerePlanerBorgerIkkeHarSet | boolean | | 1 | Indikerer om der er tidligere planer borger ikke har set |
| - - versionsnummer | int32 | | 1 | Versionsnummer for versionen af Min Plan |
| - - status | MinPlanStatusDto | | 1 | |
| - - - erValid | boolean | | 1 | Hvis sand (True): MinPlan er valid og aktiv i forhold til borgeren.
Hvis falsk (false): Borgeren har skiftet tilstand således at Min Plan ikke længere er valid / aktiv. |
| - - - invalidAarsagsType | InvalidAarsagsTypeCodeList | | 0 - 1 | |
| - - - kommentar | string | | 0 - 1 | Kommentar ifm. at plannen sættes valid |
| - - - aendringstidspunkt | date-time | | 0 - 1 | Tidspunkt for hvornår planen sidst er markeret valid eller invalid |
| - - kontaktgruppeType | ContactGroupTypeCodeList | | 0 - 1 | |
| - minPlan | MinPlanDto | | 1 | |
| - - planVersion | PlanVersionDto | | 0 - 1 | |
| - - - planVersionId | uuid | | 1 | Id for planversionen. |
| - - - planTypeIdentifier | PlanTypeCodeList | | 1 | |
| - - uddannelsesplanId | uuid | | 0 - 1 | Id på uddannelsesplan. |
| - - aktiviteter | AktivitetDtoCollection | | 1 | Samling af aktiviteter. |
| - - - AktivitetDto | AktivitetDto | | 0 - * | |
| - - - - aktivitetId | uuid | | 1 | Id på aktiviteten |
| - - - - aktivitetType | AktivitetsTypeCodeList | | 1 | |
| - - kravTilJobsoegningId | uuid | | 0 - 1 | Id på det hentede "Krav til jobsøgning". |
| - - afholdtSamtaleJobcenterId | uuid | | 0 - 1 | Id på samtalen afholdt med jobcenter. |
| - - afholdtSamtaleAkasseId | uuid | | 0 - 1 | Id på samtalen afholdt med a-kasse. |
| - - vejledningstekst | string | | 0 - 1 | Indeholder vejledningsteksten til borgerens plan. Kun for borgere med integrationskontrakt. |
| - - integrationslovsdataId | uuid | | 0 - 1 | Id på den hentede udgave af borgerens integrationslovsdata |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 110001 | Person findes ikke for det angivne CPR-nummer | Person findes ikke for det angivne CPR-nummer |
| 8306 | MinPlan findes ikke | MinPlan findes ikke |
GetMinPlanVersioner (GET /v1/MinPlan/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 | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | | | | | |
| JobCenter | | X | | X | X | X | | |
| Kommune | | X | | | | | | |
| STAR | X | | | | | | | |
Scope
borgerindsats.plan.read
| 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 | GetMinPlanVersionerResponseDto | | 1 | |
| - minPlanVersioner | MinPlanVersionBaseDtoCollection | | 1 | Liste af versioner af Min Plan |
| - - MinPlanVersionBaseDto | MinPlanVersionBaseDto | | 0 - * | |
| - - - versionId | uuid | | 1 | Id på versionen af Min Plan |
| - - - oprettelsestidspunkt | date-time | | 1 | Tidspunkt for oprettelse af versionen af Min Plan |
| - - - oprettendeSagsbehandler | SagsbehandlerDto | | 1 | |
| - - - - 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 | email | | 0 - 1 | Sagsbehandlerens emailadresse. |
| - - - - sagsbehandlerId | string | Length: 1-255 | 1 | Sagsbehandlerens id. |
| - - - planVersionHaendelsestyper | PlanVersionHaendelsesTypeCodeListCollection | | 1 | Liste af hændelsestyper der er foretaget på versionen af Min Plan inklusiv aktiveringer |
| - - - - PlanVersionHaendelsesTypeCodeList | PlanVersionHaendelsesTypeCodeList | | 0 - * | |
| - - - senestSetAfBorgerTidspunkt | date-time | | 0 - 1 | Tidspunkt hvor borger senest har set versionen af Min Plan |
| - - - erDerTidligerePlanerBorgerIkkeHarSet | boolean | | 1 | Indikerer om der er tidligere planer borger ikke har set |
| - - - versionsnummer | int32 | | 1 | Versionsnummer for versionen af Min Plan |
| - - - status | MinPlanStatusDto | | 1 | |
| - - - - erValid | boolean | | 1 | Hvis sand (True): MinPlan er valid og aktiv i forhold til borgeren.
Hvis falsk (false): Borgeren har skiftet tilstand således at Min Plan ikke længere er valid / aktiv. |
| - - - - invalidAarsagsType | InvalidAarsagsTypeCodeList | | 0 - 1 | |
| - - - - kommentar | string | | 0 - 1 | Kommentar ifm. at plannen sættes valid |
| - - - - aendringstidspunkt | date-time | | 0 - 1 | Tidspunkt for hvornår planen sidst er markeret valid eller invalid |
| - - - kontaktgruppeType | ContactGroupTypeCodeList | | 0 - 1 | |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 110001 | Person findes ikke for det angivne CPR-nummer | Person findes ikke for det angivne CPR-nummer |
UpdateMinPlanAsValid (PUT /v1/MinPlan/{minPlanVersionId}/action/SetMinPlanValid)
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 | | | |
| Kommune | | X | | | | | | |
| STAR | X | | | | | | | |
Scope
borgerindsats.plan.write
| 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 |
| minPlanVersionId [Path] | uuid | | 1 | |
| aendringskommentar [Query] | string | | 0 - 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 |
Output
Intet output
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 110001 | Person findes ikke for det angivne CPR-nummer | Person findes ikke for det angivne CPR-nummer |
UpdateMinPlan (PUT /v1/MinPlan/{minPlanVersionId}/action/SetMinPlanSet)
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 | | | |
| Kommune | | X | | | | | | |
| STAR | X | | | | | | | |
Scope
borgerindsats.plan.write
| 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 |
| minPlanVersionId [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 |
Output
Intet output
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 110001 | Person findes ikke for det angivne CPR-nummer | Person findes ikke for det angivne CPR-nummer |
| 8306 | MinPlan findes ikke | MinPlan findes ikke |
| 8302 | Kun nuvaerende MinPlan kan markeres som set | Kun nuvaerende MinPlan kan markeres som set |
| 8303 | Nuvaerende MinPlan er allerede markeret som set | Nuvaerende MinPlan er allerede markeret som set |
| 8308 | Kan ikke markere MinPlan som set da denne er invalid | Kan ikke markere MinPlan som set da denne er invalid |