bgtoverbouwen | Schema-register

Bebouwing boven maaiveld, vrijstaand op pilaren of verbonden met bebouwing op maaiveld, een voor mensen toegankelijk deel van een gebouw. - Groep: bouwwerk - Code: _, niet imgeo

Dialect2020-12

Typeobject

Health74%

Dependencies2

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
_links	`object`	Ja	The contents of the `overbouwen._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: ./bgtoverbouwenlink
eindRegistratie	`string, null`	Nee	Eind van de periode waarop deze instantie van het object geldig is bij de bronhouder. Wanneer deze waarde niet is ingevuld is de instantie nog geldig Format: date-time
geometrie	`object`	Nee	GeoJSON geometry allOf: 2 schema's
geometrie.allOf[2].coordinates	`array`	Nee	- Items type: array
geometrie.allOf[2].type	`string`	Nee	- Enum: MultiPolygon
geometrieVlak	`object`	Nee	GeoJSON geometry allOf: 2 schema's
geometrieVlak.allOf[2].coordinates	`array`	Nee	- Items type: array
geometrieVlak.allOf[2].type	`string`	Nee	- Enum: MultiPolygon
guid	`string`	Ja	Uniek identificerend kenmerk voor het object dat onveranderlijk is zolang het object bestaat
hoortBijBagPandId	`string, null`	Nee	De unieke identificatie van het object waar deze onderbouw bij hoort, zoals is toegekend in de BAG-registratie
relatieveHoogteligging	`integer, null`	Nee	Aanduiding voor de relatieve hoogte van het object ten opzichte van het maaiveld Format: int64 Minimum: -9223372036854776000 Maximum: 9223372036854776000

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/gemeente-amsterdam/bgt-btm_fu6hg/bgtoverbouwen",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Bebouwing boven maaiveld, vrijstaand op pilaren of verbonden met bebouwing op maaiveld, een voor mensen toegankelijk deel van een gebouw. - Groep: bouwwerk - Code: _, niet imgeo",
  "properties": {
    "_links": {
      "description": "The contents of the `overbouwen._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": "./bgtoverbouwenlink"
        }
      },
      "required": [
        "schema",
        "self"
      ],
      "title": " links",
      "type": "object"
    },
    "eindRegistratie": {
      "description": "Eind van de periode waarop deze instantie van het object geldig is bij de bronhouder. Wanneer deze waarde niet is ingevuld is de instantie nog geldig",
      "format": "date-time",
      "title": "Object eindregistratie datumtijd",
      "type": [
        "string",
        "null"
      ]
    },
    "geometrie": {
      "allOf": [
        {
          "$ref": "../_shared/geometry"
        },
        {
          "properties": {
            "coordinates": {
              "items": {
                "items": {
                  "items": {
                    "description": "Point in 3D space",
                    "items": {
                      "type": "number"
                    },
                    "maxItems": 3,
                    "minItems": 2,
                    "type": "array"
                  },
                  "type": "array"
                },
                "type": "array"
              },
              "type": "array"
            },
            "type": {
              "enum": [
                "MultiPolygon"
              ],
              "type": "string"
            }
          }
        }
      ],
      "description": "GeoJSON geometry",
      "type": "object"
    },
    "geometrieVlak": {
      "allOf": [
        {
          "$ref": "../_shared/geometry"
        },
        {
          "properties": {
            "coordinates": {
              "items": {
                "items": {
                  "items": {
                    "description": "Point in 3D space",
                    "items": {
                      "type": "number"
                    },
                    "maxItems": 3,
                    "minItems": 2,
                    "type": "array"
                  },
                  "type": "array"
                },
                "type": "array"
              },
              "type": "array"
            },
            "type": {
              "enum": [
                "MultiPolygon"
              ],
              "type": "string"
            }
          }
        }
      ],
      "description": "GeoJSON geometry",
      "type": "object"
    },
    "guid": {
      "description": "Uniek identificerend kenmerk voor het object dat onveranderlijk is zolang het object bestaat",
      "title": "Guid ID",
      "type": "string"
    },
    "hoortBijBagPandId": {
      "description": "De unieke identificatie van het object waar deze onderbouw bij hoort, zoals is toegekend in de BAG-registratie",
      "title": "Onderbouw hoort bij BAG pand",
      "type": [
        "string",
        "null"
      ]
    },
    "relatieveHoogteligging": {
      "description": "Aanduiding voor de relatieve hoogte van het object ten opzichte van het maaiveld",
      "format": "int64",
      "maximum": 9223372036854776000,
      "minimum": -9223372036854776000,
      "title": "Object relatieve hoogte ligging",
      "type": [
        "integer",
        "null"
      ]
    }
  },
  "required": [
    "_links",
    "guid"
  ],
  "type": "object",
  "x-derived-from": [
    "https://api.data.amsterdam.nl/v1/bgt/openapi.json#/components/schemas/Bgtoverbouwen"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
bgtoverbouwenlink	`/properties/_links/properties/self/$ref`
geometry	`/properties/geometrie/allOf/0/$ref`

Dit schema wordt gebruikt door
Schema	Locatie
embedded17	`/properties/overbouwen/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	`/properties/_links/description`
Titles should not contain leading or trailing whitespace	`/properties/_links/title`
Wrapping `$ref` in `allOf` was only necessary in JSON Schema Draft 7 and older	`/properties/geometrie/allOf/0/$ref`
Keywords inside `allOf` that do not conflict with the parent schema can be elevated	`/properties/geometrie/allOf/1/properties`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/geometrie/allOf/1/properties/type/enum – /properties/geometrie/allOf/1/properties/type/type`
An `enum` of a single value can be expressed as `const`	`/properties/geometrie/allOf/1/properties/type/enum`
Wrapping `$ref` in `allOf` was only necessary in JSON Schema Draft 7 and older	`/properties/geometrieVlak/allOf/0/$ref`
Keywords inside `allOf` that do not conflict with the parent schema can be elevated	`/properties/geometrieVlak/allOf/1/properties`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/geometrieVlak/allOf/1/properties/type/enum – /properties/geometrieVlak/allOf/1/properties/type/type`
An `enum` of a single value can be expressed as `const`	`/properties/geometrieVlak/allOf/1/properties/type/enum`
Avoid keywords that don't apply to the type or types that the current subschema expects	`/properties/relatieveHoogteligging/format`
For interoperability purposes, the JSON Schema specification advises against the use of `format` values that are not explicitly defined by the specification	`/properties/relatieveHoogteligging/format`

Schema-register: bgtoverbouwen

Details van JSON Schema: bgtoverbouwen

Details van JSON Schema: bgtoverbouwen

Beschrijving