Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Metoder

Table of Contents
maxLevel2

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

- tilkendegivelseIdentifier

uuid

0-1

Unik identifier for tilkendegivelsen. Hvis den ikke er angivet, tildeles den af DFDG.

-    tilkendegivelsestype

/wiki/spaces/ISB/pages/4186734634

1

Angivelse af hvilken tilkendegivelse borger har givet, fx samtykke eller kvitteringslæsning borger har angivet.læsningskvittering

-    startTidspunkt    starttidspunkt

date time

1

Dato Tidspunkt for tilkendegivelsens start.tilkendegivelsen

-    slutTidspunkt    sluttidspunkt

date time

0-1

Dato Tidspunkt for tilkendegivelsens afslutning.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

response

uuid

1

Fejlkoder

4950

Fejlkode

Fejltekst

Beskrivelse

En 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

STAR

X

Scope

borgerkommunikation.tilkendegivelse.borger.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetTilkendegivelserResponseDto

1

-    tilkendegivelser

TilkendegivelserDtoCollection

1

Henvisninger

-    -    HenvisningDto

HenvisningDto

0 - *

-    -    -    tilkendegivelsesId

uuid

1

Unik identifikation af anden aktør henvisning

-    - -    tilkendegivelsestype

/wiki/spaces/ISB/pages/4186734634

1

Angivelse af hvilken samtykke eller kvitteringslæsning borger har angivet.

-    -   -  startTidspunkt

date time

1

Dato for tilkendegivelsens start.

-    -    - slutTidspunkt

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

starttidspunkt

date time

0-1

Tidspunkt for første tilkendegivelse der ønskes udtrukket

sluttidspunkt

date time

0-1

Dato for tilkendegivelsens afslutning.

Fejlkoder

Ingen fejlkoder

GetTilkendegivelsesHenvisninger (GET /v1/Tilkendegivelse/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

...

STAR

...

X

Scope

borgerkommunikation.tilkendegivelse.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

Tidspunkt for sidste tilkendegivelse der ønskes udtrukket

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetTilkendegivelserResponseDto

GetTilkendegivelseResponseDto

1

tilkendegivelser

-    tilkendegivelser

TilkendegivelserDtoCollection

1

Henvisninger

Tilkendegivelser

-    -

    HenvisningDto

    tilkendegivelseDto

HenvisningDto

0 - *

-    -

    tilkendegivelsesId

    -    tilkendegivelseId

uuid

1

Unik identifikation af

anden aktør henvisning

tilkendegivelse

-    - -    tilkendegivelsestype

/wiki/spaces/ISB/pages/4186734634

1

Angivelse af hvilken tilkendegivelse borger har givet, fx samtykke eller

kvitteringslæsning borger har angivet.

læsningskvittering

-    -   -

  startTidspunkt

  starttidspunkt

date time

1

Dato

Tidspunkt for

tilkendegivelsens start.

tilkendegivelsen

-    -

slutTidspunkt

    - sluttidspunkt

date time

0-1

Dato

Tidspunkt for tilkendegivelsens afslutning.

Fejlkoder

Ingen fejlkoder