Deze API werd buiten gebruik gesteld aangezien deze vervangen werd door een REST API: GET socZek/handicap/volledigeDossiers De gegevens van VAPH kunnen met andere woorden afgenomen worden via deze REST API.

Situering

Het Vlaams Agentschap voor Personen met een Handicap (VAPH) heeft een groot aantal gegevens over de erkenningen van personen 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. 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.

Verwante diensten

Om deze webservice te kunnen gebruiken moet er eerst een inschrijving in het MAGDA inschrijvingsrepertorium voor personen aangemaakt worden. Deze inschrijvingen kunnen toegevoegd, aangepast en verwijderd worden via de webservices Repertorium.RegistreerInschrijving-02.01 en Repertorium.RegistreerUitschrijving-02.00.

Gegevensbronnen

Meer informatie over hoe deze bronnen gebruikt worden in de opbouw van het antwoord vindt u onder Opvraging.

Gebruiksvoorwaarden

Afnemers moeten aan volgende voorwaarden voldoen om deze dienst te mogen gebruiken:

• Toelating tot het MAGDA platform

• Er moet een protocol worden afgesloten tussen de bron (dit is VAPH) en de afnemer van de dienst.

Batch

Deze webservice is eveneens beschikbaar in een batch-variant (enkel XML). Voor meer informatie: webservice in batch bevragen.

Functionaliteiten

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

Logging

De opvragingen die gebeuren via deze webservice worden bewaard zoals beschreven op de pagina "MAGDA logging".

Ondersteunde talen

MAGDA ondersteunt de Nederlandse taal.

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.

Op deze pagina

Binnen deze handleiding

Omgevingsinformatie

Verwante diensten