gerelateerdplan | Schema-register

Gerelateerd plan

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
_links	`$ref`	Ja	- $ref: ./planlinks
beleidsmatigVerantwoordelijkeOverheid	`$ref`	Ja	- $ref: ./beleidsmatigverantwoordelijkeoverheid2
dossier	`object, null`	Ja	-
dossier.id	`string`	Ja	-
dossier.status	`string, null`	Ja	-
eindeRechtsgeldigheid	`string, null`	Ja	- Format: date
id	`string`	Ja	-
isHistorisch	`boolean`	Ja	-
naam	`string`	Ja	-
planstatusInfo	`$ref`	Ja	- $ref: ./planstatusinfo
publicerendBevoegdGezag	`$ref`	Ja	- $ref: ./beleidsmatigverantwoordelijkeoverheid2
relatietype	`string`	Ja	- Enum: vervangt, muteert, tenGevolgeVan, gebruiktInformatieUit, gedeeltelijkeHerzieningVan, uitTeWerkenIn, uitgewerktIn
type	`string`	Ja	De types `buiten toepassing verklaring beheersverordening` en `rijksbestemmingsplan` zouden in de praktijk niet voor mogen komen, dit is een datakwaliteit issue. Enum: aanwijzingsbesluit, amvb, beheersverordening, bestemmingsplan, buiten toepassing verklaring beheersverordening, exploitatieplan, gemeentelijk besluit; overig, gemeentelijk plan; bestemmingsplan artikel 10, gemeentelijk plan; uitwerkingsplan artikel 11, gemeentelijk plan; voorbereidingsbesluit, gemeentelijk plan; wijzigingsplan artikel 11, gemeentelijke visie; overig, gerechtelijke uitspraak, inpassingsplan, omgevingsvergunning, projectbesluit, provinciale verordening, reactieve aanwijzing, regeling, rijksbestemmingsplan, structuurvisie, tijdelijke ontheffing buitenplans, uitwerkingsplan, voorbereidingsbesluit, wijzigingsplan
verwijderdOp	`string, null`	Ja	- Format: date-time

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/ruimtelijke-plannen-api-3zzh61mdr/gerelateerdplan",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Gerelateerd plan",
  "properties": {
    "_links": {
      "$ref": "./planlinks"
    },
    "beleidsmatigVerantwoordelijkeOverheid": {
      "$ref": "./beleidsmatigverantwoordelijkeoverheid2"
    },
    "dossier": {
      "properties": {
        "id": {
          "examples": [
            "NL.IMRO.0200.bp1253"
          ],
          "nullable": false,
          "type": "string"
        },
        "status": {
          "examples": [
            "geheel onherroepelijk in werking"
          ],
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "id",
        "status"
      ],
      "type": [
        "object",
        "null"
      ]
    },
    "eindeRechtsgeldigheid": {
      "format": "date",
      "type": [
        "string",
        "null"
      ]
    },
    "id": {
      "examples": [
        "NL.IMRO.0200.bp1253-vas1"
      ],
      "type": "string"
    },
    "isHistorisch": {
      "type": "boolean"
    },
    "naam": {
      "examples": [
        "Woningbouwlocatie Laan van Westenenk 501-701"
      ],
      "type": "string"
    },
    "planstatusInfo": {
      "$ref": "./planstatusinfo"
    },
    "publicerendBevoegdGezag": {
      "$ref": "./beleidsmatigverantwoordelijkeoverheid2"
    },
    "relatietype": {
      "enum": [
        "vervangt",
        "muteert",
        "tenGevolgeVan",
        "gebruiktInformatieUit",
        "gedeeltelijkeHerzieningVan",
        "uitTeWerkenIn",
        "uitgewerktIn"
      ],
      "type": "string"
    },
    "type": {
      "description": "De types `buiten toepassing verklaring beheersverordening` en `rijksbestemmingsplan` zouden in de praktijk niet voor mogen komen, dit is een datakwaliteit issue.",
      "enum": [
        "aanwijzingsbesluit",
        "amvb",
        "beheersverordening",
        "bestemmingsplan",
        "buiten toepassing verklaring beheersverordening",
        "exploitatieplan",
        "gemeentelijk besluit; overig",
        "gemeentelijk plan; bestemmingsplan artikel 10",
        "gemeentelijk plan; uitwerkingsplan artikel 11",
        "gemeentelijk plan; voorbereidingsbesluit",
        "gemeentelijk plan; wijzigingsplan artikel 11",
        "gemeentelijke visie; overig",
        "gerechtelijke uitspraak",
        "inpassingsplan",
        "omgevingsvergunning",
        "projectbesluit",
        "provinciale verordening",
        "reactieve aanwijzing",
        "regeling",
        "rijksbestemmingsplan",
        "structuurvisie",
        "tijdelijke ontheffing buitenplans",
        "uitwerkingsplan",
        "voorbereidingsbesluit",
        "wijzigingsplan"
      ],
      "examples": [
        "bestemmingsplan"
      ],
      "type": "string"
    },
    "verwijderdOp": {
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "_links",
    "beleidsmatigVerantwoordelijkeOverheid",
    "dossier",
    "eindeRechtsgeldigheid",
    "id",
    "isHistorisch",
    "naam",
    "planstatusInfo",
    "publicerendBevoegdGezag",
    "relatietype",
    "type",
    "verwijderdOp"
  ],
  "type": "object",
  "x-derived-from": [
    "https://ruimte.omgevingswet.overheid.nl/ruimtelijke-plannen/api/opvragen/v4/openapi.json#/components/schemas/GerelateerdPlan"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
planlinks	`/properties/_links/$ref`
beleidsmatigverantwoordelijkeoverheid2	`/properties/beleidsmatigVerantwoordelijkeOverheid/$ref`
planstatusinfo	`/properties/planstatusInfo/$ref`

Dit schema wordt gebruikt door
Schema	Locatie
gerelateerdplancollectie	`/properties/gerelateerdVanuit/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
Future versions of JSON Schema will refuse to evaluate unknown keywords or custom keywords from optional vocabularies that don't have an x- prefix	`/properties/dossier/properties/id/nullable`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/relatietype/enum – /properties/relatietype/type`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/type/enum – /properties/type/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/type/description`

Schema-register: gerelateerdplan

Details van JSON Schema: gerelateerdplan

Details van JSON Schema: gerelateerdplan

Beschrijving