ideeverkenningmetadata | Schema-register

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
doelVerzoek	`string`	Ja	- Enum: Indienen, Aanvullen
initieelVerzoeknummer	`string`	Nee	Het verzoeknummer waarop een 'Aanvulling' plaats vindt.
projectId	`string`	Nee	Geeft een mogelijkheid (voor een Bevoegd Gezag) tot het relateren van verschillende aanvragen onder eenzelfde project id. Indien er een machtiging is, moet dit projectId gelijk zijn aan het projectId van de machtiging.
projectnaam	`string`	Nee	- Min length: 1 Max length: 197
verzoekType	`string`	Ja	- Enum: Idee

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/verzoeken-indienen-yktc6lgdr/ideeverkenningmetadata",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "examples": [
    {
      "doelVerzoek": "Indienen",
      "projectId": "202",
      "projectnaam": "Woongroep",
      "verzoekType": "Idee"
    }
  ],
  "properties": {
    "doelVerzoek": {
      "enum": [
        "Indienen",
        "Aanvullen"
      ],
      "type": "string"
    },
    "initieelVerzoeknummer": {
      "description": "Het verzoeknummer waarop een 'Aanvulling' plaats vindt.",
      "type": "string"
    },
    "projectId": {
      "description": "Geeft een mogelijkheid (voor een Bevoegd Gezag) tot het relateren van verschillende aanvragen onder eenzelfde project id. Indien er een machtiging is, moet dit projectId gelijk zijn aan het projectId van de machtiging.",
      "type": "string"
    },
    "projectnaam": {
      "maxLength": 197,
      "minLength": 1,
      "type": "string"
    },
    "verzoekType": {
      "enum": [
        "Idee"
      ],
      "type": "string"
    }
  },
  "required": [
    "verzoekType",
    "doelVerzoek"
  ],
  "type": "object",
  "x-derived-from": [
    "https://developer.omgevingswet.overheid.nl/publish/pages/162228/verzoeken-indienen-v4.json#/components/schemas/IdeeverkenningMetadata"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Dit schema gebruikt geen andere schema's.

Dit schema wordt gebruikt door
Schema	Locatie
ideeverkenning	`/properties/verzoekMetadata/$ref`

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 description at the top level of the schema to explain what the definition is about in detail
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/doelVerzoek/enum – /properties/doelVerzoek/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/initieelVerzoeknummer/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/projectId/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/verzoekType/enum – /properties/verzoekType/type`
An `enum` of a single value can be expressed as `const`	`/properties/verzoekType/enum`

Schema-register: ideeverkenningmetadata

Details van JSON Schema: ideeverkenningmetadata

Details van JSON Schema: ideeverkenningmetadata

Beschrijving