observationcollection | Schema-register

A collection schema for the Observation schema.

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
observaties	`array`	Nee	A list of countries. Items type: object, null
observaties[].herkomst	`object, null`	Ja	-
observaties[].herkomst.bron	`object, null`	Ja	-
observaties[].herkomst.bron.naam	`string, null`	Ja	The origin of the observation.
observaties[].herkomst.datum	`string, null`	Ja	- Format: date
observaties[].id	`string`	Ja	A unique identifier in UUID format from a sector, country, content-item etc. Format: uuid
observaties[].jaartal	`string, null`	Ja	The year of the observation.
observaties[].landen	`array`	Nee	A list of countries related to the current country observation. Items type: $ref Items $ref: ./country
observaties[].meeteenheid	`object, null`	Ja	-
observaties[].meeteenheid.afkorting	`string, null`	Ja	-
observaties[].meeteenheid.naam	`string, null`	Ja	The measuring unit.
observaties[].ranking	`integer, null`	Ja	The ranking of the observation.
observaties[].schaal	`string, null`	Ja	The scale of the observation.
observaties[].schatting	`boolean, null`	Ja	If this observation is an estimation.
observaties[].type	`string`	Ja	The type of the observation. Enum: bigMacIndex, economischeGroei, easeOfDoingBusinessIndex, uitvoerwaarde, corruptieIndex, bbp, koopkracht, globalCompetitivenessIndex, globalInnovationIndex, invoerWaarde, inflatie, logisticPerformanceIndex, inwoneraantal, oppervlakte, werkloosheid
observaties[].waarde	`string, null`	Ja	The amount of the observation.

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/rijksdienst-voor-ondernemend-nederland/iio-api-aakgfxenr/observationcollection",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "A collection schema for the Observation schema.",
  "properties": {
    "observaties": {
      "description": "A list of countries.",
      "items": {
        "description": "An observation (measurement) of a country.",
        "properties": {
          "herkomst": {
            "properties": {
              "bron": {
                "properties": {
                  "naam": {
                    "description": "The origin of the observation.",
                    "examples": [
                      "Wereldbank"
                    ],
                    "type": [
                      "string",
                      "null"
                    ]
                  }
                },
                "required": [
                  "naam"
                ],
                "type": [
                  "object",
                  "null"
                ]
              },
              "datum": {
                "examples": [
                  "2022-12-01"
                ],
                "format": "date",
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "bron",
              "datum"
            ],
            "type": [
              "object",
              "null"
            ]
          },
          "id": {
            "description": "A unique identifier in UUID format from a sector, country, content-item etc.",
            "format": "uuid",
            "type": "string"
          },
          "jaartal": {
            "description": "The year of the observation.",
            "examples": [
              "2016"
            ],
            "type": [
              "string",
              "null"
            ]
          },
          "landen": {
            "description": "A list of countries related to the current country observation.",
            "items": {
              "$ref": "./country"
            },
            "type": "array"
          },
          "meeteenheid": {
            "properties": {
              "afkorting": {
                "examples": [
                  "<p>In km²</p>"
                ],
                "type": [
                  "string",
                  "null"
                ]
              },
              "naam": {
                "description": "The measuring unit.",
                "examples": [
                  "Vierkante kilometer"
                ],
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "naam",
              "afkorting"
            ],
            "type": [
              "object",
              "null"
            ]
          },
          "ranking": {
            "description": "The ranking of the observation.",
            "examples": [
              5
            ],
            "type": [
              "integer",
              "null"
            ]
          },
          "schaal": {
            "description": "The scale of the observation.",
            "examples": [
              "km²"
            ],
            "type": [
              "string",
              "null"
            ]
          },
          "schatting": {
            "description": "If this observation is an estimation.",
            "examples": [
              false
            ],
            "type": [
              "boolean",
              "null"
            ]
          },
          "type": {
            "description": "The type of the observation.",
            "enum": [
              "bigMacIndex",
              "economischeGroei",
              "easeOfDoingBusinessIndex",
              "uitvoerwaarde",
              "corruptieIndex",
              "bbp",
              "koopkracht",
              "globalCompetitivenessIndex",
              "globalInnovationIndex",
              "invoerWaarde",
              "inflatie",
              "logisticPerformanceIndex",
              "inwoneraantal",
              "oppervlakte",
              "werkloosheid"
            ],
            "examples": [
              "oppervlakte"
            ],
            "type": "string"
          },
          "waarde": {
            "description": "The amount of the observation.",
            "examples": [
              "1671000"
            ],
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "id",
          "type",
          "meeteenheid",
          "waarde",
          "jaartal",
          "ranking",
          "schatting",
          "schaal",
          "herkomst"
        ],
        "type": [
          "object",
          "null"
        ]
      },
      "type": "array"
    }
  },
  "type": "object",
  "x-derived-from": [
    "https://internationaal.ondernemen.overheid.nl/api/iio/v1/openapi.yaml#/components/schemas/ObservationCollection"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
country	`/properties/observaties/items/properties/landen/items/$ref`

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 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/observaties/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/observaties/items/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/observaties/items/properties/herkomst/properties/bron/properties/naam/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/observaties/items/properties/id/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/observaties/items/properties/jaartal/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/observaties/items/properties/landen/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/observaties/items/properties/meeteenheid/properties/naam/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/observaties/items/properties/ranking/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/observaties/items/properties/schaal/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/observaties/items/properties/schatting/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/observaties/items/properties/type/enum – /properties/observaties/items/properties/type/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/observaties/items/properties/type/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/observaties/items/properties/waarde/description`

Schema-register: observationcollection

Details van JSON Schema: observationcollection

Details van JSON Schema: observationcollection

Beschrijving