Metoder
| Table of Contents | ||
|---|---|---|
|
...
CreateTilkendegivelse (POST /v1/
...
Tilkendegivelse)
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
borgerkommunikation.tilkendegivelse.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 | CreateHenvisningRequestDtoCreateTilkendegivelseRequestDto | 1 | ||
- tilkendegivelsestypetilkendegivelseIdentifier | stringuuid | Length: 0-100-1 | Unik identifier for tilkendegivelsen. Hvis den ikke er angivet, tildeles den af DFDG. | |
- tilkendegivelsestype | 1 | Angivelse af hvilken tilkendegivelse borger har givet, fx samtykke eller kvitteringslæsning borger har angivet.læsningskvittering | ||
- startDato starttidspunkt | date time | 1 | Dato Tidspunkt for tilkendegivelsens start.tilkendegivelsen | |
- slutDato sluttidspunkt | date time | 0-1 | Dato Tidspunkt for tilkendegivelsens afslutning. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | uuid | 1 |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse | 4950En henvisning er allerede oprettet med den angivne identifier | En henvisning er allerede oprettet med den angivne identifier | |
|---|---|---|---|---|---|
4353 | Kombinationen af CVR-nummer og P-nummer eksisterer ikke | Kombinationen af CVR-nummer og P-nummer eksisterer 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 |
...
GetTilkendegivelse (GET /v1/
...
Tilkendegivelse)
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.andenaktoertilkendegivelse.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 |
...
starttidspunkt |
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
Length: 0-8
1
Anden aktørs CVR-nummer.
- - - pNummer
string
Length: 0-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}
MinLength: 1
1
Identifikation af organisation / myndighed
Fejlkoder
Ingen fejlkoder
GetAndenAktoerHistorik (GET /v1/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 |
date time | 0-1 | Tidspunkt for første tilkendegivelse der ønskes udtrukket | ||
sluttidspunkt | date time | 0-1 | Tidspunkt for sidste tilkendegivelse der ønskes udtrukket |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response |
GetTilkendegivelseResponseDto | 1 | ||
- |
tilkendegivelser |
TilkendegivelserDtoCollection | 1 |
Tilkendegivelser |
- - |
tilkendegivelseDto |
HenvisningDto | 0 - * | ||
- - - |
tilkendegivelseId | uuid | 1 | Unik identifikation af |
tilkendegivelse |
- - |
- |
uuid
0 - 1
tilkendegivelsestype | 1 | Angivelse af hvilken tilkendegivelse borger har givet, fx samtykke eller læsningskvittering | ||
- - |
string
Length: 0-8
1
Anden aktørs CVR-nummer.
- - - pNummer
string
Length: 0-10
1
P-nr på anden aktør
- - - startDato
date
1
- starttidspunkt | date time | 1 | Tidspunkt for tilkendegivelsen | |
- - - |
sluttidspunkt | date |
1
Dato for anden aktør henvisningens afslutning.
- - - dfdgRegisteringstidspunkt
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}
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
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}
MinLength: 1
1
Organisationskode for den registrerende bruger.
- - - - - - dfdgRegistreringstidspunkt
date-time
1
0-1 | Tidspunkt for tilkendegivelsens afslutning. |
Fejlkoder
Ingen