SocZek.GeefPensioen-02.00
Informatie:
Voor de ontsluiting van een MAGDA 2.0 webservice, alsook het generieke proces binnen een 2.0 webservice, wordt verwezen naar Werking en gebruik MAGDA 2.0 Webservices.
De SocZek.GeefPensioen-02.00 is de opvolger van de SocZek.GeefPensioenrechten-02.00 webservice.
Deze webservice biedt een afnemer de mogelijkheid om zowel pensioenrechten als bedragen op te vragen bij het Pensioenkadaster.
Achterliggend roept de Magda webservice de KSZ ConsultPensionRegister webservice op. In functie van de machtigingen kan een afnemer enkel pensioenrechten, pensioenrechten met een minimum set aan betalingsgegevens of pensioenrechten en de maximum set aan betalingsgegevens opvragen.
Situering
Deze webservice kadert binnen het domein SocZek van het MAGDA platform.
Verwante diensten
SocZek.GeefPensioenrechten-02.00: webservice voor het opvragen van de pensioenrechten.
SocZek.PubliceerMutatiePensioenrechten-02.00: publicatie waarmee de informatie m.b.t. pensioenrechten komende van de KSZ ter beschikking worden gesteld van Vlaamse afnemers.
Gegevensbronnen
De gegevens zijn afkomstig van het Pensioenkadaster.
De vraag van een afnemer wordt gerouteerd naar de KSZ, die de eigenlijke opvraging doet bij het Pensioenkadaster.
Meer informatie over hoe deze bronnen gebruikt worden in de opbouw van het antwoord vindt u onder Opvraging.
Opmerking:
Agentschap Digitaal Vlaanderen is afhankelijk van de externe bron(nen) voor de kwaliteit en de aanlevering van de gegevens.
Overlap inschrijvingscontrole
Naast de standaard actieve inschrijving is deze dienst ook beschikbaar met overlap inschrijvingscontrole. Hierbij wordt een periode uit de vraag vergeleken met de periode die gebruikt is bij de Repertorium.RegistreerInschrijving-02.00 dienst. Er moet minimaal 1 dag overlap zijn tussen beide periodes. Bij een actieve inschrijvingscontrole dient het INSZ actief te zijn in het inschrijvingsrepertorium op het moment van verwerking van de vraag.
Begin- en eindatum van de periode uit de vraag
Volgende elementen worden gebruikt als begin- en einddatum
| Pad | Opmerking |
---|---|---|
Begindatum | /Inhoud/Criteria/Periode/Begin |
|
Einddatum | /Inhoud/Criteria/Periode/Einde |
|
Gebruiksvoorwaarden
Afnemers moeten aan volgende voorwaarden voldoen om deze dienst te mogen gebruiken:
Toelating tot het MAGDA platform;
Een machtiging hebben van de kamer sociale zekerheid en gezondheid van het informatieveiligheidscomité.
Informatie:
Meer informatie over deze voorwaarden is terug te vinden op de pagina “Machtigingen en toelatingen”.
Meer informatie over het aansluitingsproces is terug te vinden op deze webpagina.
Batch
Deze webservice is eveneens beschikbaar in een batch-variant (enkel XML). Voor meer informatie: Webservice In Batch bevragen.
Prefix | soczek.geefpensioen-0200 |
---|---|
Voorbeeld | soczek.geefpensioen-0200_20131103115553530.xml |
Functionaliteiten
De GeefPensioen 2.0 businessdienst maakt het mogelijk om pensioen gegevens die voldoen aan specifieke zoekcriteria te verkrijgen.
Vraag
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
extra zoekparameters om aan te geven welke gegevens gewenst zijn:
enkel pensioenrechten
pensioenrechten en minimum betalingen + aanduiding of de betalingen op de referteperiode dan wel de betalingsperiode betrekking hebben
pensioenrechten en maximum betalingen + aanduiding of de betalingen op de referteperiode dan wel de betalingsperiode betrekking hebben
de taal waarin eventuele code omschrijvingen getoond moeten worden
In functie van de verkregen machtiging wordt het gebruik van de bijkomende zoekparameters beperkt. Wanneer een afnemer gegevens wenst op te vragen waarvoor geen machtiging is verkregen, wordt dit kenbaar gemaakt met foutmelding "13102 - Een vraagelement bevat een niet toegelaten waarde".
Antwoord
Als antwoord verkrijgt de afnemer een overzicht van de pensioengegevens gegroepeerd per betalingsinstelling.
Afhankelijk van de vraag criteria bevat het antwoord minimaal de pensioenrechten per betalingsinstelling.
In functie van de zoek parameters kunnen per recht ook de bijhorende betalingen aanwezig zijn in het antwoord; dit kan een minimum set aan gegevens zijn of de maximum set.
De consultatieperiode van de betalingen heeft betrekking op de referteperiode of de betalingsperiode van de pensioenbetaling, ook weer in functie van de opgegeven zoek parameter.
Werking
Opties
Volgende configuratieparameters kunnen ingesteld worden in functie van de machtigingen en de wensen van de afnemer:
KSZ legal context op te zetten voor elke gebruiker (URI/HC)
Routering naar achterliggende bron dienst/operatie voor elke gebruiker (URI/HC) in functie van de machtigingen
Opvraging
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.
Vervolgens gebeurt een functionele validatie van de vraag criteria:
het identificatie nummer van de persoon moet een geldig INSZ zijn
de opgegeven periode moet geldig zijn, m.a.w. de begindatum moet kleiner dan of gelijk aan de einddatum zijn
Met de extra zoek parameters kan de afnemer - in functie van de verkregen machtiging - aangeven welke gegevens opgevraagd moeten worden:
enkel de pensioenrechten
pensioenrechten en minimum betalingsgegevens
pensioenrechten en maximum betalingsgegevens
Indien de afnemer niet over de juiste machtiging beschikt om de gespecificeerde informatie te verkrijgen, zal dit via foutmelding "60018 - De vraag is niet in overeenstemming met de machtiging of met de routeringsopzet" in het antwoord aangegeven worden.
Responsetijden & Beschikbaarheid
De webservice op het MAGDA platform is 24 uur op 24 en 7 dagen op 7 beschikbaar.
Logging
De opvragingen die gebeuren via deze webservice worden bewaard zoals beschreven op de pagina "MAGDA logging".
Ondersteunde talen
Deze dienst wordt enkel ondersteund in de Nederlandste taal.
Op deze pagina
Binnen deze handleiding
Omgevingsinformatie
Domein | SocZek |
---|---|
Classificatie | Persoonsgegevens |
Verwante diensten
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