API-register: Overzicht

De Ruimtelijke Plannen API is een aanvullende dienst ten opzichte van de diensten die Ruimtelijkeplannen.nl aanbiedt. De verantwoordelijkheid voor de Ruimtelijke Plannen API ligt bij Informatiehuis Ruimte. Tot de doelgroep van de Ruimtelijke Plannen API behoren de in ruimtelijke plannen geïnteresseerde personen met een sterke focus op de professionals. Van professionele gebruikers valt te verwachten dat deze deels vragen hebben die in een ruimere context gesteld moeten worden dan alleen ruimtelijke plannen. De Ruimtelijke Plannen API ontsluit echter alleen ruimtelijke plannen en geen informatie van andere thema’s. Voor de transformatie van coördinaten maken we gebruik van RDNAPTRANS.

Professionele gebruikers kunnen gebruik maken van de Ruimtelijke Plannen API van Informatiehuis Ruimte om ruimtelijke plannen op te halen en deze binnen hun eigen informatiehuishouding te combineren met andere gegevensdiensten of lokale (geo-)informatie. Dat is dan ook de plek om functionaliteit aan te bieden voor complexe vragen. Te denken valt daarbij aan de combinatie van ruimtelijke plannen met thematische (geo-)informatie als waterkansenkaart, geluidscontouren, etc.

Kortom de Ruimtelijke Plannen API is bedoeld voor geavanceerde en/of proces specifieke toepassingen, binnen de eigen informatiehuishouding. Het is alleen mogelijk informatie met betrekking tot de ruimtelijke plannen af te nemen en niet de onderliggende topografie en luchtfoto’s.

LET OP. Tot inwerkingtreding (IWT) van de Omgevingswet moet de gebruiker van deze API ermee rekening houden dat er oefencontent in de IHR datastore aanwezig kan zijn. Het is mogelijk dat deze oefencontent wordt uitgeserveerd bij het bevragen van deze API. De gebruiker van deze API wordt daarom dringend geadviseerd een disclaimer op te nemen in de toepassingen waarbinnen deze API ingezet wordt.

Specifieke, samengestelde services met betrekking tot de Registratie Toepasbare Regels.

Het ophalen van vragen en het beantwoorden van vragen (Toepasbare Regels) ten behoeve van

1. de vergunningcheck (het checken wat een initiatiefnemer moet doen, bijv. een vergunning aanvragen),
2. het opstellen van een aanvraag en/of melding of
3. het checken welke maatregelen nodig zijn

De uitkomst van het checken is een conclusie, de uitkomst van het opstellen is of deze indienbaar en compleet is. De uitkomst van maatregelen zijn verwijzingen naar de voorschriften met bijbehorende maatregelen. Voor het gebruik van de service is een x-api-key nodig. Deze versie van de api maakt gebruik van het dynamische vragen algoritme zoals beschreven in hoofdstuk 8.6 "Modelleren dynamische vragen" van versie 3 van de STTR-standaard.

Het ophalen van vragen en het beantwoorden van vragen (Toepasbare Regels) ten behoeve van

1. de vergunningcheck (het checken wat een initiatiefnemer moet doen, bijv. een vergunning aanvragen),
2. het opstellen van een aanvraag en/of melding of
3. het checken welke maatregelen nodig zijn

De uitkomst van het checken is een conclusie, de uitkomst van het opstellen is of deze indienbaar en compleet is. De uitkomst van maatregelen zijn verwijzingen naar de voorschriften met bijbehorende maatregelen. Voor het gebruik van de service is een x-api-key nodig. Deze versie van de api maakt gebruik van het dynamische vragen algoritme zoals beschreven in hoofdstuk 8.6 "Modelleren dynamische vragen" van versie 1 en 2 van de STTR-standaard.

Een REST-API voor het raadplegen van gegevens uit het Uitvoeren component

Services voor het beheren van ideeverkenningconfiguraties en notificatieversieconfiguraties.

Services voor het opvragen van ideeverkenningconfiguraties en notificatieversieconfiguraties.

Tbv ophalen verzoek, zoeken naar verzoeken en wijzigen van het bevoegd gezag. Het ophalen van een ingediend verzoek (aanvraag/melding). Een verzoek kan worden opgehaald door het opgeven van het verzoeknummer. Het opgehaalde verzoek bevat referenties naar documenten (formulieren en bijlagen). Het zoeken naar ingediende verzoeken op basis van verschillende criteria. Het wijzigen van het bevoegd gezag (en eventueel behandeldienst) voor een ingediend verzoek (aanvraag/melding). Een verzoek kan worden verwijderd door het bevoegd gezag (of eventueel behandeldienst). Een overheidsinstantie die geïnformeerd moet worden en het verzoek ook kan ophalen, kan het verzoek markeren als gelezen (afmelden).

De v2 van deze API is deprecated, gebruik v3. De wijzigingen tov de 2.0.6 zijn:

• DoelVerzoek Vooroverleg is gewijzigd naar Conceptverzoek
• Swagger validatie wordt toegepast

Tbv ophalen verzoek, zoeken naar verzoeken en wijzigen van het bevoegd gezag. Het ophalen van een ingediend verzoek (aanvraag/melding). Een verzoek kan worden opgehaald door het opgeven van het verzoeknummer. Het opgehaalde verzoek bevat referenties naar documenten (formulieren en bijlagen). Het zoeken naar ingediende verzoeken op basis van verschillende criteria. Het wijzigen van het bevoegd gezag (en eventueel behandeldienst) voor een ingediend verzoek (aanvraag/melding). Een verzoek kan worden verwijderd door het bevoegd gezag (of eventueel behandeldienst). Een overheidsinstantie die geïnformeerd moet worden en het verzoek ook kan ophalen, kan het verzoek markeren als gelezen (afmelden).

Het indienen van een verzoek (aanvraag/melding/ideeverkenning). Met deze service kan er in een aantal stappen een verzoek ingediend worden als initiatiefnemer of gemachtigde. Deze service werkt volgens de HATEOAS standaard. Als eerste start men met het initiëren van een verzoek. Het resultaat hiervan bevat de locatie van het geïnitieerde verzoek en het verzoek met de link voor het toevoegen van documenten. Documenten dienen wat betreft bestandsnaam en content uniek te zijn.

• Ophalen Door het verzoek op te halen krijgt men het verzoek met de link voor het toevoegen van documenten.
• Verwijderen Hiermee verwijdert men het geïnitieerde (nog niet ingediende) verzoek.
• Indienen Het geïnitieerde verzoek en eventueel toegevoegde documenten worden ingediend.
• Intrekken Hiermee trekt men een eerder ingediend verzoek in.

Er zijn verschillende types verzoeken. Voor het type "Idee" zijn er voor de bovenstaande stappen de endpoints op de paden die beginnen met "/ideeverkenningen". Voor de overige types verzoeken moeten de paden die beginnen met "/verzoeken" gebruikt worden. Dit onderscheid is er omdat de request body voor ideeverkenning anders is dan die van de overige types verzoeken.