verzoek | Schema-register

Verzoek bestaande uit 1 of meerdere activiteiten, bedoeld voor 1 bevoegd gezag.

Dialect2020-12

Typeunknown

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
activiteiten	`array`	Ja	Activiteiten die gegroepeerd zijn in dit verzoek, in onbepaalde volgorde. Items type: object
activiteiten[].functioneleStructuurRef	`string`	Ja	FunctioneleStructuurRef van de activiteit
activiteiten[].typering	`string`	Ja	Typering van de activiteit Enum: Water, Milieubelastende, Overige
bevoegdGezagen	`array`	Ja	Bevoegd gezagen waar het verzoek heen gestuurd kan worden Items type: object
bevoegdGezagen[].afgeleid	`boolean`	Ja	Definieert of dit het afgeleide bevoegd gezag is waar het verzoek heen moet worden gestuurd. Als deze op true staat is dit het bevoegd gezag waar het verzoek volgens de afleiding heen moet worden gestuurd. false betekent dat dit een alternatief bevoegd gezag is wat de gebruiker kan kiezen. Normaal zal in een response één bevoegd gezag afgeleid=true hebben, maar bij een project locatie over bestuurlijke grenzen kunnen alle bevoegd gezagen van dezelfde bestuurslaag afgeleid=true hebben.
bevoegdGezagen[].bestuurslaag	`string`	Ja	Bestuurslaag van een Organisatie Enum: rijk, provincie, waterschap, gemeente
bevoegdGezagen[].naam	`string`	Ja	Naam van het bevoegd gezag. Als de naam niet opgehaald kon worden uit het OIN register, staat hier het OIN.
bevoegdGezagen[].oin	`string`	Ja	OIN van het bevoegd gezag
toestemming	`object`	Ja	-
toestemming.code	`string`	Ja	Code van de toestemming Enum: Vergunning, Melding, Informatie, InformatieOngewoonVoorval, AanvraagMaatwerkvoorschrift, MeldingGelijkwaardigeMaatregel, AanvraagToestemmingGelijkwaardigeMaatregel
toestemming.waarde	`string`	Ja	Waarde van het toestemmingstype.

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/verzoeksroutering-a3hce_gdr/verzoek",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Verzoek bestaande uit 1 of meerdere activiteiten, bedoeld voor 1 bevoegd gezag.",
  "properties": {
    "activiteiten": {
      "description": "Activiteiten die gegroepeerd zijn in dit verzoek, in onbepaalde volgorde.",
      "items": {
        "description": "Een activiteit",
        "properties": {
          "functioneleStructuurRef": {
            "description": "FunctioneleStructuurRef van de activiteit",
            "type": "string"
          },
          "typering": {
            "description": "Typering van de activiteit",
            "enum": [
              "Water",
              "Milieubelastende",
              "Overige"
            ],
            "type": "string"
          }
        },
        "required": [
          "functioneleStructuurRef",
          "typering"
        ]
      },
      "type": "array"
    },
    "bevoegdGezagen": {
      "description": "Bevoegd gezagen waar het verzoek heen gestuurd kan worden",
      "items": {
        "description": "Een bevoegd gezag",
        "properties": {
          "afgeleid": {
            "description": "Definieert of dit het afgeleide bevoegd gezag is waar het verzoek heen moet worden gestuurd. Als deze op true staat is dit het bevoegd gezag waar het verzoek volgens de afleiding heen moet worden gestuurd. false betekent dat dit een alternatief bevoegd gezag is wat de gebruiker kan kiezen. Normaal zal in een response één bevoegd gezag afgeleid=true hebben, maar bij een project locatie over bestuurlijke grenzen kunnen alle bevoegd gezagen van dezelfde bestuurslaag afgeleid=true hebben.",
            "type": "boolean"
          },
          "bestuurslaag": {
            "description": "Bestuurslaag van een Organisatie",
            "enum": [
              "rijk",
              "provincie",
              "waterschap",
              "gemeente"
            ],
            "type": "string"
          },
          "naam": {
            "description": "Naam van het bevoegd gezag. Als de naam niet opgehaald kon worden uit het OIN register, staat hier het OIN.",
            "type": "string"
          },
          "oin": {
            "description": "OIN van het bevoegd gezag",
            "type": "string"
          }
        },
        "required": [
          "oin",
          "naam",
          "bestuurslaag",
          "afgeleid"
        ]
      },
      "type": "array"
    },
    "toestemming": {
      "properties": {
        "code": {
          "description": "Code van de toestemming",
          "enum": [
            "Vergunning",
            "Melding",
            "Informatie",
            "InformatieOngewoonVoorval",
            "AanvraagMaatwerkvoorschrift",
            "MeldingGelijkwaardigeMaatregel",
            "AanvraagToestemmingGelijkwaardigeMaatregel"
          ],
          "type": "string"
        },
        "waarde": {
          "description": "Waarde van het toestemmingstype.",
          "type": "string"
        }
      },
      "required": [
        "code",
        "waarde"
      ]
    }
  },
  "required": [
    "toestemming",
    "bevoegdGezagen",
    "activiteiten"
  ],
  "x-derived-from": [
    "https://developer.omgevingswet.overheid.nl/publish/pages/171058/toepasbareregels-verzoeksroutering-v2.json#/components/schemas/Verzoek"
  ]
}

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

Schema-register: verzoek

Details van JSON Schema: verzoek

Details van JSON Schema: verzoek

Beschrijving