Samengestelde Registratie Toepasbare Regels Services

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/v1

Endpoint Productie

https://service.omgevingswet.overheid.nl/publiek/toepasbare-regels/api/samengestelderegistratietoepasbareregelsservices/v1

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.
  • Zoek werkzaamheden: voor het zoeken op werkzaamheden en bijbehorende trefwoorden.
  • 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 algemene activiteit: voor het ophalen van de activiteit met de algemene vragenset indieningsvereisten.
  • Bepaal behandeldienst configuratie van activiteit: voor het ophalen van alle behandeldienst configuraties van een activiteit.
  • Bepaal omgevingsoverleg configuratie van activiteit: voor het ophalen van een omgevingsoverleg configuratie van een activiteit.

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).

Zoek werkzaamheden

Voor het zoeken op werkzaamheden en bijbehorende trefwoorden. Met de gevonden werkzaamheden kunnen vervolgens de logisch en juridisch gerelateerde werkzaamheden worden bepaald (zie Geef juridisch en logisch gerelateerde werkzaamheden services), en de vergunningscheck of het bepalen van de maatregelen worden uitgevoerd (zie API Uitvoeren services).

De werkzaamheden worden bepaald op basis van:

  • zoektermen.

De service beantwoordt dit met:

  • de werkzaamheden (functioneleStructuurRefs)
  • de gevonden bijbehorende trefwoorden

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 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)

Bepaal behandeldienst configuratie van activiteit

Voor het ophalen van alle behandeldienstconfiguraties van een subactiviteit. De functionele structuur bevat een taxonomie die is opgebouwd uit activiteiten. Een bevoegd gezag (OIN) kan een behandeldienst (OIN) koppelen aan een activiteit op elk activiteitsniveau, en optioneel hierbij een locatie (bestuurlijke grens van een OIN) en toestemming opgeven.

De toonbare activiteit wordt bepaald op basis van:

  • de meegegeven subactiviteit

De service beantwoordt dit met:

De behandeldienst (OIN) per bevoegd gezag (OIN) en optioneel per locatie (OIN) en toestemming.

Bepaal omgevingsoverleg configuratie van activiteit

Voor het ophalen van een omgevingsoverleg configuratie van een activiteit. Een bevoegd gezag (OIN) kan de mogelijkheid tot omgevingsoverleg koppelen aan een activiteit op elk activiteitsniveau, en optioneel hierbij een toestemming opgeven.

De omgevingsoverleg configuratie wordt opgehaald op basis van:

  • de meegegeven activiteit (urn)
  • het bevoegd gezag (OIN)
  • een toestemming

De service beantwoordt dit met de eerste omgevingsoverleg configuratie die het meest van toepassing is. Hierbij wordt ook rekening gehouden met eventuele configuraties van hoger gelegen activiteiten. De response is leeg als er geen configuratie wordt gevonden.

Informatiemodellen


Status

Versie 1 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.