Werkzaamheden opvragen

Label: Toepasbare regels

Endpoints

Pre-productieomgeving

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

Productieomgeving

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

Omschrijving

In het kort

Deze service biedt drie manieren om gegevens over werkzaamheden op te vragen:

1. Identificaties (URN) van alle werkzaamheden
2. Details van één werkzaamheid
3. Werkzaamheidversies

De service is bruikbaar in applicaties waarin alle werkzaamheden moeten worden getoond. Bijvoorbeeld bij het koppelen van werkzaamheden aan een activiteit, als onderdeel van ‘toepasbaar maken’.

Context

Een werkzaamheid wordt geïdentificeerd d.m.v. een urn. Werkzaamheidgegevens zijn geversioneerd. Gedurende de levenscyclus van een werkzaamheid kan daardoor een verzameling van werkzaamheidversies ontstaan. Een specifieke versie van een werkzaamheid is te identificeren met de urn van de werkzaamheid, en een datum.

Andere attributen van een werkzaamheidversie zijn (naast urn):

• Omschrijving
• Begindatum
• Einddatum (optioneel)
• (Lijst van) trefwoorden
• (Lijst van) gerelateerde werkzaamheden (op basis van urn)

Het werkzaamhedenversiebeheer is zo ingericht dat geldigheidsperiodes van de versies bij een urn niet kunnen overlappen, en dat er maximaal één versie zonder einddatum mag zijn per urn.

Alle werkzaamheden opvragen

Voor het opvragen van alle werkzaamheden zijn geen parameters nodig, anders dan die voor paginering en sortering.

De service retourneert een lijst met urn´s van alle bestaande werkzaamheden. Naast urn´s met een actuele versie dus ook urn’s met alleen een geplande versie, of met alleen verlopen versies.

Details van één werkzaamheid opvragen

Met een urn van een werkzaamheid kunnen alle gegevens bij alle versies van die werkzaamheid worden opgevraagd.

Werkzaamheidversies opvragen

Met een datum, of een aantal werkzaamheid urn´s, of een combinatie van beide, is het ook mogelijk om gericht de gegevens van meerdere werkzaamheidversies tegelijk op te halen.

Gerelateerde services

Er zijn andere services gericht op werkzaamheden in relatie tot activiteiten.

• Elk bestuursorgaan geeft aan welke werkzaamheden relevant zijn voor de eigen activiteiten. Bruikbare services daarvoor zijn Toepasbaar maken en Activiteiten opvragen.
• Initiatiefnemers en belanghebbenden zoeken graag via trefwoorden en werkzaamheden naar de activiteiten waarvoor zij eventueel aanvragen of meldingen moeten doen. Bruikbare services voor gebruikerstoepassingen die deze manier van zoeken willen ondersteunen zijn Toepasbare regels zoeken en Samengestelde RTR service.

Documentatie

Zie voor veer informatie: werkzaamheden en activiteiten combineren.

Informatiemodellen

Zie context.

Standaarden

Werkzaamhedeninformatie is formeel geen onderdeel van STAM/IMAM of STTR/IMTR.