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 3 Next »

Siden opdateres automatisk til at afspejle koden.

Metoder

GetIntegrationslovsdata (GET /v1/Integrationslov/{integrationslovsdataIdentifier})

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
JobCenterXX
STARX

Scope

borgerindsats.asyl.read

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
integrationslovsdataIdentifier [Path]uuid1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetIntegrationslovsdataResponseDto1
-    integrationslovsdataIntegrationslovsdataDto0 - 1
-    -    personnummerstringPattern: ((((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
1Borgers personnummer
-    -    integrationslovsdataIdentifieruuid0 - 1Unik identifikation for den hentede udgave af borgerens integrationslovsdata
-    -    kontraktvarighedKontraktvarighedDto0 - 1
-    -    -    foersteUnderskriftsdatodate-time0 - 1Dato for underskrift af første kontrakt er samtidig startdato for periode.
-    -    -    programStartdatodate-time0 - 1Startdato for programmet under integrationsloven.
-    -    -    programSlutdatodate-time0 - 1Slutdato for programmet under integrationsloven.
-    -    -    kontraktSlutdatodate-time0 - 1Slutdato for kontrakten under intrgrationsloven
-    -    borgersprogSprogDtoCollection1Kollektion af sprog med tilhørende erfaring og færdighedsniveauer
-    -    -    SprogDtoSprogDto0 - *
-    -    -    -    sprogStamdataSprogStamdataDto1
-    -    -    -    -    sprognavnstring0 - 1Dansk navn på sproget
-    -    -    -    -    sprogkodeint320 - 1Kode for sproget
-    -    -    -    sprogerfaringstring0 - 1Erfaring med sproget
-    -    -    -    taleforstaaelsesniveauTypeLanguageSkillLevelTypeCodeList0 - 1
-    -    -    -    taleniveauTypeLanguageSkillLevelTypeCodeList0 - 1
-    -    -    -    laeseniveauTypeLanguageSkillLevelTypeCodeList0 - 1
-    -    -    -    skriveniveauTypeLanguageSkillLevelTypeCodeList0 - 1
-    -    uddannelseGetUddannelseDto0 - 1
-    -    -    senestVejledtDatodate-time0 - 1Dato for hvornår der sidst er vejledt om at medbragt formel uddannelse kan vurderes af Uddannelses- og Forskningsstyrelsen
-    -    -    vurderingssagsstatusTypeUddannelsesVurderingssagsstatusTypeCodeList0 - 1
-    -    helbredstilstandGetHelbredstilstandDto0 - 1
-    -    -    behandlingDkstring0 - 1Igangsat eller aftalt behandling i Danmark
-    -    -    aktuelHelbredstilstandstring0 - 1Aktuel helbredstilstand
-    -    helbredsvurderingGetHelbredsvurderingDto0 - 1
-    -    -    vurderingsresultatstring0 - 1Resultat af Helbredsvurdering
-    -    -    andreHelbredsforholdstring0 - 1Eventuelle andre helbredsmæssige forhold
-    -    -    behovForVurderingboolean0 - 1Behov for helbredsvurdering
-    -    -    afgivetTilbudboolean0 - 1Er der afgivet tilbud om Helbredsvurdering
-    -    kontraktGetKontraktDto0 - 1
-    -    -    erklaeringsunderskriftsdatodate-time0 - 1Dato for underskrift af erklæring om integration og aktivt medborgerskab
-    -    -    familiemaessigeForholdstring0 - 1Familiemæssige forhold, der kan have betydning for indsatsen
-    -    -    oevrigeForholdstring0 - 1Øvrige forhold - herunder sociale - der kan have betydning for indsatsen
-    -    -    aarsagTilOpholdstilladelseTypeAarsagTilOpholdstilladelseTypeCodeList0 - 1
-    -    -    antalBoernint320 - 1Antal børn
-    -    -    danskmaalGetDanskmaalDto0 - 1
-    -    -    -    senesteMeddelelsesDatodate-time0 - 1Dato for hvornår der sidst er givet meddelelse til udlændingen om konsekvenserne om manglende dansktilegnelse, jf.bek. § 15, stk. 9 og 11
-    -    -    -    senestVejledtOmKonsekvensDatodate-time0 - 1Dato for hvornår der sidst er vejledt vedr. konsekvenserne vedr. manglende dansktilegnelse, ifht I-ydelsen, familiesammenføring, tub
-    -    -    -    danskmaalTypeDanskmaalTypeCodeList0 - 1
-    -    -    -    senestAjourfoertDatodate-time0 - 1Dato for seneste ajourføring af dansk mål
-    -    kommentarstring0 - 1Kommentar
-    -    koordinerendeForvaltningstring0 - 1Koordinerende forvaltning i kommunen

Fejlkoder

FejlkodeFejltekstBeskrivelse
110001Person findes ikke for det angivne CPR-nummerPerson findes ikke for det angivne CPR-nummer
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
9271Data på den angivne integrationslovsdataIdentifier og person findes ikke i DFDGData på den angivne integrationslovsdataIdentifier og person findes ikke i DFDG

AfslutKontrakt (PUT /v1/Integrationslov/{integrationslovsdataIdentifier})

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
JobCenterXX
STARX

Scope

borgerindsats.asyl.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
integrationslovsdataIdentifier [Path]uuid1
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
requestBodyAfslutKontraktRequestDto1
-    kontraktSlutdatodate-time1Slutdato for kontrakten under integrationsloven
-    kommentarstringLength: 1-15000 - 1Kommentar til terminering af kontrakten under integrationsloven

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
110001Person findes ikke for det angivne CPR-nummerPerson findes ikke for det angivne CPR-nummer
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
9274IntegrationContractEndDate skal være i dag eller tidligereIntegrationContractEndDate skal være i dag eller tidligere
9275IntegrationContractEndDate må ikke være før FoesteUnderskriftsdatoIntegrationContractEndDate må ikke være før FoesteUnderskriftsdato
9283Integrationskontrakten eksisterer ikkeIntegrationskontrakten eksisterer ikke

GetSenesteIntegrationslovsdata (GET /v1/Integrationslov)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
JobCenterXX
STARX

Scope

borgerindsats.asyl.read

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

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetIntegrationslovsdataResponseDto1
-    integrationslovsdataIntegrationslovsdataDto0 - 1
-    -    personnummerstringPattern: ((((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
1Borgers personnummer
-    -    integrationslovsdataIdentifieruuid0 - 1Unik identifikation for den hentede udgave af borgerens integrationslovsdata
-    -    kontraktvarighedKontraktvarighedDto0 - 1
-    -    -    foersteUnderskriftsdatodate-time0 - 1Dato for underskrift af første kontrakt er samtidig startdato for periode.
-    -    -    programStartdatodate-time0 - 1Startdato for programmet under integrationsloven.
-    -    -    programSlutdatodate-time0 - 1Slutdato for programmet under integrationsloven.
-    -    -    kontraktSlutdatodate-time0 - 1Slutdato for kontrakten under intrgrationsloven
-    -    borgersprogSprogDtoCollection1Kollektion af sprog med tilhørende erfaring og færdighedsniveauer
-    -    -    SprogDtoSprogDto0 - *
-    -    -    -    sprogStamdataSprogStamdataDto1
-    -    -    -    -    sprognavnstring0 - 1Dansk navn på sproget
-    -    -    -    -    sprogkodeint320 - 1Kode for sproget
-    -    -    -    sprogerfaringstring0 - 1Erfaring med sproget
-    -    -    -    taleforstaaelsesniveauTypeLanguageSkillLevelTypeCodeList0 - 1
-    -    -    -    taleniveauTypeLanguageSkillLevelTypeCodeList0 - 1
-    -    -    -    laeseniveauTypeLanguageSkillLevelTypeCodeList0 - 1
-    -    -    -    skriveniveauTypeLanguageSkillLevelTypeCodeList0 - 1
-    -    uddannelseGetUddannelseDto0 - 1
-    -    -    senestVejledtDatodate-time0 - 1Dato for hvornår der sidst er vejledt om at medbragt formel uddannelse kan vurderes af Uddannelses- og Forskningsstyrelsen
-    -    -    vurderingssagsstatusTypeUddannelsesVurderingssagsstatusTypeCodeList0 - 1
-    -    helbredstilstandGetHelbredstilstandDto0 - 1
-    -    -    behandlingDkstring0 - 1Igangsat eller aftalt behandling i Danmark
-    -    -    aktuelHelbredstilstandstring0 - 1Aktuel helbredstilstand
-    -    helbredsvurderingGetHelbredsvurderingDto0 - 1
-    -    -    vurderingsresultatstring0 - 1Resultat af Helbredsvurdering
-    -    -    andreHelbredsforholdstring0 - 1Eventuelle andre helbredsmæssige forhold
-    -    -    behovForVurderingboolean0 - 1Behov for helbredsvurdering
-    -    -    afgivetTilbudboolean0 - 1Er der afgivet tilbud om Helbredsvurdering
-    -    kontraktGetKontraktDto0 - 1
-    -    -    erklaeringsunderskriftsdatodate-time0 - 1Dato for underskrift af erklæring om integration og aktivt medborgerskab
-    -    -    familiemaessigeForholdstring0 - 1Familiemæssige forhold, der kan have betydning for indsatsen
-    -    -    oevrigeForholdstring0 - 1Øvrige forhold - herunder sociale - der kan have betydning for indsatsen
-    -    -    aarsagTilOpholdstilladelseTypeAarsagTilOpholdstilladelseTypeCodeList0 - 1
-    -    -    antalBoernint320 - 1Antal børn
-    -    -    danskmaalGetDanskmaalDto0 - 1
-    -    -    -    senesteMeddelelsesDatodate-time0 - 1Dato for hvornår der sidst er givet meddelelse til udlændingen om konsekvenserne om manglende dansktilegnelse, jf.bek. § 15, stk. 9 og 11
-    -    -    -    senestVejledtOmKonsekvensDatodate-time0 - 1Dato for hvornår der sidst er vejledt vedr. konsekvenserne vedr. manglende dansktilegnelse, ifht I-ydelsen, familiesammenføring, tub
-    -    -    -    danskmaalTypeDanskmaalTypeCodeList0 - 1
-    -    -    -    senestAjourfoertDatodate-time0 - 1Dato for seneste ajourføring af dansk mål
-    -    kommentarstring0 - 1Kommentar
-    -    koordinerendeForvaltningstring0 - 1Koordinerende forvaltning i kommunen

Fejlkoder

FejlkodeFejltekstBeskrivelse
110001Person findes ikke for det angivne CPR-nummerPerson findes ikke for det angivne CPR-nummer
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
9271Data på den angivne integrationslovsdataIdentifier og person findes ikke i DFDGData på den angivne integrationslovsdataIdentifier og person findes ikke i DFDG

CreateIntegrationslovsdata (POST /v1/Integrationslov)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
JobCenterXX
STARX

Scope

borgerindsats.asyl.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
requestBodyCreateIntegrationslovsdataRequestDto1
-    integrationslovsdataIdentifieruuid0 - 1Unik Identifikation som ønskes gemt.
-    kontraktvarighedKontraktvarighedDto0 - 1
-    -    foersteUnderskriftsdatodate-time0 - 1Dato for underskrift af første kontrakt er samtidig startdato for periode.
-    -    programStartdatodate-time0 - 1Startdato for programmet under integrationsloven.
-    -    programSlutdatodate-time0 - 1Slutdato for programmet under integrationsloven.
-    -    kontraktSlutdatodate-time0 - 1Slutdato for kontrakten under intrgrationsloven
-    borgersprogSprogDtoCollection1Kollektion af sprog med tilhørende erfaring og færdighedsniveauer
-    -    SprogDtoSprogDto0 - *
-    -    -    sprogStamdataSprogStamdataDto1
-    -    -    -    sprognavnstring0 - 1Dansk navn på sproget
-    -    -    -    sprogkodeint320 - 1Kode for sproget
-    -    -    sprogerfaringstring0 - 1Erfaring med sproget
-    -    -    taleforstaaelsesniveauTypeLanguageSkillLevelTypeCodeList0 - 1
-    -    -    taleniveauTypeLanguageSkillLevelTypeCodeList0 - 1
-    -    -    laeseniveauTypeLanguageSkillLevelTypeCodeList0 - 1
-    -    -    skriveniveauTypeLanguageSkillLevelTypeCodeList0 - 1
-    uddannelseCreateUddannelseDto1
-    -    senestVejledtDatodate-time0 - 1Dato for hvornår der sidst er vejledt om at medbragt formel uddannelse kan vurderes af Uddannelses- og Forskningsstyrelsen
-    -    vurderingssagsstatusTypeUddannelsesVurderingssagsstatusTypeCodeList1
-    helbredstilstandCreateHelbredstilstandDto1
-    -    behandlingDkstring0 - 1Igangsat eller aftalt behandling i Danmark
-    -    aktuelHelbredstilstandstringMinLength: 11Aktuel helbredstilstand
-    helbredsvurderingCreateHelbredsvurderingDto1
-    -    vurderingsresultatstring0 - 1Resultat af Helbredsvurdering
-    -    andreHelbredsforholdstring0 - 1Eventuelle andre helbredsmæssige forhold
-    -    behovForVurderingboolean1Behov for helbredsvurdering
-    -    afgivetTilbudboolean1Er der afgivet tilbud om Helbredsvurdering
-    kontraktCreateKontraktDto1
-    -    erklaeringsunderskriftsdatodate-time0 - 1Dato for underskrift af erklæring om integration og aktivt medborgerskab
-    -    familiemaessigeForholdstring0 - 1Familiemæssige forhold, der kan have betydning for indsatsen
-    -    oevrigeForholdstring0 - 1Øvrige forhold - herunder sociale - der kan have betydning for indsatsen
-    -    aarsagTilOpholdstilladelseTypeAarsagTilOpholdstilladelseTypeCodeList1
-    -    antalBoernint321Antal børn
-    -    danskmaalCreateDanskmaalDto0 - 1
-    -    -    senesteMeddelelsesDatodate-time0 - 1Dato for hvornår der sidst er givet meddelelse til udlændingen om konsekvenserne om manglende dansktilegnelse, jf.bek. § 15, stk. 9 og 11
-    -    -    senestVejledtOmKonsekvensDatodate-time0 - 1Dato for hvornår der sidst er vejledt vedr. konsekvenserne vedr. manglende dansktilegnelse, ifht I-ydelsen, familiesammenføring, tub
-    -    -    danskmaalTypeDanskmaalTypeCodeList1
-    koordinerendeForvaltningstring0 - 1Koordinerende forvaltning i kommunen
-    kommentarstring0 - 1Kommentar

Output

ElementTypeDetaljerForekomstBeskrivelse
responseuuid1

Fejlkoder

FejlkodeFejltekstBeskrivelse
110001Person findes ikke for det angivne CPR-nummerPerson findes ikke for det angivne CPR-nummer
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
9265ProgramSlutdato skal være efter eller lig med ProgramStartdatoProgramSlutdato skal være efter eller lig med ProgramStartdato
9273Foerste underskriftsdato skal være dags dato eller historiskFoerste underskriftsdato skal være dags dato eller historisk
9276Alle angivne sprogkundskaber skal enten have angivet sprogkode eller sprognavnAlle angivne sprogkundskaber skal enten have angivet sprogkode eller sprognavn
9277Angivne sprogkundskaber skal angivet kun ved sprogkode eller sprognavnAngivne sprogkundskaber skal angivet kun ved sprogkode eller sprognavn
9278En angiven Sprogkode er ikke en gyldig kodelisteværdiEn angiven Sprogkode er ikke en gyldig kodelisteværdi
9279Den angivne kollektion af sprogkundskaber indeholder flere kundskaber vedrørende samme sprogDen angivne kollektion af sprogkundskaber indeholder flere kundskaber vedrørende samme sprog
9280Den angivne IntegrationslovsdataIdentifier eksisterer alleredeDen angivne IntegrationslovsdataIdentifier eksisterer allerede
9284SenesteMeddelelsesDato skal være dags dato eller historiskSenesteMeddelelsesDato skal være dags dato eller historisk
9285SenestVejledtOmKonsekvensDato skal være dags dato eller historiskSenestVejledtOmKonsekvensDato skal være dags dato eller historisk
9286SenestVejledtDato skal være dags dato eller historiskSenestVejledtDato skal være dags dato eller historisk

AfslutSenesteKontrakt (PUT /v1/Integrationslov)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
JobCenterXX
STARX

Scope

borgerindsats.asyl.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
requestBodyAfslutKontraktRequestDto1
-    kontraktSlutdatodate-time1Slutdato for kontrakten under integrationsloven
-    kommentarstringLength: 1-15000 - 1Kommentar til terminering af kontrakten under integrationsloven

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
110001Person findes ikke for det angivne CPR-nummerPerson findes ikke for det angivne CPR-nummer
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
9274IntegrationContractEndDate skal være i dag eller tidligereIntegrationContractEndDate skal være i dag eller tidligere
9275IntegrationContractEndDate må ikke være før FoesteUnderskriftsdatoIntegrationContractEndDate må ikke være før FoesteUnderskriftsdato
9283Integrationskontrakten eksisterer ikkeIntegrationskontrakten eksisterer ikke
  • No labels