DIGITAAL VLAANDEREN
Overzicht uitzonderingen bij overname XSD van de bron
Deze uitzonderingen komen enkel voor indien de dienst de XSD van de bron overneemt. Zie de handleiding van de dienst zelf om te weten of dit het geval is.
Nieuwe uitzondering codes 7000X
Bij de ontwikkeling van nieuwe SOAP diensten zal MAGDA zoveel mogelijk de data structuur - ook wel data schema genoemd - van de bron overnemen. Dit voor zowel de data payload als voor de foutmelding. Bij deze diensten krijgt de afnemer de volledige fout- of statusinformatie van de bron door.
Daar de volledige informatie over de situatie van de verwerking van de request bij de bron is meegegeven in het MAGDA antwoord wordt deze informatie niet 1 op 1 gemapt naar MAGDA uitzonderingen, zoals bij de oudere versies van MAGDA SOAP diensten steeds werd gedaan. Dit zou immers een duplicatie van informatie betekenen. Daarom is beslist om een nieuwe reeks uitzonderingscodes te gebruiken die een indicatie geven van de status van het antwoord van de bron, maar niet dezelfde granulariteit hebben als de oudere diensten. De nieuwe uitzondering codes vallen in de codereeks 7000X.
Indien de fout wordt gegenereerd in de MAGDA businessdienst en niet bij de bron worden nog steeds uitzondering codes gebruikt met waarden kleiner dan 70000.
Zie ook https://vlaamseoverheid.atlassian.net/wiki/spaces/MG/pages/2104688821 voor meer info over het KSZ status element.
Uitzondering code overzicht
Deze uitzonderingen hebben steeds de bron als oorsprong daar ze door de bron worden opgegeven.
Code | Type | Omschrijving |
|---|---|---|
70001 | INFORMATIE of WAARSCHUWING | Er is data aanwezig in het antwoord maar opmerkingen over de data worden opgegeven. Bij een type WAARSCHUWING dient de afnemer een actie te ondernemen (vb. de INSZ vervangen door een nieuwe waarde). Type INFORMATIE geeft extra informatie over de data (vb. de naam van de persoon is te lang en is ingekort) maar de afnemer hoeft geen actie te ondernemen. Het fout- of status-element bevat de details van de uitzondering |
70002 | FOUT | Er is een antwoord van de bron ontvangen maar deze bevat geen data en enkel een foutmelding. Er is wel een fout- of status-element aanwezig met extra informatie over de specifieke situatie. |
70003 | FOUT | Er kan geen connectie gemaakt worden met de bron en een SOAP fault of een niet-XML antwoord (vb. stack trace) is ontvangen. In dit geval zal geen payload, noch een fout- of status-element in het antwoord aanwezig zijn daar er geen data van de bron is ontvangen. |
Uitzondering met bron MAGDA
Indien de uitzondering veroorzaakt wordt door in het MAGDA framework en niet bij de bron zal een uitzondering gegooid worden met foutcode <70000. De generieke uitzonderingen, zoals gestipuleerd op https://vlaamseoverheid.atlassian.net/wiki/spaces/MG/pages/485753722 zijn dus ook van toepassing bij diensten die de XSD van de bron gebruiken ni het schema.
Verwerking van uitzondering met code > 70000
Indien in de handleiding van de dienst aantoont dat de dienst uitzonderingen met codes > 70000 kan geven dient de business logica van de afnemer eerst de uitzondering van MAGDA te interpreteren. Indien een uitzondering met een code 70001 of 70002 wordt opgegeven dient de inhoud van de fout- of status-element verwerkt te worden. De details van de foutmelding van de bron worden gestipuleerd in de handleiding van de dienst zelf. Dit vergt mogelijks specifieke logica per dienst. Afnemers waren vragende partij om de foutmelding van de bron door te krijgen in het MAGDA antwoord.
Bij een uitzondering met code 70003 is geen payload of fout- of status-element van de bron aanwezig.
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