Inzage
Benodigde API
Voor het opvragen van voorstellen dient uw applicatie geabonneerd te zijn op onderstaande API via het API Devportal.
| API | |
|---|---|
| advice | V1 |
Voorstellen
Maandelijks worden de voorstellen twee weken voorafgaande aan de prolongatie klaargezet. Wanneer de prolongatie eenmaal is gestart, zijn de voorstellen niet meer op te halen.
Voorbeeld:
- Pakket heeft een hoofdvervaldatum op 1 november
- Premieberekening voor de prolongatie vindt plaats op 27 september
- Voorstellen worden klaargezet rond 13 september
- De voorstellen van pakketten met een hoofdvervaldatum in november zijn zichtbaar tussen 13 en 27 september
Een gepagineerde lijst van voorstellen kan opgevraagd worden via onderstaand API endpoint.
/advice
De gesorteerde resultaten kunnen beperkt worden door het toepassen van filters of zoekopdrachten in de request body. Ieder voorstel dat wordt geretourneerd heeft een ID, welke gebruikt kan worden om gedetailleerde informatie van een voorstel op te halen.
Details
Informatie rondom een voorstel kan opgehaald worden met onderstaand API endpoint.
/advice/{adviceId}
De response bevat gedetailleerde informatie over de huidige situatie, de situatie na prolongatie en de situatie na het opvolgen van een voorstel.
| BaselineCalculation | De huidige situatie met premies zoals ze nu op de polis staan |
| RenewalCalculation | De situatie zoals deze zou zijn na prolongatie zonder opvolging van het voorstel |
| AdviceCalculation | De situatie zoals deze zou zijn na opvolging van het voorstel |
Om de tarieven in bovenstaande situaties goed te kunnen vergelijken, kan onderstaand API endpoint worden gebruikt.
/advice/{adviceId}/details