Beschrijving vraag POST messages
Algemeen
Om documenten te verzenden (aangetekend of niet) via het door de verzender gekozen kanaal:
eBox
Papier
automatisch: deze waarde is standaard ingevuld, het bericht wordt altijd afgeleverd in de eBox. Indien de ontvanger geen toestemming heeft gegeven voor gebruik eBox, gebeurt er ook een verzending via papier. Opgelet: verzendingen naar de eBox die gebeurd zijn voordat de gebruiker toestemming heeft gegeven, zijn niet rechtsgeldig.
MessageToSend: opgeven van gewenste verzendmethode en optionele blokken voor verzending via eBox (eboxDeliveryData), papier (paperDeliveryData) of e-mail (emailDeliveryData).
upfile1, upfile2, upfile3, upfile4, upfile5, upfile6, upfile…: op te laden documenten.
EBOX afleveringen: Maximum 6 documenten per zending, enkel PDF mogelijk. De bestanden samen mogen maximum 7MB groot zijn.
PAPER afleveringen: Maximum 20 documenten per zending, enkel PDF mogelijk. De bestanden samen mogen maximum 30MB groot zijn
Belangrijke opmerkingen:
Op dit moment is enkel A4 mogelijk voor verzending via papier, andere formaten worden voorlopig niet ondersteund.
Gelieve (voorlopig) geen speciale tekens te gebruiken in de naamgeving van de bestanden. Indien er speciale tekens worden gebruikt, dan kan dit een fout geven. Naamgevingen met volgende elementen, geven geen problemen: a-z, letters, - of _, spatie
Element | Opmerkingen | Verplicht |
---|---|---|
x-correlation-id | HTTP header. Zie ook: Werking en overzicht uitzonderingen MAGDA RESTful services. Dit is het unieke transactie ID, gebruikt voor logging en foutafhandeling. | ja |
idempotency-key | HTTP header. Zie ook: Werking en overzicht uitzonderingen MAGDA RESTful services. Belangrijke opmerking: Deze key heeft als doel om, indien u beslist eenzelfde bericht te HERverzenden, ervoor te zorgen dat hetzelfde bericht niet meerdere keren ter beschikking gesteld wordt aan de ontvanger. De x-correlation-id is het unieke id per verzending. De idempotency-key dient echter gelijk gehouden te worden bij een herverzending van een zelfde bericht. Op die manier is het voor de documentendienst duidelijk dat het om een herverzending gaat. | nee |
messageToSend | JSON-beschrijving van messageToSend | ja |
upfile1 | Document. | nee |
upfile2 | Document. | nee |
upfile3 | Document. | nee |
upfile4 | Document. | nee |
upfile5 | Document. | nee |
upfile6 | Document. | nee |
… |
|
|
MessageToSend
Gewenste verzendmethode en optionele blokken voor verzending via eBox (eboxDeliveryData), papier (paperDeliveryData) of e-mail (emailDeliveryData).
Element | Type | Waarde | Opmerking | Verplicht |
---|---|---|---|---|
delivery | String |
| Standaard: AUTOMATIC = het bericht wordt altijd afgeleverd in de eBox. Indien de ontvanger geen toestemming heeft gegeven voor gebruik eBox, gebeurt er ook een verzending via papier. Opgelet: AUTOMATIC of PAPER_AND_EBOX delivery is enkel mogelijk wanneer u als verzender zowel aangesloten bent voor de PAPER als voor EBOX flow. | ja |
eboxDeliveryData | Zie: eboxDeliveryData: MessageToPublish | nee | ||
paperDeliveryData | Zie: paperDeliveryData: paperDeliveryData | nee | ||
businessDataList | Array | Zie: BusinessDataToPublish | nee |
eboxDeliveryData: MessageToPublish
Element | Type | Waarde | Opmerking | Verplicht | |
---|---|---|---|---|---|
recipient | ja | ||||
eboxType | String |
| Citizen: eBox burgers | ||
eboxIdValue | String | INSZ nummer indien eboxType = "CITIZEN" KBO nummer indien eboxType = "ENTERPRISE" | |||
forTheAttentionOf | Belangrijke opmerking: enkel voor ebox onderneming Indien bestemd voor een specifiek persoon binnen de onderneming | nee | |||
id | String | Mogelijkheid om INSZnr mee te geven. Indien er ingelogd wordt met dat specifieke INSZnr ziet de persoon in kwestie dat er bericht is gericht aan zijn/haar INSZnr. | |||
type | String | Belangrijke opmerking: enkel voor ebox onderneming Hier moet "person" ingevuld worden indien er bij id een INSZnr wordt meegegeven. Indien de persoon met dat specifieke INSZnr zich aanmeldt, zal die persoon zien dat er een bericht specifiek voor hem/haar is. | |||
name | String | Indien er geen INSZ nr wordt meegegeven, kan hier een naam worden ingevuld. Indien de persoon met die naam zich aanmeldt, zal die persoon niet zien dat er een bericht specifiek voor hem/haar is, maar wordt wel de naam weergegeven van de persoon voor wie het bedoeld is. | |||
originalMessageId | String | Originele ID voor bidirectioneel gebruik. | nee | ||
subject |
|
| Het onderwerp per ondersteunde taal. | ja | |
nl | Max 320 characters | ||||
fr | Max 320 characters | ||||
de | Max 320 characters | ||||
messageTypeId | String | Identificatie van bericht type. Voor ebox Burger is er slechts 1 bericht type: Persoonlijk geadresseerde brief met een standaard geldigheid van 3 jaar. Dit zal automatisch ingevuld worden door MAGDA. Voor ebox Onderneming zijn er 2 bericht types, 1 met een geldigheid van 6 maanden en 1 met een geldigheid van 2 jaar. Dit zal automatisch ingevuld worden door MAGDA op basis van de informatie verkregen tijdens het aansluitingsproces. Indien de afnemer dit zelf wenst in te vullen, is dit ook mogelijk. De geldigheid kan overschreven worden op basis van de datum die wordt meegeven bij expirationDate. Dit id kan automatisch ingevuld worden door MAGDA op basis van de verkregen informatie na succesvol onboarden | nee | ||
expirationDate | Date-time | Formaat: yyyy-MM-dd'T'HH:mm:ssXXX. EBOX: Vervaldatum van het bericht in de eBox. Indien PaperDeliveryData.documentAvailableUntilDate ook aangeboden wordt, wordt het maximum van deze beide datums genomen als vervaldatum van het bericht in de eBox | nee | ||
senderOrganizationId | String | KBOnummer van de verzendende organisatie | Formaat: [0-1][0-9]{9} Dit id wordt verkregen tijdens het onboarding proces en zal automatisch worden ingevuld door MAGDA op basis van de verkregen informatie na succesvol onboarden | nee | |
senderApplicationId | String | Dit id wordt verkregen tijdens het onboarding proces en en zal automatisch worden ingevuld door MAGDA op basis van de verkregen informatie na succesvol onboarden | nee | ||
registeredMail | Boolean |
| Indicatie of het over een aangetekende zending gaat. Standaard: false | nee | |
attachments | Array | Zie: AttachmentToPublish | nee | ||
bodyMainContent | Boolean |
| Als de waarde = "true": dan wordt de bodyContent beschouwd als de hoofdinhoud. In dat geval wordt bodyContent dan ook verplicht. Als de waarde = "false": dan wordt de bodyContent niet beschouwd als de hoofdinhoud maar als een annex. In dat geval is bodyContent niet verplicht. Belangrijke opmerking: een bericht wordt als "gelezen" aanzien van zodra de MainContent is geraadpleegd. Standaard: false | ja | |
bodyContent | nee | ||||
nl | String | ||||
fr | String | ||||
de | String | ||||
businessDataList | Array | Zie: BusinessDataToPublish | nee | ||
paymentData | Object | Zie: paymentData | nee | ||
replyAuthorized | Boolean |
| Aanduiding of er antwoord mag gestuurd worden. Standaard: false | ja |
paperDeliveryData: paperDeliveryData
Element | Type | Waarde | Opmerking | Verplicht | |
---|---|---|---|---|---|
registeredMail | Boolean |
| Indicatie of het over een aangetekende zending gaat. Belangrijke opmerking: Indien registeredMail = "true" dan is retourAddress verplicht Standaard: false | nee | |
acknowledgmentOfReceipt | Boolean |
| Aanduiding of de ontvanger een document moet tekenen om ontvangst te bevestigen. Dit document wordt vervolgens gestuurd naar het retourAddress. Belangrijke opmerking: Indien acknowledgmentOfReceipt = "true" dan is retourAddress verplicht Standaard: false | nee | |
side | String |
| Aanduiding recto verso. Standaard: RV
| nee | |
offset | integer |
| Duidt aan op welke pagina de print van de PDF moet starten. keycommunicatedViaChannel = NO_DOWNLOAD_KEY
keycommunicatedViaChannel = SAME_PAGE
keycommunicatedViaChannel = SEPARATE_PAGE
keycommunicatedViaChannel = SEPARATE_LETTER
Andere combinaties worden niet toegelaten en leiden tot een Bad request | nee | |
documentType | String | Type van het document. Bijvoorbeeld "factuur", "informatieve brief",... Dit veld kan door de verzender gebruikt worden indien hij graag voor eigen rapportering/overzichten een opsplitsing maakt tussen verschillende types documenten. | nee | ||
priority | String |
| Aanduiding binnen hoeveel dagen de verzending moet afgeleverd worden: 1 dag, of 3 dagen. Belangrijke opmerking: verzendingen die na 18u verstuurd worden, worden pas de dag erna verwerkt. Standaard: dlp3 | nee | |
documentAvailableUntilDate | Date | De ontvanger kan de originele digitale documenten downloaden via een QR code/link en een persoonlijke sleutel die hij eveneens per brief ontvangt. Deze datum verwijst naar de datum tot wanneer de ontvanger deze documenten kan downloaden. Maximum bewaartermijn is 3 jaar. Dit veld wordt op een datum van 3 maand in de toekomst gezet indien deze niet meegegeven wordt. Indien EBoxDeliveryData.expirationDate ook aangeboden wordt, wordt het maximum van deze beide datums genomen. Formaat: yyyy-MM-dd | nee | ||
keyCommunicatedViaChannel | string |
| Indicatie of de persoonlijke sleutel op een aparte pagina of via een aparte brief moet verstuurd worden. Indien de documenten klasse 3 of klasse 4 inhoud bevatten, moet de persoonlijke sleutel op een aparte pagina of via een aparte brief verstuurd worden. Standaard: SEPARATE_PAGE Belangrijke info: indien je geen download mogelijkheid wil voorzien, kies je voor NO_DOWNLOAD_KEY. De download mogelijk is voorzien in geval de ontvanger de originele digitale handtekening(en) wil kunnen controleren, dus vooral omwille van rechtsgeldigheid. Indien je als verzender deze optie niet nodig hebt, is het soms beter van te kiezen voor NO_DOWNLOAD_KEY aangezien de download mogelijks voor extra oproepen naar de helpdesk kan zorgen. | nee | |
address | Mogelijkheid om te kiezen voor aflevering naar:
Een geldige vraag bevat slechts 1 van de vermelde elementen. | nee | |||
title | String | nee | |||
firstName | String | 1 van deze 3 velden moet verplicht ingevuld zijn | |||
lastName | String | ||||
organisation | String | ||||
line1 | String | ja | |||
line2 | String | nee | |||
postalCode | String | ja | |||
city | String | ja | |||
region | String | nee | |||
country | String | ISO2 or ISO3 country code | ja | ||
retourAddress | ja indien aangetekend belangrijke opmerking: ook al zijn de zendingen niet aangetekend, wordt het toch aangeraden van een retour adress te voorzien, zodat verzender zelf de brieven terug krijgt indien er geen aflevering was | ||||
title | String | nee |
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