Voor de ontsluiting van een MAGDA 2.0 webservice, alsook het generieke proces binnen een 2.0 webservice, wordt verwezen naar Werking en gebruik MAGDA 2.0 Webservices.
Situering
Het Vlaams Agentschap voor Personen met een Handicap (VAPH) heeft een groot aantal gegevens over hun erkenningen met een handicap. Deze gegevens zijn niet beschikbaar in de stroom van de FOD Sociale Zekerheid en die aangeboden worden via de MAGDA-dienst GeefDossierhandicap 3.0 of GeefBetalingenHandicap 3.0.
Het VAPH erkent meerderjarige (vanaf 18 jaar) personen met een handicap wat een van hun opdrachten is. Er is een overlap met de erkenning van een handicap vanuit de FOD Sociale Zekerheid. Het kan dus dat een persoon erkend is bij de FOD Sociale Zekerheid en bij VAPH.
De GeefVolledigDossierHandicap 03.00 dienst maakt de gegevens van het VAPH beschikbaar voor de afnemers.
De webservice GeefVolledigDossierHandicap-03.00 laat de afnemer van het MAGDA-platform toe om het dossier met gegevens van de handicap van een persoon op te vragen. Deze gegevens komen van het VAPH, welke de authentieke bron is.
Vraag
De vraag bevat slechts 1 element: een rijksregisternummer.
Na ontvangst van de vraag wordt eerst een XSD validatie gedaan en daarna een checksum97 controle. Indien de checksum97 controle faalt wordt een uitzondering 20002 gegeven. Na een succesvolle controle wordt de vraag doorgegeven aan de connector waar deze geconverteerd wordt naar een REST/JSON formaat en kan doorgestuurd worden naar VAPH.
Antwoord
Het REST/JSON antwoord van VAPH wordt eerst gevalideerd met de SWAGGER en daarna geconverteerd naar XML. Deze XML wordt gevalideerd met een XSD die aangemaakt is aan de hand van de SWAGGER. Na filtering wordt de XML en het antwoord doorgestuurd naar de afnemer.
Werking
Aandachtspunten
In de vraag en het antwoord van MAGDA wordt de datastructuur van VAPH overgenomen. Dit maakt het converteren van REST/JSON van en naar XML eenvoudiger. Dit betekent echter dat de inhoud van de vraag en het antwoord uit elementen bestaan die niet met een hoofdletter beginnen, wat niet overeen komt met de het reguliere MAGDA XSD formaat.
Opties
Volgende configuratieparameters kunnen ingesteld worden in functie van de machtigingen en de wensen van de afnemer:
Configuratieparameters op het MAGDA platform zijn voor deze dienst niet van toepassing
Opvraging
Van zodra de vraag gesteld is, wordt er een XSD-validatie uitgevoerd. Is de ontvangen vraag-XML niet geldig tegenover het schema, dan stopt de verwerking en wordt een foutmelding aangemaakt, anders gaat de verwerking verder. Na de XSD-validatie vinden de nodige authenticatie- en autorisatiecontroles plaats.
De vraag wordt dan geconverteerd naar een REST/JSON formaat en doorgestuurd naar de bron.
Het antwoord van de bron wordt geconverteerd van REST/JSON naar XML en gevalideerd tegenover de XSD waarna het aan de afnemer ter beschikking gesteld wordt.
Responsetijden & Beschikbaarheid
Opmerking:
De MAGDA response tijden zijn heel sterk afhankelijk van de response tijden van de bron. Als de brongegevens heel traag worden aangeleverd kan het MAGDA antwoord niet snel worden aangeleverd.
Indien in de brongegevens de Nederlandse tekst niet beschikbaar is voor een bepaald element zal de eerste vertaling van de tekst in de brongegevens gebruikt worden, onafhankelijk van de taal waarin dit gegeven beschikbaar is.
Wijzigingshistoriek
Datum
Aanpassingen
Eerste versie van de handleiding
Omschrijving van elementen in het antwoord toegevoegd
