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
statuses		Array		Extra status details voor gelezen documenten	nee
	id	String	“200”		ja
	status	String	“Read”	“Read” indien document gelezen is (readStatus == True)	ja
	updated	Date-time		Moment waarop het document (voor het eerst) gelezen is Formaat: yyyy-MM-dd'T'HH:mm:ssXXX	ja
	comment	String		Wordt momenteel nog niet gebruikt

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": true,
            "visible": true,
            "statuses": [
                {
                    "id": "200",
                    "status": "Read",
                    "updated": "2020-08-26T10:09:06.089Z",
                    "comment": null
                }
            ],
        }
    ]
}

PaperOrEmailMessageStatusList

Element		Type	Waarde	Opmerking	Verplicht
`objectType`		String	`PaperOrEmailMessageStatus`		ja
messageId		String		Id van het bericht	ja
shippingDate		Date-time		Bij PAPER: datum waarop onze print partner meldde dat het bericht afgeleverd werd bij bPost. Kan enkel gepopuleerd worden voor documenten in de SENT status Formaat: yyyy-MM-dd'T'HH:mm:ssXXX	nee
mailid				Id van de bron. Enkel voor PAPER en indien status SENT	nee
trackAndTraceUri		String		Wordt alleen voorzien als: REGISTERED = TRUE we een mailid hebben de postcode van de ontvanger is ingevuld Enkel voor PAPER en indien status SENT en indien aangetekende zending	nee
statuses		Array
	id	String		Code van de status (200 - voor PROCESSING of SENT of PRINTED, 404 - voor NOT FOUND, 500 - voor ERROR of FAILED)	nee
	status	String		Not found: Wanneer we die ID niet (langer) terug vinden in ons systeem. Pending: Wanneer de documenten van het bericht nog niet doorgegeven werden aan drukker - het bericht is in afwachting van een mogelijke read van de ebox zending. Processing: De documenten van het bericht werden doorgegeven aan de drukker, maar zij werden nog niet behandeld door onze printing partner Printed: De documenten van het bericht werden geprint maar zijn nog niet verzonden. Sent: Het bericht (en haar documenten) werd verzonden door onze printing partner (eind status) Cancelled: Wanneer een uitgestelde papieren verzending nooit verzonden werd (omdat de ebox aflevering tijdig gelezen werd) Error: Wanneer er een niet-fatale fout gedetecteerd werd op het document (moet opgevolgd worden) Documenten in deze status worden pro-actief opgevolgd door het MAGDA team Uiteraard staat het u vrij om voor zulke documenten een incident in te schieten in de MAGDA service desk Een document kan nooit lang in de Error status blijven. OFWEL gaat die naar FAILED (dan werd die brief niet verzonden, dan wordt de betrokken verzender pro-actief geïnformeerd door het MAGDA team). OFWEL gaat die naar PRINTED en/of SENT, en wordt de brief alsnog mooi afgeleverd. Failed: Wanneer er een fatale fout gedetecteerd werd op het document (eind status)	nee
	updated	Date-time		Wordt momenteel nog niet gebruikt	nee
	comment	String		Wordt momenteel nog niet gebruikt

Voorbeeld PAPER

{
  "deliveryChannel": "PAPER",
  "messageStatuses": [
    {
      "objectType": "PaperOrEmailMessageStatus",
      "messageId": "5sd65464-sd4545-sdsd45-sdsdsd-sdsd45",
      "shippingDate": "2020-08-12T16:01:43.344Z",
      "mailId": "010541288500452621900095554841",
      "trackAndTraceUri": "https://track.bpost.cloud/btr/web/#/search?lang=en&itemCode=010541288500452621900095554841&postalCode=1700",
      "statuses": [
        {
          "id": "200",
          "status": "SENT"
        }
      ]
    }
}

ErrorMessage

Er is een fout opgetreden.

400 - Invalid data supplied

401 - Invalid authorization

404 - Messages not 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” : “Unexpected Server Error”,
    “detail” : “Failed to persist the file”
    “instance” : “b45754d6-e1a6-4c88-b089-c529825d9e6c”
}

Op deze pagina

1 MessagesStatusOfSameDeliveryChannel
- 1.1 EBoxMessagesStatusList
- 1.2 PaperOrEmailMessageStatusList
2 ErrorMessage

Binnen deze handleiding

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

MAGDA Gebruikersomgeving

Beschrijving Antwoord POST statusRequest

Analytics

MessagesStatusOfSameDeliveryChannel

EBoxMessagesStatusList

Voorbeeld

PaperOrEmailMessageStatusList

Voorbeeld PAPER

ErrorMessage

Voorbeeld

Related content

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