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
EMAIL

Verzendkanaal van de berichten.

ja

messages

Array

Zie:

eBoxMessages
paperMessages
emailMessages

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

{
  "deliveryChannel": "PAPER",
  "messages": {
      "objectType": "MessageIdList",
      "content": ["1231213"]
  }
}

emailMessages

Element

Type

Waarde

Opmerking

Verplicht

items

String

bericht id

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

Voorbeeld

{
  "deliveryChannel": "EMAIL",
  "messages": {
      "objectType": "MessageIdList",
      "content": ["1231213"]
  }
}

Validaties op vraag

Element	Omschrijving van de validatie	Mogelijke Foutcodes
deliveryChannel	deliveryChannel = 'EBOX' en er zit geen eboxMessages blok in de payload	400 BAD REQUEST The data block eBoxMessages is required when deliveryChannel is EBOX
deliveryChannel	deliveryChannel = 'EMAIL' en er zit geen emailMessages blok in de payload	400 BAD REQUEST The data block emailMessages is required when deliveryChannel is EMAIL"
deliveryChannel	deliveryChannel = 'PAPER' en er zit geen paperMessages blok in de payload	400 BAD REQUEST The data block paperMessages is required when deliveryChannel is PAPER
deliveryChannel	deliveryChannel = 'PAPER' en de item list paperMessages bevat niet exact 1 message ID	400 BAD REQUEST For messages with deliveryChannel PAPER, only 1 message can be consulted at a time
deliveryChannel	deliveryChannel = 'EMAIL' en de item list emailMessages bevat niet exact 1 message ID	400 BAD REQUEST For messages with deliveryChannel EMAIL, only 1 message can be consulted at a time
eboxType	eboxType bevat niet steeds dezelfde waarde (CITIZEN of ENTERPRISE)	400 BAD REQUEST Unexpected value

Op deze pagina

Binnen deze handleiding

Unable to render {children}. Page not found: POST messages/statusRequest - v1.

Met vragen kunt u steeds terecht bij de MAGDA Service Desk.

Beschrijving Vraag POST statusRequest

Algemeen

messagesStatusRequest

eBoxMessages

Voorbeeld

paperMessages

Voorbeeld

emailMessages

Voorbeeld

Validaties op vraag

De MAGDA Gebruikersomgeving is een officiële website van de Vlaamse overheid