Samengestelde services Registratie Toepasbare Regels
Een REST API voor een aantal specifiek samengestelde services op de RTR (Registratie Toepasbare Regels) gegevens voor gerichte bevragingen.
Label: Vergunningcheck en indienen
Endpoint Pre-productie
https://service.pre.omgevingswet.overheid.nl/publiek/toepasbare-regels/api/samengestelderegistratietoepasbareregelsservices/v2/
Endpoint Productie
https://service.omgevingswet.overheid.nl/publiek/toepasbare-regels/api/samengestelderegistratietoepasbareregelsservices/v2/
Omschrijving
De gegevens in de RTR (Register Toepasbare Regels) bestaan op dit moment uit activiteiten en werkzaamheden.
De functionele structuur bevat een taxonomie die is opgebouwd uit activiteiten. De functionele structuur is de kapstok waaraan de voor een activiteit relevante toepasbare regels hangen. Per activiteit worden de toepasbare regels opgenomen in een ‘verzameling regels die over hetzelfde juridische onderdeel gaan’. Deze verzameling van dezelfde regels wordt getypeerd als regelbeheerobject.
Werkzaamheden zijn bedoeld voor de incidentele initiatiefnemers, zodat zij ondersteund worden om de juiste (juridische) activiteiten te vinden tijdens het checken. Werkzaamheden zijn gekoppeld aan de laagste activiteit.
De API Samengestelde RTR services ondersteunt de volgende services:
- Bepaal regelbeheerobject typeringen: om te achterhalen of er regelbeheerobjecten en daarmee toepasbare regels aanwezig zijn voor een werkzaamheid.
- Geef logisch gerelateerde werkzaamheden: voor het ophalen van de logisch gerelateerde werkzaamheden van een werkzaamheid.
- Geef juridisch gerelateerde werkzaamheden: voor het ophalen van de juridische gerelateerde werkzaamheden van een werkzaamheid.
-
Ophalen compleetheid van werkzaamheid: om voor een combinatie van werkzaamheid en (project)locatie te achterhalen of alle bevoegd gezagen daar hebben aangegeven dat zij naar hun inzicht alle relevante activiteiten hebben gekoppeld aan de werkzaamheid.
Bepaal regelbeheerobject typeringen
Om te achterhalen of er regelbeheerobjecten, en daarmee toepasbare regels, aanwezig zijn voor een werkzaamheid. Hiermee kunnen bijvoorbeeld de gewenste meldingen en processtappen in een gebruikerstoepassing worden bepaald.
Werkzaamheden zijn gekoppeld aan activiteiten waarvoor regelbeheerobjecten kunnen zijn opgenomen waaraan de toepasbare regels hangen. Voor de verschillende verzamelingen van regels zijn er regelbeheerobject typeringen: conclusie, indieningsvereisten en maatregelen.
De aanwezigheid van regelbeheerobject typeringen wordt bepaald op basis van:
- de meegegeven werkzaamheden (functioneleStructuurRefs)
- de locatie
De service beantwoordt dit met:
- de direct en indirect aanwezige regelbeheerobject typeringen
Activiteiten kunnen juridisch aan elkaar zijn gerelateerd, waardoor voor een werkzaamheid ook indirecte regelbeheerobjecten aanwezig kunnen zijn (zie Geef juridisch gerelateerde werkzaamheden service).
Geef logisch gerelateerde werkzaamheden
Voor het ophalen van de logisch gerelateerde werkzaamheden van een werkzaamheid. Met de gevonden werkzaamheden kan vervolgens de vergunningscheck of het bepalen van de maatregelen worden uitgevoerd (zie API Uitvoeren services).
De logisch gerelateerde werkzaamheden worden bepaald op basis van:
- de meegegeven werkzaamheden (functioneleStructuurRefs)
De service beantwoordt dit met:
- de logische gerelateerde werkzaamheden (functioneleStructuurRefs)
Werkzaamheden kunnen logisch aan elkaar zijn gerelateerd.
Geef juridisch gerelateerde werkzaamheden
Voor het ophalen van de (via de activiteiten) juridisch gerelateerde werkzaamheden van een werkzaamheid. Met de gevonden werkzaamheden kan vervolgens de vergunningscheck of het bepalen van de maatregelen worden uitgevoerd (zie API Uitvoeren services).
De juridisch gerelateerde werkzaamheden worden bepaald op basis van:
- de meegegeven werkzaamheden (functioneleStructuurRefs)
- de locatie
De service beantwoordt dit met:
- de juridisch gerelateerde werkzaamheden (functioneleStructuurRefs) van en naar de meegegeven werkzaamheid
Werkzaamheden zijn gekoppeld aan activiteiten. Activiteiten kunnen juridisch aan elkaar zijn gerelateerd. Een activiteit kan naar een andere activiteit wijzen (naar) of een andere activiteit kan naar deze activiteit wijzen (van).
Ophalen compleetheid van werkzaamheid
Voor het ophalen van informatie over welke bestuursorganen hebben aangegeven alle relevante activiteiten aan de werkzaamheid te hebben gekoppeld. Hiermee kan bijvoorbeeld de gewenste melding in een gebruikerstoepassing worden bepaald.
De compleetheid wordt opgehaald op basis van een werkzaamheid en een locatie (geometrie).
De service geeft als antwoord of de werkzaamheid compleet is (ja of nee). Indien niet compleet dan wordt daarbij aangegeven welke bestuurslagen nog niet hebben aangegeven compleet te zijn.
Ophalen algemene set
Voor het ophalen van de activiteit met de algemene set indieningsvereisten. Met de opgehaalde activiteit kan vervolgens het bepalen van de indieningsvereisten worden uitgevoerd (zie API Uitvoeren services).
De service geeft als antwoord:
- de activiteit die correspondeert met de algemene set (functioneleStructuurRef)
Informatiemodellen
Delen
Status
Versie 2 is beschikbaar in de pre-productie- en productieomgeving.
API specificaties
Meer informatie
Deze service is van belang in het proces toepasbare regels voor vragenbomen.
API-key
Om API's te gebruiken dient bij elke request een API-key meegegeven te worden. Alle API's werken met dezelfde key.
Feedback
Geef feedback op deze service. Ga naar het forum om je bevindingen te delen.