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

https://service.pre.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;
  • Bepaal activiteiten: voor het ophalen van de activiteiten die van toepassing zijn in een bepaald werkingsgebied;
  • Bepaal subactiviteiten: voor het ophalen van de subactiviteiten van een activiteit.
  • Ophalen algemene activiteit: voor het ophalen van de activiteit met de algemene vragenset indieningsvereisten;
  • Bepaal of activiteit verfijnbaar is: om te achterhalen of een activiteit verfijnbaar is;
  • Bepaal toonbare activiteit van activiteit: voor het ophalen van de toonbare activiteit van een activiteit;
  • Bepaal behandeldienst configuratie van activiteit: voor het ophalen van alle behandeldienst configuraties 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).

Bepaal activiteiten:

Voor het ophalen van de activiteiten die van toepassing zijn voor een bepaalde locatie. Met de opgehaalde activiteiten kunnen vervolgens de subactiviteiten worden bepaald (zie Bepaal subactiviteiten service), en bijvoorbeeld het bepalen van de indieningsvereisten en het bevoegd gezag worden uitgevoerd (zie API’s Uitvoeren services en Verzoeksroutering).

De activiteiten worden bepaald op basis van:

  • De locatie

De service beantwoordt dit met:

  • De toonbare activiteiten met de regelbeheerobject typeringen en toestemmingtypes (functioneleStructuurRefs)
  • De bijbehorende gegevens van de activiteit

De functionele structuur bevat een taxonomie die is opgebouwd uit activiteiten. De laagste is of een hoger liggende activiteit kan toonbaar zijn. De toonbare activiteit is het activiteitsniveau wat herkenbaar moet zijn en waarop de melding/vergunning wordt gedaan/aangevraagd.

Bepaal subactiviteiten:

Voor het ophalen van de subactiviteiten van een verfijnbare toonbare activiteit. Met de opgehaalde subactiviteiten kan bijvoorbeeld het bepalen van de indieningsvereisten en het bevoegd gezag worden uitgevoerd (zie API’s Uitvoeren services en Verzoeksroutering).

De subactiviteiten worden bepaald op basis van:

  • De meegegeven activiteiten (functioneleStructuurRefs)
  • De locatie

De service beantwoordt dit met:

  • De subactiviteiten (functioneleStructuurRefs)
  • De bijbehorende gegevens van de subactiviteit

De functionele structuur bevat een taxonomie die is opgebouwd uit activiteiten. De laagste activiteiten zijn de subactiviteiten.

Ophalen algemene activiteit:

Voor het ophalen van de activiteit met de algemene vragenset indieningsvereisten. Met de opgehaalde activiteit kan vervolgens het bepalen van de indieningsvereisten worden uitgevoerd (zie API Uitvoeren services).

De service geeft als antwoord:

  • De algemene activiteit (functioneleStructuurRef)

Bepaal of activiteit verfijnbaar is:

Om te achterhalen of een activiteit verfijnbaar is. De functionele structuur bevat een taxonomie die is opgebouwd uit activiteiten. De laagste activiteiten zijn de subactiviteiten. Een hogere activiteit kan toonbaar zijn. De toonbare activiteit is het activiteitsniveau wat herkenbaar moet zijn en waarvoor de melding/vergunning wordt gedaan/aangevraagd. Afhankelijk of deze activiteit ook verfijnbaar is, kunnen de subactiviteiten met de bijbehorende vragen en instellingen worden opgehaald en gebruikt. Als de activiteit niet verfijnbaar is worden de bijbehorende vragen en instellingen van alle subactiviteiten opgehaald en gebruikt.

Of een activiteit verfijnbaar is wordt bepaald op basis van:

  • De meegegeven activiteit

De service beantwoordt dit met:

  • TRUE of FALSE

Of een activiteit verfijnbaar is wordt meegeven in de bepalen activiteiten (zie Bepalen activiteiten service) en als uitkomst van de vergunningscheck (zie API Uitvoeren services).

Bepaal toonbare activiteit:

Voor het ophalen van de toonbare activiteit van een activiteit. De functionele structuur bevat een taxonomie die is opgebouwd uit activiteiten. De laagste is of een hoger liggende activiteit kan toonbaar zijn. De toonbare activiteit is het activiteitsniveau wat herkenbaar moet zijn en waarvoor de melding/vergunning wordt gedaan/aangevraagd.

De toonbare activiteit wordt bepaald op basis van:

  • De meegegeven activiteit

De service beantwoordt dit met:

  • De toonbare activiteit
  • De bijbehorende gegevens van de toonbare activiteit

De toonbare activiteiten worden meegegeven in de bepalen activiteiten (zie Bepalen activiteiten service) en als uitkomst van de vergunningscheck (zie API Uitvoeren services).

Bepaal behandeldienst configuratie van activiteit:

Voor het ophalen van alle behandeldienst configuraties 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

Documentatie

Informatiemodellen


Status

Versie 1 beschikbaar in bèta in de pre-productieomgeving.

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.