get KennisgevingById
Situering
Opvragen van een kennisgeving aan de hand van de identificatie (kennisgevingId)
Op deze pagina
- 1 Situering
- 2 Productie
- 2.1 Beschrijving input
- 2.1.1 Algemeen
- 2.1.2 Validaties
- 2.1.3 Codetabellen
- 2.2 Beschrijving resultaat
- 2.2.1 Algemeen
- 2.2.2 Uitzonderingen
- 2.2.3 Codetabellen
- 2.1 Beschrijving input
- 3 Versies
Productie
Beschrijving input
Algemeen
Validaties
KennisgevingId moet bestaan
Entiteit heeft toegang tot alle opgegeven stukken
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) |
|
KennisgevingBelanghebbende | Lijst van belanghebbende + verzendingsgegevens van de kennisgeving |
|
belanghebbendeId | de belanghebbende op wie de kennisgeving betrekking heeft |
|
verzendAdres | het hoofdadres dat gebruikt werd bij de aanvraag van de kennisgeving (kan leeg zijn) |
|
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 |
|
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. |
|
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 |
|
redenenKennisgevingFunctioneelGefaald | De verschillende redenen waarom een kennisgeving niet kon verstuurd worden ikv een functionele fout:
|
|
bezorgingSoort | op welke wijze de kennisgeving werd verstuurd |
|
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 |
|
eboxStatus - gelezen | aanduiding of het bericht gelezen werd |
|
eboxStatus - zichtbaar | aanduiding of het bericht zichtbaar is |
|
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 |
|
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 |
|
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 |
|
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 |
|
tijdstipErsteRaadplegingDocuboxBericht | tijdstip wanneer eerste raadpleging van het verwijsdocument is gebeurt via paper of ebox |
|
entiteitCreatie | entiteit die de kennisgeving heeft aangevraagd |
|
tijdstipCreatie | tijdstip waarop de kennisgeving werd aangevraagd |
|
tijdstipLaatsteWijziging | tijdstip van laatste wijziging van de kennisgeving |
|
Uitzonderingen
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.
Codetabellen
Versies
Wijziging tov vorige versie | Datum release | Release |
---|---|---|
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 | Jul 10, 2024 | 51 |
Uitbreiding met contactgegevens voor het verwijsdocument | Jun 27, 2024 | 52 |
Uitbreiding met tijdstip eerste raadpleging | Jul 24, 2024 | 54 |
Reden kennisgeving gefaald | Sep 18, 2024 | 58 |
Verzendadres is toegevoegd aan KennisgevingBelanghebbende | Oct 2, 2024 | 59 |