bagligplaatsen | Schema-register

Een LIGPLAATS is een door het bevoegde gemeentelijke orgaan als zodanig aangewezen plaats in het water die bestemd is voor het permanent afmeren van een voor woon-, bedrijfsmatige of recreatieve doeleinden geschikt drijvend object

Dialect2020-12

Typeobject

Health81%

Dependencies8

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
_links	`object`	Ja	The contents of the `ligplaatsen._links` field. It contains all relationships with objects.
_links.heeftDossier	`$ref`	Ja	- $ref: ./bagdossierslink
_links.heeftHoofdadres	`$ref`	Ja	- $ref: ../_shared/bagnummeraanduidingenlink
_links.heeftNevenadres	`array`	Ja	- Items type: $ref Items $ref: ./bagligplaatsenheeftnevenadres_m2m
_links.heeftOnderzoeken	`array`	Ja	- Items type: $ref Items $ref: ./bagligplaatsenheeftonderzoeken_m2m
_links.ligtInBuurt	`$ref`	Ja	- $ref: ../_shared/gebiedenbuurtenlink
_links.schema	`string`	Ja	The schema field is exposed with every record Format: uri
_links.self	`$ref`	Ja	- $ref: ../_shared/bagligplaatsenlink
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 begindatum van een periode waarin een of meer gegevens die worden bijgehouden over een ligplaats een wijziging hebben ondergaan 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 een periode waarin een of meer gegevens die worden bijgehouden over een ligplaats een wijziging hebben ondergaan Format: date-time
gebruiksdoel	`array`	Ja	- Items type: $ref Items $ref: ./bagligplaatsengebruiksdoel
geconstateerd	`boolean, null`	Nee	Een aanduiding waarmee kan worden aangegeven dat een ligplaats in de registratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake was van een regulier brondocument voor deze opname
geometrie	`$ref`	Nee	- $ref: ../_shared/geometry
heeftDossierId	`string, null`	Ja	De brondocument(en) op basis waarvan de ligplaats is toegevoegd aan de registratie. Afgeleid van hetlandelijke BAG-kenmerk 'Documentnummer'
heeftHoofdadresId	`string, null`	Ja	Het HOOFDadres dat de ligplaats heeft
identificatie	`string`	Ja	Unieke identificatie van een ligplaats
ligtInBuurtId	`string, null`	Ja	De buurt waarin een ligplaats ligt
plusvolgnummer	`integer, null`	Nee	Uniek BAG-plus volgnummer van de toestand van het object Format: int64 Minimum: -9223372036854776000 Maximum: 9223372036854776000
registratiedatum	`string, null`	Nee	Begin geldigheid van een bepaalde combinatie van BAG- en BAG-plus-gegevens van een BAG-object Format: date-time
statusCode	`integer, null`	Nee	Dit is een vervallen kenmerk en wordt niet geactualiseerd Format: int64 Minimum: -9223372036854776000 Maximum: 9223372036854776000
statusOmschrijving	`string, null`	Nee	De fase van de levenscyclus van een ligplaats, waarin de betreffende ligplaats zich bevindt, Plaats aangewezen, plaats ingetrokken
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/bag-6-fsfxehg/bagligplaatsen",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Een LIGPLAATS is een door het bevoegde gemeentelijke orgaan als zodanig aangewezen plaats in het water die bestemd is voor het permanent afmeren van een voor woon-, bedrijfsmatige of recreatieve doeleinden geschikt drijvend object",
  "properties": {
    "_links": {
      "description": "The contents of the `ligplaatsen._links` field. It contains all relationships with objects.",
      "properties": {
        "heeftDossier": {
          "$ref": "./bagdossierslink"
        },
        "heeftHoofdadres": {
          "$ref": "../_shared/bagnummeraanduidingenlink"
        },
        "heeftNevenadres": {
          "items": {
            "$ref": "./bagligplaatsenheeftnevenadres_m2m"
          },
          "type": "array"
        },
        "heeftOnderzoeken": {
          "items": {
            "$ref": "./bagligplaatsenheeftonderzoeken_m2m"
          },
          "type": "array"
        },
        "ligtInBuurt": {
          "$ref": "../_shared/gebiedenbuurtenlink"
        },
        "schema": {
          "description": "The schema field is exposed with every record",
          "format": "uri",
          "readOnly": true,
          "type": "string"
        },
        "self": {
          "$ref": "../_shared/bagligplaatsenlink"
        }
      },
      "required": [
        "heeftDossier",
        "heeftHoofdadres",
        "heeftNevenadres",
        "heeftOnderzoeken",
        "ligtInBuurt",
        "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 begindatum van een periode waarin een of meer gegevens die worden bijgehouden over een ligplaats een wijziging hebben ondergaan",
      "format": "date-time",
      "title": "Ligplaats 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": "Document datum",
      "type": [
        "string",
        "null"
      ]
    },
    "documentnummer": {
      "description": "Het unieke nummer van het brondocument",
      "title": "Brondocument nummer",
      "type": [
        "string",
        "null"
      ]
    },
    "eindGeldigheid": {
      "description": "De einddatum van een periode waarin een of meer gegevens die worden bijgehouden over een ligplaats een wijziging hebben ondergaan",
      "format": "date-time",
      "title": "Ligplaats geldigheid einddatum",
      "type": [
        "string",
        "null"
      ]
    },
    "gebruiksdoel": {
      "items": {
        "$ref": "./bagligplaatsengebruiksdoel"
      },
      "type": "array"
    },
    "geconstateerd": {
      "description": "Een aanduiding waarmee kan worden aangegeven dat een ligplaats in de registratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake was van een regulier brondocument voor deze opname",
      "title": "Ligplaats geconstateerd indicatie",
      "type": [
        "boolean",
        "null"
      ]
    },
    "geometrie": {
      "$ref": "../_shared/geometry"
    },
    "heeftDossierId": {
      "deprecated": true,
      "description": "De brondocument(en) op basis waarvan de ligplaats is toegevoegd aan de registratie. Afgeleid van hetlandelijke BAG-kenmerk 'Documentnummer'",
      "readOnly": true,
      "title": "Ligplaats heeft dossier",
      "type": [
        "string",
        "null"
      ]
    },
    "heeftHoofdadresId": {
      "deprecated": true,
      "description": "Het HOOFDadres dat de ligplaats heeft",
      "readOnly": true,
      "title": "Ligplaats heeft hoofdadres",
      "type": [
        "string",
        "null"
      ]
    },
    "identificatie": {
      "description": "Unieke identificatie van een ligplaats",
      "title": "Ligplaats ID",
      "type": "string"
    },
    "ligtInBuurtId": {
      "deprecated": true,
      "description": "De buurt waarin een ligplaats ligt",
      "readOnly": true,
      "title": "Ligplaats ligt in buurt",
      "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": "Begin geldigheid van een bepaalde combinatie van BAG- en BAG-plus-gegevens van een BAG-object",
      "format": "date-time",
      "title": "Object registratiedatum",
      "type": [
        "string",
        "null"
      ]
    },
    "statusCode": {
      "description": "Dit is een vervallen kenmerk en wordt niet geactualiseerd",
      "format": "int64",
      "maximum": 9223372036854776000,
      "minimum": -9223372036854776000,
      "title": "Ligplaats status code",
      "type": [
        "integer",
        "null"
      ]
    },
    "statusOmschrijving": {
      "description": "De fase van de levenscyclus van een ligplaats, waarin de betreffende ligplaats zich bevindt, Plaats aangewezen, plaats ingetrokken",
      "title": "Ligplaats 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"
    }
  },
  "required": [
    "_links",
    "gebruiksdoel",
    "heeftDossierId",
    "heeftHoofdadresId",
    "identificatie",
    "ligtInBuurtId",
    "volgnummer"
  ],
  "type": "object",
  "x-derived-from": [
    "https://api.data.amsterdam.nl/v1/bag/openapi.json#/components/schemas/Bagligplaatsen"
  ]
}

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`
bagnummeraanduidingenlink	`/properties/_links/properties/heeftHoofdadres/$ref`
bagligplaatsenheeftnevenadres_m2m	`/properties/_links/properties/heeftNevenadres/items/$ref`
bagligplaatsenheeftonderzoeken_m2m	`/properties/_links/properties/heeftOnderzoeken/items/$ref`
gebiedenbuurtenlink	`/properties/_links/properties/ligtInBuurt/$ref`
bagligplaatsenlink	`/properties/_links/properties/self/$ref`
bagligplaatsengebruiksdoel	`/properties/gebruiksdoel/items/$ref`
geometry	`/properties/geometrie/$ref`

Dit schema wordt gebruikt door
Schema	Locatie
embedded3	`/properties/ligplaatsen/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`
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`

Schema-register: bagligplaatsen

Details van JSON Schema: bagligplaatsen

Details van JSON Schema: bagligplaatsen

Beschrijving