documentversie | Schema-register

Specifieke versie van een omgevingsdocument of IMRO-document.

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
aangeleverdDoorEen	`$ref`	Ja	- $ref: ./bevoegdgezag
beschikbaarTot	`string`	Nee	Tijdstip dat aangeeft tot wanneer een document is geregistreerd. (Omgevingsdocument) Format: date-time
beschikbaarVanaf	`string`	Ja	Tijdstip dat aangeeft vanaf wanneer een document is geregistreerd. (Omgevingsdocument) Format: date-time
expressionId	`string`	Nee	Identificatie van een specifieke versie van een document. (Omgevingdocument)
geldigTot	`string`	Nee	Datum die aangeeft tot wanneer een document geldig is. (Omgevingsdocument) Format: date
geldigVanaf	`string`	Ja	Datum die aangeeft vanaf wanneer een document geldig is. (Omgevingsdocument) Format: date
heeftVectorTiles	`boolean`	Ja	Er zijn vector tiles aanwezig voor dit document.
identificatie	`string`	Ja	Identificatie van het document (AKN bij omgevingsdocument, planId bij IMRO-document).
inwerkingTot	`string`	Nee	Datum die aangeeft tot wanneer een document juridisch geldend is. (Omgevingsdocument) Format: date
inwerkingVanaf	`string`	Nee	Datum die aangeeft vanaf wanneer een document juridisch geldend is. (Omgevingsdocument) Format: date
isToekomstig	`boolean`	Ja	Geeft aan of het document in de toekomst geldig wordt. (Omgevingsdocument)
publicatiedatum	`string`	Nee	Datum van publiceren. (Omgevingsdocument) Format: date
titel	`string`	Ja	Titel van het document. Voor omgevingsdocumenten is dit de `citeertitel`, als die niet bekend is wordt de `officieleTitel` gebruikt. Voor IMRO-documenten is dit `naam`.
uriIdentificatie	`string`	Ja	URI-veilige identificatie, waarbij `/` is vervangen door `_`.
versie	`integer`	Ja	Versienummer van het document. Format: int32

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/omgevingsinformatie-ontsluiten-api-ow7p61mdg/documentversie",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Specifieke versie van een omgevingsdocument of IMRO-document.",
  "properties": {
    "aangeleverdDoorEen": {
      "$ref": "./bevoegdgezag"
    },
    "beschikbaarTot": {
      "description": "Tijdstip dat aangeeft tot wanneer een document is geregistreerd. (Omgevingsdocument)",
      "format": "date-time",
      "type": "string"
    },
    "beschikbaarVanaf": {
      "description": "Tijdstip dat aangeeft vanaf wanneer een document is geregistreerd. (Omgevingsdocument)",
      "format": "date-time",
      "type": "string"
    },
    "expressionId": {
      "description": "Identificatie van een specifieke versie van een document. (Omgevingdocument)",
      "examples": [
        "/akn/nl/act/gm0362/2020/omgevingsplan/nld@2024-03-12;3"
      ],
      "type": "string"
    },
    "geldigTot": {
      "description": "Datum die aangeeft tot wanneer een document geldig is. (Omgevingsdocument)",
      "examples": [
        "2015-03-25"
      ],
      "format": "date",
      "type": "string"
    },
    "geldigVanaf": {
      "description": "Datum die aangeeft vanaf wanneer een document geldig is. (Omgevingsdocument)",
      "examples": [
        "2015-03-25"
      ],
      "format": "date",
      "type": "string"
    },
    "heeftVectorTiles": {
      "description": "Er zijn vector tiles aanwezig voor dit document.",
      "examples": [
        true
      ],
      "type": "boolean"
    },
    "identificatie": {
      "description": "Identificatie van het document (AKN bij omgevingsdocument, planId bij IMRO-document).",
      "examples": [
        "/akn/nl/act/gm0301/2020/omgevingsplan"
      ],
      "type": "string"
    },
    "inwerkingTot": {
      "description": "Datum die aangeeft tot wanneer een document juridisch geldend is. (Omgevingsdocument)",
      "examples": [
        "2015-03-25"
      ],
      "format": "date",
      "type": "string"
    },
    "inwerkingVanaf": {
      "description": "Datum die aangeeft vanaf wanneer een document juridisch geldend is. (Omgevingsdocument)",
      "examples": [
        "2015-03-25"
      ],
      "format": "date",
      "type": "string"
    },
    "isToekomstig": {
      "description": "Geeft aan of het document in de toekomst geldig wordt. (Omgevingsdocument)",
      "examples": [
        true
      ],
      "type": "boolean"
    },
    "publicatiedatum": {
      "description": "Datum van publiceren. (Omgevingsdocument)",
      "examples": [
        "2024-01-01"
      ],
      "format": "date",
      "type": "string"
    },
    "titel": {
      "description": "Titel van het document. Voor omgevingsdocumenten is dit de `citeertitel`, als die niet bekend is wordt de\n`officieleTitel` gebruikt. Voor IMRO-documenten is dit `naam`.",
      "examples": [
        "Bestemmingplan Lemmer Centrum"
      ],
      "type": "string"
    },
    "uriIdentificatie": {
      "description": "URI-veilige identificatie, waarbij `/` is vervangen door `_`.",
      "examples": [
        "_akn_nl_act_gm0301_2020_omgevingsplan"
      ],
      "type": "string"
    },
    "versie": {
      "description": "Versienummer van het document.",
      "examples": [
        2
      ],
      "format": "int32",
      "type": "integer"
    }
  },
  "required": [
    "aangeleverdDoorEen",
    "beschikbaarVanaf",
    "geldigVanaf",
    "heeftVectorTiles",
    "identificatie",
    "isToekomstig",
    "titel",
    "uriIdentificatie",
    "versie"
  ],
  "type": "object",
  "x-derived-from": [
    "https://service.omgevingswet.overheid.nl/publiek/omgevingsinformatie/api/ontsluiten/v2/openapi.json#/components/schemas/DocumentVersie"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
bevoegdgezag	`/properties/aangeleverdDoorEen/$ref`

Dit schema wordt gebruikt door
Schema	Locatie
imrodocumentmetadata	`/properties/gerelateerdeVersies/items/$ref`
omgevingsdocumentmetadata	`/properties/beoogdeOpvolgerVan/$ref`
ontwerpdocumentversie	`/properties/beoogdeOpvolgerVan/$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/heeftVectorTiles/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/identificatie/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/titel/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/uriIdentificatie/description`
Avoid keywords that don't apply to the type or types that the current subschema expects	`/properties/versie/format`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/versie/description`
For interoperability purposes, the JSON Schema specification advises against the use of `format` values that are not explicitly defined by the specification	`/properties/versie/format`

Schema-register: documentversie

Details van JSON Schema: documentversie

Details van JSON Schema: documentversie

Beschrijving