⚖️ Productie
Beschrijving input
Algemeen
Validaties
Panel | ||
---|---|---|
| ||
|
Codetabellen
nvt
Beschrijving resultaat
Algemeen
Attribuut
Omschrijving
Mogelijke waardes
kennisgevingId
identificatie van een kennisgeving
stukId
lijst van stukken welke deel uitmaken van de kennisgeving
kennisgevingStukken
StukId en de stukStatus: in behandeling (stuk werd nog niet afgeleid), geslaagd (stuk werd afgeleid), niet geslaagd (stuk kon niet worden afgeleid)
in behandeling
geslaagd
gefaald
KennisgevingBelanghebbende
Lijst van belanghebbende + verzendingsgegevens van de kennisgeving
belanghebbendeId
de belanghebbende op wie de kennisgeving betrekking heeft
correspondentieadresPost
het correspondentieadres welke ingegeven werd bij de aanvraag van de kennisgeving (kan leeg zijn)
retouradres
het retouradres welke ingegeven werd bij de aanvraag van de kennisgeving (kan leeg zijn)
terAttentieVanEbox
insz of naam welke ingegeven werd bij de aanvraag van de kennisgeving (kan leeg zijn)
Verzendoptie
manier van versturen van de kennisgeving
niet aangetekend
aangetekend
aangetekend met ontvangstbevestiging
datumOntvangstbevestiging
in te vullen door de aansluiter: de datum vermeld op de ontvangstbevestiging
status
Status van de kennisgeving:
te versturen: kennisgeving is aangevraagd maar nog niet doorgegeven aan de magdadocumentendienst),
verstuurd: kennisgeving is verstuurd naar de magdadocumentendienst),
functionele fout: kennisgeving bevat functionele fouten: adres is niet gekend of documenten zijn te groot,
technische fout: er is een technische fout opgetreden bij het versturen naar de magdadocumentendienst: dit wordt opgevolgd door het VHPteam
te versturen
verstuurd
functionele fout
technische fout
redenenKennisgevingFunctioneelGefaald
De verschillende redenen waarom een kennisgeving niet kon verstuurd worden ikv een functionele fout:
fout magda documentendienst: er is een fout opgetreden bij het versturen naar de magdadocumentendienst
afgeleid document gefaald: er is een stuk welke niet kon afgeleid worden
afgeleid document gecombineerde grootte boven limiet: de documenten van de kennisgeving zijn samen te groot
belanghebbende synchronisatie gefaald: de belanghebbende met INSZ, KBOnummer of OVOcode kon niet gesynchroniseerd worden met de authentieke bron
adres onvolledig: het adres van de belanghebbende is niet volledig (bvb huisnummer ontbreekt) door het werken met een correspondentie adres kan dit omzeild worden
adres onbekend: het adres van de belanghebbende is niet ingevuld, door het werken met een correspondentie adres kan dit omzeild worden
aantal stukken boven limiet: de limiet van het aantal stukken voor een zending die geprint is overschreden
afgeleid document formaat niet printbaar: rekening houden met de dimensies van de printpartner bevat de zending pagina’s die niet correct afgedrukt kunnen worden
unknown: niet gekende fout
fout magda documentendienst
afgeleid document gefaald
afgeleid document gecombineerde grootte boven limiet
belanghebbende synchronisatie gefaald
adres onvolledig
adres onbekend
aantal stukken boven limiet
afgeleid document formaat niet printbaar
unknown
bezorgingSoort
op welke wijze de kennisgeving werd verstuurd
papier
ebox
papier en ebox
belanghebbendeStatus
Status van de belanghebbende van de kennisgeving:
in behandeling: belanghebbende werd nog niet gesynchroniseerd met de authentieke bron,
geslaagd: belanghebbende werd gesynchroniseerd met de authentieke bron
gefaald: synchronisatie met de authentieke bron is gefaald
in behandeling
geslaagd
gefaald
eboxStatus - gelezen
aanduiding of het bericht gelezen werd
True = gelezen
False = niet gelezen
eboxStatus - zichtbaar
aanduiding of het bericht zichtbaar is
True = zichtbaar
False = niet zichtbaar
eboxStatus - tijdstipVerval
tijdstip waarop het bericht niet meer zichtbaar zal zijn in de e-box
eboxStatus - tijdstipStatus
tijdstip wanneer de status het laatst werd gewijzigd
eboxStatus - completed
aanduiding of de status nog kan wijzigen. Als de eindstatus bereikt is, wordt de status niet meer opgevraagd bij de MagdaDocumentenDienst
True = eindstatus
False = geen eindstatus
paperStatus - statusType
status van de verzending van de kennisgeving aangegeven door de magdadocumentendienst
niet gevonden: opgegeven id was niet gevonden bij de magdadocumentendienst,
lopend:nog niet doorgegeven naar de drukker,
in verwerking: doorgegeven naar de drukker maar nog niet geprint,
geprint: documenten werden geprint, maar nog niet verstuurd,
verstuurd: documenten zijn verzonden = eindstatus,
geannuleerd: uitgestelde verzendingen nooit verzonden werden: zou niet kunnen voorkomen, error: niet fatale fout opgetreden: tijdelijke status die wordt opgevolgd door de magdadocumentendienst en komt daarna in gefaald of geprint/verstuurd
gefaald: fatale fout eindstatus
niet gevonden
lopend
in verwerking
geprint
verstuurd
geannuleerd
error
gefaald
paperStatus - trackAndTraceUri
referentie van bpost bij aangetekende zending
paperStatus - tijdstipAfgeleverd Bpost
tijdstip waarop de kennisgeving werd afgeleverd aan Bpost
paperStatus - tijdstipStatus
tijdstip wanneer de status het laatst werd gewijzigd
paperStatus - completed
aanduiding of de status nog kan wijzigen. Als de eindstatus bereikt is, wordt de status niet meer opgevraagd bij de MagdaDocumentenDienst
True = eindstatus
False = geen eindstatus
bezorgingDocumentSoort
aanduiding wat afgeleverd wordt, alle stukken (documenten in zijn geheel) of een verwijsdocument met link waarop men de stukken kan downloaden
tijdstipKennisgevingVerstuurd
tijdstip waarop de kennisgeving verstuurd werd naar de magdadocumentendienst
entiteitCreatie
entiteit die de kennisgeving heeft aangevraagd
tijdstipCreatie
tijdstip waarop de kennisgeving werd aangevraagd
tijdstipLaatsteWijziging
tijdstip van laatste wijziging van de kennisgeving
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Uitzonderingen
Note |
---|
Indien de adresgegevens of de ISO2 code van het land van de belanghebbende niet gekend is bij verzending via PAPER zal dit leiden tot een functionele fout, dit kan opgevangen worden door het meegeven van een correspondentieadres waar deze informatie wel ingevuld is. Indien stukId niet werd opgegeven wordt er een lege lijst als resultaat gegeven |
Codetabellen
🧪 Pre prod
Volgende aanpassing(en) tov productie zijn actief.
contactgegevens
indien er een verwijsdocument wordt afgeleverd (activatie eBox = ok en zending is boven limiet eBox) dan zullen deze gegevens op het verwijsdocument toegevoegd worden.
Versies
Versie | Wijziging tov vorige versie | Datum release | Release |
---|---|---|---|
v00.01 | initiële versie | 14/06/2023 | 24 |
Uitbreiding met KennisgevingStukken met de status van de stukken die opgenomen zijn in de kennisgeving Uitbreiding met belanghebbendeStatus met de info over de status van de belanghebbende |
| 30 | |
Uitbreiding met eboxStatus en paperStatus | 02/11/2023 | 33 | |
Uitbreiding met retouradres | 20/03/2024 | 43 | |
Toevoegen attribuut redenKennisgevingFunctioneelGefaald | 02/05/2024 | 46 | |
stukStatus uitgebreid naar 3 waarden: in_behandeling, geslaagd, gefaald RedenKennisgevingFunctioneelGefaald zijn de waarden uitgebreid belanghebbendeStatus zijn de waarden gewijzigd naar: in_behandeling, geslaagd, gefaald | 29/05/2024 | 48 | |
Uitbreiding met bezorgingDocumentSoort Nieuwe waardes in enum redenenKennisgevingFunctioneelGefaald |
| 51 | |
Uitbreiding met contactgegevens voor het verwijsdocument | 52 | ||
Uitbreiding met tijdstip eerste raadpleging |
| 54 | |
Verzendadres is toegevoegd aan de response |
| 59 |