DIGITAAL VLAANDEREN

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

Algemeen

In de vraag zijn twee blokken opgenomen, één voor het opvragen op datum en één voor het opvragen op periode. In elk blok kan aangeduid worden welke authentieke bronnen moeten aangesproken worden. Tevens is het mogelijk om aan te duiden welke specifieke datablokken worden opgevraagd.

XSD Visueel

Opgelet : het blokje rechts van het Criteria is een Choice element. Dit betekent dat 1 en slechts 1 van de elementen ernaast ingevuld mag worden. Je kan dus of een opvraging op datum doen of een opvraging op periode, maar niet beide.

ConsultFilesByDateCriteria

ConsultFilesByPeriodCriteria

Detail

ConsultFilesByDateCriteria

Element
../ConsultFilesByDateCriteria/

Opmerkingen

ssin

Identificatienummer van de sociale zekerheid van de betrokkene

handicapAuthenticSources

De bronnen die geconsulteerd moeten worden.

  • De lijst is opgezet met optionele velden onder default false. Dit betekent dat als een veld niet meegegeven wordt de overeenkomstige data ook niet wordt opgevraagd.

  • De aanduiding van de bron wordt geverifieerd ten opzicht van de machtiging

  • Omdat niet alle klanten interesse hebben in de gegevens bij alle bronnen bieden we de mogelijkheid om dit specifiek aan te duiden. Door niet altijd alle bronnen op te vragen ontkoppelen we ook de technische afhankelijkheid. Wanneer één authentieke bron een technisch probleem heeft, kan de dienst gedeeltelijk blijven werken.


DGPH

Het Directie-Generaal personen met een handicap dient geconsulteerd te worden.
Aanduiden met "true" als deze bron aangesproken moet worden


VSB

Het VSB dient geconsulteerd te worden.
Aanduiden met "true" als deze bron aangesproken moet worden

referenceDate

De referentiedatum waarop het dossier geconsulteerd wordt.
Formaat : jjjj-mm-dd

parts

De onderdelen van het dossier die geconsulteerd worden. Zie ook lijst hieronder!

  • De lijst is opgezet met optionele velden onder default false. Dit betekent dat als een veld niet meegegeven wordt de overeenkomstige data ook niet wordt opgevraagd.

  • De aanduiding van de bron wordt geverifieerd ten opzicht van de machtiging

  • Niet alle blokken kunnen bij alle bronnen opgevraagd kunnen worden. Indien de afnemer enkel blokken opvraagt die niet gedefinieerd zijn voor de authentieke bronnen die hij opvraagt, wordt het request onmiddellijk geweigerd wegens inconsistent


evolutionOfRequest

De status van de aanvraag (dit blok is niet afhankelijk van de referentiedatum en behelst steeds de laatste status van de aanvraag)
Aanduiden met "true" als dit onderdeel opgevraagd moet worden


handicapRecognitions

De erkenningen op een bepaalde datum geldig (kunnen er vier zijn)
Aanduiden met "true" als dit onderdeel opgevraagd moet worden


rights

Het/de recht/en op een bepaalde datum geldig
Aanduiden met "true" als dit onderdeel opgevraagd moet worden


socialCards

De sociale kaarten op een bepaalde datum geldig (kunnen er twee zijn)
Aanduiden met "true" als dit onderdeel opgevraagd moet worden

decisionStatus

Duidt aan of de klant de decisionStatus wenst te ontvangen in het response.

enrichedRecognition

Duidt aan of de klant de legislation wenst te ontvangen in het response handicaprecognition.

ConsultFilesByPeriodCriteria

Element
../ConsultFilesByPeriodCriteria/

Opmerkingen

ssin

Identificatienummer van de sociale zekerheid van de betrokkene

handicapAuthenticResources

De bronnen die geconsulteerd moeten worden.


DGPH

Het Directie-Generaal personen met een handicap dient geconsulteerd te worden.
Aanduiden met "true" als deze bron aangesproken moet worden


VSB

Het VSB dient geconsulteerd te worden.
Aanduiden met "true" als deze bron aangesproken moet worden

period

De periode waarop het dossier geconsulteerd wordt. Zie ook opmerking hieronder


beginDate

Begindatum van de periode. Zie ook opmerking hieronder
Formaat : jjjj-mm-dd


endDate

Einddatum van de periode. Zie ook opmerking hieronder
Formaat : jjjj-mm-dd

parts


De onderdelen van het dossier die geconsulteerd worden. Zie ook lijst hieronder!

  • De lijst is opgezet met optionele velden onder default false. Dit betekent dat als een veld niet meegegeven wordt de overeenkomstige data ook niet wordt opgevraagd.

  • De aanduiding van de bron wordt geverifieerd ten opzicht van de machtiging

  • Niet alle blokken kunnen bij alle bronnen opgevraagd kunnen worden. Indien de afnemer enkel blokken opvraagt die niet gedefinieerd zijn voor de authentieke bronnen die hij opvraagt, wordt het request onmiddellijk geweigerd wegens inconsistent


evolutionOfRequest

De status van de aanvraag (dit blok is niet afhankelijk van de referentiedatum en behelst steeds de laatste status van de aanvraag)
Aanduiden met "true" als dit onderdeel opgevraagd moet worden


handicapRecognitions

De erkenningen op een bepaalde datum geldig (kunnen er vier zijn)
Aanduiden met "true" als dit onderdeel opgevraagd moet worden


rights

Het/de recht/en op een bepaalde datum geldig
Aanduiden met "true" als dit onderdeel opgevraagd moet worden


socialCards

De sociale kaarten op een bepaalde datum geldig (kunnen er twee zijn)
Aanduiden met "true" als dit onderdeel opgevraagd moet worden

Merk op dat de elementen ‘decisionStatus’ en ‘enrichedRecognition’ niet aanwezig in het request van deze operatie. Deze dienst zal decisionStatus in rights en recognition en de legislation in recognition automatisch doorgeven indien present in het antwoord van de authentieke bron.

Periode

Er kunnen periodes van maximum 3 jaar worden opgevraagd. De begindatum van de periode die wordt opgevraagd kan maximum 2 maanden in de toekomst liggen (voor een consultatie in maand X, mag de begindatum liggen tot de laatste dag van maand X+2). De einddatum moet dan kleiner zijn dan begindatum + 3 jaar. De teruggeven resultaten overlappen minstens met de opgegeven periode.

Authentieke bron - gegevensblokken

Onderstaande lijst maakt de koppeling tussen de beschikbare authentieke bronnen en de beschikbare gegevensblokken. Indien enkel blokken worden opgevraagd die niet beschikbaar zijn bij de aangeduide authentieke bron zal dit enkel een uitzondering 70002 geven met KSZ status code MSG00008 .

Element

DGPH

VSB

evolutionOfRequest

✓

✓

handicapRecognitions

✓

rights

✓

✓

socialCards

✓

Validaties op vraag

ConsultFilesByDateCriteria

Element

Omschrijving van de validatie

Mogelijke Foutcodes

ssin

De INSZ moet voldoen aan de Checksum97 validatie

20002

referenceDate

referenceDate mag niet verder dan twee maanden in de toekomst liggen

70002

ConsultFilesByPeriodCriteria

Element

Omschrijving van de validatie

Mogelijke Foutcodes

ssin

De INSZ moet voldoen aan de Checksum97 validatie

20002

beginDate
endDate

  • beginDate moet voor endDate liggen

20003

  • beginDate mag niet verder dan twee maanden in de toekomst liggen

  • De periode mag niet groter zijn dan 3 jaar

70002

Voorbeeld

Voorbeeld op Datum

<Vraag>
	<Referte>f1af3-ad0e-4958-ab8f-1b4f529bb93e</Referte>
	<Inhoud>
		<Criteria>
			<ConsultFilesByDateCriteria>
				<ssin>12345678901</ssin>
				<handicapAuthenticSources>
					<DGPH>true</DGPH>
					<VSB>true</VSB>
				</handicapAuthenticSources>
				<referenceDate>2019-10-24</referenceDate>
				<parts>
					<evolutionOfRequest>true</evolutionOfRequest>
					<handicapRecognitions>true</handicapRecognitions>
					<rights>true</rights>
					<socialCards>false</socialCards>
				</parts>
				<decisionStatus>true</decisionStatus>
				<enrichedRecognition>true</enrichedRecognition>
			</ConsultFilesByDateCriteria>
		</Criteria>
	</Inhoud>
</Vraag>

Voorbeeld op periode

<Vraag>
	<Referte>f1af3-ad0e-4958-ab8f-1b4f529bb93e</Referte>
	<Inhoud>
		<Criteria>
			<ConsultFilesByPeriodCriteria>
				<ssin>12345678901</ssin>
				<handicapAuthenticSources>
					<DGPH>true</DGPH>
					<VSB>false</VSB>
				</handicapAuthenticSources>
				<period>
					<beginDate>2020-01-01</beginDate>
					<endDate>2020-03-31</endDate>
				</period>
				<parts>
					<evolutionOfRequest>true</evolutionOfRequest>
					<handicapRecognitions>true</handicapRecognitions>
					<rights>true</rights>
					<socialCards>true</socialCards>
				</parts>
			</ConsultFilesByPeriodCriteria>
		</Criteria>
	</Inhoud>
</Vraag>

Codetabellen Vraag

Er worden geen codetabellen gebruikt in de vraag

Op deze pagina

Binnen deze handleiding

The selected root page could not be found.

  • No labels

Voor vragen of opmerkingen kan u de MAGDA helpdesk contacteren

De MAGDA Gebruikersomgeving is een officiële website van de Vlaamse overheid

uitgegeven door Digitaal Vlaanderen