Toepasbare Regels zoeken

Label: Vergunningcheck en indienen

Endpoint Pre-productieomgeving

https://service.pre.omgevingswet.overheid.nl/publiek/toepasbare-regels/api/zoekinterface/v2/

Endpoint Productieomgeving

https://service.omgevingswet.overheid.nl/publiek/toepasbare-regels/api/zoekinterface/v2/

Omschrijving

In het kort

Met de service Toepasbare Regels zoeken kan worden gezocht naar 2 verschillende zaken, namelijk:

1. Werkzaamheden
2. Activiteiten met regels voor indieningsvereisten

Context

De API biedt, d.m.v. een REST interface, toegang tot de zoekfunctionaliteit die gebruikt wordt bij de Vergunningcheck en het Aanvragen in het Omgevingsloket.

Werking

Met behulp van vrije tekst wordt gezocht in de omschrijving van de activiteit of werkzaamheid. Ook kunnen er suggesties worden gevraagd om een zoekterm aan te vullen (autocomplete). De resultaten kunnen worden gefilterd op specifieke eigenschappen.

Bij de zoekresultaten wordt o.a. de functioneleStructuurReferentie teruggegeven. Voor een werkzaamheid is dit de referentie naar de werkzaamheid, bijvoorbeeld http://toepasbare-regels.omgevingswet.overheid.nl/werkzaamheden/id/concept/DakkapelPlaatsen.

Voor een activiteit is dit de referentie naar de regels voor indieningsvereisten, bijvoorbeeld http://toepasbare-regels.omgevingswet.overheid.nl/00000001821699180000/id/concept/IndieningsvereistenMeldingGebruikVanBouwwerken.

Sortering en filtering

De sortering van zoekresultaten kan op verschillende manieren worden gesorteerd, waaronder op basis van 'beste match' en 'meest gekozen'.

Voor bepaalde filters worden aggregatiegetallen teruggegeven over het aantal mogelijke resultaten dat voldoet aan die filters.

Standaarden

• Standaard Toepasbare Regels (STTR)