Algemeen
De vraag wordt op dezelfde manier opgebouwd als de overige MAGDA diensten.
De vraag bestaat uit volgende criteria:
- een verplicht identificatienummer van de sociaal verzekerde
- een verplichte consultatieperiode waarbij zowel begin als einddatum moeten worden meegegeven
- de gewenste pensioenpijler
- de taal waarin eventuele code omschrijvingen getoond moeten worden
- een aanduiding van welke gegevens gewenst zijn:
- enkel pensioenrechten
- pensioenrechten en mininum betalingen + aanduiding of de betalingen op de referteperiode dan wel de betalingsperiode betrekking hebben
- pensioenrechten en maxinum betalingen + aanduiding of de betalingen op de referteperiode dan wel de betalingsperiode betrekking hebben
XSD Visueel
Detail
Element ../Vraag/ | Kardinaliteit | Beschrijving | |||||
|---|---|---|---|---|---|---|---|
| Referte | 1 | Unieke referte die de vraag identificeert, bij voorkeur een UUID. Bij gebruik via de webservice kan dit worden overgenomen uit ../Context/Bericht/Afzender/Referte; voor de batch variant, dient elke individuele vraag in het aangeleverde bestand een unieke referte te bevatten. | |||||
| Inhoud | 1 | ||||||
| Criteria | 1 | ||||||
| INSZ | 1 | Identificatienummer van de sociaal verzekerde. | |||||
| Periode | 1 | Consultatie periode van de vraag (begin- en einddatum verplicht). | |||||
| Begin | 1 | Begindatum van de consutatieperiode Formaat: JJJJ-MM-DD | |||||
| Einde | 1 | Begindatum van de consutatieperiode Formaat: JJJJ-MM-DD | |||||
| Pijler | 1 | De gewenste pensioenpijler gebruikt bij de opzoeking. Mogelijke waarden:
| |||||
| Taal | 1 | Taal waarin de afnemer de omschrijvingen in het antwoord wenst te ontvangen. Enkel "nl" wordt ondersteund. | |||||
| RechtenInfo | 1 | Verplicht element dat toelaat om aan te duiden welke informatie m.b.t. pensioenrechten gewenst zijn in het antwoord. | |||||
KEUZE 1 | EnkelRechten | 0..1 | De afnemer wenst enkel pensioen rechten op te vragen die voldoen aan de vraag criteria. Mogelijke waarde: "1" | ||||
| KEUZE 2 | RechtenMetBetalingen | 0..1 | Extra specificaties voor het opvragen van pensioenrechten met betalingsgegevens. | ||||
| KEUZE 2.1a | RechtenMetMinimumBetalingen | 0..1 | De afnemer wenst pensioen rechten met een minimum set aan betalingsgegevens op te vragen die voldoen aan de vraag criteria. Mogelijke waarde: "1" | ||||
| KEUZE 2.1b | RechtenMetMaximumBetalingen | 0..1 | De afnemer wenst pensioen rechten met de maximum set aan betalingsgegevens op te vragen die voldoen aan de vraag criteria. Mogelijke waarde: "1" | ||||
| KEUZE 2.2a | ZoekOpReferteperiode | 0..1 | De afnemer wenst de betalingsgegevens op te vragen die betrekking hebben tot de referteperiode van de pensioenbetaling. Mogelijke waarde: "1" | ||||
| KEUZE 2.2b | ZoekOpBetalingsperiode | 0..1 | De afnemer wenst de betalingsgegevens op te vragen die betrekking hebben tot de betalingsperiode van de pensioenbetaling. Mogelijke waarde: "1" | ||||
Validaties op vraag
| Element | Omschrijving van de validatie | MAGDA | Type Uitzondering | Oorsprong uitzondering | Diagnose | Annotaties |
|---|---|---|---|---|---|---|
| Criteria/INSZ | INSZ Checksum 97 validatie | 20002 | FOUT | MAGDA | INSZ in de vraag heeft een ongeldige structuur | niet van toepassing |
| Criteria/Periode/Begin | Kleiner dan of gelijk aan systeemdatum | 20006 | FOUT | MAGDA | Een datum in de vraag valt buiten de toegelaten datumrange | niet van toepassing |
| Criteria/Periode/Einde | Kleiner dan of gelijk aan systeemdatum | 20006 | FOUT | MAGDA | Een datum in de vraag valt buiten de toegelaten datumrange | niet van toepassing |
| Criteria/Periode | Criteria/Periode/Begin <= Criteria/Periode/Einde | 20003 | FOUT | MAGDA | Begindatum van de periode moet kleiner of gelijk zijn aan de einddatum | niet van toepassing |
Opmerkingen
Voorbeeld
Vraagcriteria voor het opvragen van enkel de pensioenrechten
<Criteria> <INSZ>01010199797</INSZ> <Periode> <Begin>2018-01-01</Begin> <Einde>2018-12-31</Einde> </Periode> <Pijler>3</Pijler> <Taal>nl</Taal> <RechtenInfo> <EnkelRechten>1</EnkelRechten> </RechtenInfo> </Criteria>
Vraagcriteria voor het opvragen van de pensioenrechten en de minimum set betalingsgegevens m.b.t. de referteperiode
<Criteria> <INSZ>01010199797</INSZ> <Periode> <Begin>2018-01-01</Begin> <Einde>2018-12-31</Einde> </Periode> <Pijler>3</Pijler> <Taal>nl</Taal> <RechtenInfo> <RechtenMetBetalingen> <RechtenMetMinimumBetalingen>1</RechtenMetMinimumBetalingen> <ZoekOpReferteperiode>1</ZoekOpReferteperiode> </RechtenMetBetalingen> </RechtenInfo> </Criteria>
Vraagcriteria voor het opvragen van de pensioenrechten en de maximum set betalingsgegevens m.b.t. de betalingsperiode
<Criteria> <INSZ>01010199797</INSZ> <Periode> <Begin>2018-01-01</Begin> <Einde>2018-12-31</Einde> </Periode> <Pijler>3</Pijler> <Taal>nl</Taal> <RechtenInfo> <RechtenMetBetalingen> <RechtenMetMaximumBetalingen>1</RechtenMetMaximumBetalingen> <ZoekOpBetalingsperiode>1</ZoekOpBetalingsperiode> </RechtenMetBetalingen> </RechtenInfo> </Criteria>
Codetabellen Vraag
| Bron dienstnaam | Element | Van code | Naar code |
|---|---|---|---|
| ConsultPensionRegisterService | Criteria/Pijler | 1 | FIRST |
| ConsultPensionRegisterService | Criteria/Pijler | 2 | SECOND |
| ConsultPensionRegisterService | Criteria/Pijler | 3 | FIRST_AND_SECOND |
| ConsultPensionRegisterService | Criteria/RechtenInfo/RechtenMetBetalingen/ZoekOpReferteperiode | 1 | REFERENCE_PERIOD |
| ConsultPensionRegisterService | Criteria/RechtenInfo/RechtenMetBetalingen/ZoekOpBetalingsperiode | 1 | MONTH_OF_PAYMENT |
Op deze pagina
Binnen deze handleiding
