{ "openapi": "3.0.0", "info": { "version": "2.1.1", "title": "CRUD RTR gegevens", "description": "Een REST-API voor het raadplegen en beheren van activiteiten en werkzaamheden.", "contact": { "name": "PR13 Team Toepasbare regels", "url": "https://aandeslagmetdeomgevingswet.nl/ontwikkelaarsportaal/services/contact/" } }, "paths": { "/": { "get": { "summary": "OpenApi Specification", "tags": [ "Meta" ], "responses": { "200": { "description": "OpenApi Specification Json", "content": { "application/json": { "schema": { "example": "{\"openapi\": \"3.0.0\", ... }" } } } } } } }, "/health": { "get": { "summary": "health info", "tags": [ "Meta" ], "responses": { "200": { "description": "Health", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "UP" ] }, "groups": { "type": "array", "items": { "type": "string" } } } } } } }, "503": { "description": "Health", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "DOWN", "OUT_OF_SERVICE" ] }, "groups": { "type": "array", "items": { "type": "string" } } } } } } } } } }, "/info": { "get": { "summary": "applicatie info", "tags": [ "Meta" ], "responses": { "200": { "description": "Info", "content": { "application/json": { "schema": { "description": "Info", "required": [ "app" ], "properties": { "app": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "version2": { "type": "string" }, "buildtime": { "type": "string" } } } } } } } } } } }, "/activiteiten": { "get": { "summary": "Ophalen alle activiteiten", "description": "Retourneert alle activiteiten die op een bepaalde datum actief zijn.", "tags": [ "Raadplegen activiteiten" ], "parameters": [ { "$ref": "#/components/parameters/x_api_key" }, { "$ref": "#/components/parameters/_sort" }, { "$ref": "#/components/parameters/datumRequired" }, { "$ref": "#/components/parameters/pageSizeEnum" }, { "$ref": "#/components/parameters/page" } ], "responses": { "200": { "description": "Lijst van activiteiten.", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ActiviteitHALResponseList" } } } }, "400": { "$ref": "#/components/responses/400" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/activiteiten/_zoek": { "post": { "summary": "Zoek activiteiten", "description": "Zoek activiteiten op basis van zoekcriteria.", "tags": [ "Raadplegen activiteiten" ], "parameters": [ { "$ref": "#/components/parameters/x_api_key" }, { "$ref": "#/components/parameters/_sort" }, { "$ref": "#/components/parameters/crs" }, { "$ref": "#/components/parameters/pageSizeEnum" }, { "$ref": "#/components/parameters/page" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoekCriteria" } } }, "description": "Zoekcriteria", "required": true }, "responses": { "200": { "description": "Activiteiten die voldoen aan de zoekcriteria.", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ActiviteitHALResponseList" } } } }, "400": { "$ref": "#/components/responses/400" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } } } }, "/activiteiten/_wijzigingen": { "post": { "summary": "Zoek naar gewijzigde activiteiten", "description": "
Retourneert de activiteiten die in de opgegeven periode gewijzigd zijn. Deze service is handig om een database met activiteiten up-to-date te houden met de activiteiten zoals die in het DSO bekend zijn. Vul hiervoor de \"datumVanaf\" in met de datum waarop de laatste keer de database is bijgewerkt. Roep de service per (bestuursorgaan-)oin aan en werk vervolgens de activiteiten bij die deze service retourneert.
Activiteiten zijn gewijzigd als: