toepasbareregels | Schema-register

Dialect2020-12

Typeunknown

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
aansluiting	`object`	Nee	aansluiting informatie van deze toepasbare regels
aansluiting.aansluitpuntSoort	`string`	Ja	De functionele versie van de aansluiting. Enum: V1, V2
aansluiting.locaties	`array`	Nee	De identifiers van de locaties waar deze aansluiting actief is Items type: string
aansluiting.standaardAansluiting	`boolean`	Ja	Is standaard aansluiting?
aansluitpunt	`object`	Nee	aansluitpunt informatie van deze toepasbare regels
aansluitpunt.aansluitpuntSoort	`string`	Ja	De functionele versie van het aansluitpunt. Enum: V1, V2
aansluitpunt.bestuurslaag	`string`	Ja	- allOf: 2 schema's
aansluitpunt.decisionName	`string`	Ja	De decision name van de topdecision die moet wordt gebruikt in het STTR bestand van de aansluiting.
aansluitpunt.modelName	`string`	Ja	De model (definition) name die moet worden gebruikt in het STTR bestand van de aansluiting.
aansluitpunt.naam	`string`	Ja	De naam van het aansluitpunt van deze toepasbare regels
begindatum	`string`	Ja	De datum vanaf wanneer deze toepasbare regels actief zijn. Het formaat van de datum is dd-MM-yyyy
einddatum	`string`	Nee	De datum tot wanneer deze toepasbare regels actief zijn. Het formaat van de datum is dd-MM-yyyy
functioneleStructuurRef	`string`	Ja	de functionele structuur referentie waaronder deze toepasbare regels bekend zijn in de registratie toepasbare regels
identifier	`integer`	Ja	-
laatsteWijzigingDatum	`string`	Ja	De datum waarop deze toepasbare regels voor het laatst gewijzigd zijn. Het formaat van de datum is dd-MM-yyyy
oin	`string`	Ja	oin van bet bestuursorgaan dat eigenaar is van deze toepasbare regels
sttrVersie	`integer`	Ja	De versie van de STTR-standaard van het bestand

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/uitvoeren-gegevens-hogd61mvg/toepasbareregels",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "aansluiting": {
      "description": "aansluiting informatie van deze toepasbare regels",
      "properties": {
        "aansluitpuntSoort": {
          "description": "De functionele versie van de aansluiting.",
          "enum": [
            "V1",
            "V2"
          ],
          "type": "string"
        },
        "locaties": {
          "description": "De identifiers van de locaties waar deze aansluiting actief is",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "standaardAansluiting": {
          "description": "Is standaard aansluiting?",
          "type": "boolean"
        }
      },
      "required": [
        "standaardAansluiting",
        "aansluitpuntSoort"
      ]
    },
    "aansluitpunt": {
      "description": "aansluitpunt informatie van deze toepasbare regels",
      "properties": {
        "aansluitpuntSoort": {
          "description": "De functionele versie van het aansluitpunt.",
          "enum": [
            "V1",
            "V2"
          ],
          "type": "string"
        },
        "bestuurslaag": {
          "allOf": [
            {
              "description": "Bestuurslaag van een Organisatie",
              "enum": [
                "rijk",
                "provincie",
                "waterschap",
                "gemeente"
              ],
              "type": "string"
            },
            {
              "description": "De aangegeven bestuurslaag van de bestuursorganen die aansluitingen kunnen aanleveren"
            }
          ],
          "type": "string"
        },
        "decisionName": {
          "description": "De decision name van de topdecision die moet wordt gebruikt in het STTR bestand van de aansluiting.",
          "type": "string"
        },
        "modelName": {
          "description": "De model (definition) name die moet worden gebruikt in het STTR bestand van de aansluiting.",
          "type": "string"
        },
        "naam": {
          "description": "De naam van het aansluitpunt van deze toepasbare regels",
          "type": "string"
        }
      },
      "required": [
        "naam",
        "bestuurslaag",
        "modelName",
        "decisionName",
        "aansluitpuntSoort"
      ]
    },
    "begindatum": {
      "description": "De datum vanaf wanneer deze toepasbare regels actief zijn. Het formaat van de datum is dd-MM-yyyy",
      "type": "string"
    },
    "einddatum": {
      "description": "De datum tot wanneer deze toepasbare regels actief zijn. Het formaat van de datum is dd-MM-yyyy",
      "type": "string"
    },
    "functioneleStructuurRef": {
      "description": "de functionele structuur referentie waaronder deze toepasbare regels bekend zijn in de registratie toepasbare regels",
      "type": "string"
    },
    "identifier": {
      "type": "integer"
    },
    "laatsteWijzigingDatum": {
      "description": "De datum waarop deze toepasbare regels voor het laatst gewijzigd zijn. Het formaat van de datum is dd-MM-yyyy",
      "type": "string"
    },
    "oin": {
      "description": "oin van bet bestuursorgaan dat eigenaar is van deze toepasbare regels",
      "type": "string"
    },
    "sttrVersie": {
      "description": "De versie van de STTR-standaard van het bestand",
      "type": "integer"
    }
  },
  "required": [
    "identifier",
    "sttrVersie",
    "functioneleStructuurRef",
    "begindatum",
    "laatsteWijzigingDatum",
    "oin"
  ],
  "x-derived-from": [
    "https://developer.omgevingswet.overheid.nl/publish/pages/183874/toepasbareregels-uitvoerengegevens-v1.json#/components/schemas/ToepasbareRegels"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Dit schema gebruikt geen andere schema's.

Dit schema wordt niet door andere schema's gebruikt.

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
Set a non-empty examples array at the top level of the schema to illustrate the expected data
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/aansluiting/properties/aansluitpuntSoort/enum – /properties/aansluiting/properties/aansluitpuntSoort/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/aansluiting/properties/aansluitpuntSoort/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/aansluitpunt/properties/aansluitpuntSoort/enum – /properties/aansluitpunt/properties/aansluitpuntSoort/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/aansluitpunt/properties/aansluitpuntSoort/description`
Keywords inside `allOf` that do not conflict with the parent schema can be elevated	`/properties/aansluitpunt/properties/bestuurslaag/allOf/1/description – /properties/aansluitpunt/properties/bestuurslaag/allOf/0/type – /properties/aansluitpunt/properties/bestuurslaag/allOf/0/enum`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/aansluitpunt/properties/bestuurslaag/allOf/0/enum – /properties/aansluitpunt/properties/bestuurslaag/allOf/0/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/aansluitpunt/properties/decisionName/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/aansluitpunt/properties/modelName/description`

Schema-register: toepasbareregels

Details van JSON Schema: toepasbareregels

Details van JSON Schema: toepasbareregels

Beschrijving