imrodocumentmetadata | Schema-register

Metadata specifiek voor IMRO-documenten. Deze wordt alleen gevuld als het Document een IMRO-document betreft.

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
bekendmakingen	`array`	Ja	Officiële overheidspublicaties zoals gepubliceerd in de Staatscourant. Items type: $ref Items $ref: ./bekendmaking
beroepEnBezwaar	`string`	Ja	Beroep en bezwaar actief.
besluitnummer	`string`	Nee	Besluitnummer van het plan.
eindeRechtsgeldigheid	`string`	Nee	Geeft datum van einde rechtsgeldigheid. Format: date
gerelateerdeVersies	`array`	Nee	Andere versies van dit plan. Unique items: true Items type: $ref Items $ref: ./documentversie
heeftPlankaart	`boolean`	Ja	Document heeft een plankaart.
imroVersie	`string`	Ja	IMRO-versie van het plan.
isHistorisch	`boolean`	Ja	Geeft aan of het plan historisch is.
isTamPlan	`boolean`	Ja	Geeft aan of het plan een tijdelijk alternatieve maatregel (TAM) is.
onderdelen	`array`	Ja	Onderdelen van het plan. Items type: $ref Items $ref: ./onderdeel
ondergronden	`array`	Ja	De ondergronden van het plan. Items type: $ref Items $ref: ./planondergrond
planstatusInfo	`$ref`	Ja	- $ref: ./planstatusinfo
regelStatus	`string, null`	Ja	- Enum: in ontwikkeling, geldend
statusDossier	`string`	Nee	Status van een dossier.
verwijderdOp	`string`	Nee	Plan is verwijderd op deze datum. Format: date-time

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/omgevingsinformatie-ontsluiten-api-ow7p61mdg/imrodocumentmetadata",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Metadata specifiek voor IMRO-documenten. Deze wordt alleen gevuld als het Document een IMRO-document betreft.",
  "properties": {
    "bekendmakingen": {
      "description": "Officiële overheidspublicaties zoals gepubliceerd in de Staatscourant.",
      "examples": [
        {
          "documentType": "Staatscourant",
          "href": "https://zoek.officielebekendmakingen.nl/stcrt-2021-15786.html",
          "titel": "Bestemmingsplan Hoek Prins Bernhardlaan - Kruisparkweg"
        }
      ],
      "items": {
        "$ref": "./bekendmaking"
      },
      "type": "array"
    },
    "beroepEnBezwaar": {
      "description": "Beroep en bezwaar actief.",
      "examples": [
        "ja, nee, niet van toepassing."
      ],
      "type": "string"
    },
    "besluitnummer": {
      "description": "Besluitnummer van het plan.",
      "examples": [
        "3"
      ],
      "type": "string"
    },
    "eindeRechtsgeldigheid": {
      "description": "Geeft datum van einde rechtsgeldigheid.",
      "examples": [
        "2022-02-22"
      ],
      "format": "date",
      "type": "string"
    },
    "gerelateerdeVersies": {
      "description": "Andere versies van dit plan.",
      "items": {
        "$ref": "./documentversie"
      },
      "type": "array",
      "uniqueItems": true
    },
    "heeftPlankaart": {
      "description": "Document heeft een plankaart.",
      "examples": [
        true
      ],
      "type": "boolean"
    },
    "imroVersie": {
      "description": "IMRO-versie van het plan.",
      "examples": [
        "IMRO2012"
      ],
      "type": "string"
    },
    "isHistorisch": {
      "description": "Geeft aan of het plan historisch is.",
      "examples": [
        true
      ],
      "type": "boolean"
    },
    "isTamPlan": {
      "description": "Geeft aan of het plan een tijdelijk alternatieve maatregel (TAM) is.",
      "examples": [
        true
      ],
      "type": "boolean"
    },
    "onderdelen": {
      "description": "Onderdelen van het plan.",
      "items": {
        "$ref": "./onderdeel"
      },
      "type": "array"
    },
    "ondergronden": {
      "description": "De ondergronden van het plan.",
      "examples": [
        {
          "datum": "2024-2-22",
          "type": "grootschalige basiskaart (GBK)"
        }
      ],
      "items": {
        "$ref": "./planondergrond"
      },
      "type": "array"
    },
    "planstatusInfo": {
      "$ref": "./planstatusinfo"
    },
    "regelStatus": {
      "enum": [
        "in ontwikkeling",
        "geldend"
      ],
      "examples": [
        null
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "statusDossier": {
      "description": "Status van een dossier.",
      "examples": [
        "geheel onherroepelijk in werking."
      ],
      "type": "string"
    },
    "verwijderdOp": {
      "description": "Plan is verwijderd op deze datum.",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "bekendmakingen",
    "beroepEnBezwaar",
    "heeftPlankaart",
    "imroVersie",
    "isHistorisch",
    "isTamPlan",
    "onderdelen",
    "ondergronden",
    "planstatusInfo",
    "regelStatus"
  ],
  "type": "object",
  "x-derived-from": [
    "https://service.omgevingswet.overheid.nl/publiek/omgevingsinformatie/api/ontsluiten/v2/openapi.json#/components/schemas/ImroDocumentMetadata"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
bekendmaking	`/properties/bekendmakingen/items/$ref`
documentversie	`/properties/gerelateerdeVersies/items/$ref`
onderdeel	`/properties/onderdelen/items/$ref`
planondergrond	`/properties/ondergronden/items/$ref`
planstatusinfo	`/properties/planstatusInfo/$ref`

Dit schema wordt gebruikt door
Schema	Locatie
document	`/properties/imroDocumentMetadata/$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/bekendmakingen/description`
Only include instances in the `examples` array that validate against the schema	`/properties/bekendmakingen/examples/0`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/beroepEnBezwaar/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/besluitnummer/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/eindeRechtsgeldigheid/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/gerelateerdeVersies/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/heeftPlankaart/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/imroVersie/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/isHistorisch/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/isTamPlan/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/onderdelen/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/ondergronden/description`
Only include instances in the `examples` array that validate against the schema	`/properties/ondergronden/examples/0`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/regelStatus/enum – /properties/regelStatus/type`
Only include instances in the `examples` array that validate against the schema	`/properties/regelStatus/examples/0`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/statusDossier/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/verwijderdOp/description`

Schema-register: imrodocumentmetadata

Details van JSON Schema: imrodocumentmetadata

Details van JSON Schema: imrodocumentmetadata

Beschrijving