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
« Previous
Version 4
Next »
Siden opdateres automatisk til at afspejle koden.
Metoder
GetIntegrationslovsdata (GET /v1/Integrationslov/{integrationslovsdataIdentifier})
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
borgerindsats.asyl.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 |
integrationslovsdataIdentifier [Path] | uuid | | 1 | |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
response | GetIntegrationslovsdataResponseDto | | 1 | |
- integrationslovsdata | IntegrationslovsdataDto | | 0 - 1 | |
- - personnummer | 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 MinLength: 1 | 1 | Borgers personnummer |
- - integrationslovsdataIdentifier | uuid | | 0 - 1 | Unik identifikation for den hentede udgave af borgerens integrationslovsdata |
- - kontraktvarighed | KontraktvarighedDto | | 0 - 1 | |
- - - foersteUnderskriftsdato | date-time | | 0 - 1 | Dato for underskrift af første kontrakt er samtidig startdato for periode. |
- - - programStartdato | date-time | | 0 - 1 | Startdato for programmet under integrationsloven. |
- - - programSlutdato | date-time | | 0 - 1 | Slutdato for programmet under integrationsloven. |
- - - kontraktSlutdato | date-time | | 0 - 1 | Slutdato for kontrakten under intrgrationsloven |
- - borgersprog | SprogDtoCollection | | 1 | Kollektion af sprog med tilhørende erfaring og færdighedsniveauer |
- - - SprogDto | SprogDto | | 0 - * | |
- - - - sprogStamdata | SprogStamdataDto | | 1 | |
- - - - - sprognavn | string | | 0 - 1 | Dansk navn på sproget |
- - - - - sprogkode | int32 | | 0 - 1 | Kode for sproget |
- - - - sprogerfaring | string | | 0 - 1 | Erfaring med sproget |
- - - - taleforstaaelsesniveauType | LanguageSkillLevelTypeCodeList | | 0 - 1 | |
- - - - taleniveauType | LanguageSkillLevelTypeCodeList | | 0 - 1 | |
- - - - laeseniveauType | LanguageSkillLevelTypeCodeList | | 0 - 1 | |
- - - - skriveniveauType | LanguageSkillLevelTypeCodeList | | 0 - 1 | |
- - uddannelse | GetUddannelseDto | | 0 - 1 | |
- - - senestVejledtDato | date-time | | 0 - 1 | Dato for hvornår der sidst er vejledt om at medbragt formel uddannelse kan vurderes af Uddannelses- og Forskningsstyrelsen |
- - - vurderingssagsstatusType | UddannelsesVurderingssagsstatusTypeCodeList | | 0 - 1 | |
- - helbredstilstand | GetHelbredstilstandDto | | 0 - 1 | |
- - - behandlingDk | string | | 0 - 1 | Igangsat eller aftalt behandling i Danmark |
- - - aktuelHelbredstilstand | string | | 0 - 1 | Aktuel helbredstilstand |
- - helbredsvurdering | GetHelbredsvurderingDto | | 0 - 1 | |
- - - vurderingsresultat | string | | 0 - 1 | Resultat af Helbredsvurdering |
- - - andreHelbredsforhold | string | | 0 - 1 | Eventuelle andre helbredsmæssige forhold |
- - - behovForVurdering | boolean | | 0 - 1 | Behov for helbredsvurdering |
- - - afgivetTilbud | boolean | | 0 - 1 | Er der afgivet tilbud om Helbredsvurdering |
- - kontrakt | GetKontraktDto | | 0 - 1 | |
- - - erklaeringsunderskriftsdato | date-time | | 0 - 1 | Dato for underskrift af erklæring om integration og aktivt medborgerskab |
- - - familiemaessigeForhold | string | | 0 - 1 | Familiemæssige forhold, der kan have betydning for indsatsen |
- - - oevrigeForhold | string | | 0 - 1 | Øvrige forhold - herunder sociale - der kan have betydning for indsatsen |
- - - aarsagTilOpholdstilladelseType | AarsagTilOpholdstilladelseTypeCodeList | | 0 - 1 | |
- - - antalBoern | int32 | | 0 - 1 | Antal børn |
- - - danskmaal | GetDanskmaalDto | | 0 - 1 | |
- - - - senesteMeddelelsesDato | date-time | | 0 - 1 | Dato for hvornår der sidst er givet meddelelse til udlændingen om konsekvenserne om manglende dansktilegnelse, jf.bek. § 15, stk. 9 og 11 |
- - - - senestVejledtOmKonsekvensDato | date-time | | 0 - 1 | Dato for hvornår der sidst er vejledt vedr. konsekvenserne vedr. manglende dansktilegnelse, ifht I-ydelsen, familiesammenføring, tub |
- - - - danskmaalType | DanskmaalTypeCodeList | | 0 - 1 | |
- - - - senestAjourfoertDato | date-time | | 0 - 1 | Dato for seneste ajourføring af dansk mål |
- - kommentar | string | | 0 - 1 | Kommentar |
- - koordinerendeForvaltning | string | | 0 - 1 | Koordinerende forvaltning i kommunen |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
110001 | Person findes ikke for det angivne CPR-nummer | Person findes ikke for det angivne CPR-nummer |
4405 | Personen med det angivne CPR-nummer er død | Personen med det angivne CPR-nummer er død |
9271 | Data på den angivne integrationslovsdataIdentifier og person findes ikke i DFDG | Data på den angivne integrationslovsdataIdentifier og person findes ikke i DFDG |
AfslutKontrakt (PUT /v1/Integrationslov/{integrationslovsdataIdentifier})
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
borgerindsats.asyl.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 |
integrationslovsdataIdentifier [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 | AfslutKontraktRequestDto | | 1 | |
- kontraktSlutdato | date-time | | 1 | Slutdato for kontrakten under integrationsloven |
- kommentar | string | Length: 1-1500 | 0 - 1 | Kommentar til terminering af kontrakten under integrationsloven |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
110001 | Person findes ikke for det angivne CPR-nummer | Person findes ikke for det angivne CPR-nummer |
4405 | Personen med det angivne CPR-nummer er død | Personen med det angivne CPR-nummer er død |
9274 | IntegrationContractEndDate skal være i dag eller tidligere | IntegrationContractEndDate skal være i dag eller tidligere |
9275 | IntegrationContractEndDate må ikke være før FoesteUnderskriftsdato | IntegrationContractEndDate må ikke være før FoesteUnderskriftsdato |
9283 | Integrationskontrakten eksisterer ikke | Integrationskontrakten eksisterer ikke |
GetSenesteIntegrationslovsdata (GET /v1/Integrationslov)
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
borgerindsats.asyl.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 | GetIntegrationslovsdataResponseDto | | 1 | |
- integrationslovsdata | IntegrationslovsdataDto | | 0 - 1 | |
- - personnummer | 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 MinLength: 1 | 1 | Borgers personnummer |
- - integrationslovsdataIdentifier | uuid | | 0 - 1 | Unik identifikation for den hentede udgave af borgerens integrationslovsdata |
- - kontraktvarighed | KontraktvarighedDto | | 0 - 1 | |
- - - foersteUnderskriftsdato | date-time | | 0 - 1 | Dato for underskrift af første kontrakt er samtidig startdato for periode. |
- - - programStartdato | date-time | | 0 - 1 | Startdato for programmet under integrationsloven. |
- - - programSlutdato | date-time | | 0 - 1 | Slutdato for programmet under integrationsloven. |
- - - kontraktSlutdato | date-time | | 0 - 1 | Slutdato for kontrakten under intrgrationsloven |
- - borgersprog | SprogDtoCollection | | 1 | Kollektion af sprog med tilhørende erfaring og færdighedsniveauer |
- - - SprogDto | SprogDto | | 0 - * | |
- - - - sprogStamdata | SprogStamdataDto | | 1 | |
- - - - - sprognavn | string | | 0 - 1 | Dansk navn på sproget |
- - - - - sprogkode | int32 | | 0 - 1 | Kode for sproget |
- - - - sprogerfaring | string | | 0 - 1 | Erfaring med sproget |
- - - - taleforstaaelsesniveauType | LanguageSkillLevelTypeCodeList | | 0 - 1 | |
- - - - taleniveauType | LanguageSkillLevelTypeCodeList | | 0 - 1 | |
- - - - laeseniveauType | LanguageSkillLevelTypeCodeList | | 0 - 1 | |
- - - - skriveniveauType | LanguageSkillLevelTypeCodeList | | 0 - 1 | |
- - uddannelse | GetUddannelseDto | | 0 - 1 | |
- - - senestVejledtDato | date-time | | 0 - 1 | Dato for hvornår der sidst er vejledt om at medbragt formel uddannelse kan vurderes af Uddannelses- og Forskningsstyrelsen |
- - - vurderingssagsstatusType | UddannelsesVurderingssagsstatusTypeCodeList | | 0 - 1 | |
- - helbredstilstand | GetHelbredstilstandDto | | 0 - 1 | |
- - - behandlingDk | string | | 0 - 1 | Igangsat eller aftalt behandling i Danmark |
- - - aktuelHelbredstilstand | string | | 0 - 1 | Aktuel helbredstilstand |
- - helbredsvurdering | GetHelbredsvurderingDto | | 0 - 1 | |
- - - vurderingsresultat | string | | 0 - 1 | Resultat af Helbredsvurdering |
- - - andreHelbredsforhold | string | | 0 - 1 | Eventuelle andre helbredsmæssige forhold |
- - - behovForVurdering | boolean | | 0 - 1 | Behov for helbredsvurdering |
- - - afgivetTilbud | boolean | | 0 - 1 | Er der afgivet tilbud om Helbredsvurdering |
- - kontrakt | GetKontraktDto | | 0 - 1 | |
- - - erklaeringsunderskriftsdato | date-time | | 0 - 1 | Dato for underskrift af erklæring om integration og aktivt medborgerskab |
- - - familiemaessigeForhold | string | | 0 - 1 | Familiemæssige forhold, der kan have betydning for indsatsen |
- - - oevrigeForhold | string | | 0 - 1 | Øvrige forhold - herunder sociale - der kan have betydning for indsatsen |
- - - aarsagTilOpholdstilladelseType | AarsagTilOpholdstilladelseTypeCodeList | | 0 - 1 | |
- - - antalBoern | int32 | | 0 - 1 | Antal børn |
- - - danskmaal | GetDanskmaalDto | | 0 - 1 | |
- - - - senesteMeddelelsesDato | date-time | | 0 - 1 | Dato for hvornår der sidst er givet meddelelse til udlændingen om konsekvenserne om manglende dansktilegnelse, jf.bek. § 15, stk. 9 og 11 |
- - - - senestVejledtOmKonsekvensDato | date-time | | 0 - 1 | Dato for hvornår der sidst er vejledt vedr. konsekvenserne vedr. manglende dansktilegnelse, ifht I-ydelsen, familiesammenføring, tub |
- - - - danskmaalType | DanskmaalTypeCodeList | | 0 - 1 | |
- - - - senestAjourfoertDato | date-time | | 0 - 1 | Dato for seneste ajourføring af dansk mål |
- - kommentar | string | | 0 - 1 | Kommentar |
- - koordinerendeForvaltning | string | | 0 - 1 | Koordinerende forvaltning i kommunen |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
110001 | Person findes ikke for det angivne CPR-nummer | Person findes ikke for det angivne CPR-nummer |
4405 | Personen med det angivne CPR-nummer er død | Personen med det angivne CPR-nummer er død |
9271 | Data på den angivne integrationslovsdataIdentifier og person findes ikke i DFDG | Data på den angivne integrationslovsdataIdentifier og person findes ikke i DFDG |
CreateIntegrationslovsdata (POST /v1/Integrationslov)
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
borgerindsats.asyl.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 |
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 | CreateIntegrationslovsdataRequestDto | | 1 | |
- integrationslovsdataIdentifier | uuid | | 0 - 1 | Unik Identifikation som ønskes gemt. |
- kontraktvarighed | KontraktvarighedDto | | 0 - 1 | |
- - foersteUnderskriftsdato | date-time | | 0 - 1 | Dato for underskrift af første kontrakt er samtidig startdato for periode. |
- - programStartdato | date-time | | 0 - 1 | Startdato for programmet under integrationsloven. |
- - programSlutdato | date-time | | 0 - 1 | Slutdato for programmet under integrationsloven. |
- - kontraktSlutdato | date-time | | 0 - 1 | Slutdato for kontrakten under intrgrationsloven |
- borgersprog | SprogDtoCollection | | 1 | Kollektion af sprog med tilhørende erfaring og færdighedsniveauer |
- - SprogDto | SprogDto | | 0 - * | |
- - - sprogStamdata | SprogStamdataDto | | 1 | |
- - - - sprognavn | string | | 0 - 1 | Dansk navn på sproget |
- - - - sprogkode | int32 | | 0 - 1 | Kode for sproget |
- - - sprogerfaring | string | | 0 - 1 | Erfaring med sproget |
- - - taleforstaaelsesniveauType | LanguageSkillLevelTypeCodeList | | 0 - 1 | |
- - - taleniveauType | LanguageSkillLevelTypeCodeList | | 0 - 1 | |
- - - laeseniveauType | LanguageSkillLevelTypeCodeList | | 0 - 1 | |
- - - skriveniveauType | LanguageSkillLevelTypeCodeList | | 0 - 1 | |
- uddannelse | CreateUddannelseDto | | 1 | |
- - senestVejledtDato | date-time | | 0 - 1 | Dato for hvornår der sidst er vejledt om at medbragt formel uddannelse kan vurderes af Uddannelses- og Forskningsstyrelsen |
- - vurderingssagsstatusType | UddannelsesVurderingssagsstatusTypeCodeList | | 1 | |
- helbredstilstand | CreateHelbredstilstandDto | | 1 | |
- - behandlingDk | string | | 0 - 1 | Igangsat eller aftalt behandling i Danmark |
- - aktuelHelbredstilstand | string | MinLength: 1 | 1 | Aktuel helbredstilstand |
- helbredsvurdering | CreateHelbredsvurderingDto | | 1 | |
- - vurderingsresultat | string | | 0 - 1 | Resultat af Helbredsvurdering |
- - andreHelbredsforhold | string | | 0 - 1 | Eventuelle andre helbredsmæssige forhold |
- - behovForVurdering | boolean | | 1 | Behov for helbredsvurdering |
- - afgivetTilbud | boolean | | 1 | Er der afgivet tilbud om Helbredsvurdering |
- kontrakt | CreateKontraktDto | | 1 | |
- - erklaeringsunderskriftsdato | date-time | | 0 - 1 | Dato for underskrift af erklæring om integration og aktivt medborgerskab |
- - familiemaessigeForhold | string | | 0 - 1 | Familiemæssige forhold, der kan have betydning for indsatsen |
- - oevrigeForhold | string | | 0 - 1 | Øvrige forhold - herunder sociale - der kan have betydning for indsatsen |
- - aarsagTilOpholdstilladelseType | AarsagTilOpholdstilladelseTypeCodeList | | 1 | |
- - antalBoern | int32 | | 1 | Antal børn |
- - danskmaal | CreateDanskmaalDto | | 0 - 1 | |
- - - senesteMeddelelsesDato | date-time | | 0 - 1 | Dato for hvornår der sidst er givet meddelelse til udlændingen om konsekvenserne om manglende dansktilegnelse, jf.bek. § 15, stk. 9 og 11 |
- - - senestVejledtOmKonsekvensDato | date-time | | 0 - 1 | Dato for hvornår der sidst er vejledt vedr. konsekvenserne vedr. manglende dansktilegnelse, ifht I-ydelsen, familiesammenføring, tub |
- - - danskmaalType | DanskmaalTypeCodeList | | 1 | |
- koordinerendeForvaltning | string | | 0 - 1 | Koordinerende forvaltning i kommunen |
- kommentar | string | | 0 - 1 | Kommentar |
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 |
4405 | Personen med det angivne CPR-nummer er død | Personen med det angivne CPR-nummer er død |
9265 | ProgramSlutdato skal være efter eller lig med ProgramStartdato | ProgramSlutdato skal være efter eller lig med ProgramStartdato |
9273 | Foerste underskriftsdato skal være dags dato eller historisk | Foerste underskriftsdato skal være dags dato eller historisk |
9276 | Alle angivne sprogkundskaber skal enten have angivet sprogkode eller sprognavn | Alle angivne sprogkundskaber skal enten have angivet sprogkode eller sprognavn |
9277 | Angivne sprogkundskaber skal angivet kun ved sprogkode eller sprognavn | Angivne sprogkundskaber skal angivet kun ved sprogkode eller sprognavn |
9278 | En angiven Sprogkode er ikke en gyldig kodelisteværdi | En angiven Sprogkode er ikke en gyldig kodelisteværdi |
9279 | Den angivne kollektion af sprogkundskaber indeholder flere kundskaber vedrørende samme sprog | Den angivne kollektion af sprogkundskaber indeholder flere kundskaber vedrørende samme sprog |
9280 | Den angivne IntegrationslovsdataIdentifier eksisterer allerede | Den angivne IntegrationslovsdataIdentifier eksisterer allerede |
9284 | SenesteMeddelelsesDato skal være dags dato eller historisk | SenesteMeddelelsesDato skal være dags dato eller historisk |
9285 | SenestVejledtOmKonsekvensDato skal være dags dato eller historisk | SenestVejledtOmKonsekvensDato skal være dags dato eller historisk |
9286 | SenestVejledtDato skal være dags dato eller historisk | SenestVejledtDato skal være dags dato eller historisk |
AfslutSenesteKontrakt (PUT /v1/Integrationslov)
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
borgerindsats.asyl.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 |
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 | AfslutKontraktRequestDto | | 1 | |
- kontraktSlutdato | date-time | | 1 | Slutdato for kontrakten under integrationsloven |
- kommentar | string | Length: 1-1500 | 0 - 1 | Kommentar til terminering af kontrakten under integrationsloven |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
110001 | Person findes ikke for det angivne CPR-nummer | Person findes ikke for det angivne CPR-nummer |
4405 | Personen med det angivne CPR-nummer er død | Personen med det angivne CPR-nummer er død |
9274 | IntegrationContractEndDate skal være i dag eller tidligere | IntegrationContractEndDate skal være i dag eller tidligere |
9275 | IntegrationContractEndDate må ikke være før FoesteUnderskriftsdato | IntegrationContractEndDate må ikke være før FoesteUnderskriftsdato |
9283 | Integrationskontrakten eksisterer ikke | Integrationskontrakten eksisterer ikke |