Kontaktforloeb.IndkaldelseService (Version 2, 2025-1)
Siden opdateres automatisk til at afspejle koden.
Metoder
- 1 CreateMyndighedsdeltager (POST /v2/Indkaldelse/myndighedsdeltager/{myndighedsdeltagerid})
- 2 UpdateMyndighedsdeltager (PUT /v2/Indkaldelse/myndighedsdeltager/{myndighedsdeltagerid})
- 3 DeleteMyndighedsdeltager (DELETE /v2/Indkaldelse/myndighedsdeltager/{myndighedsdeltagerid}/indkaldelse/{indkaldelseid})
- 4 CreateIndkaldelse (POST /v2/Indkaldelse)
- 5 GetIndkaldelser (GET /v2/Indkaldelse)
- 6 CreateIndkaldelse (POST /v2/Indkaldelse/{indkaldelseId})
- 7 UpdateIndkaldelse (PUT /v2/Indkaldelse/{indkaldelseId})
- 8 DeleteIndkaldelse (DELETE /v2/Indkaldelse/{indkaldelseId})
- 9 GetIndkaldelse (GET /v2/Indkaldelse/{indkaldelseId})
- 10 GetIndkaldelseshistorik (GET /v2/Indkaldelse/historik/{indkaldelseId})
- 11 GetIndkaldelseshistorik (GET /v2/Indkaldelse/historik)
- 12 SaveDeltagelsesvalg (POST /v2/Indkaldelse/deltagelsesvalg)
- 13 GetDeltagelsesvalg (GET /v2/Indkaldelse/deltagelsesvalg)
- 14 GetSpecifiktDeltagelsesvalg (GET /v2/Indkaldelse/deltagelsesvalg/{deltagelsesvalgId})
- 15 GetDeltagelsesvalgshistorik (GET /v2/Indkaldelse/deltagelsesvalg/historik)
- 16 GetSpecifiktDeltagelsesvalgshistorik (GET /v2/Indkaldelse/deltagelsesvalg/historik/{deltagelsesvalgId})
- 17 GetSoegning (POST /v2/Indkaldelse/action/indkaldelseSoegning)
CreateMyndighedsdeltager (POST /v2/Indkaldelse/myndighedsdeltager/{myndighedsdeltagerid})
Creates a myndighedsdeltager for a specific indkaldelse.
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 |
|
|
|
|
|
|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
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 |
myndighedsdeltagerid [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. Requestid gemmes kun i 7 dage |
requestBody | CreateMyndighedsdeltagerRequestDto |
| 1 | DTO for oprettelse af myndighedsdeltager. |
- indkaldelseIdentifier | uuid |
| 1 | Id på den indkaldelse som myndighedsdeltageren skal deltage i |
- navn | string | Length: 1-256 | 0 - 1 | Fuldt navn på deltager |
- kontaktdetaljer | string | Length: 1-256 | 0 - 1 | Anden kontaktinformation |
- telefonnummer | string | Pattern: (\+)?[0-9]{3,20} | 0 - 1 | Telefonnummer på deltager |
| 0 - 1 | Emailadresse på deltager | ||
- eksterntId | string | Length: 1-256 | 0 - 1 | Eksternt id på deltager |
- deltagerrolle |
| 1 |
| |
- afbudsaarsag |
| 0 - 1 |
| |
- afbudsuddybning | string | Length: 1-1000 | 0 - 1 | Uddybning af den gæstende myndigheds afbud |
- myndighedsrepraesentantenDeltager | boolean |
| 0 - 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | uuid |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
90101 | Opdater eksisterende myndighedsdeltagere inden oprettelse af nye | Opdater eksisterende myndighedsdeltagere inden oprettelse af nye |
90102 | Det angivne IndkaldelseId findes ikke | Det angivne IndkaldelseId findes ikke |
90105 | Det angivne DeltagerId findes allerede i systemet | Det angivne DeltagerId findes allerede i systemet |
UpdateMyndighedsdeltager (PUT /v2/Indkaldelse/myndighedsdeltager/{myndighedsdeltagerid})
Updates a myndighedsdeltager for a specific indkaldelse.
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 |
|
|
|
|
|
|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
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 |
myndighedsdeltagerid [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. Requestid gemmes kun i 7 dage |
requestBody | UpdateMyndighedsdeltagerRequestDto |
| 1 | DTO for opdatering af myndighedsdeltager. |
- indkaldelseIdentifier | uuid |
| 1 | Id på den indkaldelse som myndighedsdeltageren skal deltage i |
- navn | string | Length: 1-256 | 0 - 1 | Fuldt navn på deltager |
- kontaktdetaljer | string | Length: 1-256 | 0 - 1 | Anden kontaktinformation |
- telefonnummer | string | Pattern: (\+)?[0-9]{3,20} | 0 - 1 | Telefonnummer på deltager |
| 0 - 1 | Emailadresse på deltager | ||
- eksterntId | string | Length: 1-256 | 0 - 1 | Eksternt id på deltager |
- deltagerrolle |
| 1 |
| |
- afbudsaarsag |
| 0 - 1 |
| |
- afbudsuddybning | string | Length: 1-1000 | 0 - 1 | Uddybning af den gæstende myndigheds afbud |
- myndighedsrepraesentantenDeltager | boolean |
| 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
90102 | Det angivne IndkaldelseId findes ikke | Det angivne IndkaldelseId findes ikke |
90103 | Det angivne DeltagerId hører til en anden indkaldelse end den angivne | Det angivne DeltagerId hører til en anden indkaldelse end den angivne |
90107 | Det angivne DeltagerId findes ikke | Det angivne DeltagerId findes ikke |
DeleteMyndighedsdeltager (DELETE /v2/Indkaldelse/myndighedsdeltager/{myndighedsdeltagerid}/indkaldelse/{indkaldelseid})
Deletes a myndighedsdeltager for a specific indkaldelse.
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 |
|
|
|
|
|
|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
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 |
myndighedsdeltagerid [Path] | uuid |
| 1 |
|
indkaldelseid [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. Requestid gemmes kun i 7 dage |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
90102 | Det angivne IndkaldelseId findes ikke | Det angivne IndkaldelseId findes ikke |
90103 | Det angivne DeltagerId hører til en anden indkaldelse end den angivne | Det angivne DeltagerId hører til en anden indkaldelse end den angivne |
90107 | Det angivne DeltagerId findes ikke | Det angivne DeltagerId findes ikke |
CreateIndkaldelse (POST /v2/Indkaldelse)
Creates an indkaldelse for a specific person.
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 |
|
|
|
|
|
|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
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. Requestid gemmes kun i 7 dage |
requestBody | CreateIndkaldelseRequestDto |
| 1 | DTO for oprettelse af indkaldelse |
- aflysningsfrist | date |
| 0 - 1 | Sluttidspunkt for borgers aflysningsmulighed. |
- moedeStarttidspunkt | date-time |