Beschrijving Antwoord POST statusRequest
MessagesStatusOfSameDeliveryChannel
Request was succesvol: 200
Element | Type | Waarde | Opmerking | Verplicht |
---|---|---|---|---|
deliveryChannel | String |
| Verzendkanaal van de berichten. | ja |
messageStatuses | Array | Zie:
| ja |
EBoxMessagesStatusList
eBoxMessageStatuses: Array
Element | Type | Waarde | Opmerking | Verplicht | |
---|---|---|---|---|---|
| String |
|
| ja | |
messageId | String | Id van het bericht | ja | ||
eboxId | |||||
eboxType | String |
| ja | ||
eboxIdValue | String | CITIZEN: INSZ nummer ENTERPRISE: KBO nummer | |||
expirationDate | Date-time | Vervaldatum van bericht in eBox. Formaat: yyyy-MM-dd'T'HH:mm:ssXXX | nee | ||
readStatus | Boolean |
| Aanduiding of de hoofdinhoud (mainContent) geopend is door de ontvanger Standaard: false | ja | |
visible | Boolean |
| Aanduiding of het bericht zichtbaar is. Standaard: true Na de vervaldatum is het bericht niet langer zichtbaar, en zal de visible op false komen te staan. | nee |
Voorbeeld
PaperOrEmailMessageStatusList
Element | Type | Waarde | Opmerking | Verplicht | |
---|---|---|---|---|---|
| String |
|
| ja | |
messageId | String | Id van het bericht | ja | ||
shippingDate | Date-time | Bij PAPER: datum waarop onze print partner meldde dat het bericht afgeleverd werd bij bPost. Kan enkel gepopuleerd worden voor documenten in de SENT status Formaat: yyyy-MM-dd'T'HH:mm:ssXXX | nee | ||
mailid | Id van de bron. Enkel voor PAPER en indien status SENT | nee | |||
trackAndTraceUri | String | Wordt alleen voorzien als:
Enkel voor PAPER en indien status SENT en indien aangetekende zending | nee | ||
statuses | Array | ||||
id | String | Code van de status (200 - voor PROCESSING of SENT of PRINTED, 404 - voor NOT FOUND, 500 - voor ERROR of FAILED) | nee | ||
status | String |
| nee | ||
updated | Date-time | Wordt momenteel nog niet gebruikt | nee | ||
comment | String | Wordt momenteel nog niet gebruikt |
Voorbeeld PAPER
ErrorMessage
Er is een fout opgetreden.
400 - Invalid data supplied
401 - Invalid authorization
404 - Messages not found
500 - Unexpected Server Error
502 - Bad Gateway
503 - Service unavailable
504 - Gateway Timeout
Element | Omschrijving |
---|---|
type | Wordt niet gebruikt. |
title | Korte beschrijving van het probleem |
status | De HTTP status code van de bron |
detail | Detailbeschrijving van het probleem |
instance | Correlatie ID. Gelieve deze ID zeker te vermelden bij contact met de MAGDA helpdesk. |
Voorbeeld
Voor vragen of opmerkingen kan u de MAGDA helpdesk contacteren
De MAGDA Gebruikersomgeving is een officiële website van de Vlaamse overheid
uitgegeven door Digitaal Vlaanderen