Versions Compared

Old Version 15

changes.mady.by.user Thomas De Langhe

Saved on

compared with

New Version 16

changes.mady.by.user Thomas De Langhe

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 die toelaat te specifiëren welk type van Betalingsperiode er opgevraagd wordt. Deze filter wordt enkel gebruikt voor de bron VLAANDEREN.

  • 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

image-20240805-121440.png

Detail

Element

Opmerkingen

Referte

Unieke referte ten behoeve van traceerbaarheid van de communicatie.

Geprefereerd formaat: UUID van 36 lang

INSZ

INSZ van de persoon van wie de gegevens opgevraagd worden

BeginMaand

Begin van de referentie periode waarvoor de gegevens opgevraagd worden.

Formaat: JJJJ-MM

EindeMaand

Einde van de referentie periode waarvoor de gegevens opgevraagd worden. Dit element is optioneel; indien niet opgegeven wordt de maand van de systeemdatum gebruikt.

Formaat: JJJJ-MM

TypeFilter

Geeft aan welke type van Betalingsperiodes er teruggegeven moet worden. Het gaat over de tag dus over een filter die toegepast wordt op het element Betalingsperiodes/Betalingsperiode/Categorie/KindVoordeelCategorieCode/Code die dat zich zowel in het blok Kind als het blok Begunstigde in de response bevindt.

. Mogelijke waarden:

  • BASIS

  • KINDEROPVANG

  • KLEUTER

  • ONDERSTEUNINGSTOESLAG

  • PARTICIPATIE_SELECTIEF

  • PARTICIPATIE_UNIVERSEEL

  • ZORG_PLEEG

  • ZORG_SPECIALE_NODEN

  • ZORG_WEES

TypeSociaalInvoegen

Todo: Wat is juist ‘type sociaal’?

Tag

Merk op dat als je betalingsperiodes van type Sociale Toeslag wil opvragen dat je dan het element SociaalFilter moet gebruiken.

SociaalFilter & TypeSociaalInvoegen

  • Het element SociaalFilter geeft aan of de betalingsperiodes met type Sociale Toeslag moeten teruggegeven worden (. Het gaat dus om een filter die toegepast wordt op het element Betalingsperiodes/Betalingsperiode/Categorie/KindVoordeelBetalingsperiodeCategorieSociaal is aanwezig), dat zich zowel in het blok Kind als het blok Begunstigde in de response bevindt.

  • TypeSociaalInvoegen geeft dan vervolgens aan of het type sociale toeslag teruggeven moet worden (veld , d.w.z. of het element KindVoordeelBetalingsperiodeCategorieSociaal/typeSocialeToeslag moet teruggegeven worden. Mogelijke waarden:

    • MET_TYPE_SOCIAAL

    • ZONDER_TYPE_SOCIAAL

en dit zowel in het blok Kind als het blok Begunstigde.

Bron

Lijst van maximaal 5 bronnen die de afnemer wenst te consulteren.

Mogelijke waarden:

  • VLAANDEREN

  • WALLONIE

  • BRUSSEL

  • OOST-BELGIE

  • FEDERAAL (voor de oude dossiers van vóór 01/01/2019)

Indien geen bron aanwezig, worden alle bronnen waarvoor een machtiging bestaat geconsulteerd

Taal

Taalcode waarin eventuele code omschrijvingen worden teruggekoppeld in het antwoord naar de afnemer.

Formaat: 2 (kleine) letters, voorbeeld: “nl”

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.

Note

Opmerking:

Er is een vertraging van minimum 1 dag tussen de inschrijving door de bron en de mogelijkheid om het persoonsdossier te raadplegen.

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:

Element

Omschrijving van de validatie

Mogelijke Foutcodes

INSZ

Moet voldoen aan de checksum97 validatie

20002

BeginMaand

BeginMaand moet kleiner dan of gelijk aan de systeemdatum zijn

20006

EindeMaand

Indien ingevuld:

EindeMaand moet kleiner dan of gelijk aan de systeemdatum zijn

20006

EindeMaand

Indien ingevuld:

EindeMaand moet groter dan of gelijk aan de BeginMaand zijn

20003

Bron

Indien ingevuld:

De afnemer moet over de nodige machtiging beschikken voor elke bron opgegeven in de vraag criteria

40006

Taal

De opgegeven taal dient ondersteund te worden door de dienst.

25001

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

Expand
titleVoorbeeld
Code Block
languagexml
<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

Code

Omschrijving

nl

Nederlands

en

Engels Engels wordt toch niet ondersteund? → Inderdaad, enkel nl

Op deze pagina

Table of Contents
maxLevel2

Binnen deze handleiding

Child pages (Children Display)
depth1
allChildrentrue
style
pageGezin.GeefKindVoordelen-02.01 (work in progress)
sortAndReverse
first0
Info

Met vragen kunt u steeds terecht bij de MAGDA Service Desk.