Search

Webservice

Met behulp van de URM-DB webservice is het mogelijk om de URM aanspraak voor een deelnemer te bepalen. Deze service kan gebruikt worden om voor 1 deelnemer 1 URM aanspraak te berekenen. Voor het berekenen van meerdere aanspraken in 1 request (meerdere aanspraken per deelnemer en/of meerdere deelnemers), dient de Webservice batch pagina bekeken te worden. Hieronder wordt beschreven welke operation gebruikt moet worden voor de URM-DB webservice en hoe een request en response eruit zien.

Operation

Voor de URM-DB webservice is een specifieke operation 'URM' beschikbaar. De URL van de webservice en het maken van een test in Soap UI worden toegelicht op deze pagina.

Request

Een request ziet er als volgt uit:

<urm:data xmlns:urm="http://www.actuit.nl/URM">
    <urm:algemeen>
        <urm:scenariosetDNB/>
        <urm:haalbaarheidstoets/>
        <urm:showDetails/>
        <urm:klantcode>{{code}}</urm:klantcode>
        <urm:scenario/>
    </urm:algemeen>
    <urm:deelnemers>
        <urm:deelnemer>
            <urm:id>12345</urm:id>
            <urm:status>deelnemer</urm:status>
            <urm:datum_stand>1-1-2019</urm:datum_stand>
            <urm:aanspraken>
                <urm:aanspraak>
                    <urm:id>OP67</urm:id>
                    <urm:status>actief</urm:status>
                    <urm:pensioenberekeningsdatum>1-7-2040</urm:pensioenberekeningsdatum>
                    <urm:opgebouwd_OP>27500</urm:opgebouwd_OP>
                    <urm:bereikbaar_OP/>
                    <urm:opgebouwd_OP_ambitie>27500</urm:opgebouwd_OP_ambitie>
                    <urm:opbouw>
                        <urm:cohort eind="1-1-2030">2500</urm:cohort>
                        <urm:cohort eind="1-1-2035">1500</urm:cohort>
                        <urm:cohort eind="1-7-2040">1000</urm:cohort>
                    </urm:opbouw>
                </urm:aanspraak>
            </urm:aanspraken>
        </urm:deelnemer>
    </urm:deelnemers>
</urm:data>

scenariosetDNB

Deze parameter is optioneel. Wanneer deze waarde leeg of niet aanwezig is, wordt de default scenarioset gehanteerd. Het kiezen van de default scenarioset kan worden gedaan met behulp van de Management Site. Meer uitleg over de Management Site is te vinden op deze support pagina. Met behulp van deze parameter is het mogelijk om een andere scenarioset te hanteren dan de default scenarioset (De gehanteerde scenarioset moet wel aanwezig zijn). Een mogelijke waarde is bijvoorbeeld 'HBT scenarioset 2019 Q2'. 

haalbaarheidstoets

Deze parameter is optioneel. Wanneer deze waarde leeg is of niet aanwezig, wordt de default haalbaarheidstoets gebruikt. Met behulp van deze parameter is het mogelijk om een andere haalbaarheidstoets te hanteren. Het selecteren van een andere haalbaarheidstoets kan hierbij worden uitgevoerd door de naam van de folder, waarin de haalbaarheidstoets staat, mee te geven in deze parameter.

showDetails

Deze parameter is optioneel. Mogelijke waarden zijn 'true' en 'false'. Wanneer de waarde 'true' wordt meegegeven, worden meer details van de berekening terug gegeven. Hierin worden tussenresultaten van de berekening ook getoond. Let op, de optie showDetails is enkel voor ontwikkel doeleinden. Op productie dient deze op 'false' gezet te worden, aangezien dit een grote impact kan hebben op de performance van de webservice.

klantcode

Deze parameter is verplicht. De aanroep naar de URM DB berekening is enkel mogelijk als het fonds en de meegegeven code behoren tot de juiste klant. ActuIT zal u deze klantcode geven. Vervang vervolgens {{code}} door deze waarde, om een URM DB berekening uit te voeren.

scenario

Deze parameter is optioneel. De URM DB webservice maakt een berekening over alle 2000 scenario's en geeft vervolgens de percentielen 5%, 50% en 95% terug. Met behulp van deze parameter is het ook mogelijk om een specifiek scenario te berekenen. Default worden alle 2000 scenario's berekend. Mogelijke waarden zijn alle gehele getallen tussen de 1 en 2000.

id deelnemer

Dit is een id van de deelnemer die wordt meegegeven. Hiermee is zichtbaar welke response bij welk request hoort.

status deelnemer

Dit is de status van de deelnemer die wordt meegegeven. De mogelijke waarden zijn:

  • deelnemer
  • gewezen_deelnemer
  • gepensioneerde

Bij een gepensioneerde deelnemer wordt de aanspraak URM per datum_stand voor de komende 10 jaar terug gegeven. Bij een deelnemer of gewezen_deelnemer, wordt de aanspraak URM op pensioenberekeningsdatum gegeven.

datum_stand

Dit is de datum stand, waarop het opgebouwd_OP is bepaald. Vanaf deze datum stand wordt doorgerekend en wordt de uiteindelijke aanspraak bepaald. Deze datum wordt gegeven in het format 'd-M-yyyy'.

id aanspraak

Dit is een id van de aanspraak die wordt berekend. Hiermee is zichtbaar welke response bij welk request hoort.

status aanspraak

Dit is de status van de aanspraak. Mogelijke waarden zijn:

  • actief
  • niet_actief

Afhankelijk van deze status, wordt bepaald welke indexatie uit de haalbaarheidstoets gehanteerd wordt. Toelichting over de haalbaarheidstoets is te vinden op deze pagina.

pensioenberekeningsdatum

Dit is de datum waarop de aanspraak URM berekend moet worden. Wanneer de deelenemer status gelijk is aan 'gepensioneerde' hoeft de pensioenberekeningsdatum niet meegegeven te worden. Op dit moment wordt vanaf datum_stand de aanspraak teruggegeven voor de volgende 10 jaar. Wanneer de pensioenberekeningsdatum wel wordt meegegeven bij een deelnemer met status 'gepensioneerde', wordt de aanspraak op pensioenberekeningsdatum teruggegeven. De datum moet voldoen aan het format 'd-M-yyyy'.

opgebouwd_OP

Met deze parameter wordt het opgebouwde OP op datum_stand meegegeven. De waarde moet gegeven worden volgens het format '#.##0,##'. Een scheidingsteken bij duizendtallen is hierbij optioneel. Mogelijke invoer aan de hand van bovenstaand voorbeeldrequest zijn '27500', '27.500', '27500,00' of '27.500,00'.

bereikbaar_OP

Deze waarde geeft het bereikbaar OP weer op de pensioenberekeningsdatum. Het bereikbaar OP is niet benodigd als de deelnemer status 'gepensioneerde' is of als de opbouw per cohort wordt meegegeven. De waarde moet gegeven worden volgens het format '#.##0,##'. Zie opgebouwd_OP voor verdere toelichting voor dit format.

opgebouwd_OP_ambitie

Deze parameter is optioneel. Wanneer in de instellingen is ingesteld dat de ambitie niet wordt gebruikt, is deze parameter niet benodigd. Indien gebruik gemaakt wordt van ambitie, dient hier het opgebouwde OP meegegeven te worden, die bij de ambitie gebruikt wordt. De waarde moet gegeven worden volgens het format '#.##0,##'. Zie opgebouwd_OP voor verdere toelichting voor dit format.

opbouw

Naast het gebruiken van een opgebouwd en bereikbaar OP om de opbouw per jaar te bepalen, is het ook mogelijk om een vector mee te geven waarin de opbouw voor verschillende tijdvakken gedefinieerd is. Hierin wordt per cohort aangegeven tot welke datum deze loopt en wat de opbouw is. Op deze manier is het mogelijk om per tijdvak een andere opbouw te gebruiken. De waarde moet gegeven worden volgens het format '#.##0,##'. Zie opgebouwd_OP voor verdere toelichting voor dit format. Per cohort wordt enkel de eind datum gegeven. De begin datum van een cohort is gelijk aan de eind datum van het vorige cohort, waarbij het eerste cohort begint bij datum_stand. De einddatum van het laatste cohort dient gelijk te zijn aan de pensioenberekeningsdatum. Het opbouw element is optioneel en vervangt het vaststellen van de jaarlijkse opbouw met behulp van het opgebouwde en bereikbare OP. Indien u gebruik maakt van het opbouw element kunt u derhalve het bereikbare OP uit de request weglaten. Indien u wel een waarde invult, wordt deze niet gebruikt. In plaats daarvan wordt de opbouw zoals gedefinieerd binnen de opbouw vector gebruikt.

Response

Een response van bovenstaand request ziet er als volgt uit:

<urm:output xmlns:urm="http://www.actuit.nl/URM">
    <urm:uitgangspunten>
        <urm:algemeen>
            <urm:scenariosetDNB/>
            <urm:haalbaarheidstoets/>
            <urm:showDetails/>
            <urm:klantcode>{{code}}</urm:klantcode>
            <urm:scenario/>
        </urm:algemeen>
    </urm:uitgangspunten>
    <urm:deelnemers>
        <urm:deelnemer>
            <urm:deelnemergegevens>
               <urm:id>12345</urm:id>
               <urm:status>deelnemer</urm:status>
               <urm:datum_stand>1-1-2019</urm:datum_stand>
            </urm:deelnemergegevens>
            <urm:aanspraken>
                <urm:aanspraak>
                    <urm:uitgangspunten>
                        <urm:id>OP67</urm:id>
                        <urm:status>actief</urm:status>
                        <urm:pensioenberekeningsdatum>1-7-2040</urm:pensioenberekeningsdatum>
                        <urm:opgebouwd_OP>27.500</urm:opgebouwd_OP>
                        <urm:opgebouwd_OP_ambitie>27.500</urm:opgebouwd_OP_ambitie>
                        <urm:opbouw>
                            <urm:cohort eind="1-1-2030">2500</urm:cohort>
                            <urm:cohort eind="1-1-2035">1500</urm:cohort>
                            <urm:cohort eind="1-7-2040">1000</urm:cohort>
                        </urm:opbouw>
                    </urm:uitgangspunten>
                    <urm:aanspraak_URM>
                        <urm:percentiel5>
                           <urm:aanspraak datum="1-7-2040">19.550,98</urm:aanspraak>
                        </urm:percentiel5>
                        <urm:percentiel50>
                           <urm:aanspraak datum="1-7-2040">26.098,50</urm:aanspraak>
                        </urm:percentiel50>
                        <urm:percentiel95>
                           <urm:aanspraak datum="1-7-2040">33.989,70</urm:aanspraak>
                        </urm:percentiel95>
                    </urm:aanspraak_URM>
                </urm:aanspraak>
            </urm:aanspraken>
        </urm:deelnemer>
    </urm:deelnemers>
</urm:output>

aanspraak

Deze waarden geven de URM aanspraken weer. De URM aanspraken worden standaard teruggegeven voor de percentielen 5, 50 en 95. Naast de aanspraak URM, wordt in de response ook de datum teruggegeven, waarop deze aanspraak berekend is. In de uitleg van de request is meer te vinden over de datum die in de aanspraak wordt teruggegeven. Indien status deelnemer in de aanroep gelijk is aan 'gepensioneerde', worden de aanspraken voor de komende 10 jaar terug gegeven. Anders wordt enkel de aanspraak op de pensioenberekeningsdatum terug gegeven.

De overige parameters in de response, geven de waarde uit deze parameter uit de request weer. Zie de request voor toelichting over deze parameter.

Updated: 22-07-2019