optie | Schema-register

Dialect2020-12

Typeunknown

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
optieGeenVanBovenstaande	`boolean`	Ja	Kenmerk optieGeenVanBovenstaande=true betekent dat dit de optie "geen van bovenstaande" is en kan worden geselecteerd in plaats van de andere (antwoord) opties. Dit geldt voor meerkeuzevragen van het antwoordType 'lijstwaarde' met optieType 'meerdereAntwoorden'. Er is maximaal 1 optie met optieGeenVanBovenstaande=true.
optieTekst	`string`	Ja	De tekst die de antwoord-optie omschrijft.
sequenceId	`integer`	Ja	Numeriek veld dat wordt gebruikt voor de presentatievolgorde van de Opties.
toelichting	`object`	Nee	Verwijzing naar de toelichting bij de vraag. De inhoud van de toelichting kan opgehaald worden bij de toelichtingen service
toelichting.belangrijk	`boolean`	Ja	Definieert of de toelichting belangrijk is voor het ondersteunen en begrijpen van de vraag of het antwoord. Dit kan bijvoorbeeld gebruikt worden door frontend-applicaties als indicatie dat de toelichting direct getoond dient te worden.
toelichting.korteToelichtingId	`integer`	Nee	identifier waarmee de korte toelichting geidentificeerd wordt in de toelichtingen service. Indien er geen toelichting beschikbaar is is dit veld afwezig
toelichting.langeToelichtingId	`integer`	Nee	identifier waarmee de lange toelichting geidentificeerd wordt in de toelichtingen service. Indien er geen toelichting beschikbaar is is dit veld afwezig

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/_shared/optie",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "optieGeenVanBovenstaande": {
      "description": "Kenmerk optieGeenVanBovenstaande=true betekent dat dit de optie \"geen van bovenstaande\" is en kan worden geselecteerd in plaats van de andere (antwoord) opties. Dit geldt voor meerkeuzevragen van het antwoordType 'lijstwaarde' met optieType 'meerdereAntwoorden'. Er is maximaal 1 optie met optieGeenVanBovenstaande=true.",
      "type": "boolean"
    },
    "optieTekst": {
      "description": "De tekst die de antwoord-optie omschrijft.",
      "type": "string"
    },
    "sequenceId": {
      "description": "Numeriek veld dat wordt gebruikt voor de presentatievolgorde van de Opties.",
      "type": "integer"
    },
    "toelichting": {
      "description": "Verwijzing naar de toelichting bij de vraag. De inhoud van de toelichting kan opgehaald worden bij de toelichtingen service",
      "properties": {
        "belangrijk": {
          "description": "Definieert of de toelichting belangrijk is voor het ondersteunen en begrijpen van de vraag of het antwoord. Dit kan bijvoorbeeld gebruikt worden door frontend-applicaties als indicatie dat de toelichting direct getoond dient te worden.",
          "type": "boolean"
        },
        "korteToelichtingId": {
          "description": "identifier waarmee de korte toelichting geidentificeerd wordt in de toelichtingen service. Indien er geen toelichting beschikbaar is is dit veld afwezig",
          "type": "integer"
        },
        "langeToelichtingId": {
          "description": "identifier waarmee de lange toelichting geidentificeerd wordt in de toelichtingen service. Indien er geen toelichting beschikbaar is is dit veld afwezig",
          "type": "integer"
        }
      },
      "required": [
        "belangrijk"
      ]
    }
  },
  "required": [
    "optieTekst",
    "sequenceId",
    "optieGeenVanBovenstaande"
  ],
  "x-derived-from": [
    "https://developer.omgevingswet.overheid.nl/publish/pages/171046/toepasbareregels-uitvoerenservices-v2.json#/components/schemas/Optie",
    "https://developer.omgevingswet.overheid.nl/publish/pages/171046/toepasbareregels-uitvoerenservices-v3.json#/components/schemas/Optie"
  ]
}

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/optieGeenVanBovenstaande/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/optieTekst/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/sequenceId/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/toelichting/properties/belangrijk/description`

Schema-register: optie

Details van JSON Schema: optie

Details van JSON Schema: optie

Beschrijving