formeelinstellingsadres | Schema-register

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
adresregelBuitenlandDrie	`string`	Nee	Een regel voor een of meerdere elementen van een adres buiten Nederland. Min length: 1 Max length: 80
adresregelBuitenlandEen	`string`	Nee	Een regel voor een of meerdere elementen van een adres buiten Nederland. Min length: 1 Max length: 80
adresregelBuitenlandTwee	`string`	Nee	Een regel voor een of meerdere elementen van een adres buiten Nederland. Min length: 1 Max length: 80
bag-id	`string`	Nee	De identificatie van een gebouw zoals dat in de Basisadministratie Gebouwen (BAG) bekend is.
begindatum	`string`	Ja	De datum die het begin van de periode aangeeft (inclusief). Format: date
einddatum	`string`	Nee	De datum die het einde van de periode aangeeft (exclusief). Format: date
gemeentenaam	`string`	Nee	De officiële door de gemeente vastgestelde naam van de gemeente. Min length: 1 Max length: 40
huisnummer	`integer`	Nee	De numerieke aanduiding zoals deze door het gemeentebestuur aan het object is toegekend. Format: int32 Minimum: 1 Maximum: 99999
huisnummertoevoeging	`string`	Nee	Die letters of tekens die noodzakelijk zijn om, naast het juiste huisnummer, de brievenbus te vinden. Min length: 1 Max length: 6
landcode	`string`	Nee	De code van een land in de tabel 34 van de Rijkdienst voor Identiteitsgegevens. Pattern: \d{4,4} Min length: 4 Max length: 4
plaatsnaam	`string`	Nee	De naam van de plaats. Min length: 1 Max length: 40
postcode	`string`	Nee	De door de Post NL vastgestelde code behorend bij de straatnaam en het huisnummer dan wel de door Post NL vastgestelde code behorende bij een bepaalde combinatie van een naam openbare ruimte en een huisnummer. Pattern: ([1-9]{1}[0-9]{3}[A-Z]{2}) Max length: 6
rijksdriehoekX	`number`	Nee	Coördinaat om geografische data eenduidig vast te leggen gezien van west naar oost. Minimum: 0 Maximum: 280000
rijksdriehoekY	`number`	Nee	Coördinaat om geografische data eenduidig vast te leggen gezien van zuid naar noord. Minimum: 300000 Maximum: 625000
straatnaam	`string`	Nee	De straatnaam zoals die officieel is vastgesteld door de gemeente. Min length: 1 Max length: 80
type	`string`	Ja	Geeft aan wat voor soort FormeelAdres het betreft. Enum: BINNENLANDS_ADRES, BUITENLANDS_ADRES

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/dienst-uitvoering-onderwijs/rio-lod-api-a2amj_gdg/formeelinstellingsadres",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "adresregelBuitenlandDrie": {
      "description": "Een regel voor een of meerdere elementen van een adres buiten Nederland.",
      "maxLength": 80,
      "minLength": 1,
      "type": "string"
    },
    "adresregelBuitenlandEen": {
      "description": "Een regel voor een of meerdere elementen van een adres buiten Nederland.",
      "maxLength": 80,
      "minLength": 1,
      "type": "string"
    },
    "adresregelBuitenlandTwee": {
      "description": "Een regel voor een of meerdere elementen van een adres buiten Nederland.",
      "maxLength": 80,
      "minLength": 1,
      "type": "string"
    },
    "bag-id": {
      "description": "De identificatie van een gebouw zoals dat in de Basisadministratie Gebouwen (BAG) bekend is.",
      "type": "string"
    },
    "begindatum": {
      "description": "De datum die het begin van de periode aangeeft (inclusief).",
      "format": "date",
      "type": "string"
    },
    "einddatum": {
      "description": "De datum die het einde van de periode aangeeft (exclusief).",
      "format": "date",
      "type": "string"
    },
    "gemeentenaam": {
      "description": "De officiële door de gemeente vastgestelde naam van de gemeente.",
      "maxLength": 40,
      "minLength": 1,
      "type": "string"
    },
    "huisnummer": {
      "description": "De numerieke aanduiding zoals deze door het gemeentebestuur aan het object is toegekend.",
      "format": "int32",
      "maximum": 99999,
      "minimum": 1,
      "type": "integer"
    },
    "huisnummertoevoeging": {
      "description": "Die letters of tekens die noodzakelijk zijn om, naast het juiste huisnummer, de brievenbus te vinden.",
      "maxLength": 6,
      "minLength": 1,
      "type": "string"
    },
    "landcode": {
      "description": "De code van een land in de tabel 34 van de Rijkdienst voor Identiteitsgegevens.",
      "maxLength": 4,
      "minLength": 4,
      "pattern": "\\d{4,4}",
      "type": "string"
    },
    "plaatsnaam": {
      "description": "De naam van de plaats.",
      "maxLength": 40,
      "minLength": 1,
      "type": "string"
    },
    "postcode": {
      "description": "De door de Post NL vastgestelde code behorend bij de straatnaam en het huisnummer dan wel de door Post NL vastgestelde code behorende bij een bepaalde combinatie van een naam openbare ruimte en een huisnummer.",
      "maxLength": 6,
      "pattern": "([1-9]{1}[0-9]{3}[A-Z]{2})",
      "type": "string"
    },
    "rijksdriehoekX": {
      "description": "Coördinaat om geografische data eenduidig vast te leggen gezien van west naar oost.",
      "maximum": 280000,
      "minimum": 0,
      "type": "number"
    },
    "rijksdriehoekY": {
      "description": "Coördinaat om geografische data eenduidig vast te leggen gezien van zuid naar noord.",
      "maximum": 625000,
      "minimum": 300000,
      "type": "number"
    },
    "straatnaam": {
      "description": "De straatnaam zoals die officieel is vastgesteld door de gemeente.",
      "maxLength": 80,
      "minLength": 1,
      "type": "string"
    },
    "type": {
      "description": "Geeft aan wat voor soort FormeelAdres het betreft.",
      "enum": [
        "BINNENLANDS_ADRES",
        "BUITENLANDS_ADRES"
      ],
      "type": "string"
    }
  },
  "required": [
    "begindatum",
    "type"
  ],
  "type": "object",
  "x-class-extra-annotation": "@Relation(collectionRelation = \"FormeelInstellingsadressen\")",
  "x-derived-from": [
    "https://lod.onderwijsregistratie.nl/rio-api/assets/RIO_LOD_API_v2.yml#/components/schemas/FormeelInstellingsadres"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Dit schema gebruikt geen andere schema's.

Dit schema wordt gebruikt door
Schema	Locatie
embeddedformeelinstellingsadres	`/properties/formeelInstellingsadres/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 description at the top level of the schema to explain what the definition is about in detail
Set a non-empty examples array at the top level of the schema to illustrate the expected data
Set `properties` to identifier names that can be easily mapped to programming languages (matching [A-Za-z_][A-Za-z0-9_]*)	`/properties/bag-id`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/adresregelBuitenlandDrie/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/adresregelBuitenlandEen/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/adresregelBuitenlandTwee/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/bag-id/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/begindatum/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/einddatum/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/gemeentenaam/description`
Avoid keywords that don't apply to the type or types that the current subschema expects	`/properties/huisnummer/format`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/huisnummer/description`
For interoperability purposes, the JSON Schema specification advises against the use of `format` values that are not explicitly defined by the specification	`/properties/huisnummer/format`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/huisnummertoevoeging/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/landcode/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/plaatsnaam/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/postcode/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/rijksdriehoekX/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/rijksdriehoekY/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/straatnaam/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/type/enum – /properties/type/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/type/description`

Schema-register: formeelinstellingsadres

Details van JSON Schema: formeelinstellingsadres

Details van JSON Schema: formeelinstellingsadres

Beschrijving