opleidingseenheid | Schema-register

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
afkorting	`string`	Nee	Is een korte omschrijving van de naam van de opleiding. Min length: 1 Max length: 12
begindatum	`string`	Ja	De datum die het begin van de periode aangeeft (inclusief). Format: date
eigenOpleidingseenheidsleutel	`string`	Nee	Een identificerend kenmerk dat door een particuliere organisatie is bepaald voor een particuliere opleiding ten behoeve van uitwisseling in de keten. Min length: 1 Max length: 60
einddatum	`string`	Nee	De datum die het einde van de periode aangeeft (exclusief). Format: date
id	`string`	Ja	Algemeen gegevenstype voor het vastleggen van een naam Min length: 1 Max length: 100
internationaleNaamEngels	`string`	Nee	De naam voor internationaal gebruik ter aanduiding van een opleidingseenheid zoals een opleiding, een opleidingsgroep, een opleidingsfase of een opleidingsonderdeel. Min length: 1 Max length: 225
korteNaam	`string`	Nee	Korte naam voor een opleidingseenheid zoals een opleiding, een opleidingsgroep, een opleidingsfase of een opleidingsonderdeel. Min length: 1 Max length: 40
omschrijving	`string`	Nee	Nadere beschrijving Max length: 3000
opheffingsdatum	`string`	Nee	De datum die het einde van de periode aangeeft (exclusief). Format: date
opleidingseenheidcode	`string`	Ja	Een betekenisloze identifier voor een opleidingseenheid in de Registratie Instellingen en Opleidingen. Pattern: (\d{4}O\d{4}) Min length: 9 Max length: 9
opleidingsherkomst	`string`	Ja	Geeft aan welke instantie zeggenschap heeft over de opleidingseenheid. Enum: INSTELLING, NKC_EVC, NVAO, OCW, OCW_G, SBB, VORAAD
startdatum	`string`	Ja	De datum die het begin van de periode aangeeft (inclusief). Format: date
volledigeNaam	`string`	Ja	Lange naam voor een opleidingseenheid zoals een opleiding, een opleidingsgroep, een opleidingsfase of een opleidingsonderdeel. Min length: 1 Max length: 225

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/dienst-uitvoering-onderwijs/rio-lod-api-a2amj_gdg/opleidingseenheid",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "afkorting": {
      "description": "Is een korte omschrijving van de naam van de opleiding.",
      "maxLength": 12,
      "minLength": 1,
      "type": "string"
    },
    "begindatum": {
      "description": "De datum die het begin van de periode aangeeft (inclusief).",
      "format": "date",
      "type": "string"
    },
    "eigenOpleidingseenheidsleutel": {
      "description": "Een identificerend kenmerk dat door een particuliere organisatie is bepaald voor een particuliere opleiding ten behoeve van uitwisseling in de keten.",
      "maxLength": 60,
      "minLength": 1,
      "type": "string"
    },
    "einddatum": {
      "description": "De datum die het einde van de periode aangeeft (exclusief).",
      "format": "date",
      "type": "string"
    },
    "id": {
      "description": "Algemeen gegevenstype voor het vastleggen van een naam",
      "maxLength": 100,
      "minLength": 1,
      "type": "string"
    },
    "internationaleNaamEngels": {
      "description": "De naam voor internationaal gebruik ter aanduiding van een opleidingseenheid zoals een opleiding, een opleidingsgroep, een opleidingsfase of een opleidingsonderdeel.",
      "maxLength": 225,
      "minLength": 1,
      "type": "string"
    },
    "korteNaam": {
      "description": "Korte naam voor een opleidingseenheid zoals een opleiding, een opleidingsgroep, een opleidingsfase of een opleidingsonderdeel.",
      "maxLength": 40,
      "minLength": 1,
      "type": "string"
    },
    "omschrijving": {
      "description": "Nadere beschrijving ",
      "maxLength": 3000,
      "type": "string"
    },
    "opheffingsdatum": {
      "deprecated": true,
      "description": "De datum die het einde van de periode aangeeft (exclusief).",
      "format": "date",
      "type": "string"
    },
    "opleidingseenheidcode": {
      "description": "Een betekenisloze identifier voor een opleidingseenheid in de Registratie Instellingen en Opleidingen.",
      "maxLength": 9,
      "minLength": 9,
      "pattern": "(\\d{4}O\\d{4})",
      "type": "string"
    },
    "opleidingsherkomst": {
      "description": "Geeft aan welke instantie zeggenschap heeft over de opleidingseenheid.",
      "enum": [
        "INSTELLING",
        "NKC_EVC",
        "NVAO",
        "OCW",
        "OCW_G",
        "SBB",
        "VORAAD"
      ],
      "type": "string"
    },
    "startdatum": {
      "deprecated": true,
      "description": "De datum die het begin van de periode aangeeft (inclusief).",
      "format": "date",
      "type": "string"
    },
    "volledigeNaam": {
      "description": "Lange naam voor een opleidingseenheid zoals een opleiding, een opleidingsgroep, een opleidingsfase of een opleidingsonderdeel.",
      "maxLength": 225,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "id",
    "opleidingseenheidcode",
    "opleidingsherkomst",
    "startdatum",
    "volledigeNaam",
    "begindatum"
  ],
  "type": "object",
  "x-derived-from": [
    "https://lod.onderwijsregistratie.nl/rio-api/assets/RIO_LOD_API_v2.yml#/components/schemas/Opleidingseenheid"
  ]
}

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/afkorting/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/eigenOpleidingseenheidsleutel/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/internationaleNaamEngels/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/korteNaam/description`
Descriptions should not contain leading or trailing whitespace	`/properties/omschrijving/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/opheffingsdatum/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/opleidingseenheidcode/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/opleidingsherkomst/enum – /properties/opleidingsherkomst/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/opleidingsherkomst/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/startdatum/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/volledigeNaam/description`

Schema-register: opleidingseenheid

Details van JSON Schema: opleidingseenheid

Details van JSON Schema: opleidingseenheid

Beschrijving