gebiedenggpgebieden | Schema-register

ggpgebieden

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
_links	`object`	Ja	The contents of the `ggpgebieden._links` field. It contains all relationships with objects.
_links.bestaatUitBuurten	`array`	Ja	- Items type: $ref Items $ref: ./gebiedenggpgebiedenbestaatuitbuurten_m2m
_links.ligtInStadsdeel	`$ref`	Ja	- $ref: ../_shared/gebiedenstadsdelenlink
_links.schema	`string`	Ja	The schema field is exposed with every record Format: uri
_links.self	`$ref`	Ja	- $ref: ./gebiedenggpgebiedenlink
beginGeldigheid	`string, null`	Nee	De ingangsdatum van de geldigheid van een bepaalde combinatie van gegevens over een gebied Format: date-time
code	`string, null`	Nee	Officiële code van het object
documentdatum	`string, null`	Nee	De datum waarop het document is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van het object heeft plaatsgevonden Format: date
documentnummer	`string, null`	Nee	Unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van het object heeft plaatsgevonden
eindGeldigheid	`string, null`	Nee	De einddatum van de geldigheid van een bepaalde combinatie van gegevens over een gebied Format: date-time
geometrie	`object`	Nee	GeoJSON geometry allOf: 2 schema's
geometrie.allOf[1].coordinates	`array`	Nee	Based on the geometry type, a point or collection of points. Min items: 2 Items type: number
geometrie.allOf[1].type	`string`	Ja	the geometry type Enum: Point, LineString, Polygon, MultiPoint, MultiLineString, MultiPolygon
geometrie.allOf[2].coordinates	`array`	Nee	- Items type: array
geometrie.allOf[2].type	`string`	Nee	- Enum: Polygon
identificatie	`string`	Ja	Uniek identificerend kenmerk voor het object dat onveranderlijk is zolang het object bestaat
ligtInStadsdeelId	`string, null`	Ja	Het stadsdeel waar het ggpgebied in ligt
naam	`string, null`	Nee	De naam van het object
registratiedatum	`string, null`	Nee	Datum waarop het gegeven in de bron geregistreerd is Format: date-time
volgnummer	`integer`	Ja	Uniek volgnummer van de toestand van het object Format: int64 Minimum: -9223372036854776000 Maximum: 9223372036854776000

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/gemeente-amsterdam/gebieden--nkpfu6hg/gebiedenggpgebieden",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "ggpgebieden",
  "properties": {
    "_links": {
      "description": "The contents of the `ggpgebieden._links` field. It contains all relationships with objects.",
      "properties": {
        "bestaatUitBuurten": {
          "items": {
            "$ref": "./gebiedenggpgebiedenbestaatuitbuurten_m2m"
          },
          "type": "array"
        },
        "ligtInStadsdeel": {
          "$ref": "../_shared/gebiedenstadsdelenlink"
        },
        "schema": {
          "description": "The schema field is exposed with every record",
          "format": "uri",
          "readOnly": true,
          "type": "string"
        },
        "self": {
          "$ref": "./gebiedenggpgebiedenlink"
        }
      },
      "required": [
        "bestaatUitBuurten",
        "ligtInStadsdeel",
        "schema",
        "self"
      ],
      "title": " links",
      "type": "object"
    },
    "beginGeldigheid": {
      "description": "De ingangsdatum van de geldigheid van een bepaalde combinatie van gegevens over een gebied",
      "format": "date-time",
      "title": "Object geldigheid startdatum",
      "type": [
        "string",
        "null"
      ]
    },
    "code": {
      "description": "Officiële code van het object",
      "title": "Object code",
      "type": [
        "string",
        "null"
      ]
    },
    "documentdatum": {
      "description": "De datum waarop het document is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van het object heeft plaatsgevonden",
      "format": "date",
      "title": "Brondocument datum",
      "type": [
        "string",
        "null"
      ]
    },
    "documentnummer": {
      "description": "Unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van het object heeft plaatsgevonden",
      "title": "Brondocument nummer",
      "type": [
        "string",
        "null"
      ]
    },
    "eindGeldigheid": {
      "description": "De einddatum van de geldigheid van een bepaalde combinatie van gegevens over een gebied",
      "format": "date-time",
      "title": "Object geldigheid einddatum",
      "type": [
        "string",
        "null"
      ]
    },
    "geometrie": {
      "allOf": [
        {
          "description": "GeoJSON geometry",
          "discriminator": {
            "propertyName": "type"
          },
          "properties": {
            "coordinates": {
              "description": "Based on the geometry type, a point or collection of points.",
              "items": {
                "type": "number"
              },
              "minItems": 2,
              "type": "array"
            },
            "type": {
              "description": "the geometry type",
              "enum": [
                "Point",
                "LineString",
                "Polygon",
                "MultiPoint",
                "MultiLineString",
                "MultiPolygon"
              ],
              "type": "string"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        },
        {
          "properties": {
            "coordinates": {
              "items": {
                "items": {
                  "description": "Point in 3D space",
                  "items": {
                    "type": "number"
                  },
                  "maxItems": 3,
                  "minItems": 2,
                  "type": "array"
                },
                "type": "array"
              },
              "type": "array"
            },
            "type": {
              "enum": [
                "Polygon"
              ],
              "type": "string"
            }
          }
        }
      ],
      "description": "GeoJSON geometry",
      "type": "object"
    },
    "identificatie": {
      "description": "Uniek identificerend kenmerk voor het object dat onveranderlijk is zolang het object bestaat",
      "title": "Object ID",
      "type": "string"
    },
    "ligtInStadsdeelId": {
      "deprecated": true,
      "description": "Het stadsdeel waar het ggpgebied in ligt",
      "readOnly": true,
      "title": "GGP gebied ligt in stadsdeel",
      "type": [
        "string",
        "null"
      ]
    },
    "naam": {
      "description": "De naam van het object",
      "title": "Object naam",
      "type": [
        "string",
        "null"
      ]
    },
    "registratiedatum": {
      "description": "Datum waarop het gegeven in de bron geregistreerd is",
      "format": "date-time",
      "title": "Object registratiedatum",
      "type": [
        "string",
        "null"
      ]
    },
    "volgnummer": {
      "description": "Uniek volgnummer van de toestand van het object",
      "format": "int64",
      "maximum": 9223372036854776000,
      "minimum": -9223372036854776000,
      "title": "Object volgnummer",
      "type": "integer"
    }
  },
  "required": [
    "_links",
    "identificatie",
    "ligtInStadsdeelId",
    "volgnummer"
  ],
  "type": "object",
  "x-derived-from": [
    "https://api.data.amsterdam.nl/v1/gebieden/openapi.json#/components/schemas/Gebiedenggpgebieden"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
gebiedenggpgebiedenbestaatuitbuurten_m2m	`/properties/_links/properties/bestaatUitBuurten/items/$ref`
gebiedenstadsdelenlink	`/properties/_links/properties/ligtInStadsdeel/$ref`
gebiedenggpgebiedenlink	`/properties/_links/properties/self/$ref`

Dit schema wordt gebruikt door
Schema	Locatie
embedded3	`/properties/ggpgebieden/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`
Keywords inside `allOf` that do not conflict with the parent schema can be elevated	`/properties/geometrie/allOf/0/type – /properties/geometrie/allOf/0/required – /properties/geometrie/allOf/0/discriminator – /properties/geometrie/allOf/0/description`
Future versions of JSON Schema will refuse to evaluate unknown keywords or custom keywords from optional vocabularies that don't have an x- prefix	`/properties/geometrie/allOf/0/discriminator`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/geometrie/allOf/0/properties/coordinates/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/geometrie/allOf/0/properties/type/enum – /properties/geometrie/allOf/0/properties/type/type`
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`
Avoid keywords that don't apply to the type or types that the current subschema expects	`/properties/volgnummer/format`
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`

Schema-register: gebiedenggpgebieden

Details van JSON Schema: gebiedenggpgebieden

Details van JSON Schema: gebiedenggpgebieden

Beschrijving