bagwoonplaatsen

Een WOONPLAATS is een door het bevoegde gemeentelijke orgaan als zodanig aangewezen en van een naam voorzien gedeelte van het grondgebied van de gemeente

Dialect2020-12

Typeobject

Health72%

Dependencies6

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
_links	`object`	Ja	The contents of the `woonplaatsen._links` field. It contains all relationships with objects.
_links.heeftDossier	`$ref`	Ja	- $ref: ./bagdossierslink
_links.heeftOnderzoeken	`array`	Ja	- Items type: $ref Items $ref: ./bagwoonplaatsenheeftonderzoeken_m2m
_links.ligtInGemeente	`$ref`	Ja	- $ref: ../_shared/brk2gemeenteslink
_links.openbareruimtes	`$ref`	Ja	- $ref: ./relatedsummary
_links.schema	`string`	Ja	The schema field is exposed with every record Format: uri
_links.self	`$ref`	Ja	- $ref: ./bagwoonplaatsenlink
bagprocesCode	`integer, null`	Nee	Functionele handeling die ten grondslag ligt aan de gebeurtenis. code Format: int64 Minimum: -9223372036854776000 Maximum: 9223372036854776000
bagprocesOmschrijving	`string, null`	Nee	Functionele handeling die ten grondslag ligt aan de gebeurtenis. omschrijving
beginGeldigheid	`string, null`	Nee	De ingangsdatum van de geldigheid van een bepaalde combinatie van gegevens over een WOONPLAATS Format: date-time
datumActueelTot	`string, null`	Nee	Einddatum van de cyclus, eventueel in combinatie met het kenmerk Status Format: date-time
documentdatum	`string, null`	Nee	De datum waarop het brondocument is vastgesteld Format: date
documentnummer	`string, null`	Nee	Het unieke nummer van het brondocument
eindGeldigheid	`string, null`	Nee	De einddatum van de geldigheid van een bepaalde combinatie van gegevens over een WOONPLAATS Format: date-time
geconstateerd	`string, null`	Nee	Dit geeft aan dat een WOONPLAATS in de registratie is opgenomen als gevolg van een feitelijke constatering en niet op basis van een regulier brondocument
geometrie	`$ref`	Nee	- $ref: ../_shared/geometry
heeftDossierId	`string, null`	Ja	Het dossier op basis waarvan het object is toegevoegd aan de registratie
identificatie	`string`	Ja	Unieke aanduiding van een woonplaats
ligtInGemeenteId	`string, null`	Ja	De gemeente waarin de woonplaats ligt.
naam	`string, null`	Nee	Officiële naam woonplaats
plusvolgnummer	`integer, null`	Nee	Uniek BAG-plus volgnummer van de toestand van het object Format: int64 Minimum: -9223372036854776000 Maximum: 9223372036854776000
registratiedatum	`string, null`	Nee	De datum waarop de toestand van het object is geregistreerd Format: date-time
statusCode	`integer, null`	Nee	De levenscyclus van een WOONPLAATS waarin de betreffende woonplaats zich bevindt. Code Format: int64 Minimum: -9223372036854776000 Maximum: 9223372036854776000
statusOmschrijving	`string, null`	Nee	De levenscyclus van een WOONPLAATS waarin de betreffende woonplaats zich bevindt. Omschrijving
volgnummer	`integer`	Ja	Uniek volgnummer van de toestand van het object Format: int64 Minimum: -9223372036854776000 Maximum: 9223372036854776000
woonplaatsPtt	`string, null`	Nee	Dit is een vervallen kenmerk en wordt niet geactualiseerd.

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/gemeente-amsterdam/bag-6-fsfxehg/bagwoonplaatsen",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Een WOONPLAATS is een door het bevoegde gemeentelijke orgaan als zodanig aangewezen en van een naam voorzien gedeelte van het grondgebied van de gemeente",
  "properties": {
    "_links": {
      "description": "The contents of the `woonplaatsen._links` field. It contains all relationships with objects.",
      "properties": {
        "heeftDossier": {
          "$ref": "./bagdossierslink"
        },
        "heeftOnderzoeken": {
          "items": {
            "$ref": "./bagwoonplaatsenheeftonderzoeken_m2m"
          },
          "type": "array"
        },
        "ligtInGemeente": {
          "$ref": "../_shared/brk2gemeenteslink"
        },
        "openbareruimtes": {
          "$ref": "./relatedsummary"
        },
        "schema": {
          "description": "The schema field is exposed with every record",
          "format": "uri",
          "readOnly": true,
          "type": "string"
        },
        "self": {
          "$ref": "./bagwoonplaatsenlink"
        }
      },
      "required": [
        "heeftDossier",
        "heeftOnderzoeken",
        "ligtInGemeente",
        "openbareruimtes",
        "schema",
        "self"
      ],
      "title": " links",
      "type": "object"
    },
    "bagprocesCode": {
      "description": "Functionele handeling die ten grondslag ligt aan de gebeurtenis. code",
      "format": "int64",
      "maximum": 9223372036854776000,
      "minimum": -9223372036854776000,
      "title": "BAG proces code",
      "type": [
        "integer",
        "null"
      ]
    },
    "bagprocesOmschrijving": {
      "description": "Functionele handeling die ten grondslag ligt aan de gebeurtenis. omschrijving",
      "title": "BAG proces omschrijving",
      "type": [
        "string",
        "null"
      ]
    },
    "beginGeldigheid": {
      "description": "De ingangsdatum van de geldigheid van een bepaalde combinatie van gegevens over een WOONPLAATS",
      "format": "date-time",
      "title": "Woonplaats geldigheid begindatum",
      "type": [
        "string",
        "null"
      ]
    },
    "datumActueelTot": {
      "description": "Einddatum van de cyclus, eventueel in combinatie met het kenmerk Status",
      "format": "date-time",
      "title": "Actueel tot datum",
      "type": [
        "string",
        "null"
      ]
    },
    "documentdatum": {
      "description": "De datum waarop het brondocument is vastgesteld",
      "format": "date",
      "title": "Brondocument datum",
      "type": [
        "string",
        "null"
      ]
    },
    "documentnummer": {
      "description": "Het unieke nummer van het brondocument",
      "title": "Brondocument nummer",
      "type": [
        "string",
        "null"
      ]
    },
    "eindGeldigheid": {
      "description": "De einddatum van de geldigheid van een bepaalde combinatie van gegevens over een WOONPLAATS",
      "format": "date-time",
      "title": "Woonplaats geldigheid einddatum",
      "type": [
        "string",
        "null"
      ]
    },
    "geconstateerd": {
      "description": "Dit geeft aan dat een WOONPLAATS in de registratie is opgenomen als gevolg van een feitelijke constatering en niet op basis van een regulier brondocument",
      "title": "Woonplaats geconstateerd indicatie",
      "type": [
        "string",
        "null"
      ]
    },
    "geometrie": {
      "$ref": "../_shared/geometry"
    },
    "heeftDossierId": {
      "deprecated": true,
      "description": "Het dossier op basis waarvan het object is toegevoegd aan de registratie",
      "readOnly": true,
      "title": "Woonplaats heeft dossier",
      "type": [
        "string",
        "null"
      ]
    },
    "identificatie": {
      "description": "Unieke aanduiding van een woonplaats",
      "title": "Woonplaats ID",
      "type": "string"
    },
    "ligtInGemeenteId": {
      "deprecated": true,
      "description": "De gemeente waarin de woonplaats ligt.",
      "readOnly": true,
      "title": "Woonplaats ligt in gemeente",
      "type": [
        "string",
        "null"
      ]
    },
    "naam": {
      "description": "Officiële naam woonplaats",
      "title": "Woonplaats naam",
      "type": [
        "string",
        "null"
      ]
    },
    "plusvolgnummer": {
      "description": "Uniek BAG-plus volgnummer van de toestand van het object",
      "format": "int64",
      "maximum": 9223372036854776000,
      "minimum": -9223372036854776000,
      "title": "Object plus volgnummer",
      "type": [
        "integer",
        "null"
      ]
    },
    "registratiedatum": {
      "description": "De datum waarop de toestand van het object is geregistreerd",
      "format": "date-time",
      "title": "Object registratiedatum",
      "type": [
        "string",
        "null"
      ]
    },
    "statusCode": {
      "description": "De levenscyclus van een WOONPLAATS waarin de betreffende woonplaats zich bevindt. Code",
      "format": "int64",
      "maximum": 9223372036854776000,
      "minimum": -9223372036854776000,
      "title": "Woonplaats status code",
      "type": [
        "integer",
        "null"
      ]
    },
    "statusOmschrijving": {
      "description": "De levenscyclus van een WOONPLAATS waarin de betreffende woonplaats zich bevindt. Omschrijving",
      "title": "Woonplaats status omschrijving",
      "type": [
        "string",
        "null"
      ]
    },
    "volgnummer": {
      "description": "Uniek volgnummer van de toestand van het object",
      "format": "int64",
      "maximum": 9223372036854776000,
      "minimum": -9223372036854776000,
      "title": "Object volgnummer",
      "type": "integer"
    },
    "woonplaatsPtt": {
      "description": "Dit is een vervallen kenmerk en wordt niet geactualiseerd.",
      "title": "Woonplaatsnaam conform PTT regels",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "_links",
    "heeftDossierId",
    "identificatie",
    "ligtInGemeenteId",
    "volgnummer"
  ],
  "type": "object",
  "x-derived-from": [
    "https://api.data.amsterdam.nl/v1/bag/openapi.json#/components/schemas/Bagwoonplaatsen"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
bagdossierslink	`/properties/_links/properties/heeftDossier/$ref`
bagwoonplaatsenheeftonderzoeken_m2m	`/properties/_links/properties/heeftOnderzoeken/items/$ref`
brk2gemeenteslink	`/properties/_links/properties/ligtInGemeente/$ref`
relatedsummary	`/properties/_links/properties/openbareruimtes/$ref`
bagwoonplaatsenlink	`/properties/_links/properties/self/$ref`
geometry	`/properties/geometrie/$ref`

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

Schema-register: bagwoonplaatsen

Details van JSON Schema: bagwoonplaatsen

Details van JSON Schema: bagwoonplaatsen

Beschrijving