Borgerkommunikation.AndenAktoerHenvisningService (Version 2, 2024-3)
Siden opdateres automatisk til at afspejle koden.
Metoder
- 1 CreateHenvisning (POST /v2/AndenAktoerHenvisning)
- 2 CreateHenvisningMedIdentifier (POST /v2/AndenAktoerHenvisning/{henvisningsId})
- 3 UpdateHenvisning (PUT /v2/AndenAktoerHenvisning/{henvisningsId})
- 4 AfslutHenvisning (PUT /v2/AndenAktoerHenvisning/{henvisningsId}/action/afslut)
- 5 SkiftAndenAktoer (PUT /v2/AndenAktoerHenvisning/action/skiftAndenAktoer)
- 6 GetAndenAktoerHenvisninger (GET /v2/AndenAktoerHenvisning/henvisninger)
- 7 GetAndenAktoerHistorik (GET /v2/AndenAktoerHenvisning/historik)
- 8 GetHenvisningerForJobcenter (GET /v2/AndenAktoerHenvisning/andenAktoer)
- 9 GetJobcentre (GET /v2/AndenAktoerHenvisning/jobcentre)
CreateHenvisning (POST /v2/AndenAktoerHenvisning)
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
borgerkommunikation.andenaktoer.write
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 |
requestBody | CreateHenvisningRequestDto |
| 1 |
|
- eksternSystemAftaleId | uuid |
| 0 - 1 | Id på delaftale i det ekstern system |
- cvrEnhedsid | string | Pattern: [0-9]{8} | 1 | Anden aktørs CVR-nummer. |
- pNummer | string | Pattern: [0-9]{10} | 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. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | uuid |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
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 |
CreateHenvisningMedIdentifier (POST /v2/AndenAktoerHenvisning/{henvisningsId})
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
borgerkommunikation.andenaktoer.write
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 |
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} | 1 | Anden aktørs CVR-nummer. |
- pNummer | string | Pattern: [0-9]{10} | 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. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | uuid |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
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 |
UpdateHenvisning (PUT /v2/AndenAktoerHenvisning/{henvisningsId})
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
borgerkommunikation.andenaktoer.write
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 |
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 |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
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 |
AfslutHenvisning (PUT /v2/AndenAktoerHenvisning/{henvisningsId}/action/afslut)
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
borgerkommunikation.andenaktoer.write
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 |
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 |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
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 |
SkiftAndenAktoer (PUT /v2/AndenAktoerHenvisning/action/skiftAndenAktoer)
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
borgerkommunikation.andenaktoer.write
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 | 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 | 1 | CPR nummer på borger der er henvist til anden aktør |
- - - cvrEnhedsid | string | Pattern: [0-9]{8} | 1 | Anden aktørs CVR-nummer. |
- - - pNummer | string | Pattern: [0-9]{10} | 1 | Anden aktørs P-nummer. |
- - - kommentar | string | Length: 0-1500 | 1 | Kommentar. |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
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 |
GetAndenAktoerHenvisninger (GET /v2/AndenAktoerHenvisning/henvisninger)
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 |
---|---|---|---|---|---|---|---|---|
A-kasse |
| X | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | X |
|
|
|
|
JobCenter |
| X |
| X | X | X |
|
|
Kommune |
| X |
| X |
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
borgerkommunikation.andenaktoer.borger.read
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 | 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} | 1 | Anden aktørs CVR-nummer. |
- - - pNummer | string | Pattern: [0-9]{10} | 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 |
| 1 |
| |
- - - - organisationskode | string | Pattern: [-][1]|[0-9]{1,8} | 1 | Identifikation af organisation / myndighed |
Fejlkoder
Ingen fejlkoder
GetAndenAktoerHistorik (GET /v2/AndenAktoerHenvisning/historik)
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 |
---|---|---|---|---|---|---|---|---|
A-kasse |
| X | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | X |
|
|
|
|
JobCenter |
| X |
| X | X | X |
|
|
Kommune |
| X |
| X |
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
borgerkommunikation.andenaktoer.borger.read
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 | 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} | 1 | Anden aktørs CVR-nummer. |
- - - pNummer | string | Pattern: [0-9]{10} | 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 |
| 1 |
| |
- - - - - organisationskode | string | Pattern: [-][1]|[0-9]{1,8} | 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 |
| 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 |
| 0 - 1 | Brugers e-mail. | |
- - - - - - brugerOrganisation | BrugerOrganisationDto |
| 1 |
|
- - - - - - - organisationType |
| 1 |
| |
- - - - - - - organisationskode | string | Pattern: [-][1]|[0-9]{1,8} | 1 | Organisationskode for den registrerende bruger. |
- - - - - - dfdgRegistreringstidspunkt | date-time |
| 1 | Tidspunkt for registrering i DFDG |
Fejlkoder
Ingen fejlkoder
GetHenvisningerForJobcenter (GET /v2/AndenAktoerHenvisning/andenAktoer)
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
borgerkommunikation.andenaktoer.myndighed.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
jobcenterkode [Query] | int32 |
| 0 - 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetHenvisningerResponseDto |
| 1 |
|
- andenAktoererDto | AndenAktoerDtoCollection |
| 1 | Liste over andre aktører. |
- - AndenAktoerDto | AndenAktoerDto |
| 0 - * |
|
- - - cvrEnhedsid | string | Pattern: [0-9]{8} | 1 | Anden aktørs CVR-nummer. |
- - - pNummer | string | Pattern: [0-9]{10} | 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. |
Fejlkoder
Ingen fejlkoder
GetJobcentre (GET /v2/AndenAktoerHenvisning/jobcentre)
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
borgerkommunikation.andenaktoer.myndighed.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
cvrEnhedsid [Query] | string |
| 1 |
|
pNummer [Query] | string |
| 0 - 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
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. |
Fejlkoder
Ingen fejlkoder