Versions Compared

Version Old Version 1 New Version 2
Changes made by

Katrien Goossens

Katrien Goossens

Saved on

Key

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

Algemeen

De GET statuses 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.

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
deliveryChannelString
  • EBOX
  • PAPER
  • EMAIL
Verzendkanaal van de berichten. ja
messagesArray

Zie: 

  • eBoxMessages
  • paperMessages
  • emailMessages
ja

eBoxMessages

ElementTypeWaardeOpmerkingVerplicht
messageIdString

Id van het bericht

nee
eboxId




eboxTypeString
  • ENTERPRISE
  • CITIZEN

ja

eboxIdValueString

ja

Voorbeeld

Code Block
languagexml
titleVoorbeeld
linenumberstrue
{
  "deliveryChannel": "EBOX",
  "eBoxMessages": [
    {
      "messageId": "bb708728-5re3-oi3f-453c-00azs26838dsd",
      "eboxId": {
        "eboxType": "ENTERPRISE",
        "eboxIdValue": "0406798006"
      }
    },
    {
      "messageId": "aa704428-5dd3-003f-873c-19vnb6838aza",
      "eboxId": {
        "eboxType": "ENTERPRISE",
        "eboxIdValue": "0406798006"
      }
    }
  ]
}

paperMessages

ElementTypeWaardeOpmerkingVerplicht
itemsString

bericht id

(s)

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


Voorbeeld

Code Block
languagexml
titleVoorbeeld
linenumberstrue
{
  "deliveryChannel": "PAPER",
  "paperMessages": [
    "02708728-5fe3-443f-933c-19c626838c40",
    "aa704428-5dd3-003f-873c-19vnb6838aza",
    "bb708728-5re3-oi3f-453c-00azs26838dsd"
  ]
}

emailMessages


ElementTypeWaardeOpmerkingVerplicht
itemsString

bericht id

(s)

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


Voorbeeld

Code Block
languagexml
titleVoorbeeld
linenumberstrue
{
  "deliveryChannel": "EMAIL",
  "emailMessages": [
"02708728-5fe3-443f-933c-19c626838c40", "aa704428-5dd3-003f-873c-19vnb6838aza",

    "bb708728-5re3-oi3f-453c-00azs26838dsd"
  ]
}


Validaties op vraag


Element-Naam

Code

Omschrijving
ElementOmschrijving van de validatieMogelijke Foutcodes

Opmerkingen

Voorbeeld

Code Block
languagexml
titleVoorbeeld
linenumberstrue

Codetabellen Vraag

Element-Naam

Code

Omschrijving

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

deliveryChanneldeliveryChannel = '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


Op deze pagina

Table of Contents
maxLevel2

Binnen deze handleiding

Page Tree
root@parent