contactadres | Schema-register

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
_embedded	`$ref`	Nee	- $ref: ./embeddedcontactadres
contactnaam	`string`	Nee	Een identificerende omschrijving van de contactpersoon of -afdeling Min length: 1 Max length: 200
context	`string`	Ja	Het kader waarbinnen men in contact treedt dat als linked open data mag worden gepubliceerd. Enum: AANMELDEN, ALGEMEEN, CENTRAAL_AANMELDEN_MBO, FACTURATIE
eMailadres	`string`	Nee	Is een adres voor het ontvangen en verzenden van elektronische post. Pattern: (?=^.{3,253}$)(?:^[a-zA-Z0-9!\x22\\#\&$%+=?^_`{\|}~.-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-][a-zA-Z0-9])?(?:\.[a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]){1,6}$) Min length: 4 Max length: 253
faxnummer	`string`	Nee	Het geheel aan cijfers en tekens waarmee wordt aangeduid hoe een persoon via telefonie kan worden bereikt. Pattern: ^(\+\|[0-9])((\s\|\s?(-\|$0$)\s?)?[0-9]){2,15}([,][1-9][0-9]{1,8})?$ Min length: 3 Max length: 22
id	`string`	Ja	Algemeen gegevenstype voor het vastleggen van een naam Min length: 1 Max length: 100
subcontext	`string`	Nee	Omschrijving van een set van bereikbaarheidsgegevens binnen een communicatiecontext Max length: 200
subcontextnummer	`string`	Ja	Aanduiding van een set aan bereikbaarheidsgegevens binnen een communicatiecontext. Min length: 1 Max length: 4
telefoonnummer	`string`	Nee	Het geheel aan cijfers en tekens waarmee wordt aangeduid hoe een persoon via telefonie kan worden bereikt. Pattern: ^(\+\|[0-9])((\s\|\s?(-\|$0$)\s?)?[0-9]){2,15}([,][1-9][0-9]{1,8})?$ Min length: 3 Max length: 22
types	`array`	Ja	- Min length: 1 Items type: string
webadres	`string`	Nee	De locatie op het World Wide Web waar documenten en andere objecten kunnen worden gevonden. Pattern: [Hh][Tt][Tt][Pp][Ss]?:\/\/.{0,312} Min length: 7 Max length: 320

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/dienst-uitvoering-onderwijs/rio-lod-api-a2amj_gdg/contactadres",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "_embedded": {
      "$ref": "./embeddedcontactadres"
    },
    "contactnaam": {
      "description": "Een identificerende omschrijving van de contactpersoon of -afdeling",
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "context": {
      "description": "Het kader waarbinnen men in contact treedt dat als linked open data mag worden gepubliceerd. ",
      "enum": [
        "AANMELDEN",
        "ALGEMEEN",
        "CENTRAAL_AANMELDEN_MBO",
        "FACTURATIE"
      ],
      "type": "string"
    },
    "eMailadres": {
      "description": "Is een adres voor het ontvangen en verzenden van elektronische post.",
      "maxLength": 253,
      "minLength": 4,
      "pattern": "(?=^.{3,253}$)(?:^[a-zA-Z0-9!\\x22\\\\#\\&$%*+=?^_`{|}~.-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?(?:\\.[a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]){1,6}$)",
      "type": "string"
    },
    "faxnummer": {
      "description": "Het geheel aan cijfers en tekens waarmee wordt aangeduid hoe een persoon via telefonie kan worden bereikt.",
      "maxLength": 22,
      "minLength": 3,
      "pattern": "^(\\+|[0-9])((\\s|\\s?(-|\\(0\\))\\s?)?[0-9]){2,15}([,][1-9][0-9]{1,8})?$",
      "type": "string"
    },
    "id": {
      "description": "Algemeen gegevenstype voor het vastleggen van een naam",
      "maxLength": 100,
      "minLength": 1,
      "type": "string"
    },
    "subcontext": {
      "description": "Omschrijving van een set van bereikbaarheidsgegevens binnen een communicatiecontext",
      "maxLength": 200,
      "type": "string"
    },
    "subcontextnummer": {
      "description": "Aanduiding van een set aan bereikbaarheidsgegevens binnen een communicatiecontext.",
      "maxLength": 4,
      "minLength": 1,
      "type": "string"
    },
    "telefoonnummer": {
      "description": "Het geheel aan cijfers en tekens waarmee wordt aangeduid hoe een persoon via telefonie kan worden bereikt.",
      "maxLength": 22,
      "minLength": 3,
      "pattern": "^(\\+|[0-9])((\\s|\\s?(-|\\(0\\))\\s?)?[0-9]){2,15}([,][1-9][0-9]{1,8})?$",
      "type": "string"
    },
    "types": {
      "items": {
        "description": "Geeft aan wat voor soort Contactadres het betreft.",
        "enum": [
          "BEZOEKBTL",
          "BEZOEKNL",
          "CONTACTPUNT",
          "EMAIL",
          "FAX",
          "POSTNL",
          "POSTBTL",
          "TELEFOON",
          "WEB"
        ],
        "type": "string"
      },
      "minLength": 1,
      "type": "array"
    },
    "webadres": {
      "description": "De locatie op het World Wide Web waar documenten en andere objecten kunnen worden gevonden.",
      "maxLength": 320,
      "minLength": 7,
      "pattern": "[Hh][Tt][Tt][Pp][Ss]?:\\/\\/.{0,312}",
      "type": "string"
    }
  },
  "required": [
    "context",
    "id",
    "subcontextnummer",
    "types"
  ],
  "type": "object",
  "x-class-extra-annotation": "@Relation(collectionRelation = \"Contactadressen\")",
  "x-derived-from": [
    "https://lod.onderwijsregistratie.nl/rio-api/assets/RIO_LOD_API_v2.yml#/components/schemas/Contactadres"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
embeddedcontactadres	`/properties/_embedded/$ref`

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
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/context/enum – /properties/context/type`
Descriptions should not contain leading or trailing whitespace	`/properties/context/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/eMailadres/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/faxnummer/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/subcontextnummer/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/telefoonnummer/description`
Avoid keywords that don't apply to the type or types that the current subschema expects	`/properties/types/minLength`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/types/items/enum – /properties/types/items/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/types/items/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/webadres/description`

Schema-register: contactadres

Details van JSON Schema: contactadres

Details van JSON Schema: contactadres

Beschrijving