VerblijfsobjectIO | Schema-register

Een verzameling van een verblijfsobject en een lijst van alle bijbehorende inonderzoek informatie.

Dialect2020-12

Typeunknown

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
inonderzoek	`array`	Nee	- Min items: 1 Items type: $ref Items $ref: ./kenmerkverblijfsobjectinonderzoek
verblijfsobject	`allOf`	Ja	Een Verblijfsobject is de kleinste binnen een of meer panden gelegen en voor woon-, bedrijfsmatige, of recreatieve doeleinden geschikte eenheid van gebruik die ontsloten wordt via een eigen afsluitbare toegang vanaf de openbare weg, een erf of een gedeelde verkeersruimte, onderwerp kan zijn van goederenrechtelijke rechtshandelingen en in functioneel opzicht zelfstandig is. heeftAlsHoofdAdres: Een adresseerbaar object heeft als hoofadres een nummeraanduiding. Deze property bevat de identificatie van de nummeraanduiding die het hoofdadres is van het adresseerbare object. geometrie: De minimaal tweedimensionale geometrische representatie van een verblijfsobject. status: De fase van de levenscyclus van een verblijfsobject, waarin het betreffende verblijfsobject zich bevindt. geconstateerd: Een aanduiding waarmee kan worden aangegeven dat een object 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. voorkomen: De toestand van een object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie. allOf: 2 schema's
verblijfsobject.allOf[2].documentdatum	`string`	Ja	De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden. Format: date
verblijfsobject.allOf[2].documentnummer	`string`	Ja	De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan. Min length: 1 Max length: 40
verblijfsobject.allOf[2].domein	`string`	Ja	NL.IMBAG.Verblijfsobject Min length: 1
verblijfsobject.allOf[2].gebruiksdoelen	`array`	Ja	- Min items: 1 Items type: string
verblijfsobject.allOf[2].geconstateerd	`string`	Ja	Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie. Enum: J, N
verblijfsobject.allOf[2].geometrie	`$ref`	Ja	- $ref: ./puntofvlak
verblijfsobject.allOf[2].identificatie	`string`	Ja	De unieke aanduiding van een verblijfsobject. Pattern: ^[0-9]{4}01[0-9]{10}$
verblijfsobject.allOf[2].maaktDeelUitVan	`array`	Ja	Een verblijfsobject maakt onderdeel uit van een pand. Deze property bevat de identificaties van de panden waar het verblijfsobject onderdeel van uitmaakt. Min items: 1 Items type: string
verblijfsobject.allOf[2].oppervlakte	`integer`	Ja	De gebruiksoppervlakte van een verblijfsobject in gehele vierkante meters. Pattern: ^[1-9][0-9]{0,5}$
verblijfsobject.allOf[2].status	`string`	Ja	Een aanduiding van alle waarden die de status van een verblijfsobject kan aannemen. Enum: Verblijfsobject gevormd, Niet gerealiseerd verblijfsobject, Verblijfsobject in gebruik (niet ingemeten), Verblijfsobject in gebruik, Verbouwing verblijfsobject, Verblijfsobject ingetrokken, Verblijfsobject buiten gebruik, Verblijfsobject ten onrechte opgevoerd
verblijfsobject.allOf[2].voorkomen	`$ref`	Ja	- $ref: ./voorkomenlv

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/dienst-voor-het-kadaster-en-de-openbare-registers/imbag-api-van-de-lvbag-7fnzbuehg/verblijfsobjectio",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Een verzameling van een verblijfsobject en een lijst van alle bijbehorende inonderzoek informatie.",
  "properties": {
    "inonderzoek": {
      "items": {
        "$ref": "./kenmerkverblijfsobjectinonderzoek"
      },
      "minItems": 1,
      "type": "array"
    },
    "verblijfsobject": {
      "allOf": [
        {
          "$ref": "./adresseerbaarobject"
        },
        {
          "properties": {
            "documentdatum": {
              "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.\n",
              "examples": [
                "2019-11-22"
              ],
              "format": "date",
              "title": "documentdatum",
              "type": "string"
            },
            "documentnummer": {
              "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.\n",
              "examples": [
                "19SZ2048"
              ],
              "maxLength": 40,
              "minLength": 1,
              "title": "Documentnummer",
              "type": "string"
            },
            "domein": {
              "description": "NL.IMBAG.Verblijfsobject",
              "examples": [
                "NL.IMBAG.Verblijfsobject"
              ],
              "minLength": 1,
              "title": "domein",
              "type": "string"
            },
            "gebruiksdoelen": {
              "items": {
                "description": "Een categorisering waarmee het gebruiksdoel van een object kan worden verbijzonderd.",
                "enum": [
                  "woonfunctie",
                  "bijeenkomstfunctie",
                  "celfunctie",
                  "gezondheidszorgfunctie",
                  "industriefunctie",
                  "kantoorfunctie",
                  "logiesfunctie",
                  "onderwijsfunctie",
                  "sportfunctie",
                  "winkelfunctie",
                  "overige gebruiksfunctie"
                ],
                "title": "Gebruiksdoel",
                "type": "string"
              },
              "minItems": 1,
              "type": "array"
            },
            "geconstateerd": {
              "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.",
              "enum": [
                "J",
                "N"
              ],
              "title": "Indicatie",
              "type": "string"
            },
            "geometrie": {
              "$ref": "./puntofvlak"
            },
            "identificatie": {
              "description": "De unieke aanduiding van een verblijfsobject.",
              "examples": [
                "0226010000038820"
              ],
              "pattern": "^[0-9]{4}01[0-9]{10}$",
              "title": "VerblijfsobjectIdentificatie",
              "type": "string"
            },
            "maaktDeelUitVan": {
              "description": "Een verblijfsobject maakt onderdeel uit van een pand.\n\nDeze property bevat de identificaties van de panden waar het verblijfsobject onderdeel van uitmaakt.\n",
              "items": {
                "description": "De unieke aanduiding van een pand.",
                "examples": [
                  "0226100000008856"
                ],
                "pattern": "^[0-9]{4}10[0-9]{10}$",
                "title": "PandIdentificatie",
                "type": "string"
              },
              "minItems": 1,
              "type": "array"
            },
            "oppervlakte": {
              "description": "De gebruiksoppervlakte van een verblijfsobject in gehele vierkante meters.",
              "examples": [
                205
              ],
              "pattern": "^[1-9][0-9]{0,5}$",
              "title": "oppervlakte",
              "type": "integer"
            },
            "status": {
              "description": "Een aanduiding van alle waarden die de status van een verblijfsobject kan aannemen.",
              "enum": [
                "Verblijfsobject gevormd",
                "Niet gerealiseerd verblijfsobject",
                "Verblijfsobject in gebruik (niet ingemeten)",
                "Verblijfsobject in gebruik",
                "Verbouwing verblijfsobject",
                "Verblijfsobject ingetrokken",
                "Verblijfsobject buiten gebruik",
                "Verblijfsobject ten onrechte opgevoerd"
              ],
              "title": "StatusVerblijfsobject",
              "type": "string"
            },
            "voorkomen": {
              "$ref": "./voorkomenlv"
            }
          },
          "required": [
            "documentdatum",
            "documentnummer",
            "domein",
            "gebruiksdoelen",
            "geconstateerd",
            "geometrie",
            "identificatie",
            "maaktDeelUitVan",
            "oppervlakte",
            "status",
            "voorkomen"
          ],
          "type": "object"
        }
      ],
      "description": "Een Verblijfsobject is de kleinste binnen een of meer panden gelegen\nen voor woon-, bedrijfsmatige, of recreatieve doeleinden geschikte\neenheid van gebruik die ontsloten wordt via een eigen afsluitbare\ntoegang vanaf de openbare weg, een erf of een gedeelde\nverkeersruimte, onderwerp kan zijn van goederenrechtelijke\nrechtshandelingen en in functioneel opzicht zelfstandig is.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**geometrie**: De minimaal tweedimensionale geometrische representatie van \neen verblijfsobject.\n\n**status**: De fase van de levenscyclus van een verblijfsobject, waarin het \nbetreffende verblijfsobject zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n",
      "title": "Verblijfsobject"
    }
  },
  "required": [
    "verblijfsobject"
  ],
  "title": "VerblijfsobjectIO",
  "x-derived-from": [
    "https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2/openapi.yaml#/components/schemas/VerblijfsobjectIO"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
KenmerkVerblijfsobjectInOnderzoek	`/properties/inonderzoek/items/$ref`
AdresseerbaarObject	`/properties/verblijfsobject/allOf/0/$ref`
PuntOfVlak	`/properties/verblijfsobject/allOf/1/properties/geometrie/$ref`
VoorkomenLV	`/properties/verblijfsobject/allOf/1/properties/voorkomen/$ref`

Dit schema wordt niet door andere schema's gebruikt.

Health issues

Health issues
Message	Pointer
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	`/description`
Descriptions should not contain leading or trailing whitespace	`/properties/verblijfsobject/description`
Wrapping `$ref` in `allOf` was only necessary in JSON Schema Draft 7 and older	`/properties/verblijfsobject/allOf/0/$ref`
Keywords inside `allOf` that do not conflict with the parent schema can be elevated	`/properties/verblijfsobject/allOf/1/type – /properties/verblijfsobject/allOf/1/required – /properties/verblijfsobject/allOf/1/properties`
Descriptions should not contain leading or trailing whitespace	`/properties/verblijfsobject/allOf/1/properties/documentdatum/description`
Descriptions should not contain leading or trailing whitespace	`/properties/verblijfsobject/allOf/1/properties/documentnummer/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/verblijfsobject/allOf/1/properties/gebruiksdoelen/items/enum – /properties/verblijfsobject/allOf/1/properties/gebruiksdoelen/items/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/verblijfsobject/allOf/1/properties/gebruiksdoelen/items/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/verblijfsobject/allOf/1/properties/geconstateerd/enum – /properties/verblijfsobject/allOf/1/properties/geconstateerd/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/verblijfsobject/allOf/1/properties/geconstateerd/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/verblijfsobject/allOf/1/properties/identificatie/description`
Descriptions should not contain leading or trailing whitespace	`/properties/verblijfsobject/allOf/1/properties/maaktDeelUitVan/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/verblijfsobject/allOf/1/properties/maaktDeelUitVan/items/description`
Avoid keywords that don't apply to the type or types that the current subschema expects	`/properties/verblijfsobject/allOf/1/properties/oppervlakte/pattern`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/verblijfsobject/allOf/1/properties/oppervlakte/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/verblijfsobject/allOf/1/properties/status/enum – /properties/verblijfsobject/allOf/1/properties/status/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/verblijfsobject/allOf/1/properties/status/description`

Schema-register: VerblijfsobjectIO

Details van JSON Schema: VerblijfsobjectIO

Details van JSON Schema: VerblijfsobjectIO

Beschrijving