KET-038: Het gebruik van de Header entiteit

Owned by Remco Beverdam
01 aug. , 2024
2 min read

Samenvatting

De entiteit Header is in elk HDN-bericht optioneel. Deze ketenafspraak stelt eisen dat, afhankelijk van de gebruikte HDN Platform API versie, de entiteit juist wel of niet gevuld moet of mag zijn.

Geïntroduceerd in HDN-versie

HDN-23

Geldig vanaf datum

May 13, 2023

Impact op

OfferTeaanvraag (AX) / Beheerverzoek (MX) /Informatieaanvraag (iA)/InformatieBericht (iX)/ KredietAanvraag (KX)/ Levenaanvraag (lx) / Offerte (Ox) / Statusmelding (Sx)/ WaarborgBERICHT (wx)/ Doc.aanvraagBericht (DA)/ DocumentBericht (DX)/

Relevant voor rollen

  • Rol 1: Softwarepakketten (voorkant)

  • Rol 2: Tussenstations zonder aanpassingen

  • Rol 3: Tussenstations met aanpassingen

  • Rol 4: Aanbieder

Type ketenafspraak

  • Berichtvulling

Van toepassing op de velden

 

Van toepassing op de entiteiten

OfferTeaanvraag (AX) / Beheerverzoek (MX) /Informatieaanvraag (iA)/InformatieBericht (iX)/ KredietAanvraag (KX)/ Levenaanvraag (lx) / Offerte (Ox) / Statusmelding (Sx)/ WaarborgBERICHT (wx)/ Doc.aanvraagBericht (DA)/ DocumentBericht (DX)

  • //Header/

Ketenafspraak

Vereisten voor Rol 1: Softwarepakketten (voorkant), Rol 2: Tussenstations zonder aanpassingen, Rol 3: Tussenstations met aanpassingen, Rol 4: Aanbieder

  1. Wanneer HDN Platform API versie 1 in gebruik is, is het verplicht de entiteit //Header/ mee te geven in elk te versturen HDN-bericht.

    1. De gegevens in de //Header/ moeten overeenkomen met de velden in de JSON envelop.
      NB: Deze afspraak is technisch afgedwongen en leidt tot een fout respons van de API en het niet kunnen versturen van het bericht.

  2. Wanneer HDN Platform API versie 2 in gebruik is, is het niet toegestaan de entiteit //Header/ mee te geven in elk te versturen HDN-bericht.

  3. Wanneer HDN Platform API versie 2 in gebruik is en een HDN-bericht ontvangen met daarin de eniteit//Header/, moet het systeem de gegevens hierin negeren.

Aanleiding & achtergrond

Om de volgende stap in de ontwikkeling van het HDN-platform mogelijk te maken is gekozen om de stuurinformatie te scheiden van de inhoudelijke berichtinformatie. Dit betekent dat de //Header/ entiteit uit alle HDN-berichten verdwijnt.

Omdat het wenselijk is dat elke organisatie zelf kan bepalen wanneer de overgang plaats vindt, is gekozen een versie 2 van de HDN Platform API te maken waarin deze stuurinformatie los van het bericht moet zijn meegegeven. Gedurende de overgangsperiode ondersteunt de HDN Standaard beide versies en daarmee is de entiteit //Header/ in elk berichtschema optioneel.

Vanaf de datum dat HDN 24 live gaat (op May 25, 2024 ) is het de bedoeling dat alle organisaties over zijn op versie 2 van de HDN Platform API. Versie 1, en daarmee de //Header/ entiteit, mag dan alleen in het incidenteel geval nog zijn gebruikt, bijvoorbeeld als er een technisch probleem optrad bij de in productiename van de software van de organisatie die deze versie ondersteunt.

Met ingang van HDN25 zal de //Header/ entiteit definitief verwijderd zijn uit alle berichten.