organisatierelatie | Schema-register

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
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
naarOrganisatorischeEenheid	`string`	Ja	Identificerend kenmerk voor een organisatorische eenheid ten behoeve van uitwisseling in de keten. Pattern: \d{3}[A-Z]{1}\d{3} Min length: 7 Max length: 7
soort	`string`	Ja	Mogelijke relatiesoorten tussen organisatorische-eenheden. Enum: HIERARCHISCH, OVERGANG
vanOrganisatorischeEenheid	`string`	Ja	Identificerend kenmerk voor een organisatorische eenheid ten behoeve van uitwisseling in de keten. Pattern: \d{3}[A-Z]{1}\d{3} Min length: 7 Max length: 7

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/dienst-uitvoering-onderwijs/rio-lod-api-a2amj_gdg/organisatierelatie",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "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"
    },
    "naarOrganisatorischeEenheid": {
      "description": "Identificerend kenmerk voor een organisatorische eenheid ten behoeve van uitwisseling in de keten.",
      "maxLength": 7,
      "minLength": 7,
      "pattern": "\\d{3}[A-Z]{1}\\d{3}",
      "type": "string"
    },
    "soort": {
      "description": "Mogelijke relatiesoorten tussen organisatorische-eenheden.",
      "enum": [
        "HIERARCHISCH",
        "OVERGANG"
      ],
      "type": "string"
    },
    "vanOrganisatorischeEenheid": {
      "description": "Identificerend kenmerk voor een organisatorische eenheid ten behoeve van uitwisseling in de keten.",
      "maxLength": 7,
      "minLength": 7,
      "pattern": "\\d{3}[A-Z]{1}\\d{3}",
      "type": "string"
    }
  },
  "required": [
    "begindatum",
    "naarOrganisatorischeEenheid",
    "soort",
    "vanOrganisatorischeEenheid"
  ],
  "type": "object",
  "x-class-extra-annotation": "@Relation(collectionRelation = \"Organisatierelaties\")",
  "x-derived-from": [
    "https://lod.onderwijsregistratie.nl/rio-api/assets/RIO_LOD_API_v2.yml#/components/schemas/Organisatierelatie"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Dit schema gebruikt geen andere schema's.

Dit schema wordt niet door andere schema's gebruikt.

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
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/naarOrganisatorischeEenheid/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/soort/enum – /properties/soort/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/soort/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/vanOrganisatorischeEenheid/description`

Schema-register: organisatierelatie

Details van JSON Schema: organisatierelatie

Details van JSON Schema: organisatierelatie

Beschrijving