Algemeen

Deze webservice bevat vier consultatie criteria:

• INSZ: het INSZ van de persoon (kind of begunstigde) waarvoor Vlaamse Groeipakket gegevens opgevraagd worden

• Periode/BeginMaand: begin maand van de referentie periode waarop gezocht moet worden

• Periode/EindeMaand: optionele einde maand van de referentie periode waarop gezocht moet worden; indien er geen einde maand wordt opgegeven in de vraag criteria, dan wordt hiervoor de systeem datum gebruikt.

• Een optionele lijst van BetalingsperiodeFilters wat is dit juist?

• Bronnen/Bron: optionele lijst van bronnen die de afnemer wenst te consulteren; indien niet opgegeven, worden alle bronnen geconsulteerd waarvoor de afnemer gemachtigd is

XSD Visueel

Detail

Validaties op vraag

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.

In functie van de afnemer en hoedanigheid gebeurt vervolgens een controle of voor het opgegeven INSZ een inschrijving bestaat in het MAGDA inschrijvingsrepertorium. Voor consultaties van authentieke bronnen die via de KSZ passeren, gebeurt op niveau van de KSZ ook een controle of er een inschrijvingsdossier bestaat bij de KSZ én bij de achterliggende bron. Indien de inschrijvingscontrole faalt, zal de dienst geen achterliggende bronnen raadplegen en een uitzondering werpen.

Indien de inschrijvingscontrole succesvol (of niet) wordt doorlopen, worden de vraag criteria functioneel gevalideerd. Indien niet voldaan aan de functionele validatie, wordt de verwerking van de dienst gestopt en wordt een uitzondering geworpen.

Volgende tabel geeft aan welke validaties worden uitgevoerd en welke uitzonderingen worden geworpen:

In functie van de opgegeven bronnen, roept de GeefKindVoordelen-02.01 dienst de diensten van de achterliggende diensten aan en bundelt de teruggekomen antwoorden tot één MAGDA antwoord. Als er geen bronnen worden meegegeven in de vraag criteria, dan zal de MAGDA dienst alle achterliggende bronnen aanroepen waarvoor de afnemer in de opgegeven hoedanigheid gemachtigd is om ze te consulteren.

De antwoorden van de authentieke bronnen, alsook het MAGDA antwoord wordt gevalideerd tegenover de XSD alvorens het wordt afgeleverd aan de afnemer. Anomalieën worden via uitzonderingen kenbaar gemaakt.

Voorbeeld

<Vraag>
	<Referte>5000aa93-f7d1-4c7e-bcf7-9e3ae23682a4</Referte>
	<Inhoud>
		<Criteria>
			<INSZ>00000000100</INSZ>
			<Periode>
				<BeginMaand>2018-01</BeginMaand>
			</Periode>
			<Bronnen>
				<Bron>VLAANDEREN</Bron>
			</Bronnen>
		</Criteria>
		<Taal>nl</Taal>
	</Inhoud>
</Vraag>

Codetabellen Vraag

Element Taal