Versions Compared

Version Old Version 1 New Version Current
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 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.

EMAIL

Element

Type

Waarde

Opmerking

Verplicht

deliveryChannel

String

  • EBOX

  • PAPER


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

xmllinenumberstrue
Code Block
language
Expand
titleVoorbeeld
Code Block
language
xml
{
  "deliveryChannel": "EBOX",
  "
eBoxMessages
messages": {
      "objectType": "TypedMessageIdEboxIdList",
      "content": [
          {
              "messageId": "
bb708728
4e11bbaf-
5re3
656c-
oi3f
410c-
453c
a520-
00azs26838dsd
8b43551a68de",
              "eboxId" : {
                  "eboxType" : "
ENTERPRISE
CITIZEN",
                  "eboxIdValue" : "
0406798006
92042816483"
                  }
            }
        ]
  }
}

{
  "deliveryChannel": "EBOX",
  "messages": {
      "objectType": "TypedMessageIdEboxIdList",
      "content": [
          {
              "messageId": "
aa704428
4e11bbaf-
5dd3
656c-
003f
410c-
873c
a520-
19vnb6838aza
8b43551a68de",
              "eboxId" : {
                  "eboxType" : "ENTERPRISE",
                  "eboxIdValue" : "
0406798006
0402206045"
}
}
]
 }

paperMessages

ElementTypeWaardeOpmerkingVerplichtitemsString

bericht id(s)

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

paperMessages

Element

Type

Waarde

Opmerking

Verplicht

items

String


bericht id

(s)

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


Voorbeeld

code
Expand
languagexml
titleVoorbeeld
Code Block
linenumbers
language
true
xml
{
  "deliveryChannel": "
EMAIL
PAPER",
  "
emailMessages
messages": {
[
"02708728-5fe3-443f-933c-19c626838c40
"objectType": "MessageIdList",
"aa704428-5dd3-003f-873c-19vnb6838aza", "bb708728-5re3-oi3f-453c-00azs26838dsd" ]
  "content": ["1231213"]
  }
}

Validaties op vraag

Code

Omschrijving

Element-Naam

Code

Omschrijving

Element

Omschrijving van de validatie

Mogelijke Foutcodes

Opmerkingen

Voorbeeld

Code Block
languagexml
titleVoorbeeld
linenumberstrue

Codetabellen Vraag

Element-Naam

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

eboxType

eboxType bevat niet steeds dezelfde waarde (CITIZEN of ENTERPRISE)

400 BAD REQUEST

Unexpected value

Op deze pagina

Table of Contents
maxLevel2
minLevel1

Binnen deze handleiding

Page Treeroot@parent

Child pages (Children Display)
pagePOST statusRequest - v1
Info

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