Document toolboxDocument toolbox


DIGITAAL VLAANDEREN

Beschrijving Antwoord POST statusRequest

Owned by Katrien Goossens
Last updated: 23 Jun, 2023 by Peter Ebraert (Deactivated)
3 min read

MessagesStatusOfSameDeliveryChannel

Request was succesvol: 200

Element

Type

Waarde

Opmerking

Verplicht

deliveryChannel

String

  • EBOX

  • PAPER

Verzendkanaal van de berichten. 

ja

messageStatuses

Array



Zie: 

  • EBoxMessagesStatusList

  • PaperOrEmailMessageStatusList

ja

EBoxMessagesStatusList

eBoxMessageStatuses: Array

Element

Type

Waarde

Opmerking

Verplicht

objectType

String

EBoxMessageStatus

 

ja

messageId

String



Id van het bericht

ja

eboxId











eboxType

String

  • ENTERPRISE

  • CITIZEN



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

  • true

  • false

Aanduiding of de hoofdinhoud (mainContent) geopend is door de ontvanger

Standaard: false

ja

visible

Boolean

  • true

  • false

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

{ "deliveryChannel": "EBOX", "messageStatuses": [ { "objectType": "EBoxMessageStatus", "messageId": "4e11bbaf-656c-410c-a520-8b43551a68de", "eboxId": { "eboxType": "CITIZEN", "eboxIdValue": "92042816483" }, "expirationDate": "2020-09-26T10:09:06.089Z", "readStatus": false, "visible": true }, { "objectType": "EBoxMessageStatus", "messageId": "azdsdsds-1245-re87-g567-zf56as1268za", "eboxId": { "eboxType": "CITIZEN", "eboxIdValue": "92042816483" }, "expirationDate": "2020-09-26T10:09:06.089Z", "readStatus": false, "visible": true } ] }

PaperOrEmailMessageStatusList

Element

Type

Waarde

Opmerking

Verplicht

objectType

String

PaperOrEmailMessageStatus