...
Table of Contents | ||
---|---|---|
|
CreateText (POST /v1/DynamicTexts/create)
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 | |
---|---|---|---|---|---|---|---|---|
STAR | X |
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
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 | CreateDynamicTextDto | 1 | ||
- text | string | MinLength: 1 | 1 | |
- displayText | string | MinLength: 1 | 1 | |
- groupExternalIdentifier | uuid | 0 - 1 |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | uuid | 1 |
Fejlkoder
Ingen fejlkoder
DeleteText (DELETE /v1/DynamicTexts/{externalIdentifier})
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 | |
---|---|---|---|---|---|---|---|---|
STAR | X |
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
externalIdentifier [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
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | ActionResult | 1 |
Fejlkoder
Ingen fejlkoder
GetText (GET /v1/DynamicTexts/{externalIdentifier})
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 | |
---|---|---|---|---|---|---|---|---|
STAR | X |
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
externalIdentifier [Path] | uuid | 1 |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetDynamicTextDto | 1 | ||
- externalIdentifier | uuid | 1 | ||
- text | string | MinLength: 1 | 1 | |
- displayText | string | MinLength: 1 | 1 | |
- group | GetDynamicTextGroupDto | 0 - 1 | ||
- - externalIdentifier | uuid | 1 | ||
- - name | string | MinLength: 1 | 1 |
Fejlkoder
Ingen fejlkoder
GetTexts (GET /v1/DynamicTexts)
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 | |
---|---|---|---|---|---|---|---|---|
STAR | X |
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
externalGroupIdentifier [Query] | uuid | 0 - 1 |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetDynamicTextDtoCollection | 1 | ||
- GetDynamicTextDto | GetDynamicTextDto | 0 - * | ||
- - externalIdentifier | uuid | 1 | ||
- - text | string | MinLength: 1 | 1 | |
- - displayText | string | MinLength: 1 | 1 | |
- - group | GetDynamicTextGroupDto | 0 - 1 | ||
- - - externalIdentifier | uuid | 1 | ||
- - - name | string | MinLength: 1 | 1 |
Fejlkoder
Ingen fejlkoder
GetAllGroups (GET /v1/DynamicTexts/groups)
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 | |
---|---|---|---|---|---|---|---|---|
STAR | X |
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetDynamicTextGroupDtoCollection | 1 | ||
- GetDynamicTextGroupDto | GetDynamicTextGroupDto | 0 - * | ||
- - externalIdentifier | uuid | 1 | ||
- - name | string | MinLength: 1 | 1 |
Fejlkoder
Ingen fejlkoder
UpdateText (PUT /v1/DynamicTexts/update/{externalIdentifier})
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 | |
---|---|---|---|---|---|---|---|---|
STAR | X |
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
externalIdentifier [Path] | string | 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 | UpdateDynamicTextDto | 1 | ||
- externalIdentifier | uuid | 1 | ||
- text | string | MinLength: 1 | 1 | |
- displayText | string | MinLength: 1 | 1 | |
- groupExternalIdentifier | uuid | 0 - 1 |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | ActionResult | 1 |
Fejlkoder
Ingen fejlkoder
GetIntegrationslovsdata (GET /v1/LetasylIntegrationslov)
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
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 |
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 | |
- - uddannelse | UddannelseDto | 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 | HelbredstilstandDto | 0 - 1 | ||
- - - aktuelHelbredstilstand | string | 0 - 1 | Aktuel helbredstilstand | |
- - - behandlingDk | string | 0 - 1 | Igangsat eller aftalt behandling i Danmark | |
- - helbredsvurdering | HelbredsvurderingDto | 0 - 1 | ||
- - - behovForVurdering | boolean | 0 - 1 | Behov for helbredsvurdering | |
- - - afgivetTilbud | boolean | 0 - 1 | Er der afgivet tilbud om Helbredsvurdering | |
- - - vurderingsresultat | string | 0 - 1 | Resultat af Helbredsvurdering | |
- - - andreHelbredsforhold | string | 0 - 1 | Eventuelle andre helbredsmæssige forhold | |
- - kontrakt | KontraktDto | 0 - 1 | ||
- - - aarsagTilOpholdstilladelseType | AarsagTilOpholdstilladelseTypeCodeList | 0 - 1 | ||
- - - erklaeringsunderskriftsdato | date-time | 0 - 1 | Dato for underskrift af erklæring om integration og aktivt medborgerskab | |
- - - danskmaal | DanskmaalDto | 0 - 1 | ||
- - - - danskmaalType | DanskmaalTypeCodeList | 0 - 1 | ||
- - - - senestAjourfoertDato | date-time | 0 - 1 | Dato for seneste ajourføring af dansk mål | |
- - - - 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 | |
- - - 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 | |
- - - antalBoern | int32 | 0 - 1 | Antal børn | |
- - 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 | ||
- - 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 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
9294 | Ubehandlet fejl modtaget fra asyloperatøren | Ubehandlet fejl modtaget fra asyloperatøren |
9293 | Ugyldige logningsoverskrifter indsendt til asyloperatøren | Ugyldige logningsoverskrifter indsendt til asyloperatøren |
9292 | Kommunikation med asyloperatøren (LetAsyl) er udløbet (timed out) | Kommunikation med asyloperatøren (LetAsyl) er udløbet (timed out) |
9287 | Kommunikation med asyloperatøren (LetAsyl) ikke mulig | Kommunikation med asyloperatøren (LetAsyl) ikke mulig |
9290 | Ugyldig kommunekode angivet til asyloperatøren (LetAsyl) | Ugyldig kommunekode angivet til asyloperatøren (LetAsyl) |
9289 | Ugyldig URL eller ukendt personnummer angivet til asyloperatøren (LetAsyl) | Ugyldig URL eller ukendt personnummer angivet til asyloperatøren (LetAsyl) |
9291 | Ugyldige parametre angivet til asyloperatøren (LetAsyl) | Ugyldige parametre angivet til asyloperatøren (LetAsyl) |
9288 | Ukendt brugernavn og password angivet til asyloperatøren (LetAsyl) | Ukendt brugernavn og password angivet til asyloperatøren (LetAsyl) |
GetIntegrationslovsdataPdf (GET /v1/LetasylIntegrationslov/pdf)
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
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 |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetIntegrationslovdataSomPdfResponseDto | 1 | ||
- letAsylIntegrationslovdataSomPdf | GetIntegrationslovdataSomPdfDto | 0 - 1 | ||
- - jobcenterkode | string | Pattern: [0-9]{5} | 0 - 1 | Borgerens jobcenter |
- - pdfData | base64Binary | 1 | Integrationslovdata i PDF-format, som er base 64-kodet |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
110001 | Person findes ikke for det angivne CPR-nummer | Person findes ikke for det angivne CPR-nummer |
4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
9294 | Ubehandlet fejl modtaget fra asyloperatøren | Ubehandlet fejl modtaget fra asyloperatøren |
9293 | Ugyldige logningsoverskrifter indsendt til asyloperatøren | Ugyldige logningsoverskrifter indsendt til asyloperatøren |
9292 | Kommunikation med asyloperatøren (LetAsyl) er udløbet (timed out) | Kommunikation med asyloperatøren (LetAsyl) er udløbet (timed out) |
9287 | Kommunikation med asyloperatøren (LetAsyl) ikke mulig | Kommunikation med asyloperatøren (LetAsyl) ikke mulig |
9290 | Ugyldig kommunekode angivet til asyloperatøren (LetAsyl) | Ugyldig kommunekode angivet til asyloperatøren (LetAsyl) |
9289 | Ugyldig URL eller ukendt personnummer angivet til asyloperatøren (LetAsyl) | Ugyldig URL eller ukendt personnummer angivet til asyloperatøren (LetAsyl) |
9291 | Ugyldige parametre angivet til asyloperatøren (LetAsyl) | Ugyldige parametre angivet til asyloperatøren (LetAsyl) |
9288 | Ukendt brugernavn og password angivet til asyloperatøren (LetAsyl) | Ukendt brugernavn og password angivet til asyloperatøren (LetAsyl) |
OverfoerLetAsylIntegrationslovsdata (POST /v1/LetasylIntegrationslov/action/transfer)
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 | |||||||
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 |
Output
Intet output
Fejlkoder
Ingen fejlkoder