Laadpaal

Overige Objecten Registratie API

Gerelateerde thema's

Met de Overige Objecten Registratie API-specificaties (Objecten en Objecttypen) kunnen gemeenten eenduidig objecten (zoals prullenbakken, laadpalen etc.) registreren, opslaan en ontsluiten. Gegevens van deze objecten zijn vaak nog niet beschikbaar in gegevensbronnen, terwijl ze de gemeentelijke dienstverlening ze wel nodig heeft. Gemeentelijke afdelingen kunnen met deze API’S intern en met externe betrokkenen makkelijker afstemmen over de kenmerken van een object.

Doel

De Objecten API heeft als doel om uiteenlopende objecten eenvoudig te kunnen registreren en ontsluiten in een gestandaardiseerd formaat. De Objecten API kan worden gebruikt om objecten te beheren. Ook kan een organisatie de Objecten API inzetten voor Open Data, waarbij de geregistreerde objecten publiekelijk toegankelijk zijn.

Beschrijving

De Overige Object Registratie specificatie bestaat uit twee open API-specificaties, die samen kunnen worden gebruikt: de Objecttypen API en de Objecten API. 

Met de Objecttypen API kunnen organisaties technische definities van objecten beschikbaar stellen voor technische gebruikers en applicaties. Gebruikers en applicaties kunnen inspecteren welke attributen een bepaald object bevat, en hierop inspelen met eigen applicatielogica. 

Met de Objecten API kunnen organisaties objecten ontsluiten en opslaan, die voldoen aan de specificaties zoals die zijn opgenomen in de Objecttypen API. Dit kan zowel open-, deels open of niet open data betreffen. 

Als objecten worden aangemaakt in de Objecten API, worden de gegevens vergeleken met de definitie in de Objecttypen API. Elk object bevat een verwijzing naar een specifieke definitie in een specifieke Objecttypen API. Hierdoor kunnen binnen één Objecten API bij een organisatie niet alleen objecten met diverse definities opgeslagen en ontsloten zijn maar ook registraties volgens definities die zich (de definities) buiten de eigen organisatie bevinden.

Hierdoor kunnen organisaties elkaars definities hergebruiken. Als een overkoepelende organisatie een Objecttypen API met definities beschikbaar stelt, kunnen meerdere organisaties deze definities hergebruiken. VNG kan zo als overkoepelde organisatie bepaalde vastgestelde definities gaan aanbieden. Applicatieleveranciers kunnen vervolgens rekening houden met deze vastgestelde definities, die beschikbaar zijn in de Objecttypen API. 

Het gebruiken van objecten, maar ook het beheer van objecten, kan door derde applicaties plaatsvinden via de Objecten API. 

API specificaties

De API specificaties en bijbehorende artefacten zijn beschikbaar op de volgende locaties: