- SourceMeta name
- woonplaats
- Base dialect
- https://json-schema.org/draft/2020-12/schema
- SourceMeta dialect
- https://json-schema.org/draft/2020-12/schema
- Bytes
- 3.580 bytes
- Bytes bundled
- 8.000 bytes
- Health
- 23%
- Dependencies
- 1
Dependencies
- At
- /properties/voorkomen/$ref
Health issues
- Name
- top_level_examples
- Message
- Set a non-empty examples array at the top level of the schema to illustrate the expected data
- Pointers
- Name
- description_trim
- Message
- Descriptions should not contain leading or trailing whitespace
- Pointers
- /description
- Name
- description_trailing_period
- Message
- Descriptions should not end with a period to give user interfaces flexibility in presenting the text
- Pointers
- /properties/documentdatum/description
- Name
- description_trailing_period
- Message
- Descriptions should not end with a period to give user interfaces flexibility in presenting the text
- Pointers
- /properties/documentnummer/description
- Name
- enum_with_type
- Message
- Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types
- Pointers
- /properties/geconstateerd/enum - /properties/geconstateerd/type
- Name
- description_trailing_period
- Message
- Descriptions should not end with a period to give user interfaces flexibility in presenting the text
- Pointers
- /properties/geconstateerd/description
- Name
- description_trim
- Message
- Descriptions should not contain leading or trailing whitespace
- Pointers
- /properties/identificatie/description
- Name
- description_trailing_period
- Message
- Descriptions should not end with a period to give user interfaces flexibility in presenting the text
- Pointers
- /properties/naam/description
- Name
- enum_with_type
- Message
- Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types
- Pointers
- /properties/status/enum - /properties/status/type
- Name
- description_trailing_period
- Message
- Descriptions should not end with a period to give user interfaces flexibility in presenting the text
- Pointers
- /properties/status/description
{
"$id": "https://schemas.don.projects.digilab.network/schemas/api-register/dienst-voor-het-kadaster-en-de-openbare-registers/imbag-api-van-de-lvbag-7fnzbuehg/woonplaats",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Een Woonplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorzien gedeelte van het grondgebied van de \ngemeente.\n\n**status**: De fase van de levenscyclus van een woonplaats, waarin de \nbetreffende woonplaats 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 waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n",
"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.",
"examples": [
"2009-02-09"
],
"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.",
"examples": [
"09.0898"
],
"maxLength": 40,
"minLength": 1,
"title": "documentnummer",
"type": "string"
},
"domein": {
"description": "NL.IMBAG.Woonplaats",
"examples": [
"NL.IMBAG.Woonplaats"
],
"minLength": 1,
"title": "domein",
"type": "string"
},
"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"
},
"identificatie": {
"description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n",
"examples": [
"2096"
],
"pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$",
"title": "WoonplaatsIdentificatie",
"type": "string"
},
"naam": {
"description": "De benaming van een door het gemeentebestuur aangewezen woonplaats.",
"examples": [
"Duiven"
],
"maxLength": 80,
"minLength": 1,
"title": "naam",
"type": "string"
},
"status": {
"description": "Een aanduiding van alle waarden die de status van een woonplaats kan aannemen.",
"enum": [
"Woonplaats aangewezen",
"Woonplaats ingetrokken"
],
"title": "StatusWoonplaats",
"type": "string"
},
"voorkomen": {
"$ref": "./voorkomenlv"
}
},
"required": [
"documentdatum",
"documentnummer",
"domein",
"geconstateerd",
"identificatie",
"naam",
"status",
"voorkomen"
],
"title": "Woonplaats",
"type": "object",
"x-derived-from": [
"https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2/openapi.yaml#/components/schemas/Woonplaats"
]
}