Algemeen

Het request is op dezelfde manier opgebouwd als alle andere MAGDA webservices:

Een verplicht identificatienummer van de sociaal verzekerde
Een verplichte referentiedatum of periode waarop het dossier geconsulteerd wordt
Een aanduiding van de gegevensblokken die gewenst zijn in het response:
- Status van de aanvraag
- Zorgtoeslag erkenningen

XSD Visueel

Detail

Opmerking:

De vraag bestaat standaard uit Context, Reference en Antwoord zoals beschreven in het document Gebruik Magda Webservices 02.00. Verder zal enkel aandacht besteed worden aan het specifieke Antwoord element.

Element ../Request/				Beschrijving
Reference				Unieke referte ten behoeve van traceerbaarheid van de communicatie. Geprefereerd formaat: UUID van 36 lang
Content				Inhoud blok van de vraag
	criteria			Criteria blok van de vraag
		ssin		Identificatienummer van de sociale zekerheid van de betrokkene
		referenceDate		De referentiedatum waarop het dossier geconsulteerd wordt. Kan niet opgegeven worden samen met de periode
		period		inhoud van het periode blok. Kan niet opgegeven worden samen met de referentiedatum
			beginDate	begindatum van de period
			endDate	einddatum van de periode
		parts		De onderdelen van het dossier die geconsulteerd worden
			evolutionOfRequest	De afnemer wenst de status van het dossier te consulteren Mogelijke waarden: true false (default)
			recognition	De afnemer wenst de erkenningen van zorgtoeslag te consulteren Mogelijke waarden: true false (default)

Validaties op vraag

Element criteria/..	Omschrijving van de validatie	Exception Identification	Exception Type	Exception Origin	Exception Diagnosis
ssin	INSZ Checksum 97 validatie	20002	ERROR	KENG	The structure of the INSZ given in request is invalid
referenceDate	Kleiner dan of gelijk aan systeemdatum	20006	ERROR	KENG	A date in the request is outside the allowed date range
periode/beginDate period/endDate	Einddatum ligt voor de begindatum	20003	ERROR	KENG	Invalid Period : enddate before begindate
parts	Minstens 1 onderliggend element op true	40102	ERROR	KENG	No data parts have been selected in the criteria

Voorbeeld

<Request>
    <Reference>3e58eb64-6681-4b88-bd06-66775d34a402</Reference>
    <Content>
        <criteria>
            <ssin>01010199797</ssin>
            <referenceDate>2019-01-01</referenceDate>
            <parts>
                <evolutionOfRequest>true</evolutionOfRequest>
            </parts>
        </criteria>
    </Content>
</Request>

Opmerkingen

Op deze pagina

1 Algemeen
2 XSD Visueel
3 Detail
4 Validaties op vraag
5 Voorbeeld
6 Opmerkingen

Binnen deze handleiding

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

MAGDA Gebruikersomgeving

Beschrijving Vraag (GetCareAllowance-03.00)