zoekcriteriaactiviteiten | Schema-register

De zoekcriteria om activiteiten te zoeken. Zoeken gebeurt op basis van een zoekterm, resultaten kunnen verder gefilterd worden op de velden in het zoekresultaat.

Dialect2020-12

Typeunknown

Health34%

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
bestuurslagen	`array`	Nee	Filter op bestuurslaag van het bestuursorgaan van de activiteit. Min items: 1 Max items: 4 Items type: string
datum	`string`	Nee	Datum in het formaat dd-MM-yyyy. Pattern: ^\d{2}-\d{2}-\d{4}$
functioneleStructuurReferenties	`array`	Nee	De zoekterm op basis waarvan in de activiteiten gezocht wordt. Filter op functioneleStructuurReferentie Min items: 1 Max items: 1000 Items type: string
locaties	`array`	Nee	Filter op de locatie van de activiteit. Min items: 1 Max items: 10000 Items type: string
sortering	`string`	Nee	De sortering waarin de resultaten worden geretourneerd. Bij "alfabetisch" worden de resultaten alfabetisch gesorteerd. "besteMatch" zorgt ervoor dat de resultaten die het meest matchen met de zoekterm bovenaan komen (bij deze sortering is het veld "zoekterm" daarom verplicht). "meestGekozen" wil zeggen dat de in het loket meest gekozen resultaten bovenaan staan. Als het veld "sortering" niet wordt meegegeven wordt de "meestGekozen" sortering gebruikt. Enum: alfabetisch, besteMatch, meestGekozen Default: meestGekozen
toestemmingen	`array`	Nee	Filter op indieningsvereisten toestemming Min items: 1 Max items: 7 Items type: string
zoekterm	`string`	Nee	De zoekterm op basis waarvan in de activiteiten gezocht wordt. Min length: 1 Max length: 250

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/zoeken-in-activiteiten-voor-indieningsvereisten-en-werkzaamheden-q7gc6lgvr/zoekcriteriaactiviteiten",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "De zoekcriteria om activiteiten te zoeken. Zoeken gebeurt op basis van een zoekterm, resultaten kunnen verder gefilterd worden op de velden in het zoekresultaat.",
  "properties": {
    "bestuurslagen": {
      "description": "Filter op bestuurslaag van het bestuursorgaan van de activiteit.",
      "items": {
        "description": "Bestuurslaag van een Organisatie",
        "enum": [
          "rijk",
          "provincie",
          "waterschap",
          "gemeente"
        ],
        "type": "string"
      },
      "maxItems": 4,
      "minItems": 1,
      "type": "array"
    },
    "datum": {
      "description": "Datum in het formaat dd-MM-yyyy.",
      "examples": [
        "01-01-2023"
      ],
      "pattern": "^\\d{2}-\\d{2}-\\d{4}$",
      "type": "string"
    },
    "functioneleStructuurReferenties": {
      "description": "De zoekterm op basis waarvan in de activiteiten gezocht wordt. Filter op functioneleStructuurReferentie",
      "items": {
        "type": "string"
      },
      "maxItems": 1000,
      "minItems": 1,
      "type": "array"
    },
    "locaties": {
      "description": "Filter op de locatie van de activiteit.",
      "items": {
        "type": "string"
      },
      "maxItems": 10000,
      "minItems": 1,
      "type": "array"
    },
    "sortering": {
      "default": "meestGekozen",
      "description": "De sortering waarin de resultaten worden geretourneerd. Bij \"alfabetisch\" worden de resultaten alfabetisch gesorteerd. \"besteMatch\" zorgt ervoor dat de resultaten die het meest matchen met de zoekterm bovenaan komen (bij deze sortering is het veld \"zoekterm\" daarom verplicht). \"meestGekozen\" wil zeggen dat de in het loket meest gekozen resultaten bovenaan staan. Als het veld \"sortering\" niet wordt meegegeven wordt de \"meestGekozen\" sortering gebruikt.",
      "enum": [
        "alfabetisch",
        "besteMatch",
        "meestGekozen"
      ],
      "type": "string"
    },
    "toestemmingen": {
      "description": "Filter op indieningsvereisten toestemming",
      "items": {
        "description": "Code van de toestemming",
        "enum": [
          "Vergunning",
          "Melding",
          "Informatie",
          "InformatieOngewoonVoorval",
          "AanvraagMaatwerkvoorschrift",
          "MeldingGelijkwaardigeMaatregel",
          "AanvraagToestemmingGelijkwaardigeMaatregel"
        ],
        "type": "string"
      },
      "maxItems": 7,
      "minItems": 1,
      "type": "array"
    },
    "zoekterm": {
      "description": "De zoekterm op basis waarvan in de activiteiten gezocht wordt.",
      "maxLength": 250,
      "minLength": 1,
      "type": "string"
    }
  },
  "x-derived-from": [
    "https://developer.omgevingswet.overheid.nl/publish/pages/235013/toepasbareregels-zoekinterface-v2.json#/components/schemas/ZoekCriteriaActiviteiten"
  ]
}

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	`/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/bestuurslagen/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/bestuurslagen/items/enum – /properties/bestuurslagen/items/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/locaties/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/sortering/enum – /properties/sortering/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/sortering/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/toestemmingen/items/enum – /properties/toestemmingen/items/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/zoekterm/description`

Schema-register: zoekcriteriaactiviteiten

Details van JSON Schema: zoekcriteriaactiviteiten

Details van JSON Schema: zoekcriteriaactiviteiten

Beschrijving