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 | Opmerkingen | |
|---|---|---|
ssin | Identificatienummer van de sociale zekerheid van de betrokkene | |
handicapAuthenticSources | De bronnen die geconsulteerd moeten worden.
| |
DGPH | Het Directie-Generaal personen met een handicap dient geconsulteerd te worden. | |
VSB | Het VSB dient geconsulteerd te worden. | |
referenceDate | De referentiedatum waarop het dossier geconsulteerd wordt. | |
parts | De onderdelen van het dossier die geconsulteerd worden. Zie ook lijst hieronder!
| |
evolutionOfRequest | De status van de aanvraag (dit blok is niet afhankelijk van de referentiedatum en behelst steeds de laatste status van de aanvraag) | |
handicapRecognitions | De erkenningen op een bepaalde datum geldig (kunnen er vier zijn) | |
rights | Het/de recht/en op een bepaalde datum geldig | |
socialCards | De sociale kaarten op een bepaalde datum geldig (kunnen er twee zijn) | |
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 | 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. | |
VSB | Het VSB dient geconsulteerd te worden. | |
period | De periode waarop het dossier geconsulteerd wordt. Zie ook opmerking hieronder | |
beginDate | Begindatum van de periode. Zie ook opmerking hieronder | |
endDate | Einddatum van de periode. Zie ook opmerking hieronder | |
parts | De onderdelen van het dossier die geconsulteerd worden. Zie ook lijst hieronder!
| |
evolutionOfRequest | De status van de aanvraag (dit blok is niet afhankelijk van de referentiedatum en behelst steeds de laatste status van de aanvraag) | |
handicapRecognitions | De erkenningen op een bepaalde datum geldig (kunnen er vier zijn) | |
rights | Het/de recht/en op een bepaalde datum geldig | |
socialCards | De sociale kaarten op een bepaalde datum geldig (kunnen er twee zijn) | |
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 periode mag slechts 12 maanden in zich hebben.
Begindatum niet verder dan de tweebegindatum van de periode die wordt opgevraagd kan maximum 2 maanden in de toekomst
Einddatum moet voor de begindatum liggen
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 |
| 20003 |
| 70002 |
Voorbeeld
Voorbeeld op Datum
| Code Block | ||
|---|---|---|
| ||
<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
| Code Block | ||
|---|---|---|
| ||
<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
| Table of Contents | ||
|---|---|---|
|
Binnen deze handleiding
| Page Tree | ||
|---|---|---|
|