Borgerkommunikation.AndenAktoerHenvisningService (Version 2, 2024-3)

JobCenter

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

CreateHenvisningRequestDto

1

-    eksternSystemAftaleId

uuid

0 - 1

Id på delaftale i det ekstern system

-    cvrEnhedsid

string

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

1

Anden aktørs CVR-nummer.

-    pNummer

string

Pattern: [0-9]{10}
MinLength: 1

1

P-nr på anden aktør

-    startDato

date

1

Dato for anden aktør henvisningens start.

-    slutDato

date

1

Dato for anden aktør henvisningens afslutning.

response

uuid

1

4950

En henvisning er allerede oprettet med den angivne identifier

En henvisning er allerede oprettet med den angivne identifier

4353

Den angivne kombination af CVR- og P-nummer findes ikke

Den angivne kombination af CVR- og P-nummer findes ikke

60005

Slutdato må ikke være før startdato

Slutdato må ikke være før startdato

60006

Unknown cpr

Unknown cpr

60007

The person with specified cpr is dead

The person with specified cpr is dead

JobCenter

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

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

CreateHenvisningRequestDto

1

-    eksternSystemAftaleId

uuid

0 - 1

Id på delaftale i det ekstern system

-    cvrEnhedsid

string

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

1

Anden aktørs CVR-nummer.

-    pNummer

string

Pattern: [0-9]{10}
MinLength: 1

1

P-nr på anden aktør

-    startDato

date

1

Dato for anden aktør henvisningens start.

-    slutDato

date

1

Dato for anden aktør henvisningens afslutning.

response

uuid

1

4950

En henvisning er allerede oprettet med den angivne identifier

En henvisning er allerede oprettet med den angivne identifier

4353

Den angivne kombination af CVR- og P-nummer findes ikke

Den angivne kombination af CVR- og P-nummer findes ikke

60005

Slutdato må ikke være før startdato

Slutdato må ikke være før startdato

60006

Unknown cpr

Unknown cpr

60007

The person with specified cpr is dead

The person with specified cpr is dead

JobCenter

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

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

UpdateHenvisningRequestDto

1

-    eksternSystemAftaleId

uuid

0 - 1

Id på delaftale i det ekstern system

-    startDato

date

1

Dato for anden aktør henvisningens start.

-    slutDato

date

1

Dato for anden aktør henvisningens afslutning.

-    kommentar

string

Length: 0-1500

0 - 1

Berigtigelseskommentar

60005

Slutdato må ikke være før startdato

Slutdato må ikke være før startdato

4909

Det angivne cpr nummer er ikke identisk med cpr nummer på henvisningen

Det angivne cpr nummer er ikke identisk med cpr nummer på henvisningen

4938

Det er ikke muligt at opdatere en afsluttet henvisning

Det er ikke muligt at opdatere en afsluttet henvisning

4952

Den angivne henvisning er ukendt

Den angivne henvisning er ukendt

60006

Unknown cpr

Unknown cpr

JobCenter

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

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

AfslutHenvisningRequestDto

1

-    kommentar

string

Length: 0-1500

1

Berigtigelseskommentar

4909

Det angivne cpr nummer er ikke identisk med cpr nummer på henvisningen

Det angivne cpr nummer er ikke identisk med cpr nummer på henvisningen

4952

Den angivne henvisning er ukendt

Den angivne henvisning er ukendt

60006

Unknown cpr

Unknown cpr

JobCenter

STAR

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

SkiftAndenAktoerRequestDto

1

-    henvisninger

SkiftAndenAktoerHenvisningDtoCollection

1

Liste af anden aktør henvisninger der skal opdateres.

-    -    SkiftAndenAktoerHenvisningDto

SkiftAndenAktoerHenvisningDto

0 - *

-    -    -    henvisningId

uuid

1

Entydig identifikation af den anden aktør henvisning, man ønsker ændre.

-    -    -    civilRegistrationIdentifier

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

CPR nummer på borger der er henvist til anden aktør

-    -    -    cvrEnhedsid

string

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

1

Anden aktørs CVR-nummer.

-    -    -    pNummer

string

Pattern: [0-9]{10}
MinLength: 1

1

Anden aktørs P-nummer.

-    -    -    kommentar

string

Length: 0-1500

1

Kommentar.

4353

Den angivne kombination af CVR- og P-nummer findes ikke

Den angivne kombination af CVR- og P-nummer findes ikke

4909

Det angivne cpr nummer er ikke identisk med cpr nummer på henvisningen

Det angivne cpr nummer er ikke identisk med cpr nummer på henvisningen

4938

Det er ikke muligt at opdatere en afsluttet henvisning

Det er ikke muligt at opdatere en afsluttet henvisning

4952

Den angivne henvisning er ukendt

Den angivne henvisning er ukendt

60005

Slutdato må ikke være før startdato

Slutdato må ikke være før startdato

60006

Unknown cpr

Unknown cpr

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

response

GetHenvisningResponseDto

1

-    henvisninger

HenvisningDtoCollection

1

Henvisninger

-    -    HenvisningDto

HenvisningDto

0 - *

-    -    -    henvisningsId

uuid

1

Unik identifikation af anden aktør henvisning

-    -    -    eksternSystemAftaleId

uuid

0 - 1

Id på delaftale i det ekstern system

-    -    -    cvrEnhedsid

string

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

1

Anden aktørs CVR-nummer.

-    -    -    pNummer

string

Pattern: [0-9]{10}
MinLength: 1

1

P-nr på anden aktør

-    -    -    startDato

date

1

Dato for anden aktør henvisningens start.

-    -    -    slutDato

date

1

Dato for anden aktør henvisningens afslutning.

-    -    -    dfdgRegisteringstidspunkt

date-time

1

Dato for anden aktør henvisningens start.

-    -    -    erAnnulleret

boolean

1

Om Anden Aktør henvisning er annulleret eller ej

-    -    -    kommentar

string

0 - 1

Kommentar

-    -    -    sagsbehandler

SagsbehandlerDto

1

-    -    -    -    brugerFuldtNavn

string

Length: 1-140

0 - 1

Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her.

-    -    -    -    brugerId

string

Length: 1-64

1

Sagsbehandlerens RID fra medarbejder OCES certifikatet eller andet entydigt id

-    -    -    registrerendeMyndighed

RegistrerendeMyndighedDtoBase

1

-    -    -    -    organisationType

OrganisationTypeCodeList

1

-    -    -    -    organisationskode

string

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

1

Identifikation af organisation / myndighed

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

response

GetHenvisningHistorikResponseDto

1

-    henvisningHistorik

HenvisningHistorikDtoCollection

1

Henvisningshistorik

-    -    HenvisningHistorikDto

HenvisningHistorikDto

0 - *

-    -    -    henvisningsId

uuid

1

Unik identifikation af anden aktør henvisning

-    -    -    eksternSystemAftaleId

uuid

0 - 1

Id på delaftale i det ekstern system

-    -    -    cvrEnhedsid

string

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

1

Anden aktørs CVR-nummer.

-    -    -    pNummer

string

Pattern: [0-9]{10}
MinLength: 1

1

P-nr på anden aktør

-    -    -    startDato

date

1

Dato for anden aktør henvisningens start.

-    -    -    slutDato

date

1

Dato for anden aktør henvisningens afslutning.

-    -    -    dfdgRegisteringstidspunkt

date-time

1

Dato for anden aktør henvisningens start.

-    -    -    erAnnulleret

boolean

1

Om Anden Aktør henvisning er annulleret eller ej

-    -    -    berigtigelseskommentar

string

0 - 1

Berigtigelseskommentar

-    -    -    registreringsmetadata

RegistreringsmetadataDto

1

-    -    -    -    erSlettet

boolean

1

Angiver om registreringen er en sletning

-    -    -    -    erAktuel

boolean

1

Det er en række som er aktuel (kan typisk også ses i PSS).

-    -    -    -    registrerendeMyndighed

RegistrerendeMyndighedDto

0 - 1

-    -    -    -    -    organisationType

OrganisationTypeCodeList

1

-    -    -    -    -    organisationskode

string

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

1

Identifikation af organisation / myndighed

-    -    -    -    -    registrerendeBruger

RegistrerendeBrugerDto

0 - 1

-    -    -    -    -    -    kaldendeBruger

KaldendeBrugerDto

1

-    -    -    -    -    -    -    brugerFuldtNavn

string

Length: 1-140

1

Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her.

-    -    -    -    -    -    -    brugerType

RequestUserTypeCodeList

1

-    -    -    -    -    -    -    brugerId

string

Length: 1-255

1

Unik identifikation af brugeren, f.eks. en GUID, et medarbejder ID, system ID, bruger ID, certifikat ID, cpr-nummer, email (hvis den er unik) o.l.

-    -    -    -    -    -    -    brugerEmail

email

0 - 1

Brugers e-mail.

-    -    -    -    -    -    brugerOrganisation

BrugerOrganisationDto

1

-    -    -    -    -    -    -    organisationType

OrganisationTypeCodeList

1

-    -    -    -    -    -    -    organisationskode

string

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

1

Organisationskode for den registrerende bruger.

-    -    -    -    -    -    dfdgRegistreringstidspunkt

date-time

1

Tidspunkt for registrering i DFDG

JobCenter

STAR

jobcenterkode [Query]

int32

0 - 1

response

GetHenvisningerResponseDto

1

-    andenAktoererDto

AndenAktoerDtoCollection

1

Liste over andre aktører.

-    -    AndenAktoerDto

AndenAktoerDto

0 - *

-    -    -    cvrEnhedsid

string

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

1

Anden aktørs CVR-nummer.

-    -    -    pNummer

string

Pattern: [0-9]{10}
MinLength: 1

1

Anden aktørs P-nummer.

-    -    -    jobcenterkode

int32

Pattern: [1-9][0-9]{4}

1

Identifikation af det jobcenter hvor anden aktør er tilkyttet.

JobCenter

STAR

cvrEnhedsid [Query]

string

1

pNummer [Query]

string

0 - 1

response

GetJobcentreResponseDto

1

-    jobcentre

AndenAktoerJobcenterDtoCollection

1

Liste over jobcentre hvor en given anden aktør har aktive anden aktør henvisninger.

-    -    AndenAktoerJobcenterDto

AndenAktoerJobcenterDto

0 - *

-    -    -    jobcenterkode

int32

Pattern: [1-9][0-9]{4}

1

Identifikation af jobcenter.