SendStatusMessageList

Verzending was succesvol: 201 - Created

Array. Er wordt minstens 1 SendStatusMessage als antwoord gegeven.

Element	Omschrijving
messageId	De messageId die de Documentendienst toekende aan de zending van dit bericht.
expirationDate	Verzending EBOX: vervaldatum van het bericht in eBox. Verzending PAPER: vervaldatum verwijst naar de termijn dat de originele PDF bewaard wordt op de locatie waar de ontvanger de originele PDF kan downloaden. Formaat: yyyy-MM-dd'T'HH:mm:ssXXX
deliveryChannel	Kanaal van verzending. Mogelijke waarden: EBOX PAPER
code
message

Voorbeelden

EBOX verzending

[
  {
    "messageId": "0bd269d7-d91b-446a-8979-ba35bad45a9d",
    "expirationDate": "2020-04-02T15:25:30.243Z",
    "deliveryChannel": "EBOX"
  }
]

AUTOMATIC verzending waarbij er zowel verzonden is naar eBox als per papier

Bij AUTOMATIC, leveren we het bericht af in de EBOX van de ontvanger. Vervolgens kijken we na of de ontvanger toestemming heeft gegeven voor het gebruik van ebox. Indien niet, gaan we ook nog een PAPIEREN verzending doen via de klassieke post. In dit geval gebeuren er 2 verzendingen (ebox + papier) en krijg je dus per kanaal een messageId. Zo kan je nadien de status van elke zending opvolgen.

Indien de ontvanger wel een actieve consent heeft, volgt er geen papieren nazending meer, en krijg je slechts 1 messageId terug: Die van de EBOX aflevering.

Voor ondernemingen gaat MAGDA er van uit dat EBOX consents niet ingetrokken kunnen worden. Voor zendingen naar ondernemingen, wordt er eerst nagekeken in de MAGDA databank of er in het verleden reeds een consent gevonden was voor de bestemmeling. Zoja, wordt er geen consent bevraging meer gedaan naar de bron voor die zending.

In de unhappy paths (bvb EBOX aflevering lukt niet), kan het zijn dat we u toch een 201 kunnen terug geven met slechts 1 message ID in. In zulke gevallen geven we ook een HTTP header X-Magda-Exception mee waarin we uitleg verstrekken over wat er fout ging.

We geven u 1 messageIdEbox terug => Bericht werd ENKEL afgeleverd op ebox (= happy flow)
We geven u zowel een messageIdPaper als een messageIDEbox terug => Bericht werd afgeleverd op zowel ebox als papier (er zit ook een HTTP header bij die vermeldt dat de ontvanger geen actieve ebox consent heeft).
We geven u 1 messageIdPaper terug => Bericht werd ENKEL afgeleverd op papier (er zit ook een HTTP header bij die vermeldt waarom er geen ebox aflevering gebeurde)

Indien we er niet in slagen om een bericht af te leveren, krijg je van ons een andere response code.

[
  {
    "messageId": "0bd269d7-d91b-446a-8979-ba35bad45a9d",
    "expirationDate": "2020-04-02T15:25:30.243Z",
    "deliveryChannel": "EBOX"
  },
  {
    "messageId": "a3ed22d8-95b9-45c2-be29-3072f4a354cc",
    "expirationDate": "2020-04-02T15:25:30.243Z",
    "deliveryChannel": "PAPER"
  }
]

PAPER verzending

[
  {
    "messageId": "a3ed22d8-95b9-45c2-be29-3072f4a354cc",
    "expirationDate": "2020-04-02T15:25:30.243Z",
    "deliveryChannel": "PAPER"
  }
]

ErrorMessage

Er is een fout opgetreden.

400 - Invalid data supplied

401 - Invalid authorization

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.

Voorbeelden

Op deze pagina

1 SendStatusMessageList
- 1.1 Voorbeelden
2 ErrorMessage
- 2.1 Voorbeelden

Binnen deze handleiding

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

MAGDA Gebruikersomgeving

Beschrijving Antwoord POST messages

SendStatusMessageList

Voorbeelden

EBOX verzending

AUTOMATIC verzending waarbij er zowel verzonden is naar eBox als per papier

PAPER verzending

ErrorMessage

Voorbeelden

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