/
Beschrijving Vraag POST statusRequest
Document toolboxDocument toolbox


DIGITAAL VLAANDEREN

Beschrijving Vraag POST statusRequest

Owned by Katrien Goossens
Last updated: 23 Dec, 2022
2 min read

Algemeen

De POST statusRequest laat een verzender toe om de status van verzonden berichten op te vragen. Het is niet mogelijk om in 1 en dezelfde vraag de status op te vragen van verzendingen die niet via het zelfde kanaal (EBOX, PAPER, EMAIL) zijn gebeurd. Per kanaal is er een aparte vraag nodig.

Element

Opmerkingen

Verplicht

x-correlation-id

Maakt deel uit van de header. Zie ook: Werking en overzicht uitzonderingen MAGDA RESTful services.

Dit is het transactie ID, gebruikt voor logging en foutafhandeling

ja

messagesStatusRequest

Lijst van status requests van 1 en hetzelfde verzendkanaal: EBOX of PAPER of EMAIL

ja

messagesStatusRequest

Dit betreft een lijst van status requests van 1 en hetzelfde verzendkanaal: EBOX of PAPER of EMAIL.

Naast het verzendkanaal moeten verplicht de berichten meegegeven worden waarvoor de opvraging gebeurt, afhankelijk van het kanaal.

Element

Type

Waarde

Opmerking

Verplicht

deliveryChannel

String

  • EBOX

  • PAPER

Verzendkanaal van de berichten. 

ja

messages

Array



Zie: 

  • eBoxMessages

  • paperMessages

ja

eBoxMessages

Element

Type

Waarde

Opmerking

Verplicht

messageId

String



Id van het bericht

nee

eboxId











eboxType

String

  • ENTERPRISE

  • CITIZEN

Belangrijke opmerking: 1 vraag moet steeds hetzelfde eboxType bevatten, je kan ze niet combineren in 1 en dezelfde vraag. Maximum aantal IDs dat kan worden meegegeven is 500.

ja



eboxIdValue

String





ja

Voorbeeld

{ "deliveryChannel": "EBOX", "messages": { "objectType": "TypedMessageIdEboxIdList", "content": [ { "messageId": "4e11bbaf-656c-410c-a520-8b43551a68de", "eboxId" : { "eboxType" : "CITIZEN", "eboxIdValue" : "92042816483" } } ] } } { "deliveryChannel": "EBOX", "messages": { "objectType": "TypedMessageIdEboxIdList", "content": [ { "messageId": "4e11bbaf-656c-410c-a520-8b43551a68de", "eboxId" : { "eboxType" : "ENTERPRISE", "eboxIdValue" : "0402206045" } } ] } }

paperMessages

Element

Type

Waarde

Opmerking

Verplicht

items

String



bericht id

Belangrijke opmerking: je mag (voorlopig) slechts 1 ID meegeven in de vraag



Voorbeeld