Document toolboxDocument toolbox


DIGITAAL VLAANDEREN

Beschrijving vraag POST messages

Owned by Katrien Goossens
Last updated: 23 Apr, 2024 by Kurt Janssen
12 min read

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

  • EBOX

  • PAPER

  • AUTOMATIC

  • PAPER_AND_EBOX

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

  • ENTERPRISE

Citizen: eBox burgers
Enterprise: eBox onderneming





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.