Verzoekconfiguratie beheren

Label: Configuraties beheren

Endpoints

Pre-productieomgeving

• https://pkio.service.pre.omgevingswet.overheid.nl/overheid/verzoekconfiguratie/api/beheren/v1/

Productieomgeving

• https://pkio.service.omgevingswet.overheid.nl/overheid/verzoekconfiguratie/api/beheren/v1/

Omschrijving

Verzoeknotificatie: instellen versie

De overheidsorganisatie (bevoegd gezag of behandeldienst) die het verzoek moet afhandelen ontvangt een verzoeknotificatie. In deze verzoeknotificatie staan gegevens die het bevoegd gezag nodig heeft om het verzoek op te halen uit de werkmap en in het VTH-systeem of zaaksysteem te laden. Afhankelijk van de STAM-versies die op een bepaald moment in de tijd worden ondersteund, zijn er ook verschillende versies van de verzoeknotificatie die kunnen worden verzonden. Met deze service kan het bevoegd gezag of de behandeldienst aangeven welke versie van de verzoeknotificatie zij willen ontvangen. Zo kunnen ze zelf bepalen wanneer ze willen overstappen naar een nieuwe versie van de verzoeknotificatie.

De versie die wordt opgegeven is de major-versie van de verzoeknotificatie. (Tijdelijk) overstappen van een hogere naar een lagere versie is ook mogelijk, als andere configuratie-instellingen dit toelaten (zie hieronder bij 'Verken uw idee: instellen'). Als er geen versie is ingesteld, ontvangt men automatisch de verzoeknotificatie die hoort bij de oudste, nog ondersteunde versie van STAM. Momenteel worden versie 4 en versie 5 van verzoeknotificatie ondersteund. Het is wel de bedoeling dat het bevoegd gezag of de behandeldienst altijd op termijn overstapt naar de meest actuele versie, omdat alleen de laatste 2 versies worden ondersteund.

Let op! Versie 5 van de verzoeknotificatie bevat breaking changes ten opzichte van versie 4 van de verzoeknotificatie. Bereid u dus goed voor, en test goed voordat u overstapt van versie 4 naar versie 5.

Verzoeknotificatie: opvragen ondersteunde versies

Met deze service kan worden bepaald welke versies kunnen worden gebruikt voor 'Verzoeknotificatie: instellen versie'.

Verken uw idee: instellen

Met deze service kan bevoegd gezag aangeven of zij wel of niet toestaat dat verzoeken van het type 'Idee' bij haar kunnen worden ingediend. Ook moet er een toelichting worden opgegeven, die vervolgens in het omgevingsloket wordt getoond op de pagina waar een gebruiker een overlegpartner kiest.

'Verken uw idee' kan alleen worden ingesteld door het bevoegd gezag zelf,  en niet door (of voor) een bij dit bevoegd gezag horende behandeldienst. Als 'Verken uw idee' niet is ingesteld wordt ervan uitgegaan dat een bevoegd gezag géén 'Verken uw idee' ondersteunt. Er wordt dan een standaardtoelichting getoond. Het is wenselijk dat ook bij een keuze voor niet ondersteunen deze standaardtoelichting wordt vervangen door een eigen toelichting van het bevoegd gezag.

Voor 'Verken uw idee' is versie 5 (of hoger) van de verzoeknotificatie nodig. Deze versie moet eerst zijn ingesteld voordat 'Verken uw idee' op 'ja' kan worden ingesteld. Andersom, als een bevoegd gezag 'Verken uw idee' ondersteunt en dit heeft ingesteld, is het niet mogelijk om een lagere versie dan versie 5 van de verzoeknotificatie te gebruiken.

Gerelateerde services

De services die gebruikt kunnen worden om informatie over ingestelde versies van verzoeknotificaties en instellingen voor 'Verken uw idee' op te vragen maken onderdeel uit van de API Verzoekconfiguratie opvragen.

Standaard- en informatiemodel

• STAM en IMAM