opleiding | 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
eQF	`string`	Nee	Het Europees Kwalificatieraamwerk waardoor opleidingen binnen Europese landen (globaal) ingeschat kunnen worden op hun niveau. Enum: 1, 2, 3, 4, 5, 6, 7, 8
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
iSCED	`integer`	Nee	Het kwalificatieraamwerk waardoor opleidingen internationaal ingeschat kunnen worden op hun niveau. Format: int32 Minimum: 0 Maximum: 999
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
nLQF	`string`	Nee	Het Nederlands Kwalificatieraamwerk waardoor opleidingen binnen Nederland ingeschat kunnen worden op hun niveau. Enum: 1, 2, 3, 4, 4p, 5, 6, 7, 8
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
type	`string`	Ja	Geeft aan wat voor soort opleidingseenheid het betreft. Enum: BOGROEP, BOOPLEIDING, BOOPLEIDINGSFASE, BUITENLANDSE_OPLEIDING, EDUCATIEOPLEIDING, EDUCATIEOPLEIDINGSONDERDEEL, EVCSTANDAARD, HOONDERWIJSEENHEDENCLUSTER, HOONDERWIJSEENHEID, HOOPLEIDING, MBOCERTIFICEERBAREEENHEID, MBOCROSS_OVERKWALIFICATIE, MBODEELKWALIFICATIE, MBODOMEIN, MBOGENERIEKEXAMENONDERDEEL, MBOKEUZEDEEL, MBOKWALIFICATIE, MBOKWALIFICATIEDOSSIER, MBOREGIONAALKEUZEDEEL, MBOREGIONALEKWALIFICATIE, PARTICULIEREOPLEIDING, SOGROEP, SOOPLEIDING, VAVOGROEP, VAVOOPLEIDING, VAVOOPLEIDINGSFASE, VOGROEP, VOOPLEIDING, VOOPLEIDINGSFASE, VOSTAGE, VOVAK, VSOGROEP, VSOOPLEIDING, VSOOPLEIDINGSFASE
volledigeNaam	`string`	Ja	Lange naam voor een opleidingseenheid zoals een opleiding, een opleidingsgroep, een opleidingsfase of een opleidingsonderdeel. Min length: 1 Max length: 225
waardedocumentsoort	`string`	Nee	Aanduiding van het soort waardedocument dat kan worden of is behaald. Enum: CERTIFICAAT, DIPLOMA, GEEN_OFFICIEEL_DOCUMENT, GETUIGSCHRIFT, SCHOOLADVIES, VAKBEKWAAMHEIDSBEWIJS

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/dienst-uitvoering-onderwijs/rio-lod-api-a2amj_gdg/opleiding",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "discriminator": {
    "propertyName": "type"
  },
  "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"
    },
    "eQF": {
      "description": "Het Europees Kwalificatieraamwerk waardoor opleidingen binnen Europese landen (globaal) ingeschat kunnen worden op hun niveau.",
      "enum": [
        "1",
        "2",
        "3",
        "4",
        "5",
        "6",
        "7",
        "8"
      ],
      "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"
    },
    "iSCED": {
      "description": "Het kwalificatieraamwerk waardoor opleidingen internationaal ingeschat kunnen worden op hun niveau.",
      "format": "int32",
      "maximum": 999,
      "minimum": 0,
      "type": "integer"
    },
    "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"
    },
    "nLQF": {
      "description": "Het Nederlands Kwalificatieraamwerk waardoor opleidingen binnen Nederland ingeschat kunnen worden op hun niveau.",
      "enum": [
        "1",
        "2",
        "3",
        "4",
        "4p",
        "5",
        "6",
        "7",
        "8"
      ],
      "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"
    },
    "type": {
      "description": "Geeft aan wat voor soort opleidingseenheid het betreft. ",
      "enum": [
        "BOGROEP",
        "BOOPLEIDING",
        "BOOPLEIDINGSFASE",
        "BUITENLANDSE_OPLEIDING",
        "EDUCATIEOPLEIDING",
        "EDUCATIEOPLEIDINGSONDERDEEL",
        "EVCSTANDAARD",
        "HOONDERWIJSEENHEDENCLUSTER",
        "HOONDERWIJSEENHEID",
        "HOOPLEIDING",
        "MBOCERTIFICEERBAREEENHEID",
        "MBOCROSS_OVERKWALIFICATIE",
        "MBODEELKWALIFICATIE",
        "MBODOMEIN",
        "MBOGENERIEKEXAMENONDERDEEL",
        "MBOKEUZEDEEL",
        "MBOKWALIFICATIE",
        "MBOKWALIFICATIEDOSSIER",
        "MBOREGIONAALKEUZEDEEL",
        "MBOREGIONALEKWALIFICATIE",
        "PARTICULIEREOPLEIDING",
        "SOGROEP",
        "SOOPLEIDING",
        "VAVOGROEP",
        "VAVOOPLEIDING",
        "VAVOOPLEIDINGSFASE",
        "VOGROEP",
        "VOOPLEIDING",
        "VOOPLEIDINGSFASE",
        "VOSTAGE",
        "VOVAK",
        "VSOGROEP",
        "VSOOPLEIDING",
        "VSOOPLEIDINGSFASE"
      ],
      "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"
    },
    "waardedocumentsoort": {
      "description": "Aanduiding van het soort waardedocument dat kan worden of is behaald.",
      "enum": [
        "CERTIFICAAT",
        "DIPLOMA",
        "GEEN_OFFICIEEL_DOCUMENT",
        "GETUIGSCHRIFT",
        "SCHOOLADVIES",
        "VAKBEKWAAMHEIDSBEWIJS"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "opleidingseenheidcode",
    "opleidingsherkomst",
    "startdatum",
    "type",
    "volledigeNaam",
    "begindatum"
  ],
  "type": "object",
  "x-class-extra-annotation": "@Relation(collectionRelation = \"Opleidingen\")",
  "x-derived-from": [
    "https://lod.onderwijsregistratie.nl/rio-api/assets/RIO_LOD_API_v2.yml#/components/schemas/Opleiding"
  ],
  "x-implements": "nl.ocwduo.ggm.lod.assembler.opleidingseenheid.IOpleidingseenheid"
}

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
Future versions of JSON Schema will refuse to evaluate unknown keywords or custom keywords from optional vocabularies that don't have an x- prefix	`/discriminator`
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`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/eQF/enum – /properties/eQF/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/eQF/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`
Avoid keywords that don't apply to the type or types that the current subschema expects	`/properties/iSCED/format`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/iSCED/description`
For interoperability purposes, the JSON Schema specification advises against the use of `format` values that are not explicitly defined by the specification	`/properties/iSCED/format`
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`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/nLQF/enum – /properties/nLQF/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/nLQF/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`
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 contain leading or trailing whitespace	`/properties/type/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/volledigeNaam/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/waardedocumentsoort/enum – /properties/waardedocumentsoort/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/waardedocumentsoort/description`

Schema-register: opleiding

Details van JSON Schema: opleiding

Details van JSON Schema: opleiding

Beschrijving