toelichtingdetails | Schema-register

Verwijzing naar de toelichting bij de vraag. De inhoud van de toelichting kan opgehaald worden bij de toelichtingen service

Dialect2020-12

Typeunknown

Health50%

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
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.
korteToelichtingId	`integer`	Nee	identifier waarmee de korte toelichting geidentificeerd wordt in de toelichtingen service. Indien er geen toelichting beschikbaar is is dit veld afwezig
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/toelichtingdetails",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "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"
  ],
  "x-derived-from": [
    "https://developer.omgevingswet.overheid.nl/publish/pages/171046/toepasbareregels-uitvoerenservices-v2.json#/components/schemas/ToelichtingDetails",
    "https://developer.omgevingswet.overheid.nl/publish/pages/171046/toepasbareregels-uitvoerenservices-v3.json#/components/schemas/ToelichtingDetails"
  ]
}

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 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/belangrijk/description`

Schema-register: toelichtingdetails

Details van JSON Schema: toelichtingdetails

Details van JSON Schema: toelichtingdetails

Beschrijving