Verzoek indienen
Een REST API waarmee een verzoek kan worden ingediend, zonder gebruik te maken van de gebruikerstoepassing "Aanvragen" van het Omgevingsloket.
Label: Vergunningcheck en indienen
Endpoints
Pre-productieomgeving
https://service.pre.omgevingswet.overheid.nl/publiek/verzoeken/api/indienen/v3/
https://service.pre.omgevingswet.overheid.nl/publiek/verzoeken/api/indienen/v4/
Productieomgeving
https://service.omgevingswet.overheid.nl/publiek/verzoeken/api/indienen/v3/
https://service.omgevingswet.overheid.nl/publiek/verzoeken/api/indienen/v4/
Omschrijving
Met de "Verzoek indienen" API kan in een aantal stappen een verzoek ingediend worden. Deze stappen worden hieronder beschreven. Voor elke stap is een aparte service. Niet alle stappen zijn verplicht.
Eerste stap
De eerste stap in het proces bestaat uit het initiëren van het indienproces. Dit is een verplichte stap. Het resultaat van de aanroep van de bij deze stap behorende service bevat een link naar het verzoek én een link voor elk toe te voegen document. Ook wordt een (tijdelijke) verzoekidentificatie in het resultaat mee teruggegeven. Voor het verzoektype "Idee", het type dat hoort bij de functionaliteit "Ideeverkenning", wordt een ander endpoint gebruikt dan bij de overige verzoektypen (zie ook STAM).
De payload van de service bestaat uit een “indienbericht”. Een indienbericht bestaat uit de volgende onderdelen:
- Algemene gegevens, waaronder het verzoektype (bijvoorbeeld "Aanvraag vergunning" en het doel van het verzoek (bijvoorbeeld “Initiëren”), etc.
- OIN van het bevoegd gezag.
- Activiteit(en). Dit betreft de juridische activiteiten waarop het indienbericht betrekking heeft.
- Locatie, zowel bronlocatie als geometrie in RD-formaat. Dit betreft de locatie waar de in het indienbericht genoemde activiteit(en) worden uitgevoerd.
- Een lijst met vragen die een algemeen karakter hebben, bijvoorbeeld gegevens over de aanvrager en/of diens gemachtigde.
- Een lijst met specifieke vragen over de in het indienbericht genoemde activiteit(en) (niet van toepassing bij "Ideeverkenning").
De Verzoek indienen service valideert de onderdelen van het indienbericht met behulp van de service “Indieningsvereisten bepalen” (onderdeel van de API “Uitvoeren services"): als niet aan de indieningsvereisten wordt voldaan dan is het indienbericht niet valide. Deze service is bedoeld om de actuele en correcte vragenlijsten op te halen. Om deze reden is het gebruik van deze service ook voor de afnemers van “Verzoek Indienen” onmisbaar.
Bij "Ideeverkenning" wordt voor dezelfde processtap een ander endpoint gebruikt. Het belangrijkste verschil met het endpoint voor de overige verzoektype is dat er hier geen verzoektype, geen projectactiviteiten en (dus) ook geen vragenlijsten worden opgegeven. Er vindt dus ook geen validatie plaats zoals dat bij de overige verzoektypen gebeurt.
Hoewel het indienbericht geen deel uitmaakt van de STAM-standaard kan deze standaard wel worden gebruikt om meer inzicht te geven in de specifieke betekenis van de verschillende onderdelen van het indienbericht.
Toevoegen
In deze (optionele) stap kunnen documenten (bijlagen) worden toegevoegd aan het verzoek. Documenten worden gescand op virussen, en gecontroleerd op omvang en toegestane formaten. Ook hier geldt dat er bij verzoeken van een type "Verken uw idee" een ander endpoint moet worden gebruikt.
Indienen
De indiening van het verzoek en eventueel toegevoegde documenten wordt in deze stap afgerond. De service retourneert onder meer het verzoeknummer, waaronder het verzoek wordt doorgegeven naar het bevoegd gezag. Het is de laatste, (verplichte) stap in het proces van indienen. Als deze stap niet wordt uitgevoerd binnen 24 uur nadat het indienproces is geïnitieerd dan wordt de indiening afgebroken en is er (dus) geen verzoek ingediend.
Ophalen
Door het (nog niet volledig ingediende) verzoek op te halen krijgt men het verzoek en (nogmaals) de link voor het toevoegen van documenten.
Verwijderen
Hiermee verwijdert men het (deels) ingediende verzoek, dus voordat de indiening werd afgerond. Dit is bedoeld om het hele proces tussentijds af te breken. Een eenmaal ingediend verzoek kan niet meer via deze weg worden verwijderd. Een ingediend verzoek kan alleen nog worden ingetrokken, zie de volgende kop.
Aanvullen en intrekken
Naast ingediend kan een verzoek ook worden aangevuld of ingetrokken. Voor het intrekken van een verzoek dient alleen de eerde benoemde eerste stap en de stap indienen te worden gevolgd. Via aanvullen kunnen aan een ingediend verzoek nieuwe of gewijzigde antwoorden worden toegevoegd en/of bestaande verwijderd. Ook kunnen bijlagen worden verwijderd en/of toegevoegd. Een aanvulling moet altijd een compleet verzoek zijn en vervangt de voorgaande versie van het verzoek. Op deze manier kan ook door worden gegeven dat bestaande informatie uit het oorspronkelijke verzoek niet meer relevant is.
Met intrekken wordt het gehele ingediende verzoek verwijderd, waarna het bevoegde gezag de verdere behandeling van het verzoek zal stoppen.
Standaard en informatiemodel
Delen
Status
Versie 3 en 4 zijn beschikbaar in de pre-productieomgeving en productieomgeving.
Versie 3 is beschikbaar tot december 2024.
API specificaties
Meer informatie
Deze service is van belang bij het ontwikkelen van toepassingen met vragenbomen.
Authenticatie
De API kan afgenomen worden met 'access tokens', die verkregen kunnen worden na authenticatie van de initiatiefnemer (of gemachtigde) van het in te dienen verzoek op de DSO identity server. Die authenticatie wordt gedaan op de DSO Identity Server met OpenIDConnect 2.0 (Authorisation Code Flow). Hiervoor zijn enkele voorwaarden: de applicaties moeten geregistreerd zijn bij de DSO identity server, ze voldoen aan de aansluitcriteria en hebben de acceptatietest doorstaan.
Aanmelden
Wilt u gebruikmaken van deze API, dan kunt u zich hier aanmelden:
Feedback
Geef feedback op deze service. Ga naar het forum om bevindingen te delen.