benkaggbagzoek | Schema-register

Specifiek voor Data Verkenner gemaakte BAG-tabel van Nummeraanduidingen t.b.v. zoekfunctie met de verblijfsobjecten en gebieden waar ze een relatie mee hebben.

Dialect2020-12

Typeobject

Health14%

Dependencies2

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
_links	`object`	Ja	The contents of the `bagzoek._links` field. It contains all relationships with objects.
_links.schema	`string`	Ja	The schema field is exposed with every record Format: uri
_links.self	`$ref`	Ja	- $ref: ../_shared/benkaggbagzoeklink
adresseertVerblijfsobjectIdentificatie	`string, null`	Nee	Het verblijfsobject (landelijke identificatie) dat door de nummeraanduiding wordt aangeduid.
beginGeldigheid	`string, null`	Nee	De datum waarop de nummeraanduiding geldig is geworden. Format: date-time
eindGeldigheid	`string, null`	Nee	De datum waarop de nummeraanduiding niet meer geldig is. Format: date-time
huisletter	`string, null`	Nee	Een door het bevoegde gemeentelijke orgaan ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.
huisnummer	`integer, null`	Nee	Een door het bevoegde gemeentelijke orgaan ten aanzien van een adresseerbaar object toegekende nummering. Format: int64 Minimum: -9223372036854776000 Maximum: 9223372036854776000
huisnummertoevoeging	`string, null`	Nee	Een door het bevoegde gemeentelijke orgaan ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.
identificatie	`string`	Ja	Landelijke identificerende sleutel.
openbareruimteIdentificatie	`string, null`	Nee	Landelijke identificerende sleutel.
openbareruimteNaam	`string, null`	Nee	Officiële naam openbare ruimte (80 tekens).
openbareruimteTypeCode	`integer, null`	Nee	De aard van de zodanig benoemde openbare ruimte (01 Weg, 02 Water, 03 Spoorbaan, 04 Terrein, 05 Kunstwerk, 06 Landschappelijk gebied, 07 Administratief gebied) code Format: int64 Minimum: -9223372036854776000 Maximum: 9223372036854776000
postcode	`string, null`	Nee	De door PostNL vastgestelde code bestaande uit 4 cijfers en 2 letters (1234AB).
typeAdres	`string, null`	Nee	Hiermee wordt aangegeven of het een relatie betreft vanuit een hoofdadres. Anders is er sprake van een nevenadres (Hoofdadres, Nevenadres).
verblijfsobjectGeometrie	`$ref`	Nee	- $ref: ../_shared/geometry
verblijfsobjectIdentificatie	`string, null`	Nee	Landelijke identificerende sleutel.
verblijfsobjectVolgnummer	`integer, null`	Nee	Uniek volgnummer van de toestand van het object. Format: int64 Minimum: -9223372036854776000 Maximum: 9223372036854776000
volgnummer	`integer, null`	Nee	Volgnummer van de nummeraanduiding in de administratie van de bronhouder. Format: int64 Minimum: -9223372036854776000 Maximum: 9223372036854776000
woonplaatsIdentificatie	`string, null`	Nee	Landelijke identificerende code woonplaats Amsterdam 3594 en woonplaats Weesp 3631.
woonplaatsNaam	`string, null`	Nee	Officiële naam woonplaats.

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/gemeente-amsterdam/benkagg-lqtl1u6hg/benkaggbagzoek",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Specifiek voor Data Verkenner gemaakte BAG-tabel van Nummeraanduidingen t.b.v. zoekfunctie met de verblijfsobjecten en gebieden waar ze een relatie mee hebben.",
  "properties": {
    "_links": {
      "description": "The contents of the `bagzoek._links` field. It contains all relationships with objects.",
      "properties": {
        "schema": {
          "description": "The schema field is exposed with every record",
          "format": "uri",
          "readOnly": true,
          "type": "string"
        },
        "self": {
          "$ref": "../_shared/benkaggbagzoeklink"
        }
      },
      "required": [
        "schema",
        "self"
      ],
      "title": " links",
      "type": "object"
    },
    "adresseertVerblijfsobjectIdentificatie": {
      "description": "Het verblijfsobject (landelijke identificatie) dat door de nummeraanduiding wordt aangeduid.",
      "type": [
        "string",
        "null"
      ]
    },
    "beginGeldigheid": {
      "description": "De datum waarop de nummeraanduiding geldig is geworden.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "eindGeldigheid": {
      "description": "De datum waarop de nummeraanduiding niet meer geldig is.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "huisletter": {
      "description": "Een door het bevoegde gemeentelijke orgaan ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.",
      "type": [
        "string",
        "null"
      ]
    },
    "huisnummer": {
      "description": "Een door het bevoegde gemeentelijke orgaan ten aanzien van een adresseerbaar object toegekende nummering.",
      "format": "int64",
      "maximum": 9223372036854776000,
      "minimum": -9223372036854776000,
      "type": [
        "integer",
        "null"
      ]
    },
    "huisnummertoevoeging": {
      "description": "Een door het bevoegde gemeentelijke orgaan ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.",
      "type": [
        "string",
        "null"
      ]
    },
    "identificatie": {
      "description": "Landelijke identificerende sleutel.",
      "type": "string"
    },
    "openbareruimteIdentificatie": {
      "description": "Landelijke identificerende sleutel.",
      "type": [
        "string",
        "null"
      ]
    },
    "openbareruimteNaam": {
      "description": "Officiële naam openbare ruimte (80 tekens).",
      "type": [
        "string",
        "null"
      ]
    },
    "openbareruimteTypeCode": {
      "description": "De aard van de zodanig benoemde openbare ruimte (01 Weg, 02 Water, 03 Spoorbaan, 04 Terrein, 05 Kunstwerk, 06 Landschappelijk gebied, 07 Administratief gebied) code",
      "format": "int64",
      "maximum": 9223372036854776000,
      "minimum": -9223372036854776000,
      "type": [
        "integer",
        "null"
      ]
    },
    "postcode": {
      "description": "De door PostNL vastgestelde code bestaande uit 4 cijfers en 2 letters (1234AB).",
      "type": [
        "string",
        "null"
      ]
    },
    "typeAdres": {
      "description": "Hiermee wordt aangegeven of het een relatie betreft vanuit een hoofdadres. Anders is er sprake van een nevenadres (Hoofdadres, Nevenadres).",
      "type": [
        "string",
        "null"
      ]
    },
    "verblijfsobjectGeometrie": {
      "$ref": "../_shared/geometry"
    },
    "verblijfsobjectIdentificatie": {
      "description": "Landelijke identificerende sleutel.",
      "type": [
        "string",
        "null"
      ]
    },
    "verblijfsobjectVolgnummer": {
      "description": "Uniek volgnummer van de toestand van het object.",
      "format": "int64",
      "maximum": 9223372036854776000,
      "minimum": -9223372036854776000,
      "type": [
        "integer",
        "null"
      ]
    },
    "volgnummer": {
      "description": "Volgnummer van de nummeraanduiding in de administratie van de bronhouder.",
      "format": "int64",
      "maximum": 9223372036854776000,
      "minimum": -9223372036854776000,
      "type": [
        "integer",
        "null"
      ]
    },
    "woonplaatsIdentificatie": {
      "description": "Landelijke identificerende code woonplaats Amsterdam 3594 en woonplaats Weesp 3631.",
      "type": [
        "string",
        "null"
      ]
    },
    "woonplaatsNaam": {
      "description": "Officiële naam woonplaats.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "_links",
    "identificatie"
  ],
  "type": "object",
  "x-derived-from": [
    "https://api.data.amsterdam.nl/v1/benkagg/openapi.json#/components/schemas/Benkaggbagzoek"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
benkaggbagzoeklink	`/properties/_links/properties/self/$ref`
geometry	`/properties/verblijfsobjectGeometrie/$ref`

Dit schema wordt gebruikt door
Schema	Locatie
embedded5	`/properties/bagzoek/items/$ref`

Health issues

Health issues
Message	Pointer
Set a concise non-empty title at the top level of the schema to explain what the definition is about
Set a non-empty examples array at the top level of the schema to illustrate the expected data
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/_links/description`
Titles should not contain leading or trailing whitespace	`/properties/_links/title`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/adresseertVerblijfsobjectIdentificatie/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/beginGeldigheid/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/eindGeldigheid/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/huisletter/description`
Avoid keywords that don't apply to the type or types that the current subschema expects	`/properties/huisnummer/format`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/huisnummer/description`
For interoperability purposes, the JSON Schema specification advises against the use of `format` values that are not explicitly defined by the specification	`/properties/huisnummer/format`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/huisnummertoevoeging/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/identificatie/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/openbareruimteIdentificatie/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/openbareruimteNaam/description`
Avoid keywords that don't apply to the type or types that the current subschema expects	`/properties/openbareruimteTypeCode/format`
For interoperability purposes, the JSON Schema specification advises against the use of `format` values that are not explicitly defined by the specification	`/properties/openbareruimteTypeCode/format`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/postcode/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/typeAdres/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/verblijfsobjectIdentificatie/description`
Avoid keywords that don't apply to the type or types that the current subschema expects	`/properties/verblijfsobjectVolgnummer/format`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/verblijfsobjectVolgnummer/description`
For interoperability purposes, the JSON Schema specification advises against the use of `format` values that are not explicitly defined by the specification	`/properties/verblijfsobjectVolgnummer/format`
Avoid keywords that don't apply to the type or types that the current subschema expects	`/properties/volgnummer/format`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/volgnummer/description`
For interoperability purposes, the JSON Schema specification advises against the use of `format` values that are not explicitly defined by the specification	`/properties/volgnummer/format`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/woonplaatsIdentificatie/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/woonplaatsNaam/description`

Schema-register: benkaggbagzoek

Details van JSON Schema: benkaggbagzoek

Details van JSON Schema: benkaggbagzoek

Beschrijving