zoekcriteria | Schema-register

Zoek criteria waar de geretourneerde activiteiten op gefilterd moeten worden. Indien er op meerdere properties tegelijk gefilterd wordt, dan zullen alleen de activiteiten geretourneerd worden die aan alle properties voldoen.

Dialect2020-12

Typeunknown

Health40%

Dependencies3

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
_geo	`object`	Nee	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
bestuursorgaan	`object`	Nee	Filter op bestuursorgaan.
bestuursorgaan.bestuurslaag	`string`	Nee	Bestuurslaag van een Organisatie Enum: rijk, provincie, waterschap, gemeente
bestuursorgaan.oin	`string`	Nee	De OIN van het bestuursorgaan.
bestuursorgaan.organisatieCode	`string`	Nee	De organisatieCode (CBS code, het numerieke deel van de BG code).
bestuursorgaan.organisatieType	`string`	Nee	Het organisatie type (niet-numerieke deel van de BG code).
bevoegdGezag	`object`	Nee	Filter op bevoegd gezag.
bevoegdGezag.bestuurslaag	`string`	Ja	Bestuurslaag van een Organisatie Enum: rijk, provincie, waterschap, gemeente
datum	`string`	Ja	Datum in het formaat dd-MM-yyyy. Pattern: ^\d{2}-\d{2}-\d{4}$
magneet	`boolean`	Nee	Filter op activiteiten met het kenmerk magneet.
omschrijving	`string`	Nee	Zoek in de omschrijving van de activiteit.
typering	`string`	Nee	Typering van de activiteit Enum: Water, Milieubelastende, Overige
werkzaamheid	`string`	Nee	Filter op activiteiten die gekoppeld zijn aan deze werkzaamheid (urn).

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/crud-rtr-gegevens-g85pejgdr/zoekcriteria",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Zoek criteria waar de geretourneerde activiteiten op gefilterd moeten worden. Indien er op meerdere properties tegelijk gefilterd wordt, dan zullen alleen de activiteiten geretourneerd worden die aan alle properties voldoen.",
  "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"
      ]
    },
    "bestuursorgaan": {
      "description": "Filter op bestuursorgaan.",
      "properties": {
        "bestuurslaag": {
          "description": "Bestuurslaag van een Organisatie",
          "enum": [
            "rijk",
            "provincie",
            "waterschap",
            "gemeente"
          ],
          "type": "string"
        },
        "oin": {
          "description": "De OIN van het bestuursorgaan.",
          "type": "string"
        },
        "organisatieCode": {
          "description": "De organisatieCode (CBS code, het numerieke deel van de BG code).",
          "type": "string"
        },
        "organisatieType": {
          "description": "Het organisatie type (niet-numerieke deel van de BG code).",
          "type": "string"
        }
      }
    },
    "bevoegdGezag": {
      "description": "Filter op bevoegd gezag.",
      "properties": {
        "bestuurslaag": {
          "description": "Bestuurslaag van een Organisatie",
          "enum": [
            "rijk",
            "provincie",
            "waterschap",
            "gemeente"
          ],
          "type": "string"
        }
      },
      "required": [
        "bestuurslaag"
      ]
    },
    "datum": {
      "description": "Datum in het formaat dd-MM-yyyy.",
      "examples": [
        "01-01-2023"
      ],
      "pattern": "^\\d{2}-\\d{2}-\\d{4}$",
      "type": "string"
    },
    "magneet": {
      "description": "Filter op activiteiten met het kenmerk magneet.",
      "type": "boolean"
    },
    "omschrijving": {
      "description": "Zoek in de omschrijving van de activiteit.",
      "type": "string"
    },
    "typering": {
      "description": "Typering van de activiteit",
      "enum": [
        "Water",
        "Milieubelastende",
        "Overige"
      ],
      "type": "string"
    },
    "werkzaamheid": {
      "description": "Filter op activiteiten die gekoppeld zijn aan deze werkzaamheid (urn).",
      "type": "string"
    }
  },
  "required": [
    "datum"
  ],
  "x-derived-from": [
    "https://developer.omgevingswet.overheid.nl/publish/pages/167490/toepasbareregels-crud-rtr-gegevens-v2.json#/components/schemas/ZoekCriteria"
  ]
}

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	`/description`
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`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/bestuursorgaan/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/bestuursorgaan/properties/bestuurslaag/enum – /properties/bestuursorgaan/properties/bestuurslaag/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/bestuursorgaan/properties/oin/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/bestuursorgaan/properties/organisatieCode/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/bestuursorgaan/properties/organisatieType/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/bevoegdGezag/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/bevoegdGezag/properties/bestuurslaag/enum – /properties/bevoegdGezag/properties/bestuurslaag/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/datum/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/magneet/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/omschrijving/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/typering/enum – /properties/typering/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/werkzaamheid/description`

Schema-register: zoekcriteria

Details van JSON Schema: zoekcriteria

Details van JSON Schema: zoekcriteria

Beschrijving