verzoekenzoekcriteria | Schema-register

Zoekcriteria voor het zoeken naar ingediende verzoeken. Het VerzoekenZoekcriteria-object bevat of verzoeknummer of geometrie. Wanneer met het VerzoekenZoekcriteria-object wordt gezocht, retourneert de zoekopdracht de verzoeken waarvan de projectlocatie op of binnen de gegeven geometrie vallen.

Dialect2020-12

Typeobject

Health34%

Dependencies3

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
activiteit	`string`	Nee	Een zoekcriteriaparameter die aangeeft voor welke activiteit een verzoek is ingediend. Deze parameter dient gevuld te worden met de 'urn' van een activiteit. Ook wel imow-id genoemd.
eindDatumIngediendOp	`string`	Nee	Een zoekcriteriaparameter die aangeeft dat verzoeken zijn ingediend tot en met deze datum. Format: date
geometrie	`oneOf`	Nee	Punt of vlak waarop/waarbinnen de projectlocaties van de verzoeken moeten vallen. Indien deze parameter is gevuld, kan er geen verzoeknummer worden opgegeven in de zoekcriteria. oneOf: 3 schema's
startDatumIngediendOp	`string`	Nee	Een zoekcriteriaparameter die aangeeft dat verzoeken zijn ingediend op of na deze datum. Format: date
verzoeknummer	`string`	Nee	Het verzoeknummer van het ingediende verzoek wat dient als basis voor het zoeken naar verzoeken. De projectlocatie van het verzoek word gebruikt om te zoeken naar andere verzoeken die binnen de projectlocatie vallen. Indien deze parameter is gevuld, kan er geen geometrie worden opgegeven in de zoekcriteria. Max length: 13

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/_shared/verzoekenzoekcriteria",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Zoekcriteria voor het zoeken naar ingediende verzoeken. Het VerzoekenZoekcriteria-object bevat of verzoeknummer of geometrie.\nWanneer met het VerzoekenZoekcriteria-object wordt gezocht, retourneert de zoekopdracht de verzoeken waarvan de projectlocatie op of binnen de gegeven geometrie vallen.\n",
  "examples": [
    {
      "activiteit": "nl.imow-mnre1034.activiteit.AanbrengenLagenMetalen",
      "eindDatumIngediendOp": "2021-05-20",
      "geometrie": {
        "coordinates": [
          81523.058,
          456081.0821
        ],
        "type": "Point"
      },
      "startDatumIngediendOp": "2021-01-20",
      "verzoeknummer": "2019012100003"
    }
  ],
  "properties": {
    "activiteit": {
      "description": "Een zoekcriteriaparameter die aangeeft voor welke activiteit een verzoek is ingediend.\nDeze parameter dient gevuld te worden met de 'urn' van een activiteit. Ook wel imow-id genoemd.\n",
      "examples": [
        "nl.imow-mnre1034.activiteit.AanbrengenLagenMetalen"
      ],
      "type": "string"
    },
    "eindDatumIngediendOp": {
      "description": "Een zoekcriteriaparameter die aangeeft dat verzoeken zijn ingediend tot en met deze datum.\n",
      "examples": [
        "2021-01-20"
      ],
      "format": "date",
      "type": "string"
    },
    "geometrie": {
      "description": "Punt of vlak waarop/waarbinnen de projectlocaties van de verzoeken moeten vallen.\nIndien deze parameter is gevuld, kan er geen verzoeknummer worden opgegeven in de zoekcriteria.\n",
      "examples": [
        {
          "coordinates": [
            81523.058,
            456081.0821
          ],
          "type": "Point"
        }
      ],
      "oneOf": [
        {
          "$ref": "./point"
        },
        {
          "$ref": "./polygon"
        },
        {
          "$ref": "./geometrycollection"
        }
      ]
    },
    "startDatumIngediendOp": {
      "description": "Een zoekcriteriaparameter die aangeeft dat verzoeken zijn ingediend op of na deze datum.\n",
      "examples": [
        "2021-01-20"
      ],
      "format": "date",
      "type": "string"
    },
    "verzoeknummer": {
      "description": "Het verzoeknummer van het ingediende verzoek wat dient als basis voor het zoeken naar verzoeken.\nDe projectlocatie van het verzoek word gebruikt om te zoeken naar andere verzoeken die binnen de projectlocatie vallen.\nIndien deze parameter is gevuld, kan er geen geometrie worden opgegeven in de zoekcriteria.\n",
      "examples": [
        "2019012100003"
      ],
      "maxLength": 13,
      "type": "string"
    }
  },
  "type": "object",
  "x-derived-from": [
    "https://developer.omgevingswet.overheid.nl/publish/pages/196036/verzoeken-afhandelen-v2.json#/components/schemas/VerzoekenZoekcriteria",
    "https://developer.omgevingswet.overheid.nl/publish/pages/196036/verzoeken-afhandelen-v3.json#/components/schemas/VerzoekenZoekcriteria",
    "https://developer.omgevingswet.overheid.nl/publish/pages/238080/verzoekenoverzicht-raadplegen-v1.json#/components/schemas/VerzoekenZoekcriteria"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
Punt	`/properties/geometrie/oneOf/0/$ref`
Vlak	`/properties/geometrie/oneOf/1/$ref`
Vlak	`/properties/geometrie/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
Descriptions should not contain leading or trailing whitespace	`/description`
Descriptions should not contain leading or trailing whitespace	`/properties/activiteit/description`
Descriptions should not contain leading or trailing whitespace	`/properties/eindDatumIngediendOp/description`
Descriptions should not contain leading or trailing whitespace	`/properties/geometrie/description`
Descriptions should not contain leading or trailing whitespace	`/properties/startDatumIngediendOp/description`
Descriptions should not contain leading or trailing whitespace	`/properties/verzoeknummer/description`

Schema-register: verzoekenzoekcriteria

Details van JSON Schema: verzoekenzoekcriteria

Details van JSON Schema: verzoekenzoekcriteria

Beschrijving