Document toolboxDocument toolbox


DIGITAAL VLAANDEREN

Beschrijving Antwoord POST eboxPreferences/search

EboxInfoList

Request was succesvol: 200

Array met de antwoorden van de opgevraagde ebox ids.

Element

Type

Waarde

Opmerking

Verplicht

eboxId







ja



eboxType

String

  • ENTERPRISE

  • CITIZEN



ja



eboxIdValue

String



CITIZEN: INSZ nummer

ENTERPRISE: KBO nummer

ja

exclusivelyEbox


Boolean

  • true

  • false

Aanduiding of de ontvanger toestemming (consent) heeft gegeven voor ebox

ja

lastConnectionDate

Date-time

  • true

  • false

Datum waarop de ontvanger de ebox de laatste keer geraadpleegd heeft

Formaat: yyyy-MM-dd'T'HH:mm:ssXXX.

Belangrijke opmerking: enkel bij eBox onderneming

nee

totalNumberOfMessages

Integer



Totaal aantal berichten in de ebox

Belangrijke opmerking: enkel bij eBox onderneming

nee

totalNumberOfUnreadMessages

Integer



Totaal aantal ongelezen berichten

Belangrijke opmerking: enkel bij eBox onderneming

nee

Voorbeeld antwoord eBox burger

[ { "eboxId" : { "eboxType" : "CITIZEN", "eboxIdValue" : "92042816483" }, "exclusivelyEbox" : true }, { "eboxId" : { "eboxType" : "CITIZEN", "eboxIdValue" : "75120136503" }, "exclusivelyEbox" : true }, { "eboxId" : { "eboxType" : "CITIZEN", "eboxIdValue" : "84031815028" }, "exclusivelyEbox" : true }, { "eboxId" : { "eboxType" : "CITIZEN", "eboxIdValue" : "76121827193" }, "exclusivelyEbox" : true }, { "eboxId" : { "eboxType" : "CITIZEN", "eboxIdValue" : "ddd" }, "exclusivelyEbox" : false } ]

Voorbeeld antwoord eBox onderneming

[ { "eboxId" : { "eboxType" : "ENTERPRISE", "eboxIdValue" : "0406798006" }, "exclusivelyEbox": true, "lastConnectionDate": "2019-04-19T20:00:00Z", "totalNumberOfMessages": "999", "totalNumberOfUnreadMessages": "3" }, { "eboxId" : { "eboxType" : "ENTERPRISE", "eboxIdValue" : "47071447049" }, "exclusivelyEbox": true, "lastConnectionDate": "2020-01-19T20:00:00Z" }, { "eboxId" : { "eboxType" : "ENTERPRISE", "eboxIdValue" : "47040242545" }, "exclusivelyEbox": true }, { "eboxId" : { "eboxType" : "ENTERPRISE", "eboxIdValue" : "4745645745" }, "exclusivelyEbox": false } ]

ErrorMessage

Er is een fout opgetreden.

400 - Invalid data supplied

401 - Invalid authorization

404 - No mailbox 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

{ “title” : “Unauthorized”, “status” : “401", “detail” : “Invalid token” }

Op deze pagina


Binnen deze handleiding


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

 


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