request | Schema-register

Request voor ophalen en beantwoorden van vragen

Dialect2020-12

Typeunknown

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
_geo	`object`	Ja	Filter op geografisch punt of vlak. Zie de [DSO API/URI strategie](https://iplo.nl/digitaal-stelsel/aansluiten/standaarden/api-en-uri-strategie).
_geo.intersects	`oneOf`	Ja	Punt of vlak waarmee het resultaat raakvlak moet hebben. Analoog aan ElasticSearch GeoShape Query (https://www.elastic.co/guide/en/elasticsearch/reference/5.0/query-dsl-geo-shape-query.html) oneOf: 4 schema's
_geo.intersects.oneOf[4].geometries	`array`	Ja	- Items type: anyOf
_geo.intersects.oneOf[4].type	`string`	Ja	- Enum: GeometryCollection
datum	`allOf`	Nee	- allOf: 2 schema's
functioneleStructuurRefs	`array`	Ja	De verwijzingen naar een regelbeheerobject van de activiteit in de functionele structuur met eventueel bijbehorende antwoorden Min items: 1 Max items: 100 Items type: object
functioneleStructuurRefs[].antwoorden	`array`	Nee	Optionele lijst van Antwoord objecten Max items: 500 Items type: object
functioneleStructuurRefs[].antwoorden[].antwoord	`string`	Nee	Het antwoord op de uitvoeringsregel met het desbetreffende id. Indien meerdere antwoorden bij een lijstwaarde dan komma gescheiden met spaties. Indien het antwoord op de vraag vooringevuld is door de service maar leeg moet worden gemaakt (denk aan huisletter) dan dit antwoord als een lege string aanleveren, ongeacht het antwoordType (dus ook bij numeriek). Max length: 6144
functioneleStructuurRefs[].antwoorden[].id	`integer`	Ja	Het id waarmee het antwoord aan de juiste uitvoeringsregel (vraag/bijlage) wordt gekoppeld.
functioneleStructuurRefs[].functioneleStructuurRef	`string`	Ja	De verwijzing naar een regelbeheerobject van een geselecteerde activiteit in de functionele structuur in de Registratie Toepasbare Regels.

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/toepasbare-regels-uitvoeren-services-g1mc6lrvg/request",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Request voor ophalen en beantwoorden van vragen",
  "properties": {
    "_geo": {
      "description": "Filter op geografisch punt of vlak. Zie de [DSO API/URI strategie](https://iplo.nl/digitaal-stelsel/aansluiten/standaarden/api-en-uri-strategie).",
      "examples": [
        {
          "intersects": {
            "coordinates": [
              155000,
              463000
            ],
            "type": "Point"
          }
        }
      ],
      "properties": {
        "intersects": {
          "description": "Punt of vlak waarmee het resultaat raakvlak moet hebben. Analoog aan ElasticSearch GeoShape Query (https://www.elastic.co/guide/en/elasticsearch/reference/5.0/query-dsl-geo-shape-query.html)",
          "oneOf": [
            {
              "$ref": "./point"
            },
            {
              "$ref": "./polygon"
            },
            {
              "$ref": "../_shared/multipolygon"
            },
            {
              "description": "GeoJSon geometry collection volgens https://tools.ietf.org/html/rfc7946#section-3.1.8",
              "properties": {
                "geometries": {
                  "items": {
                    "anyOf": [
                      {
                        "$ref": "./point"
                      },
                      {
                        "$ref": "./polygon"
                      },
                      {
                        "$ref": "../_shared/multipolygon"
                      }
                    ],
                    "minItems": 0
                  },
                  "type": "array"
                },
                "type": {
                  "enum": [
                    "GeometryCollection"
                  ],
                  "type": "string"
                }
              },
              "required": [
                "geometries",
                "type"
              ],
              "type": "object"
            }
          ]
        }
      },
      "required": [
        "intersects"
      ]
    },
    "datum": {
      "allOf": [
        {
          "description": "Het verzoek wordt uitgevoerd met de versie van de sttr-bestanden die geldig zijn op deze datum. Indien geen datum meegegeven wordt het verzoek uitgevoerd tegen de op dit moment geldende sttr-bestanden. Het formaat van de datum is dd-MM-yyyy"
        },
        {
          "description": "Datum in het formaat dd-MM-yyyy.",
          "examples": [
            "01-01-2023"
          ],
          "pattern": "^\\d{2}-\\d{2}-\\d{4}$",
          "type": "string"
        }
      ]
    },
    "functioneleStructuurRefs": {
      "description": "De verwijzingen naar een regelbeheerobject van de activiteit in de functionele structuur met eventueel bijbehorende antwoorden",
      "items": {
        "properties": {
          "antwoorden": {
            "description": "Optionele lijst van Antwoord objecten",
            "items": {
              "properties": {
                "antwoord": {
                  "description": "Het antwoord op de uitvoeringsregel met het desbetreffende id. Indien meerdere antwoorden bij een lijstwaarde dan komma gescheiden met spaties. Indien het antwoord op de vraag vooringevuld is door de service maar leeg moet worden gemaakt (denk aan huisletter) dan dit antwoord als een lege string aanleveren, ongeacht het antwoordType (dus ook bij numeriek).",
                  "maxLength": 6144,
                  "type": "string"
                },
                "id": {
                  "description": "Het id waarmee het antwoord aan de juiste uitvoeringsregel (vraag/bijlage) wordt gekoppeld.",
                  "type": "integer"
                }
              },
              "required": [
                "id"
              ]
            },
            "maxItems": 500,
            "type": "array"
          },
          "functioneleStructuurRef": {
            "description": "De verwijzing naar een regelbeheerobject van een geselecteerde activiteit in de functionele structuur in de Registratie Toepasbare Regels.",
            "type": "string"
          }
        },
        "required": [
          "functioneleStructuurRef"
        ]
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array"
    }
  },
  "required": [
    "functioneleStructuurRefs",
    "_geo"
  ],
  "x-derived-from": [
    "https://developer.omgevingswet.overheid.nl/publish/pages/171046/toepasbareregels-uitvoerenservices-v3.json#/components/schemas/Request"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
Point	`/properties/_geo/properties/intersects/oneOf/0/$ref`
Polygon	`/properties/_geo/properties/intersects/oneOf/1/$ref`
MultiPolygon	`/properties/_geo/properties/intersects/oneOf/2/$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 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/_geo/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/_geo/properties/intersects/oneOf/3/properties/type/enum – /properties/_geo/properties/intersects/oneOf/3/properties/type/type`
An `enum` of a single value can be expressed as `const`	`/properties/_geo/properties/intersects/oneOf/3/properties/type/enum`
Keywords inside `allOf` that do not conflict with the parent schema can be elevated	`/properties/datum/allOf/1/type – /properties/datum/allOf/1/pattern – /properties/datum/allOf/1/description – /properties/datum/allOf/1/examples`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/datum/allOf/1/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/functioneleStructuurRefs/items/properties/antwoorden/items/properties/antwoord/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/functioneleStructuurRefs/items/properties/antwoorden/items/properties/id/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/functioneleStructuurRefs/items/properties/functioneleStructuurRef/description`

Schema-register: request

Details van JSON Schema: request

Details van JSON Schema: request

Beschrijving