Algemeen
Bij de nieuwe MAGDA webservices wordt zoveel mogelijk gebruik gemaakt van de schema’s van de bron. Over het algemeen betekent dit dat vanuit de MAGDA XSD de XSD van de bron wordt geïmporteerd. Bij diensten die gebruik maken van KSZ als bron wordt hierbij niet alleen de result overgenomen, maar ook het status element. Dit status element is een standaard element dat in alle KSZ diensten voorkomt en wordt gebruikt om de staat van het antwoord door te geven naar de afnemer.
Visueel
Elementen
Element | Omschrijving | |
|---|---|---|
value | Mogelijke waarden:
| |
code | Code van de status. | |
description | Omschrijving van de status. | |
information | Dit element wordt ingevuld wanneer meer informatie moet worden toegevoegd aan de status om een bijkomende toelichting te krijgen. De gegevens in dit information element zijn afhankelijk van de status code maar ook van de specifieke dienst. | |
fieldName | Omschrijving van de bijkomende toelichting | |
fieldValue | Waarde van de bijkomende toelichting | |
Mapping naar MAGDA uitzonderingen
Daar het status element van KSZ reeds de details van de situatie doorgeeft geeft MAGDA in zijn uitzonderingen niet even gedetailleerd de situatie van het antwoord door. De mogelijke uitzonderingen worden nu bepaald door het aanwezig zijn van gegevens in het antwoord met bijbehorende opmerkingen of eventuele fouten.
De waarde van het status/value element bepaalt welke foutmelding MAGDA zal doorgeven.
KSZ status/value | MAGDA Uitzondering | |
|---|---|---|
Identificatie | Beschrijving | |
DATA_FOUND | Geen uitzondering | Antwoord met gegevens wordt teruggeven |
NO_DATA_FOUND | 70001 | Er zijn geen gegevens gevonden voor de zoekopdracht |
INCOMPLETE_DATA | 70001 | Er worden gegevens doorgegeven maar deze zijn niet compleet. Extra informatie is opgenomen in het Information element |
NO_RESULT | 70002 | Er worden geen gegevens teruggegeven omwille van bepaalde foutmeldingen. vb. fouten in de vraagcriteria |
TECHNICAL_ERROR | 70002 | Er worden geen gegevens teruggegeven omwille van technische fouten, vb. geen connectie met de achterliggende bron. |
Volledigheidshalve dient vermeld te worden dat ook een 70003 uitzondering kan doorgegeven worden welke zal voorkomen bij een SOAP fault. Daar de details van de SOAP faults kunnen verschillen van dienst tot dienst wordt deze hier niet verder behandelt. Er is ook geen link tussen het status element en de uitzondering 70003, SOAP Fault.
