Wijzigingshistoriek

Situering

Deze webservice kadert binnen het domein Family van het ISB platform.

Verwante diensten

Gezin.GeefZorgtoeslag-02.00: Vlaamse webservice voor het consulteren van zorgtoeslag gegevens bij authentieke bron Kind & Gezin; deze webservice wordt aangeroepen vanuit de GetCareAllowance-02.00 service.

Gegevensbronnen

De gegevens zijn afkomstig van het Vlaams Kadaster, beheerd door Kind & Gezin.

Meer informatie over hoe deze bronnen gebruikt worden in de opbouw van het antwoord vindt u onder Opvragingterug onder Beschrijving Antwoord (GetCareAllowance-02.00).

Gebruiksvoorwaarden

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

• Toelating tot het ISB platform

Batch

Deze webservice wordt niet beschikbaar gesteld in een batch-variant.

Functionaliteiten

De GetCareAllowance-02.00 businessdienst maakt het mogelijk om zorgtoeslag gegevens die voldoen aan specifieke zoekcriteria te consulteren.

Vraag

Een request bestaat uit volgende criteria:

• een

  Een verplicht identificatienummer van de sociaal verzekerde

• een

  Een verplichte referentiedatum waarop het dossier geconsulteerd wordt

• optionele

  Optionele zoekparameters om aan te geven welke informatie gewenst is in het response

  • status

    Status van de aanvraag

  • zorgtoeslagd

    Zorgtoeslag erkenningen

Antwoord

Een response bestaat uit:

• de

  De opgegeven request criteria

• status

  Status informatie van het response volgens de KSZ standaard

• zorgtoeslag

  Zorgtoeslag informatie die voldoet aan de request criteria, opgesplitst in volgende gegevensblokken:

  • status

    Status van de aanvraag

  • zorgtoeslagd erkenningen

Werking

Beschrijving van de activiteiten

Authenticatie op de PEP

Authenticatie van de afnemer gebeurt op niveau van de PEP. Hier wordt de identiteit van de afnemer gecontroleerd. Wanneer de authenticatie faalt wordt dit teruggekoppeld als een soap fault.

<se:Envelope xmlns:se="http://schemas.xmlsoap.org/soap/envelope/">
	<se:Body>
		<se:Fault>
			<faultcode>Client</faultcode>
			<faultstring>ERR_030: Authorization failure: certificate(s) are not allowed</faultstring>
		</se:Fault>
	</se:Body>
</se:Envelope>

Logging van het request

Het inkomende request wordt gelogd in het VIP kort journaal op het Magda platform om te voldoen aan de wettelijke loggingvereisten.

Technische validatie van het request

Het inkomende request wordt gecontroleerd tegenover het XSD schema. Wanneer het request niet conform het schema is, wordt dit teruggekoppeld in de vorm van een soap fault.

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
	<SOAP-ENV:Header/>
	<SOAP-ENV:Body>
		<SOAP-ENV:Fault>
			<faultcode>SOAP-ENV:Client.10501</faultcode>
			<faultstring>XSD validation on request failed</faultstring>
			<faultactor>MAGDA</faultactor>
			<detail>string value '0000000010a' does not match pattern for SSINType in namespace http://key-02_00.vip.flanders.be
				<xml-fragment/>
			</detail>
		</SOAP-ENV:Fault>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Transformeer en valideer request naar Magda Gezin.GeefZorgtoeslag-02.00

De Engelstalige webservice transformeert deKSZ request formaat naar het Magda vraag formaat en controleert het resultaat van de transformatie tegenover het XSD schema van de Vlaamse webservice.
Als het bericht geldig is, wordt de achterliggende Magda Gezin.GeefZorgtoeslag-02.00 aangeroepen.

In geval de validatie fouten aan het licht brengt, wordt het request niet naar de Magda Gezin.GeefZorgtoeslag-02.00 dienst verstuurd, maar wordt een exception aangemaakt.
De verwerking wordt hervat bij het opbouwen van het response naar de afnemer waarbij de logica wordt gevolgd van een ontbrekend antwoord vanuit de bron.

Verstuur request naar Magda Gezin.GeefZorgtoeslag-02.00

Alle business logica gebeurt op het Magda platform in de Magda Gezin.GeefZorgtoeslag-02.00 webservice. Het is ook deze service die de achterliggende bron (Vlaamse Groeipakket gegevens) consulteert en het antwoord aflevert aan de Family.GetCareAllowance-02.00 service.

Het antwoord volgt de Magda-02.00 standaard en bevat – indien aanwezig – inhoudelijke informatie en/of eventuele uitzonderingen waarin fouten, waarschuwingen en/of informatieve boodschappen met betrekking tot de verwerking van het request teruggekoppeld worden naar de afnemer.

Technische validatie van het response

Na de transformatie naar een response bericht, wordt dit bericht nogmaals gevalideerd ten opzichte van het XSD schema. Wanneer het response niet conform het schema is, wordt dit teruggekoppeld in de vorm van een soap fault.

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
	<SOAP-ENV:Header/>
	<SOAP-ENV:Body>
		<SOAP-ENV:Fault>
			<faultcode>SOAP-ENV:Client.60008</faultcode>
			<faultstring> XSD validation error on response</faultstring>
			<faultactor>MAGDA</faultactor>
			<detail> Element has xsi:nil attribute but is not nillable in element Exception
<xml-fragment/>
			</detail>
		</SOAP-ENV:Fault>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Log response

Het uitgaande response wordt gelogd in het VIP kort journaal op het Magda platform om te voldoen aan de wettelijke loggingvereisten.

• • Zorgtoeslag erkenningen

Opties

Configuratieparameters op het MAGDA platform zijn voor deze dienst niet van toepassing.

Responsetijden & Beschikbaarheid

De webservice op het MAGDA platform is 24 uur op 24 en 7 dagen op 7 beschikbaar.

Ondersteunde talen

Deze dienst voorziet in een Engelstalige interface met Engelstalige omschrijvingen in het status element en het Exceptions element.

De inhoudelijke gegevens die afkomstig zijn van de authentieke bron worden echter steeds getoond in de Nederlandse taal.