Kontaktforloeb.AfholdtSamtaleService (Version 1, 2024-4)

A-kasse

JobCenter

Kommune

STAR

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

CreateAfholdtSamtaleRequestDto

1

DTO for creating afholdt samtale.

-    samtaleType

SamtaleTypeCodeList

1

-    indkaldelseId

uuid

0 - 1

Mulighed for at angive id på den forudgående ikke-aflyste indkaldelse indrapporteret til DFDG.

-    afholdendeMyndighed

AnsvarligMyndighedDto

1

DTO for AnsvarligMyndighed

-    -    organisationskode

string

Pattern: [-][1]|[0-9]{1,8}
MinLength: 1

1

Myndighedskode

-    -    organisationsnavn

string

Length: 1-100

1

Myndighedsnavn

-    -    organisationType

OrganisationTypeCodeList

1

-    -    afholdendeSagsbehandler

SagsbehandlerDto

1

Sagsbehandler

-    -    -    fornavne

string

Length: 1-50

1

Sagsbehandlerens fornavn(e).

-    -    -    mellemnavn

string

Length: 1-40

0 - 1

Sagsbehandlerens mellemnavn.

-    -    -    efternavn

string

Length: 1-40

1

Sagsbehandlerens efternavn.

-    -    -    eksterntId

string

Length: 1-256

1

Sagsbehandler-id

-    moedeStarttidspunkt

date-time

1

Mødeafholdelsestidspunkt. Kan variere fra det planlagte tidspunkt og registreringstidspunkt.

-    samtaleform

SamtaleformTypeCodeList

1

-    gaestendeMyndighedIndkaldt

boolean

1

Angiver at samtalen er indkaldt med deltagelse af anden myndighed end den afholdende.

-    moededeltagelseStatus

MoededeltagelseStatusTypeCodeList

0 - 1

-    aftalebeskrivelse

string

Length: 1-3000

1

Beskrivelsesfelt til at beskrive aftalen mellem sagsbehandler og borger.

-    afholdtSamtaleIdentifier

uuid

0 - 1

Unik nøgle. DFDG opretter nøgle hvis den ikke medsendes.

-    moededeltagere

MoededeltagerDtoCollection

0 - 1

Deltagere på mødet og deres deltagelse.

-    -    MoededeltagerDto

MoededeltagerDto

0 - *

-    -    -    deltagerIdentifier

uuid

1

Unik nøgle.

-    -    -    navn

string

Length: 1-256

1

Fuldt navn på deltageren.

-    -    -    deltagelsesform

SamtaleformTypeCodeList

1

-    -    -    deltagerrolle

DeltagerrolleTypeCodeList

1

-    -    -    eksterntId

string

Length: 1-256

0 - 1

Eksternt id på deltageren.

response

uuid

1

4405

Borgeren med det specificerede CPR nummer er død

Borgeren med det specificerede CPR nummer er død

4657

Samtaletidspunktet kan ikke være i fremtiden

Samtaletidspunktet kan ikke være i fremtiden

4721

AfholdtSamtaleIdentifier findes allerede i systemet

AfholdtSamtaleIdentifier findes allerede i systemet

4768

Det angivne IndkaldelseId er ikke kendt i systemet

Det angivne IndkaldelseId er ikke kendt i systemet

4856

Borgeren er ikke medlem af en a-kasse

Borgeren er ikke medlem af en a-kasse

6054

GaestendeMyndighedIndkaldt skal være true for denne samtaleType

GaestendeMyndighedIndkaldt skal være true for denne samtaleType

6055

Når gaestendeMyndighedDeltagelseType indikerer deltagelse skal deltager angives

Når gaestendeMyndighedDeltagelseType indikerer deltagelse skal deltager angives

6058

Samtaletypen er kun tilladt for denne kontaktgruppe når borger er sygemeldt med fravær id 11

Samtaletypen er kun tilladt for denne kontaktgruppe når borger er sygemeldt med fravær id 11

8058

SamtaleTypen er ikke lovlig jf.borgers kontaktgruppe

SamtaleTypen er ikke lovlig jf.borgers kontaktgruppe

9126

Når gæstende myndighed er inviteret skal MoededeltagelseStatus angives

Når gæstende myndighed er inviteret skal MoededeltagelseStatus angives

A-kasse

Driftsselskab

JobCenter

Kommune

STAR

Udbetaling Danmark (UDK)

Udlændinge- og Integrationsministeriet (UIM)

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

response

GetAfholdtSamtaleResponseDto

1

DTO for getting afholdt samtale response.

-    afholdteSamtaler

AfholdtSamtaleDtoCollection

1

The afholdte samtaler.

-    -    AfholdtSamtaleDto

AfholdtSamtaleDto

0 - *

-    -    -    samtaleType

SamtaleTypeCodeList

1

-    -    -    indkaldelseId

uuid

0 - 1

Mulighed for at angive id på den forudgående ikke-aflyste indkaldelse indrapporteret til DFDG.

-    -    -    afholdendeMyndighed

AnsvarligMyndighedDto

1

DTO for AnsvarligMyndighed

-    -    -    -    organisationskode

string

Pattern: [-][1]|[0-9]{1,8}
MinLength: 1

1

Myndighedskode

-    -    -    -    organisationsnavn

string

Length: 1-100

1

Myndighedsnavn

-    -    -    -    organisationType

OrganisationTypeCodeList

1

-    -    -    -    afholdendeSagsbehandler

SagsbehandlerDto

1

Sagsbehandler

-    -    -    -    -    fornavne

string

Length: 1-50

1

Sagsbehandlerens fornavn(e).

-    -    -    -    -    mellemnavn

string

Length: 1-40

0 - 1

Sagsbehandlerens mellemnavn.

-    -    -    -    -    efternavn

string

Length: 1-40

1

Sagsbehandlerens efternavn.

-    -    -    -    -    eksterntId

string

Length: 1-256

1

Sagsbehandler-id

-    -    -    moedeStarttidspunkt

date-time

1

Mødeafholdelsestidspunkt. Kan variere fra det planlagte tidspunkt og registreringstidspunkt.

-    -    -    samtaleform

SamtaleformTypeCodeList

1

-    -    -    gaestendeMyndighedIndkaldt

boolean

1

Angiver at samtalen er indkaldt med deltagelse af anden myndighed end den afholdende.

-    -    -    moededeltagelseStatus

MoededeltagelseStatusTypeCodeList

0 - 1

-    -    -    aftalebeskrivelse

string

Length: 1-3000

1

Beskrivelsesfelt til at beskrive aftalen mellem sagsbehandler og borger.

-    -    -    afholdtSamtaleIdentifier

uuid

1

Unik nøgle.

-    -    -    moededeltagere

MoededeltagerDtoCollection

1

Deltagere på mødet og deres deltagelse.

-    -    -    -    MoededeltagerDto

MoededeltagerDto

0 - *

-    -    -    -    -    deltagerIdentifier

uuid

1

Unik nøgle.

-    -    -    -    -    navn

string

Length: 1-256

1

Fuldt navn på deltageren.

-    -    -    -    -    deltagelsesform

SamtaleformTypeCodeList

1

-    -    -    -    -    deltagerrolle

DeltagerrolleTypeCodeList

1

-    -    -    -    -    eksterntId

string

Length: 1-256

0 - 1

Eksternt id på deltageren.

-    -    -    berigtigelseskommentar

string

0 - 1

Kommentar til berigtigelse af en registrering.

-    -    -    dfdgRegistreringstidspunkt

date-time

1

Registreringstidspunkt i DFDG.

-    -    -    efterregistreretSamtale

boolean

1

Angiver om der er tale om en efterregistreret samtale

A-kasse

JobCenter

Kommune

STAR

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

afholdtSamtaleIdentifier [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

UpdateAfholdtSamtaleRequestDto

1

DTO for opdatering af afholdt samtale.

-    samtaleType

SamtaleTypeCodeList

1

-    indkaldelseId

uuid

0 - 1

Mulighed for at angive id på den forudgående ikke-aflyste indkaldelse indrapporteret til DFDG.

-    afholdendeMyndighed

AnsvarligMyndighedDto

1

DTO for AnsvarligMyndighed

-    -    organisationskode

string

Pattern: [-][1]|[0-9]{1,8}
MinLength: 1

1

Myndighedskode

-    -    organisationsnavn

string

Length: 1-100

1

Myndighedsnavn

-    -    organisationType

OrganisationTypeCodeList

1

-    -    afholdendeSagsbehandler

SagsbehandlerDto

1

Sagsbehandler

-    -    -    fornavne

string

Length: 1-50

1

Sagsbehandlerens fornavn(e).

-    -    -    mellemnavn

string

Length: 1-40

0 - 1

Sagsbehandlerens mellemnavn.

-    -    -    efternavn

string

Length: 1-40

1

Sagsbehandlerens efternavn.

-    -    -    eksterntId

string

Length: 1-256

1

Sagsbehandler-id

-    moedeStarttidspunkt

date-time

1

Mødeafholdelsestidspunkt. Kan variere fra det planlagte tidspunkt og registreringstidspunkt.

-    samtaleform

SamtaleformTypeCodeList

1

-    gaestendeMyndighedIndkaldt

boolean

1

Angiver at samtalen er indkaldt med deltagelse af anden myndighed end den afholdende.

-    moededeltagelseStatus

MoededeltagelseStatusTypeCodeList

0 - 1

-    aftalebeskrivelse

string

Length: 1-3000

1

Beskrivelsesfelt til at beskrive aftalen mellem sagsbehandler og borger.

-    berigtigelseskommentar

string

Length: 1-1500

1

Kommentar til berigtigelse af en registrering.

4405

Borgeren med det specificerede CPR nummer er død

Borgeren med det specificerede CPR nummer er død

4768

Det angivne IndkaldelseId er ikke kendt i systemet

Det angivne IndkaldelseId er ikke kendt i systemet

8184

Det er ikke tilladt at opdatere samtaledatoen

Det er ikke tilladt at opdatere samtaledatoen

8186

Det er ikke tilladt at opdatere AfholdtSamtaleIdentifier

Det er ikke tilladt at opdatere AfholdtSamtaleIdentifier

8187

Det er ikke lovligt at opdatere samtaletypen

Det er ikke lovligt at opdatere samtaletypen

8188

Det er ikke tilladt at opdatere GaestendeMyndighedIndkaldt

Det er ikke tilladt at opdatere GaestendeMyndighedIndkaldt

8237

Samtalen er ikke fundet for borgeren

Samtalen er ikke fundet for borgeren

9126

Når gæstende myndighed er inviteret skal MoededeltagelseStatus angives

Når gæstende myndighed er inviteret skal MoededeltagelseStatus angives

9415

Afholdelsestidspunktet må ikke ændre samtalens status som nulstillende eller ej

Afholdelsestidspunktet må ikke ændre samtalens status som nulstillende eller ej

A-kasse

Driftsselskab

JobCenter

Kommune

STAR

Udbetaling Danmark (UDK)

Udlændinge- og Integrationsministeriet (UIM)

afholdtSamtaleIdentifier [Path]

uuid

1

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

response

GetAfholdtSamtaleResponseDto

1

DTO for getting afholdt samtale response.

-    afholdteSamtaler

AfholdtSamtaleDtoCollection

1

The afholdte samtaler.

-    -    AfholdtSamtaleDto

AfholdtSamtaleDto

0 - *

-    -    -    samtaleType

SamtaleTypeCodeList

1

-    -    -    indkaldelseId

uuid

0 - 1

Mulighed for at angive id på den forudgående ikke-aflyste indkaldelse indrapporteret til DFDG.

-    -    -    afholdendeMyndighed

AnsvarligMyndighedDto

1

DTO for AnsvarligMyndighed

-    -    -    -    organisationskode

string

Pattern: [-][1]|[0-9]{1,8}
MinLength: 1

1

Myndighedskode

-    -    -    -    organisationsnavn

string

Length: 1-100

1

Myndighedsnavn

-    -    -    -    organisationType

OrganisationTypeCodeList

1

-    -    -    -    afholdendeSagsbehandler

SagsbehandlerDto

1

Sagsbehandler

-    -    -    -    -    fornavne

string

Length: 1-50

1

Sagsbehandlerens fornavn(e).

-    -    -    -    -    mellemnavn

string

Length: 1-40

0 - 1

Sagsbehandlerens mellemnavn.

-    -    -    -    -    efternavn

string

Length: 1-40

1

Sagsbehandlerens efternavn.

-    -    -    -    -    eksterntId

string

Length: 1-256

1

Sagsbehandler-id

-    -    -    moedeStarttidspunkt

date-time

1

Mødeafholdelsestidspunkt. Kan variere fra det planlagte tidspunkt og registreringstidspunkt.

-    -    -    samtaleform

SamtaleformTypeCodeList

1

-    -    -    gaestendeMyndighedIndkaldt

boolean

1

Angiver at samtalen er indkaldt med deltagelse af anden myndighed end den afholdende.

-    -    -    moededeltagelseStatus

MoededeltagelseStatusTypeCodeList

0 - 1

-    -    -    aftalebeskrivelse

string

Length: 1-3000

1

Beskrivelsesfelt til at beskrive aftalen mellem sagsbehandler og borger.

-    -    -    afholdtSamtaleIdentifier

uuid

1

Unik nøgle.

-    -    -    moededeltagere

MoededeltagerDtoCollection

1

Deltagere på mødet og deres deltagelse.

-    -    -    -    MoededeltagerDto

MoededeltagerDto

0 - *

-    -    -    -    -    deltagerIdentifier

uuid

1

Unik nøgle.

-    -    -    -    -    navn

string

Length: 1-256

1

Fuldt navn på deltageren.

-    -    -    -    -    deltagelsesform

SamtaleformTypeCodeList

1

-    -    -    -    -    deltagerrolle

DeltagerrolleTypeCodeList

1

-    -    -    -    -    eksterntId

string

Length: 1-256

0 - 1

Eksternt id på deltageren.

-    -    -    berigtigelseskommentar

string

0 - 1

Kommentar til berigtigelse af en registrering.

-    -    -    dfdgRegistreringstidspunkt

date-time

1

Registreringstidspunkt i DFDG.

-    -    -    efterregistreretSamtale

boolean

1

Angiver om der er tale om en efterregistreret samtale

90215

Det angivne AfholdtSamtaleIdentifier er ikke kendt i systemet

Det angivne AfholdtSamtaleIdentifier er ikke kendt i systemet

A-kasse

JobCenter

Kommune

STAR

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

afholdtSamtaleIdentifier [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

CreateMoededeltagerRequestDto

1

DTO for oprettelse af mødedeltager.

-    navn

string

Length: 1-256

1

Fuldt navn på deltageren.

-    eksterntId

string

Length: 1-256

0 - 1

Eksternt id på deltageren.

-    deltagerIdentifier

uuid

0 - 1

Unikt id på mødedeltageren. DFDG opretter Id hvis den ikke medsendes

-    deltagelsesform

SamtaleformTypeCodeList

1

-    deltagerrolle

DeltagerrolleTypeCodeList

1

response

uuid

1

1

Person does not exist for given cpr number.

Person does not exist for given cpr number.

4405

Borgeren med det specificerede CPR nummer er død

Borgeren med det specificerede CPR nummer er død

8237

Samtalen er ikke fundet for borgeren

Samtalen er ikke fundet for borgeren

A-kasse

JobCenter

Kommune

STAR

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

afholdtSamtaleIdentifier [Path]

uuid

1

moededeltagerIdentifier [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

UpdateMoededeltagerRequestDto

1

DTO for opdatering af mødedeltager.

-    navn

string

Length: 1-256

1

Fuldt navn på deltageren.

-    eksterntId

string

Length: 1-256

0 - 1

Eksternt id på deltageren.

1

Person does not exist for given cpr number.

Person does not exist for given cpr number.

4405

Borgeren med det specificerede CPR nummer er død

Borgeren med det specificerede CPR nummer er død

8237

Samtalen er ikke fundet for borgeren

Samtalen er ikke fundet for borgeren

90211

Den angivne deltagerIdentifier er ikke fundet eller findes allerede i systemet

Den angivne deltagerIdentifier er ikke fundet eller findes allerede i systemet

8198

Mødedeltager ikke fundet for den angivne samtale

Mødedeltager ikke fundet for den angivne samtale

A-kasse

JobCenter

Kommune

STAR

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

afholdtSamtaleIdentifier [Path]

uuid

1

moededeltagerIdentifier [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

1

Person does not exist for given cpr number.

Person does not exist for given cpr number.

4405

Borgeren med det specificerede CPR nummer er død

Borgeren med det specificerede CPR nummer er død

8237

Samtalen er ikke fundet for borgeren

Samtalen er ikke fundet for borgeren

90211

Den angivne deltagerIdentifier er ikke fundet eller findes allerede i systemet

Den angivne deltagerIdentifier er ikke fundet eller findes allerede i systemet

8198

Mødedeltager ikke fundet for den angivne samtale

Mødedeltager ikke fundet for den angivne samtale