Versions Compared

Version Old Version 6 New Version 7
Changes made by

Katrien Goossens

Peter Ebraert (Deactivated)

Saved on

Key

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

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.


ElementOpmerkingenVerplicht
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
messagesStatusRequestLijst van status requests van 1 en hetzelfde verzendkanaal: EBOX of PAPER of EMAILja

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
Belangrijke opmerking: 1 vraag moet steeds hetzelfde eboxType bevatten, je kan ze niet combineren in 1 en dezelfde vraagja

eboxIdValueString

ja

Voorbeeld

Code Block
languagexml
titleVoorbeeld
linenumberstrue
{
  "deliveryChannel": "EBOX",
  "eBoxMessagesmessages": [
    {
      "messageIdobjectType": "bb708728-5re3-oi3f-453c-00azs26838dsdTypedMessageIdEboxIdList",
      "eboxIdcontent": {[
        "eboxType": "ENTERPRISE", {
       "eboxIdValue": "0406798006"       }"messageId": "4e11bbaf-656c-410c-a520-8b43551a68de",
           },   "eboxId" : {
      "messageId"            "eboxType" : "aa704428-5dd3-003f-873c-19vnb6838aza",CITIZEN",
                  "eboxIdValue" : "92042816483"
                  }
            }
        ]
  }
}

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

paperMessages

ElementTypeWaardeOpmerkingVerplicht
itemsString

bericht id

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


Voorbeeld

Code Block
languagexml
titleVoorbeeld
linenumberstrue
{
  "deliveryChannel": "PAPER",
  "messages": {
      "paperMessagesobjectType": [ "MessageIdList",
      "content": "bb708728-5re3-oi3f-453c-00azs26838dsd"["1231213"]
  ]}
}

emailMessages


ElementTypeWaardeOpmerkingVerplicht
itemsString

bericht id

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


Voorbeeld

Code Block
languagexml
titleVoorbeeld
linenumberstrue
{
  "deliveryChannel": "EMAIL",
  "emailMessagesmessages": {
 [     "bb708728-5re3-oi3f-453c-00azs26838dsd"
  ]"objectType": "MessageIdList",
      "content": ["1231213"]
  }
}


Validaties op vraag


ElementOmschrijving van de validatieMogelijke 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

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

eboxTypeeboxType bevat niet steeds dezelfde waarde (CITIZEN of ENTERPRISE)

400 BAD REQUEST

Unexpected value


Op deze pagina

Table of Contents
maxLevel2

Binnen deze handleiding

Page Tree
root@parent