Gemeente | Schema-register

Een bronhouder is een gemeente of samenwerkingsverband van gemeenten en heeft een code en naam net als een gemeente.

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
beginGeldigheid	`string`	Ja	De datum waarop een versie van een bronhouder geldig is in de werkelijkheid. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Format: date
code	`string`	Ja	Een officiële code die aan een gemeente is toegekend, ontleend is aan tabel 33 en zoals bijgehouden in de LVBAG. Dit gegeven is geen officieel BAG gegeven en wordt niet als kenmerk van het BAG object Woonplaats object bijgehouden. Het wordt als hulpgegeven meegeleverd. Pattern: ^[0-9]{4}$
eindGeldigheid	`string`	Nee	De datum waarop de periode van geldigheid van een versie van een bronhouder eindigt. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig. Dit tijdstip wordt vastgelegd in de eindGeldigheid. Format: date
naam	`string`	Ja	Een officiële naam die aan een gemeente is toegekend. Min length: 1 Max length: 80
provincie	`$ref`	Ja	- $ref: ./provincie
status	`string`	Ja	Een aanduiding van alle waarden die de status van een gemeente kan aannemen. Enum: Actief, Beëindigd
tijdstipEindRegistratieLV	`string`	Nee	Dit is het tijdstip (conform RFC 3339) waarop een versie van een object of een relatie is beëindigd in de registratie van de landelijke voorziening. Format: date-time
tijdstipRegistratieLV	`string`	Ja	Dit is het tijdstip (conform RFC 3339) waarop een versie van een object of een relatie is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers. Format: date-time
versie	`integer`	Ja	De identificatie van een voorkomen van een object.

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/dienst-voor-het-kadaster-en-de-openbare-registers/imbag-api-van-de-lvbag-7fnzbuehg/gemeente",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Een bronhouder is een gemeente of samenwerkingsverband van gemeenten en \nheeft een code en naam net als een gemeente.\n",
  "properties": {
    "beginGeldigheid": {
      "description": "De datum waarop een versie van een bronhouder geldig is in de werkelijkheid. \nDit tijdstip wordt vastgelegd in de beginGeldigheid.\n",
      "examples": [
        "2019-06-01"
      ],
      "format": "date",
      "title": "beginGeldigheid",
      "type": "string"
    },
    "code": {
      "description": "Een officiële code die aan een gemeente is toegekend, ontleend is aan \ntabel 33 en zoals bijgehouden in de LVBAG. \nDit gegeven is geen officieel BAG gegeven en wordt niet als kenmerk van \nhet BAG object Woonplaats object bijgehouden. \nHet wordt als hulpgegeven meegeleverd.\n",
      "examples": [
        "0226"
      ],
      "pattern": "^[0-9]{4}$",
      "title": "code",
      "type": "string"
    },
    "eindGeldigheid": {
      "description": "De datum waarop de periode van geldigheid van een versie van een bronhouder \neindigt. \nWanneer er geen tijdstip is ingevuld, dan is de versie nog geldig. \nDit tijdstip wordt vastgelegd in de eindGeldigheid.\n",
      "examples": [
        "2019-06-01"
      ],
      "format": "date",
      "title": "eindGeldigheid",
      "type": "string"
    },
    "naam": {
      "description": "Een officiële naam die aan een gemeente is toegekend.",
      "examples": [
        "Duiven"
      ],
      "maxLength": 80,
      "minLength": 1,
      "title": "naam",
      "type": "string"
    },
    "provincie": {
      "$ref": "./provincie"
    },
    "status": {
      "description": "Een aanduiding van alle waarden die de status van een gemeente kan aannemen.",
      "enum": [
        "Actief",
        "Beëindigd"
      ],
      "title": "StatusGemeente",
      "type": "string"
    },
    "tijdstipEindRegistratieLV": {
      "description": "Dit is het tijdstip (conform RFC 3339) waarop een versie van een object of een relatie is beëindigd in de registratie van de landelijke voorziening.",
      "examples": [
        "2019-06-01T12:00:00+01:00"
      ],
      "format": "date-time",
      "title": "tijdstipEindRegistratieLV",
      "type": "string"
    },
    "tijdstipRegistratieLV": {
      "description": "Dit is het tijdstip (conform RFC 3339) waarop een versie van een object of een relatie is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.",
      "examples": [
        "2019-06-01T12:00:00+01:00"
      ],
      "format": "date-time",
      "title": "tijdstipRegistratieLV",
      "type": "string"
    },
    "versie": {
      "description": "De identificatie van een voorkomen van een object.",
      "examples": [
        3
      ],
      "title": "versie",
      "type": "integer"
    }
  },
  "required": [
    "beginGeldigheid",
    "code",
    "naam",
    "provincie",
    "status",
    "tijdstipRegistratieLV",
    "versie"
  ],
  "title": "Gemeente",
  "type": "object",
  "x-derived-from": [
    "https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2/openapi.yaml#/components/schemas/Gemeente"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
Provincie	`/properties/provincie/$ref`

Dit schema wordt gebruikt door
Schema	Locatie
BronhouderHal	`/properties/bronhouder/$ref`
woonplaatsembedded	`/properties/bronhouders/items/$ref`

Health issues

Health issues
Message	Pointer
Set a non-empty examples array at the top level of the schema to illustrate the expected data
Descriptions should not contain leading or trailing whitespace	`/description`
Descriptions should not contain leading or trailing whitespace	`/properties/beginGeldigheid/description`
Descriptions should not contain leading or trailing whitespace	`/properties/code/description`
Descriptions should not contain leading or trailing whitespace	`/properties/eindGeldigheid/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/naam/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/status/enum – /properties/status/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/status/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/tijdstipEindRegistratieLV/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/tijdstipRegistratieLV/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/versie/description`

Schema-register: Gemeente

Details van JSON Schema: Gemeente

Details van JSON Schema: Gemeente

Beschrijving