KET-041: Het gebruik van requestversion in HDN-berichten
Samenvatting | Deze ketenafspraak beschrijft hoe om te gaan met een gewijzigde aanvraag en |
---|---|
Geïntroduceerd in HDN-versie | HDN-24 |
Geldig vanaf datum | May 25, 2024 |
Impact op | OfferTeaanvraag (AX)/KredietAanvraag (KX)/ Levenaanvraag (lx)/WaarborgBERICHT (wx) / DocumentBericht (DX) / Doc.aanvraagBericht (DA) |
| |
Type ketenafspraak |
|
Van toepassing op de velden | API
Statusmelding (Sx)
|
Van toepassing op de entiteiten | Statusmelding (Sx)
|
Ketenafspraak
Vereisten voor rol 1 Softwarepakketten (voorkant)
Bij het versturen van een het eerste bericht in een dossier is het verplicht het veld
requestVersion
in de JSON met1
te vullen.Het is alleen toegestaan een nieuwe
requestVersion
te introduceren bij het versturen van een bericht met één van de volgendemessageType
OfferTeaanvraag (AX)/KredietAanvraag (KX)/ Levenaanvraag (lx)/ WaarborgBERICHT (wx).Het is niet toegestaan binnen een dossier twee keer een HDN-bericht van hetzelfde
messageType
,receiver
,sender
enrequestVersion
te versturen.Dit geldt alleen voor de volgende
messageType
OfferTeaanvraag (AX)/KredietAanvraag (KX)Levenaanvraag (lx) /WaarborgBERICHT (wx).
Wanneer er een nieuwe aanvraag ingediend wordt is het verplicht de huidige
requestVersion
met1
te verhogen.
Ter verduidelijking: ‘huidige' betekent een bericht van elkmessageType
, dus ook Doc.aanvraagBericht (DA), Offerte (OX)en StatusMelding (SX) . Hiermee wordt voorkomen dat een HDN-bericht verderop in de keten wordt verhoogd en er daardoor meerdere keren dezelfderequestVersion
wordt gemaakt.
Voorbeeld: Rol 1: Softwarepakketten stuurtrequestVersion
1
naar een Rol 3: Tussenstations met aanpassingen. Deze maakt een wijziging en introduceertrequestVersion
2
. De aanbieder stuurt daarop een StatusMelding (SX) metrequestVersion
2
terug. De serviceprovider stuurt deze weer terug naar het adviespakket. Wanneer een intermediair een wijziging in de aanvraag wil doorvoeren moet de nieuwerequestVersion
de waarde3
hebben. Deze moet gebaseerd zijn het op het laatste bericht dat het adviespakket heeft ontvangen, de StatusMelding (SX)(2
) +1
=3
.Wanneer een nieuwe
requestVersion
bekend is, is het niet toegestaan om te reageren op berichten van de ouderequestVersion
.
Ter verduidelijking: Het is niet toegestaan nog een DocumentBericht (DX) te versturen als reactie te versturen op een Doc.aanvraagBericht (DA) met een verouderderequestVersion
. Om documenten te versturen is een Doc.aanvraagBericht (DA) met de nieuwerequestVersion
nodig.Uitzondering: Dit geldt niet indien de nieuwe
requestVersion
niet geaccepteerd is bij de aanbieder, zie daarvoor punt 3 bij Rol 4: Aanbieder. In dat geval moet de ouderequestVersion
gehandhaaft blijven.
Het is verplicht een ontvangen bericht met een onbekende
requestVersion
te verwerken.
Achtergrond: Deze regel is noodzakelijk omdat het mogelijk is dat ook Rol 3: Tussenstations met aanpassingen een nieuwerequestVersion
kan introduceren. Rol 1: Softwarepakketten kan dus ook retourberichten ontvangen op eenrequestVersion
die nog niet bekend is.
Vereisten voor Rol 2: Tussenstations zonder aanpassingen
Het is niet toegestaan een nieuwe
requestVersion
in het dossier te introduceren.Het is verplicht een aanvraag met een
requestversion
>1 te kunnen herkennen en verwerken.Het is niet toegestaan binnen een dossier twee keer een HDN-bericht van hetzelfde
messageType
,receiver
,sender
enrequestVersion
te versturen.Dit geldt alleen voor de volgende
messageType
OfferTeaanvraag (AX)/KredietAanvraag (KX)/ WaarborgBERICHT (wx)/LevenAanvraag (LX).
Wanneer een nieuwe
requestVersion
bekend is, is het niet toegestaan om te reageren op berichten van de ouderequestVersion
.
Ter verduidelijking: Het is niet toegestaan nog een DocumentBericht (DX) te versturen als reactie te versturen op een Doc.aanvraagBericht (DA) met een verouderderequestVersion
. Om documenten te versturen is een Doc.aanvraagBericht (DA) met de nieuwerequestVersion
nodig.Uitzondering: Dit geldt niet indien de nieuwe
requestVersion
niet geaccepteerd is bij de aanbieder, zie daarvoor punt 3 bij Rol 4: Aanbieder. In dat geval moet de ouderequestVersion
gehandhaaft blijven.
Het is verplicht een ontvangen bericht met een onbekende
requestVersion
te verwerken.
Achtergrond: Deze regel is noodzakelijk omdat het mogelijk is dat ook Rol 3: Tussenstations met aanpassingen een nieuwerequestVersion
kan introduceren. Rol 2: tussenstations zonder aanpassing kan dus ook retourberichten ontvangen op eenrequestVersion
die nog niet bekend is.
Vereisten voor Rol 3: Tussenstations met aanpassingen
Het is verplicht de
requestVersion
te wijzigen wanneer een bericht wordt doorgestuurd waarin afwijkingen zitten ten opzicht van het ontvangen HDN-bericht.Hierop zijn uitzonderingen, zie KET-027: Niet toegestane wijzigingen op een lopende aanvraag , Rol 3, punt 4.
Het is niet toegestaan binnen een dossier twee keer een HDN-bericht van hetzelfde
messageType
,receiver
,sender
enrequestVersion
te versturen.Dit geldt alleen voor de volgende
messageType
OfferTeaanvraag (AX)/KredietAanvraag (KX)/ WaarborGBERICHT (wx)/LevenAanvraag (LX).
Het is verplicht een aanvraag met een
requestversion
> 1 te kunnen herkennen en verwerken.Wanneer een aanvraagbericht wordt ontvangen met een
requestVersion
welke al bekend is, is het verplicht dit bericht door te sturen met een ge-updaterequestVersion
, welke 1 hoger is dan derequestVersion
die bekend is.
Voorbeeld: Rol 3: Tussenstations met aanpassingen verhoogt derequestVersion
van een ontvangen aanvraag naar2
en stuurt deze door. Als op een later moment ook een organisatie in Rol 1: Softwarepakketten derequestVersion
verhoogt en hierbij ook2
gebruikt, moet de organisatie in Rol 3: Tussenstations met aanpassingen dezerequestVersion
verhogen naar3
.Wanneer er gekozen wordt om
requestVersion
te wijzigen wordt deze bepaald door het laatste verstuurde of ontvangen bericht van hetzelfdemessageType
in het dossier. Dit wordt als volgt berekend: derequestVersion
van het bericht van hetzelfdemessageType
die als laatste ontvangen of verstuurd is wordt verhoogd met1
.Wanneer een nieuwe
requestVersion
bekend is, is het niet toegestaan om te reageren op berichten van de ouderequestVersion
.
Voorbeeld: Het is dus niet toegestaan nog een Documentbericht (DX) te versturen als reactie op een Doc.aanvraagBericht (DA) met een verouderderequestVersion
. Om documenten te versturen woordt gewacht op een Doc.aanvraagBericht (DA) met de nieuwerequestVersion
.
Ter verduidelijking: Dit betekent ook dat zodra een nieuwerequestVersion
door een organisatie in Rol 1: Softwarepakketten of Rol 2: tussenstations zonder aanpassing is aangemaakt het alleen nog toegestaan is om het bericht door te sturen. Het is dus niet toegestaan nog een Documentbericht (DX) te versturen met de ouderequestVersion
.
Uitzondering: Dit geldt niet indien de nieuwerequestVersion
niet geaccepteerd is bij de aanbieder, zie daarvoor punt 3 bij Rol 4: Aanbieder. In dat geval is het toegestaan om berichten met de ouderequestVersion
uit te wisselen.
Vereisten voor Rol 4a: Aanbieder: Hypotheken, Rol 4b: Aanbieder: Verzekeren, Rol 4c: Aanbieder: Kredieten, Rol 4e: Aanbieder: Waarborgen
Het is niet toegestaan een nieuwe
requestVersion
in het dossier te introduceren.Het is verplicht een aanvraag met een
requestversion
> 1 op te kunnen halen.Indien een verhoogde
requestVersion
niet acceptabel is moet de aanbieder een Statusmelding (Sx) versturen.Deze Statusmelding (Sx) moet de volgende informatie bevatten:
In geval van OfferTeaanvraag (AX):
//Status/AXBerichtStatusSpecificatie/StatusAXBericht
gevuld met25 Offerteaanvraag technisch niet te verwerken
.In geval van KredietAanvraag (KX):
//Status/KXBerichtStatusSpecificatie/StatusKXBericht
gevuld met25 Kredietaanvraag technisch niet te verwerken
.In geval van WaarborgBERICHT (wx):
//Status/WXBerichtStatusSpecificatie/StatusWXBericht
gevuld met03 Bankgarantieaanvraag niet te verwerken, zie toelichting
.In geval van LevenAanvraag (LX):
//Status/LXBerichtStatusSpecificatie/StatusLXBericht
gevuld met13 Levenaanvraag niet te verwerken, zie toelichting.
Ter verduidelijking: Dit scenario kan optreden wanneer een aanbieder geen gewijzigde aanvraag kan ontvangen (bijvoorbeeld de scenario’s uit Wijziging op lopende aanvragenarchived ) of wanneer de aanbieder in het geheel geen gewijzigde aanvragen ondersteunt.
In de
//StatusTekstRegels/
entiteit van deze Statusmelding (Sx) moet minimaal een tekst staan met de volgende strekking: “Aanvraagversie wordt niet ondersteund”.
Wanneer een nieuwe
requestVersion
bekend is bij de organisatie is het niet toegestaan om te reageren op berichten van de ouderequestVersion
.
Voorbeeld: Het is dus niet toegestaan nog een Statusmelding (Sx) te versturen waarin bijvoorbeeld de vorigerequestVersion
wordt beëindigd.
Ter verduidelijking: Dit betekent ook dat het voor de de rest van de keten bijvoorbeeld niet toegestaan is om eendocumentBericht (DX) te sturen. Dit kan pas weer als er een nieuw Doc.aanvraagBericht (DA) bericht is opgestuurd, waarin de nieuwerequestVersion
staat.Uitzondering:Deze regel geldt niet indien de nieuwe
requestVersion
niet geaccepteerd wordt, zie daarvoor punt 3. In dat geval is het toegestaan berichten met de oude versie te blijven versturen.
Aanleiding en achtergrond
Deze ketenafspraak beschrijft hoe om te gaan met een gewijzigde aanvraag. Dit voorkomt onduidelijkheden wanneer en voor wie het mogelijk is om een wijziging in de requestVersion
door te voeren, en wat er nog toegestaan is nadat er een nieuwe requestVersion
is.