Skip to content

Latest commit

 

History

History
101 lines (76 loc) · 4.06 KB

README.rst

File metadata and controls

101 lines (76 loc) · 4.06 KB
Raw

Objecttypes

A collection of objecttypes, created and used by Dutch government organizations, for use with the Objecttypes API. (Nederlandse versie)

Introduction

Objecttypes are technical definitions of an object. If every application can expect, create and use the same technical definition for an object, integration between systems would be much easier. The use of objecttypes that everyone agreed upon, allow for exactly this.

An objecttype can describe anything: A monument, boat, road, tree, marriage official, pension plan, form, etc. These technical definitions are described as a JSON schema and the objecttype adds some meta information to offer context for this JSON schema.

The Objects API and the Objecttypes API are two components that complement eachother. The Objecttypes API holds the objecttypes for objects that can be stored in the Objects API. Together they provide a powerfull way to create and store any kind of object. They are designed in line with the Common Ground philosophy and they can be used by other API's that need to store domain specific data.

The objecttypes in this repository (CC0), and also the Objecttypes API (EUPL) and the Objects API (EUPL) are open source and therefore free to use.

Participants in the community standards

The Objects API and the Objecttypes API are in the process of standardization within VNG. Meanwhile, several public organizations have indicated they will (plan to) use and support these API's. They intent to use objecttypes and will actively contribute by providing new and/or improved objecttypes and share them here.

A, most likely incomplete, list of participants is shown below:

  • Dimpact (cooperation of 40+ municipalities)
  • GBI (part of VNG)
  • Municipality of Utrecht
  • Municipality of Delft
  • Municipality of Amsterdam
  • Municipality of Rotterdam (also member of Dimpact)
  • Municipality of Haarlem

How to use

There are 4 folders in this repository:

  • community-concepts - Contains all objecttypes that are created by the community. They are typically not used by many public organizations, can change without notice but submitted here to benefit and provide inspiration to others. If multiple public organizations use an objecttype, it can be "upgraded" to a community standard (see below).
  • community-standards - Contains objecttypes that a group of public organizations agreed upon. The objecttype is considered to be a community standard and cannot be changed. Only newer versions can be submitted as community concept.
  • official-concepts - Contains objecttypes that are considered to become an official standard but are not yet there. If, after a certain period, there are no objections to this objecttype, it can be "upgraded" to an official standard.
  • official-standards - Contains objecttypes that are recommended for all organizations to use. These objecttypes will typically not see newer versions anytime soon and can most likely be used for a long period of time.

These folders contain JSON schemas. They can be loaded into your own Objecttypes API with appropriate meta data.

References

Licence

Licensed under the Creative Commons Zero (CC0) v1.0 Universal