Toepasbare regels aanleveren

Een SOAP API voor het toepasbaar maken van activiteiten en het aanleveren en beheren van toepasbare regels.

Label: Toepasbare regels

Endpoint

https://service.pre.omgevingswet.overheid.nl/overheid/toepasbare-regels/aanleverentoepasbareregels/v1

Beveiligde REST-service

Vraag toegang aan voor deze beveiligde REST-service via het aanvraagformulier.

Omschrijving

Om de geldende wet- en regelgeving voor een bepaalde activiteit en werkingsgebied te ontsluiten in een voor initiatiefnemers begrijpelijke vorm, worden juridische regels vertaald naar zogeheten “toepasbare regels”. Deze toepasbare regels moeten worden aangeleverd conform de Standaard Toepasbare Regels (STTR) en het onderliggende Informatiemodel Toepasbare Regels (IMTR).

De functionele structuur bevat een taxonomie die is opgebouwd uit activiteiten. De activiteiten volgen uit de regelgeving en worden ook zodanig vastgelegd bij het opstellen van het omgevingsplan. 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.

Met de Toepasbare regels aanleveren service kan één van de volgende drie enkelvoudige opdrachten worden uitgevoerd:

  1. Het vullen of muteren van de attributen van een activiteit in de Registratie Toepasbare Regels (RTR), die de activiteit toepasbaar maken inclusief het toevoegen van regelbeheerobjecten. Dit wordt het “toepasbaar maken van een activiteit” genoemd.
  2. Het aanleveren van toepasbare regels voor een activiteit.
  3. Het verwijderen van toepasbare regels van een activiteit.

Met de Aanleveren toepasbare regels service kan één opdracht met één bijbehorend bestand per keer worden aangeleverd en verwerkt:

  • óf het vullen of muteren van de toepasbare attributen van één activiteit inclusief de bijhorende regelbeheerobjecten
  • óf het aanleveren of muteren van één toepasbare regelbestand en deze koppelen aan het juiste regelbeheerobject van de activiteit
  • óf het verwijderen van één toepasbare regelbestand

Toepasbaar maken activiteiten en toevoegen regelbeheerobjecten

Om toepasbare regels aan te leveren en uit te voeren moeten activiteiten ‘toepasbaar’ gemaakt worden. Hiervoor moeten de toepasbare attributen van de activiteit worden gevuld en de regelbeheerobjecten worden aangeleverd. De attributen die vanuit het omgevingsplan bij de activiteit horen, kunnen niet via deze opdracht gemuteerd worden.

Met de enkelvoudige opdracht “updateActiviteit” en het bestand activiteit.xml kunnen deze attributen en regelbeheerobjecten worden aangeleverd.

De regelbeheerobjecten hebben een typering (Conclusie, Indieningsvereisten of Maatregelen) en een toestemming in het geval van Indieningsvereisten (zie voor de toestemmingen, bijlage 1 van de STTR (Standaard Toepasbare Regels)).

Aanleveren toepasbare regels

Toepasbare regels kunnen worden aangeleverd en gekoppeld aan een regelbeheerobject van een activiteit.

Met de enkelvoudige opdracht “toevoegenToepasbareRegels” of “toevoegenToepasbareRegelsAansluiting”, een geldigheid (begin- en einddatum), het toepasbare regel-bestand (bijvoorbeeld: sttr.xml) en bij een aansluiting eventueel een locatie kunnen de toepasbare regels worden aangeleverd.

Het toepasbare regel-bestand wordt na het aanleveren op een aantal manieren geverifieerd. Er wordt gecontroleerd of het bestand voldoet aan de eisen van STTR/IMTR. De verificatie kent de volgende methoden:

  • Syntactisch – Tegen de XSD van DMN en de XSD’s van de + laag (Bedrijfsregels, Uitvoeringsregels, Interactieregels, Content). Hier wordt gecontroleerd of de structuur van het bestand correct is volgens de XSD’s.
  • Semantisch – Met behulp van Schematron (ISO Standaard). Hier wordt gecontroleerd of de onderlinge relaties in het bestand logisch en correct zijn en of het bestand consistent en volledig is.
  • Functionele verificatie – Door de achterliggende componenten. Bijvoorbeeld of de GEO gegevens vindbaar zijn in OZON, dat wil zeggen dat het locatieobject bestaat.

Voor de details van de verificatie zie hoofdstuk Verificaties van het IMTR document.

Als de verificatie niet slaagt dan beantwoordt de service dit met één of meerdere verificatiemeldingen met als mogelijk:

  • De verificatiemethode
  • De reden van de melding en bijbehorende oplossing/eis
  • Het element binnen het toepasbare regel-bestand

Verwijderen toepasbare regels

Het toepasbare regel-bestand met toepasbare regels kan op basis van het bestand-ID worden verwijderd indien deze nog niet in werking is getreden. Het bestand-ID is te raadplegen via de RTR (Registratie Toepasbare Regels) en de API Raadplegen RTR gegevens.

Met de enkelvoudige opdracht “verwijderToepasbareRegels” kunnen de toepasbare regels worden verwijderd.

Aanvullende informatie

De Aanleveren toepasbare regels service wordt aangeboden via een Digikoppeling ebMS waarbij er een zip-bestand wordt aangeleverd met daarin een aantal bestanden, afhankelijk van de opdracht:

  1. xml: bevat een overzicht van alle bestanden in het zip-bestand
  2. xml: bevat de opdracht die moet worden uitgevoerd (één van de drie mogelijke opdrachten)
  3. xml: bevat toepasbare attributen van de activiteit inclusief de gewenste regelbeheerobjecten
  4. xml: bevat het toepasbare regelbestand

Voor de eerste drie bestanden zijn er XSD-bestanden die de structuur van de inhoud definiëren (zie bijlage Koppelvlak aanleveren toepasbare regels).  Het bestand sttr.xml moet voldoen aan de Standaard Toepasbare Regels (STTR).

Documentatie

Standaarden

Informatiemodellen


Status

Meer informatie

Deze service is van belang in het proces toepasbare regels voor vragenbomen.

PKIoverheid-certificaat

Deze service kan alleen worden gebruikt met een PKIoverheid-certificaat.

Feedback

Geef feedback op deze service. Ga naar het forum om je bevindingen te delen.