aggregaties | Schema-register

Het aantal resultaten per mogelijke filterwaarde voor toestemming en bestuurslaag. Heeft betrekking op het totaal aantal resultaten en niet over de betreffende pagina.

Dialect2020-12

Typeunknown

Health50%

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
bestuurslagen	`array`	Ja	- Items type: object
bestuurslagen[].aantal	`number`	Ja	Het aantal resultaten voor de bestuurslaag, waarbij het bestuurslaag filter NIET wordt meegenomen
bestuurslagen[].bestuurslaag	`string`	Ja	Bestuurslaag van een Organisatie Enum: rijk, provincie, waterschap, gemeente
bestuursorganenPerBestuurslaag	`array`	Ja	- Items type: object
bestuursorganenPerBestuurslaag[].bestuurslaag	`string`	Ja	Bestuurslaag van een Organisatie Enum: rijk, provincie, waterschap, gemeente
bestuursorganenPerBestuurslaag[].bestuursorganen	`array`	Ja	- Items type: object
bestuursorganenPerBestuurslaag[].bestuursorganen[].aantal	`number`	Ja	-
bestuursorganenPerBestuurslaag[].bestuursorganen[].oin	`string`	Ja	Identificatie van een bestuursorgaan. Min length: 20 Max length: 20
toestemmingen	`array`	Ja	- Items type: object
toestemmingen[].aantal	`number`	Ja	Het aantal resultaten voor de toestemming, waarbij het bestuurslaag filter NIET wordt meegenomen
toestemmingen[].toestemming	`string`	Ja	Code van de toestemming Enum: Vergunning, Melding, Informatie, InformatieOngewoonVoorval, AanvraagMaatwerkvoorschrift, MeldingGelijkwaardigeMaatregel, AanvraagToestemmingGelijkwaardigeMaatregel

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/zoeken-in-activiteiten-voor-indieningsvereisten-en-werkzaamheden-q7gc6lgvr/aggregaties",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Het aantal resultaten per mogelijke filterwaarde voor toestemming en bestuurslaag. Heeft betrekking op het totaal aantal resultaten en niet over de betreffende pagina.",
  "properties": {
    "bestuurslagen": {
      "items": {
        "description": "Per bestuurslaag het aantal keer dat de bestuurslaag voorkomt in de gevonden activiteiten. Let op dat het bestuurslaag filter hierin NIET wordt meegenomen (andere filters wel). Dit is handig wanneer de aggregaties worden gepresenteerd in een user interface, dan kan de gebruiker namelijk het aantal resultaten uitbreiden door ook een andere bestuurslaag te selecteren.",
        "properties": {
          "aantal": {
            "description": "Het aantal resultaten voor de bestuurslaag, waarbij het bestuurslaag filter NIET wordt meegenomen",
            "type": "number"
          },
          "bestuurslaag": {
            "description": "Bestuurslaag van een Organisatie",
            "enum": [
              "rijk",
              "provincie",
              "waterschap",
              "gemeente"
            ],
            "type": "string"
          }
        },
        "required": [
          "bestuurslaag",
          "aantal"
        ]
      },
      "type": "array"
    },
    "bestuursorganenPerBestuurslaag": {
      "items": {
        "description": "De meest voorkomende bestuursorganen in de gevonden activiteiten met het aantal keer dat ze voorkomen. Deze zijn opgedeeld per bestuurslaag.",
        "properties": {
          "bestuurslaag": {
            "description": "Bestuurslaag van een Organisatie",
            "enum": [
              "rijk",
              "provincie",
              "waterschap",
              "gemeente"
            ],
            "type": "string"
          },
          "bestuursorganen": {
            "items": {
              "description": "Het aantal resultaten per bestuursorgaan",
              "properties": {
                "aantal": {
                  "type": "number"
                },
                "oin": {
                  "description": "Identificatie van een bestuursorgaan.",
                  "maxLength": 20,
                  "minLength": 20,
                  "type": "string"
                }
              },
              "required": [
                "oin",
                "aantal"
              ]
            },
            "type": "array"
          }
        },
        "required": [
          "bestuurslaag",
          "bestuursorganen"
        ]
      },
      "type": "array"
    },
    "toestemmingen": {
      "items": {
        "description": "Per toestemming het aantal keer dat de toestemming voorkomt in de gevonden activiteiten. Let op dat het toestemming filter hierin NIET wordt meegenomen (andere filters wel). Dit is handig wanneer de aggregaties worden gepresenteerd in een user interface, dan kan de gebruiker namelijk het aantal resultaten uitbreiden door ook een andere toestemming te selecteren.",
        "properties": {
          "aantal": {
            "description": "Het aantal resultaten voor de toestemming, waarbij het bestuurslaag filter NIET wordt meegenomen",
            "type": "number"
          },
          "toestemming": {
            "description": "Code van de toestemming",
            "enum": [
              "Vergunning",
              "Melding",
              "Informatie",
              "InformatieOngewoonVoorval",
              "AanvraagMaatwerkvoorschrift",
              "MeldingGelijkwaardigeMaatregel",
              "AanvraagToestemmingGelijkwaardigeMaatregel"
            ],
            "type": "string"
          }
        },
        "required": [
          "toestemming",
          "aantal"
        ]
      },
      "type": "array"
    }
  },
  "required": [
    "toestemmingen",
    "bestuurslagen",
    "bestuursorganenPerBestuurslaag"
  ],
  "x-derived-from": [
    "https://developer.omgevingswet.overheid.nl/publish/pages/235013/toepasbareregels-zoekinterface-v2.json#/components/schemas/Aggregaties"
  ]
}

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

Schema-register: aggregaties

Details van JSON Schema: aggregaties

Details van JSON Schema: aggregaties

Beschrijving