Toepasbaar Opvragen API

Organisaties Digitaal Stelsel Omgevingswet
#1

Ik ben aan de slag gegaan met de Toepasbaar Opvragen API (v7). Dit doe ik door gebruik te maken van de ‘activiteiten/{identificatie}/levenscyclus’ endpoint. Dit betreft dan ook een GET-request.
Hoewel deze request bij mij werkt (http code = 200), krijg ik een leeg resultaat wat betreft activiteiten:

image
image696×59 4.51 KB

{"_links":{“self”:{“href”:“https://service.omgevingswet.overheid.nl/publiek/omgevingsdocumenten/api/toepasbaaropvragen/v7/activiteiten/nl.imow-mnre1034.ambtsgebied.LND6030A/levenscyclus?page=0&size=20"}},"_embedded":{“activiteiten”:[]},“page”:{“size”:20,“totalElements”:0,“totalPages”:0,"number”:0}}

naast de x-api-key gebruikte ik ook de volgende header:
Content-Type = application/hal+json

Hierboven is de output te zien voor één bepaald gebied. Echter, krijg ik ditzelfde resultaat voor alle 205 gebieden waarvan ik via deze API data wil opvragen. Dit resultaat is leeg, terwijl hier volgens de Devportal wel degelijk informatie zou moeten staan. Aangezien de http code suggereert dat de request goed is gegaan, vraag ik mij af wat er dan toch fout gaat. Of dat er iets aan de hand is aan de data-kant van dit verhaal?

Alvast bedankt!

#2

Dag Guido,

De DSO API-strategie definieert CRUD acties op resource-collecties. Met een identifier is een specifiek object in de collectie te adresseren, bijv. activiteiten/{identificatie}/levenscyclus voor het ophalen van een levenscyclus van een activiteit. Voor {identificatie} moet de identificerende string worden ingevuld van een activiteit (dus niet een locatie). Als er geen activiteit kan worden gevonden voor een meegegeven identificatie dan wordt een response met HTTP-code 200 teruggeven met een lege collectie in het _embedded object (“activiteiten” : []).

Om de activiteiten per locatie op te halen moet de omgevingsdocument presenteren API worden gebruikt. Dit gaat met een POST-request zoekopdracht via het endpoint activiteiten/_zoek en een payload waarin de locatie identifier als zoekparameter kan worden meegegeven. De juiste aanroep voor het ophalen van activiteiten per locatie is:

https://service.omgevingswet.overheid.nl/publiek/omgevingsdocumenten/api/presenteren/v6/activiteiten/_zoek

Met als payload:

{ "zoekParameters": [ { "parameter": "locatie.identificatie", "zoekWaarden": [ "nl.imow-mnre1034.ambtsgebied.LND6030A" ] } ] }

#3

Dag mspeyer,

Bedankt voor het antwoord! Ik had inderdaad over het hoofd gezien dat het om een activiteit-id moest gaan. Bedankt voor de tips over de payload, het is inmiddels gelukt en ik krijg betekenisvol resultaat.