huishoudelijkafvalcluster | Schema-register

cluster

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
_links	`object`	Ja	The contents of the `cluster._links` field. It contains all relationships with objects.
_links.bagHoofdadresVerblijfsobject	`$ref`	Ja	- $ref: ./bagverblijfsobjectenrawidentifier
_links.bagNummeraanduiding	`$ref`	Ja	- $ref: ./bagnummeraanduidingenrawidentifier
_links.bagOpenbareruimte	`$ref`	Ja	- $ref: ./bagopenbareruimtesrawidentifier
_links.gbdBuurt	`$ref`	Ja	- $ref: ../_shared/gebiedenbuurtenrawidentifier
_links.schema	`string`	Ja	The schema field is exposed with every record Format: uri
_links.self	`$ref`	Ja	- $ref: ./huishoudelijkafvalclusterlink
bagHoofdadresVerblijfsobjectId	`string, null`	Ja	Een identificatiecode van een verblijfsobject is een authentiek gegeven en een unieke aanduiding van het verblijfsobject.
bagNummeraanduidingId	`string, null`	Ja	Identificatie nummeraanduiding
bagOpenbareruimteId	`string, null`	Ja	Openbare ruimte identificatie
bronadres	`string, null`	Nee	Adres van het cluster zoals die in bron geregistreerd is.
datumEinde	`string, null`	Nee	Datum wanneer het cluster geen relaties meer heeft met containers met status=1. Format: date
datumOntstaan	`string, null`	Nee	Datum ontstaan van het cluster. Dit is afgeleid van de plaatsingsdatum van de oudste container ,wanneer het gegeven bij het systeem bekend is of peildatum 01-01-2016 Format: date
datumOpvoer	`string, null`	Nee	Datum opvoer van het cluster. Dit is afgeleid van wanneer het gegeven bij het systeem bekend is of peildatum 01-01-2016 Format: date-time
gbdBuurtId	`string, null`	Ja	Unieke identificatie van het object
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	Point in 3D space Min items: 2 Max items: 3 Items type: number
geometrie.allOf[2].type	`string`	Nee	- Enum: Point
id	`string`	Ja	Uniek identificerend kenmerk van cluster
opmerking	`string, null`	Nee	Extra aanwijzing van de locatie voor de bestuurder.
status	`integer, null`	Nee	Status van het cluster (0 - inactief , 1 - actief) Format: int64 Minimum: -9223372036854776000 Maximum: 9223372036854776000
subclusterIndicatie	`boolean, null`	Nee	Indicatie of het een cluster betreft dat is gesplitst door een weg
verwijderdDp	`boolean, null`	Nee	Indicatie of het object verwijderd is bij de bronhouder
wijzigingsdatumDp	`string, null`	Nee	Datum waarop het object is gewijzigd Format: date-time

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/gemeente-amsterdam/afvalcontainers-putten-en-weeggegevens--mrgfx6ng/huishoudelijkafvalcluster",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "cluster",
  "properties": {
    "_links": {
      "description": "The contents of the `cluster._links` field. It contains all relationships with objects.",
      "properties": {
        "bagHoofdadresVerblijfsobject": {
          "$ref": "./bagverblijfsobjectenrawidentifier"
        },
        "bagNummeraanduiding": {
          "$ref": "./bagnummeraanduidingenrawidentifier"
        },
        "bagOpenbareruimte": {
          "$ref": "./bagopenbareruimtesrawidentifier"
        },
        "gbdBuurt": {
          "$ref": "../_shared/gebiedenbuurtenrawidentifier"
        },
        "schema": {
          "description": "The schema field is exposed with every record",
          "format": "uri",
          "readOnly": true,
          "type": "string"
        },
        "self": {
          "$ref": "./huishoudelijkafvalclusterlink"
        }
      },
      "required": [
        "bagHoofdadresVerblijfsobject",
        "bagNummeraanduiding",
        "bagOpenbareruimte",
        "gbdBuurt",
        "schema",
        "self"
      ],
      "title": " links",
      "type": "object"
    },
    "bagHoofdadresVerblijfsobjectId": {
      "deprecated": true,
      "description": "Een identificatiecode van een verblijfsobject is een authentiek gegeven en een unieke aanduiding van het verblijfsobject.",
      "readOnly": true,
      "title": "BAG  hoofdadres verblijfsobject",
      "type": [
        "string",
        "null"
      ]
    },
    "bagNummeraanduidingId": {
      "deprecated": true,
      "description": "Identificatie nummeraanduiding",
      "readOnly": true,
      "title": "Nummeraanduiding ID",
      "type": [
        "string",
        "null"
      ]
    },
    "bagOpenbareruimteId": {
      "deprecated": true,
      "description": "Openbare ruimte identificatie",
      "readOnly": true,
      "title": "Openbare ruimte ID",
      "type": [
        "string",
        "null"
      ]
    },
    "bronadres": {
      "description": "Adres van het cluster zoals die in bron geregistreerd is.",
      "title": "Adres",
      "type": [
        "string",
        "null"
      ]
    },
    "datumEinde": {
      "description": "Datum wanneer het cluster geen relaties meer heeft met containers met status=1.",
      "format": "date",
      "title": "Cluster einddatum",
      "type": [
        "string",
        "null"
      ]
    },
    "datumOntstaan": {
      "description": "Datum ontstaan van het cluster. Dit is afgeleid van de plaatsingsdatum van de oudste container ,wanneer het gegeven bij het systeem bekend is of peildatum 01-01-2016",
      "format": "date",
      "title": "Cluster startdatum",
      "type": [
        "string",
        "null"
      ]
    },
    "datumOpvoer": {
      "description": "Datum opvoer van het cluster. Dit is afgeleid van wanneer het gegeven bij het systeem bekend is of peildatum 01-01-2016",
      "format": "date-time",
      "title": "Geldigheid startdatumtijd",
      "type": [
        "string",
        "null"
      ]
    },
    "gbdBuurtId": {
      "deprecated": true,
      "description": "Unieke identificatie van het object",
      "readOnly": true,
      "title": "Gebied buurt",
      "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": {
              "description": "Point in 3D space",
              "items": {
                "type": "number"
              },
              "maxItems": 3,
              "minItems": 2,
              "type": "array"
            },
            "type": {
              "enum": [
                "Point"
              ],
              "type": "string"
            }
          }
        }
      ],
      "description": "GeoJSON geometry",
      "type": "object"
    },
    "id": {
      "description": "Uniek identificerend kenmerk van cluster",
      "title": "Cluster ID",
      "type": "string"
    },
    "opmerking": {
      "description": "Extra aanwijzing van de locatie voor de bestuurder.",
      "type": [
        "string",
        "null"
      ]
    },
    "status": {
      "description": "Status van het cluster (0 - inactief , 1 - actief)",
      "format": "int64",
      "maximum": 9223372036854776000,
      "minimum": -9223372036854776000,
      "title": "Cluster status code",
      "type": [
        "integer",
        "null"
      ]
    },
    "subclusterIndicatie": {
      "description": "Indicatie of het een cluster betreft dat is gesplitst door een weg",
      "title": "Subcluster ID",
      "type": [
        "boolean",
        "null"
      ]
    },
    "verwijderdDp": {
      "description": "Indicatie of het object verwijderd is bij de bronhouder",
      "title": "Geldigheid einddatumtijd",
      "type": [
        "boolean",
        "null"
      ]
    },
    "wijzigingsdatumDp": {
      "description": "Datum waarop het object is gewijzigd",
      "format": "date-time",
      "title": "Datumtijd aanmaak wijziging",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "_links",
    "bagHoofdadresVerblijfsobjectId",
    "bagNummeraanduidingId",
    "bagOpenbareruimteId",
    "gbdBuurtId",
    "id"
  ],
  "type": "object",
  "x-derived-from": [
    "https://api.data.amsterdam.nl/v1/huishoudelijkafval/openapi.json#/components/schemas/Huishoudelijkafvalcluster"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
bagverblijfsobjectenrawidentifier	`/properties/_links/properties/bagHoofdadresVerblijfsobject/$ref`
bagnummeraanduidingenrawidentifier	`/properties/_links/properties/bagNummeraanduiding/$ref`
bagopenbareruimtesrawidentifier	`/properties/_links/properties/bagOpenbareruimte/$ref`
gebiedenbuurtenrawidentifier	`/properties/_links/properties/gbdBuurt/$ref`
huishoudelijkafvalclusterlink	`/properties/_links/properties/self/$ref`

Dit schema wordt gebruikt door
Schema	Locatie
embedded5	`/properties/cluster/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`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/bagHoofdadresVerblijfsobjectId/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/bronadres/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/datumEinde/description`
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`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/opmerking/description`
Avoid keywords that don't apply to the type or types that the current subschema expects	`/properties/status/format`
For interoperability purposes, the JSON Schema specification advises against the use of `format` values that are not explicitly defined by the specification	`/properties/status/format`

Schema-register: huishoudelijkafvalcluster

Details van JSON Schema: huishoudelijkafvalcluster

Details van JSON Schema: huishoudelijkafvalcluster

Beschrijving