documentsuggestie | Schema-register

Gevonden matches. Eerst worden exacte matches teruggegeven, aangevuld met fuzzy matches tot het opgegeven limiet wordt bereikt.

Dialect2020-12

Typeobject

Health59%

Dependencies1

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
identificatie	`string`	Ja	Identificatie van het document
isBesluit	`boolean`	Ja	Geeft aan of het een besluit betreft. (Omgevingsdocument)
isOntwerp	`boolean`	Ja	Geeft aan of het een ontwerp betreft. (Omgevingsdocument)
matches	`array`	Ja	- Items type: $ref Items $ref: ./match
opgesteldDoor	`string`	Ja	De naam van het bevoegde gezag die dit document opgesteld heeft.
status	`string`	Nee	De planstatus van een IMRO document.
statusdatum	`string`	Ja	Voor IMRO documenten geeft dit de datum van de planstatus weer. Voor regelingen en omgevingsvergunningen geeft dit de beginInwerking datum weer (als beginInwerking nog niet is geregistreerd dan geeft het de beginGeldigheid weer). Voor ontwerpregelingen geeft dit de datum van publicatie weer (als de publicatiedatum nog niet is geregistreerd dan geeft het de ontvangenOp datum van het procedureverloop weer). Format: date
titel	`string`	Ja	Titel van het document
type	`string`	Ja	Een classificatie van het type gebied
uriIdentificatie	`string`	Ja	URI-veilige identificatie, waarbij `/` is vervangen door `_`.

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/omgevingsinformatie-ontsluiten-api-ow7p61mdg/documentsuggestie",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Gevonden matches. Eerst worden exacte matches teruggegeven, aangevuld met fuzzy matches tot het opgegeven limiet\nwordt bereikt.",
  "properties": {
    "identificatie": {
      "description": "Identificatie van het document",
      "examples": [
        "NL.IMRO.0861.099101FIETSPHOVENR-0402"
      ],
      "type": "string"
    },
    "isBesluit": {
      "description": "Geeft aan of het een besluit betreft. (Omgevingsdocument)",
      "examples": [
        true
      ],
      "type": "boolean"
    },
    "isOntwerp": {
      "description": "Geeft aan of het een ontwerp betreft. (Omgevingsdocument)",
      "examples": [
        true
      ],
      "type": "boolean"
    },
    "matches": {
      "items": {
        "$ref": "./match"
      },
      "type": "array"
    },
    "opgesteldDoor": {
      "description": "De naam van het bevoegde gezag die dit document opgesteld heeft.",
      "examples": [
        "Gemeente Veldhoven"
      ],
      "type": "string"
    },
    "status": {
      "description": "De planstatus van een IMRO document.",
      "examples": [
        "vastgesteld"
      ],
      "type": "string"
    },
    "statusdatum": {
      "description": "Voor IMRO documenten geeft dit de datum van de planstatus weer. Voor regelingen en omgevingsvergunningen geeft dit de beginInwerking datum weer (als beginInwerking nog niet is geregistreerd dan geeft het de beginGeldigheid weer). Voor ontwerpregelingen geeft dit de datum van publicatie weer (als de publicatiedatum nog niet is geregistreerd dan geeft het de ontvangenOp datum van het procedureverloop weer).",
      "examples": [
        "2025-04-21"
      ],
      "format": "date",
      "type": "string"
    },
    "titel": {
      "description": "Titel van het document",
      "examples": [
        "Projectbesluit fietspad Hovenring"
      ],
      "type": "string"
    },
    "type": {
      "description": "Een classificatie van het type gebied",
      "examples": [
        "Projectbesluit"
      ],
      "type": "string"
    },
    "uriIdentificatie": {
      "description": "URI-veilige identificatie, waarbij `/` is vervangen door `_`.",
      "examples": [
        "_akn_nl_act_gm0301_2020_omgevingsplan"
      ],
      "type": "string"
    }
  },
  "required": [
    "identificatie",
    "isBesluit",
    "isOntwerp",
    "matches",
    "opgesteldDoor",
    "statusdatum",
    "titel",
    "type",
    "uriIdentificatie"
  ],
  "type": "object",
  "x-derived-from": [
    "https://service.omgevingswet.overheid.nl/publiek/omgevingsinformatie/api/ontsluiten/v2/openapi.json#/components/schemas/DocumentSuggestie"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
match	`/properties/matches/items/$ref`

Dit schema wordt gebruikt door
Schema	Locatie
embedded2	`/properties/suggesties/items/$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 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/opgesteldDoor/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/status/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/statusdatum/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/uriIdentificatie/description`

Schema-register: documentsuggestie

Details van JSON Schema: documentsuggestie

Details van JSON Schema: documentsuggestie

Beschrijving