DIGITAAL VLAANDEREN
Werking uitzonderingen publicaties
Deze pagina beschrijft de werking van de foutafhandeling voor MAGDA 2.0 publicaties. Elke MAGDA 2.0 publicatie werkt op het vlak van foutafhandeling op eenzelfde manier.
Generieke foutcodes
Generieke foutcodes, welke hieronder zijn vermeld, worden gegenereerd door het MAGDA platform zelf en zijn niet service afhankelijk.
Codes die aan een specifieke dienst verbonden zijn wordt gedocumenteerd bij de dienst zelf en zijn steeds op niveau 3.
Niveau uitzonderingen
Bij een MAGDA 2.0 publicatie kunnen Uitzonderingen voorkomen op twee verschillende niveaus.
Niveau 2: Uitzondering op het niveau van Publicatie
Uitzonderingen op niveau 2 doen zich voor onder het Publicatie-element. Bij deze uitzonderingen zal nooit een Onderwerpen-element terugkomen. Deze uitzonderingen hebben steeds als Oorsprong "MAGDA".
Deze uitzondering doet zich nagenoeg niet voor. Enkel bij bepaalde publicaties, en indien gevraagd tijdens het aansluitingsproces, kan zich de melding voordoen dat een publicatie "geen te publiceren gegevens" heeft.
In onderstaande tabel zijn de mogelijke foutcodes opgekomen die binnen een MAGDA 2.0 publicatie-service kunnen voordoen.
Foutcode | Verduidelijking |
|---|---|
15015 | Geen te publiceren gegevens |
Opmerking: foutcode 15015 is niet van toepassing voor VKBO-publicaties. De foutcode komt tevens enkel voor indien de afnemer een uitzonderingsbestand wenst (aan te vragen tijdens het aansluitingsproces).
Niveau 3: Uitzondering binnen het Onderwerp-element
Binnen het Onderwerp kunnen geen, één of meerdere Uitzondering-elementen voorkomen, al dan niet samen met een Inhoud-element. Deze uitzonderingen zijn echter dienstspecifiek, bijgevolg wordt verwezen naar de dienstspecifieke pagina's.
Type uitzonderingen
Het type uitzondering duidt de zwaarte van uitzondering aan. Echter wordt aanbevolen enkel op de foutcode te werken.
Type | Definitie |
|---|---|
FOUT | De afnemer zal geen data object (Vb Persoon) ontvangen van de businessdienst doordat er een fout opgetreden is. Dit moet niet zozeer een technische fout zijn, maar kan ook een validatiefout zijn, autorisatiefout, … .. Vb: INSZ checksum is ongeldig, foutcode van de bron waarbij er geen data object terug komt, … |
INFORMATIE | De afnemer ontvangt een data object maar binnen de uitzondering is er extra informatie opgenomen met betrekking tot het data object of de verwerking. |
WAARSCHUWING | De afnemer ontvangt een data object, of zou er een kunnen ontvangen, maar moet actie ondernemen. Vb: Persoon heeft een nieuw INSZ verkregen |
Oorsprong
De Oorsprong geeft aan wie de fout aangemaakt heeft. De oorsprong is (max) vijf karakters lang en uniek voor een bron. Op deze manier is het voor afnemers eenvoudig te bepalen bij welke partij de fout is opgetreden.
Daar foutcodes maximaal hergebruikt worden is de mogelijkheid dat een foutcode met een oorsprong MAGDA maar ook met een oorsprong bron kan voorkomen binnen een dienst.
Oorsprong | Richtlijn |
|---|---|
MAGDA | Elke uitzondering die door MAGDA zelf aangemaakt is:
|
Bron | Elke uitzondering (ruime zin), door de bron aangemaakt:
|
Annotaties
Binnen een Uitzonderingen kunnen Annotatie-elementen voorkomen. Deze Annotatie-elementen, onder de vorm van een naam/waarde-paar, geven meer informatie rond de uitzonderingen.
De meest voorkomende annotatie is Oud INSZ en Nieuw INSZ.
<Annotaties>
<Annotatie>
<Naam>Oud INSZ</Naam>
<Waarde>69011005111</Waarde>
</Annotatie>
<Annotatie>
<Naam>Nieuw INSZ</Naam>
<Waarde>63032411222</Waarde>
</Annotatie>
</Annotaties> |
Of een annotatie al dan niet voorkomt binnen een dienst wordt in de diensthandleiding beschreven.
Run-time uitzonderingen
De run-time uitzonderingen die in publicaties kunnen voorkomen zijn dezelfde als bij de MAGDA-webservices. Beschrijvingen van deze codes kunnen terug gevonden worden onderaan https://vlaamseoverheid.atlassian.net/wiki/pages/createpage.action?spaceKey=MG&title=Overzicht%20uitzonderingen%20MAGDA%202.0%20Webservices&linkCreation=true&fromPageId=1901920670.
Op deze pagina
Verbonden pagina’s
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