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

CreateAfholdtSamtale (POST /v1/AfholdtSamtale)

Creates an afholdt samtale for a given person.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseXFra 120 dage inden medlemskab til 365 dage efter medlemskab
JobCenterXX
KommuneX
STARX

Scope

kontaktforloeb.samtale.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
requestBodyCreateAfholdtSamtaleRequestDto1DTO for creating afholdt samtale.
-    samtaleTypeSamtaleTypeCodeList1
-    indkaldelseIduuid0 - 1Mulighed for at angive id på den forudgående ikke-aflyste indkaldelse indrapporteret til DFDG.
-    afholdendeMyndighedAnsvarligMyndighedDto1DTO for AnsvarligMyndighed
-    -    organisationskodestringPattern: [-][1]|[0-9]{1,8}
MinLength: 1
1Myndighedskode
-    -    organisationnavnstringLength: 1-1001Myndighedsnavn
-    -    organisationTypeOrganisationTypeCodeList1
-    -    afholdendeSagsbehandlerSagsbehandlerDto1Sagsbehandler
-    -    -    fornavnestringLength: 1-501Sagsbehandlerens fornavn(e).
-    -    -    mellemnavnstringLength: 1-400 - 1Sagsbehandlerens mellemnavn.
-    -    -    efternavnstringLength: 1-401Sagsbehandlerens efternavn.
-    -    -    eksterntIdstringLength: 1-2561Sagsbehandler-id
-    moedeStarttidspunktdate-time1Mødeafholdelsestidspunkt. Kan variere fra det planlagte tidspunkt og registreringstidspunkt.
-    samtaleformSamtaleformTypeCodeList1
-    gaestendeMyndighedIndkaldtboolean1Angiver at samtalen er indkaldt med deltagelse af anden myndighed end den afholdende.
-    moededeltagelseStatusMoededeltagelseStatusTypeCodeList0 - 1
-    aftalebeskrivelsestringLength: 1-30001Beskrivelsesfelt til at beskrive aftalen mellem sagsbehandler og borger.
-    afholdtSamtaleIdentifieruuid0 - 1Unik nøgle. DFDG opretter nøgle hvis den ikke medsendes.
-    moededeltagereMoededeltagerDtoCollection0 - 1Deltagere på mødet og deres deltagelse.
-    -    MoededeltagerDtoMoededeltagerDto0 - *
-    -    -    deltagerIdentifieruuid1Unik nøgle.
-    -    -    navnstringLength: 1-2561Fuldt navn på deltageren.
-    -    -    deltagelsesformSamtaleformTypeCodeList1
-    -    -    deltagerrolleDeltagerrolleTypeCodeList1
-    -    -    eksterntIdstringLength: 1-2560 - 1Eksternt id på deltageren.

Output

ElementTypeDetaljerForekomstBeskrivelse
responseuuid1

Fejlkoder

FejlkodeFejltekstBeskrivelse
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
4657Samtaletidspunktet kan ikke være i fremtidenSamtaletidspunktet kan ikke være i fremtiden
4721AfholdtSamtaleIdentifier findes allerede i systemetAfholdtSamtaleIdentifier findes allerede i systemet
4768Det angivne IndkaldelseId er ikke kendt i systemetDet angivne IndkaldelseId er ikke kendt i systemet
4856Borgeren er ikke medlem af en a-kasseBorgeren er ikke medlem af en a-kasse
6054GaestendeMyndighedIndkaldt skal være true for denne samtaleTypeGaestendeMyndighedIndkaldt skal være true for denne samtaleType
6055Når gaestendeMyndighedDeltagelseType indikerer deltagelse skal deltager angivesNår gaestendeMyndighedDeltagelseType indikerer deltagelse skal deltager angives
6058Samtaletypen er kun tilladt for denne kontaktgruppe når borger er sygemeldt med fravær id 11Samtaletypen er kun tilladt for denne kontaktgruppe når borger er sygemeldt med fravær id 11
8058SamtaleTypen er ikke lovlig jf.borgers kontaktgruppeSamtaleTypen er ikke lovlig jf.borgers kontaktgruppe
9126Når gæstende myndighed er inviteret skal MoededeltagelseStatus angivesNår gæstende myndighed er inviteret skal MoededeltagelseStatus angives

GetAfholdteSamtaler (GET /v1/AfholdtSamtale)

Gets all afholdte samtaler for a given person.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseXFra 120 dage inden medlemskab til 365 dage efter medlemskabX
DriftsselskabXX
JobCenterXXXX
KommuneXX
STARX
Udbetaling Danmark (UDK)XX
Udlændinge- og Integrationsministeriet (UIM)XX

Scope

kontaktforloeb.samtale.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
responseGetAfholdtSamtaleResponseDto1DTO for getting afholdt samtale response.
-    afholdteSamtalerAfholdtSamtaleDtoCollection1The afholdte samtaler.
-    -    AfholdtSamtaleDtoAfholdtSamtaleDto0 - *
-    -    -    samtaleTypeSamtaleTypeCodeList1
-    -    -    indkaldelseIduuid0 - 1Mulighed for at angive id på den forudgående ikke-aflyste indkaldelse indrapporteret til DFDG.
-    -    -    afholdendeMyndighedAnsvarligMyndighedDto1DTO for AnsvarligMyndighed
-    -    -    -    organisationskodestringPattern: [-][1]|[0-9]{1,8}
MinLength: 1
1Myndighedskode
-    -    -    -    organisationnavnstringLength: 1-1001Myndighedsnavn
-    -    -    -    organisationTypeOrganisationTypeCodeList1
-    -    -    -    afholdendeSagsbehandlerSagsbehandlerDto1Sagsbehandler
-    -    -    -    -    fornavnestringLength: 1-501Sagsbehandlerens fornavn(e).
-    -    -    -    -    mellemnavnstringLength: 1-400 - 1Sagsbehandlerens mellemnavn.
-    -    -    -    -    efternavnstringLength: 1-401Sagsbehandlerens efternavn.
-    -    -    -    -    eksterntIdstringLength: 1-2561Sagsbehandler-id
-    -    -    moedeStarttidspunktdate-time1Mødeafholdelsestidspunkt. Kan variere fra det planlagte tidspunkt og registreringstidspunkt.
-    -    -    samtaleformSamtaleformTypeCodeList1
-    -    -    gaestendeMyndighedIndkaldtboolean1Angiver at samtalen er indkaldt med deltagelse af anden myndighed end den afholdende.
-    -    -    moededeltagelseStatusMoededeltagelseStatusTypeCodeList0 - 1
-    -    -    aftalebeskrivelsestringLength: 1-30001Beskrivelsesfelt til at beskrive aftalen mellem sagsbehandler og borger.
-    -    -    afholdtSamtaleIdentifieruuid1Unik nøgle.
-    -    -    moededeltagereMoededeltagerDtoCollection1Deltagere på mødet og deres deltagelse.
-    -    -    -    MoededeltagerDtoMoededeltagerDto0 - *
-    -    -    -    -    deltagerIdentifieruuid1Unik nøgle.
-    -    -    -    -    navnstringLength: 1-2561Fuldt navn på deltageren.
-    -    -    -    -    deltagelsesformSamtaleformTypeCodeList1
-    -    -    -    -    deltagerrolleDeltagerrolleTypeCodeList1
-    -    -    -    -    eksterntIdstringLength: 1-2560 - 1Eksternt id på deltageren.
-    -    -    berigtigelseskommentarstring0 - 1Kommentar til berigtigelse af en registrering.
-    -    -    dfdgRegistreringstidspunktdate-time1Registreringstidspunkt i DFDG.
-    -    -    efterregistreretSamtaleboolean1Angiver om der er tale om en efterregistreret samtale

Fejlkoder

Ingen fejlkoder

UpdateAfholdtSamtale (PUT /v1/AfholdtSamtale/{afholdtSamtaleIdentifier})

Updates an afholdt samtale for a given person.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseXFra 120 dage inden medlemskab til 365 dage efter medlemskab
JobCenterXX
KommuneX
STARX

Scope

kontaktforloeb.samtale.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
afholdtSamtaleIdentifier [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
requestBodyUpdateAfholdtSamtaleRequestDto1DTO for opdatering af afholdt samtale.
-    samtaleTypeSamtaleTypeCodeList1
-    indkaldelseIduuid0 - 1Mulighed for at angive id på den forudgående ikke-aflyste indkaldelse indrapporteret til DFDG.
-    afholdendeMyndighedAnsvarligMyndighedDto1DTO for AnsvarligMyndighed
-    -    organisationskodestringPattern: [-][1]|[0-9]{1,8}
MinLength: 1
1Myndighedskode
-    -    organisationnavnstringLength: 1-1001Myndighedsnavn
-    -    organisationTypeOrganisationTypeCodeList1
-    -    afholdendeSagsbehandlerSagsbehandlerDto1Sagsbehandler
-    -    -    fornavnestringLength: 1-501Sagsbehandlerens fornavn(e).
-    -    -    mellemnavnstringLength: 1-400 - 1Sagsbehandlerens mellemnavn.
-    -    -    efternavnstringLength: 1-401Sagsbehandlerens efternavn.
-    -    -    eksterntIdstringLength: 1-2561Sagsbehandler-id
-    moedeStarttidspunktdate-time1Mødeafholdelsestidspunkt. Kan variere fra det planlagte tidspunkt og registreringstidspunkt.
-    samtaleformSamtaleformTypeCodeList1
-    gaestendeMyndighedIndkaldtboolean1Angiver at samtalen er indkaldt med deltagelse af anden myndighed end den afholdende.
-    moededeltagelseStatusMoededeltagelseStatusTypeCodeList0 - 1
-    aftalebeskrivelsestringLength: 1-30001Beskrivelsesfelt til at beskrive aftalen mellem sagsbehandler og borger.
-    berigtigelseskommentarstringLength: 1-15001Kommentar til berigtigelse af en registrering.

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
4768Det angivne IndkaldelseId er ikke kendt i systemetDet angivne IndkaldelseId er ikke kendt i systemet
8184Det er ikke tilladt at opdatere samtaledatoenDet er ikke tilladt at opdatere samtaledatoen
8186Det er ikke tilladt at opdatere AfholdtSamtaleIdentifierDet er ikke tilladt at opdatere AfholdtSamtaleIdentifier
8187Det er ikke lovligt at opdatere samtaletypenDet er ikke lovligt at opdatere samtaletypen
8188Det er ikke tilladt at opdatere GaestendeMyndighedIndkaldtDet er ikke tilladt at opdatere GaestendeMyndighedIndkaldt
8237Samtalen er ikke fundet for borgerenSamtalen er ikke fundet for borgeren
9126Når gæstende myndighed er inviteret skal MoededeltagelseStatus angivesNår gæstende myndighed er inviteret skal MoededeltagelseStatus angives
9415Afholdelsestidspunktet må ikke ændre samtalens status som nulstillende eller ejAfholdelsestidspunktet må ikke ændre samtalens status som nulstillende eller ej

GetAfholdtSamtale (GET /v1/AfholdtSamtale/{afholdtSamtaleIdentifier})

Gets an afholdt samtale for a given person.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseXFra 120 dage inden medlemskab til 365 dage efter medlemskabX
DriftsselskabXX
JobCenterXXXX
KommuneXX
STARX
Udbetaling Danmark (UDK)XX
Udlændinge- og Integrationsministeriet (UIM)XX

Scope

kontaktforloeb.samtale.read

Input

ElementTypeDetaljerForekomstBeskrivelse
afholdtSamtaleIdentifier [Path]uuid1
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
responseGetAfholdtSamtaleResponseDto1DTO for getting afholdt samtale response.
-    afholdteSamtalerAfholdtSamtaleDtoCollection1The afholdte samtaler.
-    -    AfholdtSamtaleDtoAfholdtSamtaleDto0 - *
-    -    -    samtaleTypeSamtaleTypeCodeList1
-    -    -    indkaldelseIduuid0 - 1Mulighed for at angive id på den forudgående ikke-aflyste indkaldelse indrapporteret til DFDG.
-    -    -    afholdendeMyndighedAnsvarligMyndighedDto1DTO for AnsvarligMyndighed
-    -    -    -    organisationskodestringPattern: [-][1]|[0-9]{1,8}
MinLength: 1
1Myndighedskode
-    -    -    -    organisationnavnstringLength: 1-1001Myndighedsnavn
-    -    -    -    organisationTypeOrganisationTypeCodeList1
-    -    -    -    afholdendeSagsbehandlerSagsbehandlerDto1Sagsbehandler
-    -    -    -    -    fornavnestringLength: 1-501Sagsbehandlerens fornavn(e).
-    -    -    -    -    mellemnavnstringLength: 1-400 - 1Sagsbehandlerens mellemnavn.
-    -    -    -    -    efternavnstringLength: 1-401Sagsbehandlerens efternavn.
-    -    -    -    -    eksterntIdstringLength: 1-2561Sagsbehandler-id
-    -    -    moedeStarttidspunktdate-time1Mødeafholdelsestidspunkt. Kan variere fra det planlagte tidspunkt og registreringstidspunkt.
-    -    -    samtaleformSamtaleformTypeCodeList1
-    -    -    gaestendeMyndighedIndkaldtboolean1Angiver at samtalen er indkaldt med deltagelse af anden myndighed end den afholdende.
-    -    -    moededeltagelseStatusMoededeltagelseStatusTypeCodeList0 - 1
-    -    -    aftalebeskrivelsestringLength: 1-30001Beskrivelsesfelt til at beskrive aftalen mellem sagsbehandler og borger.
-    -    -    afholdtSamtaleIdentifieruuid1Unik nøgle.
-    -    -    moededeltagereMoededeltagerDtoCollection1Deltagere på mødet og deres deltagelse.
-    -    -    -    MoededeltagerDtoMoededeltagerDto0 - *
-    -    -    -    -    deltagerIdentifieruuid1Unik nøgle.
-    -    -    -    -    navnstringLength: 1-2561Fuldt navn på deltageren.
-    -    -    -    -    deltagelsesformSamtaleformTypeCodeList1
-    -    -    -    -    deltagerrolleDeltagerrolleTypeCodeList1
-    -    -    -    -    eksterntIdstringLength: 1-2560 - 1Eksternt id på deltageren.
-    -    -    berigtigelseskommentarstring0 - 1Kommentar til berigtigelse af en registrering.
-    -    -    dfdgRegistreringstidspunktdate-time1Registreringstidspunkt i DFDG.
-    -    -    efterregistreretSamtaleboolean1Angiver om der er tale om en efterregistreret samtale

Fejlkoder

FejlkodeFejltekstBeskrivelse
90215Det angivne AfholdtSamtaleIdentifier er ikke kendt i systemetDet angivne AfholdtSamtaleIdentifier er ikke kendt i systemet

CreateMoededeltager (POST /v1/AfholdtSamtale/{afholdtSamtaleIdentifier}/moededeltager)

Creates a new moededeltager for a given afholdt samtale

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseXFra 120 dage inden medlemskab til 365 dage efter medlemskab
JobCenterXX
KommuneX
STARX

Scope

kontaktforloeb.samtale.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
afholdtSamtaleIdentifier [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
requestBodyCreateMoededeltagerRequestDto1DTO for oprettelse af mødedeltager.
-    navnstringLength: 1-2561Fuldt navn på deltageren.
-    eksterntIdstringLength: 1-2560 - 1Eksternt id på deltageren.
-    deltagerIdentifieruuid0 - 1Unikt id på mødedeltageren. DFDG opretter Id hvis den ikke medsendes
-    deltagelsesformSamtaleformTypeCodeList1
-    deltagerrolleDeltagerrolleTypeCodeList1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseuuid1

Fejlkoder

FejlkodeFejltekstBeskrivelse
1Person does not exist for given cpr number.Person does not exist for given cpr number.
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
8237Samtalen er ikke fundet for borgerenSamtalen er ikke fundet for borgeren

UpdateMoededeltager (PUT /v1/AfholdtSamtale/{afholdtSamtaleIdentifier}/moededeltager/{moededeltagerIdentifier})

Updates an existing moededeltager for a given afholdt samtale

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseXFra 120 dage inden medlemskab til 365 dage efter medlemskab
JobCenterXX
KommuneX
STARX

Scope

kontaktforloeb.samtale.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
afholdtSamtaleIdentifier [Path]uuid1
moededeltagerIdentifier [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
requestBodyUpdateMoededeltagerRequestDto1DTO for opdatering af mødedeltager.
-    navnstringLength: 1-2561Fuldt navn på deltageren.
-    eksterntIdstringLength: 1-2560 - 1Eksternt id på deltageren.

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
1Person does not exist for given cpr number.Person does not exist for given cpr number.
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
8237Samtalen er ikke fundet for borgerenSamtalen er ikke fundet for borgeren
90211Den angivne deltagerIdentifier er ikke fundet eller findes allerede i systemetDen angivne deltagerIdentifier er ikke fundet eller findes allerede i systemet
8198Mødedeltager ikke fundet for den angivne samtaleMødedeltager ikke fundet for den angivne samtale

DeleteMoededeltager (DELETE /v1/AfholdtSamtale/{afholdtSamtaleIdentifier}/moededeltager/{moededeltagerIdentifier})

Deletes an existing moededeltager for a given afholdt samtale

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseXFra 120 dage inden medlemskab til 365 dage efter medlemskab
JobCenterXX
KommuneX
STARX

Scope

kontaktforloeb.samtale.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
afholdtSamtaleIdentifier [Path]uuid1
moededeltagerIdentifier [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

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
1Person does not exist for given cpr number.Person does not exist for given cpr number.
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
8237Samtalen er ikke fundet for borgerenSamtalen er ikke fundet for borgeren
90211Den angivne deltagerIdentifier er ikke fundet eller findes allerede i systemetDen angivne deltagerIdentifier er ikke fundet eller findes allerede i systemet
8198Mødedeltager ikke fundet for den angivne samtaleMødedeltager ikke fundet for den angivne samtale
  • No labels