hallink | Schema-register

Het Link Object zoals gespecificeerd in https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
href	`string`	Ja	-
templated	`boolean`	Nee	-
title	`string`	Nee	Voor mens leesbaar label bij de link

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/dienst-voor-het-kadaster-en-de-openbare-registers/imbag-api-van-de-lvbag-7fnzbuehg/hallink",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n",
  "properties": {
    "href": {
      "examples": [
        "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}"
      ],
      "title": "Href",
      "type": "string"
    },
    "templated": {
      "type": "boolean"
    },
    "title": {
      "description": "Voor mens leesbaar label bij de link",
      "type": "string"
    }
  },
  "required": [
    "href"
  ],
  "type": "object",
  "x-derived-from": [
    "https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2/openapi.yaml#/components/schemas/HalLink"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Dit schema gebruikt geen andere schema's.

Dit schema wordt gebruikt door
Schema	Locatie
adresiohalcollection	`/properties/_links/allOf/1/properties/first/$ref`
adresiolinks	`/properties/adresseerbaarObject/$ref`
AdresseerbaarObjectIO	`/properties/ligplaats/allOf/0/allOf/1/properties/_links/properties/heeftAlsHoofdAdres/$ref`
adresseerbaarobjectlinks	`/properties/heeftAlsHoofdAdres/$ref`
bronhouderlinks	`/properties/self/$ref`
HalCollectionLinks	`/properties/self/$ref`
HalPaginationLinks	`/allOf/1/properties/first/$ref`
ligplaatsiohal	`/allOf/0/allOf/1/properties/_links/properties/heeftAlsHoofdAdres/$ref`
ligplaatsiohalbasis	`/allOf/1/properties/_links/properties/heeftAlsHoofdAdres/$ref`
ligplaatsiohalcollectionembedded	`/properties/ligplaatsen/items/allOf/0/allOf/1/properties/_links/properties/heeftAlsHoofdAdres/$ref`
ligplaatsiolvchalcollectionembedded	`/properties/voorkomens/items/allOf/0/allOf/1/properties/_links/properties/heeftAlsHoofdAdres/$ref`
ligplaatslinks	`/properties/heeftAlsHoofdAdres/$ref`
nummeraanduidinglinks	`/properties/ligtAanOpenbareRuimte/$ref`
openbareruimtelinks	`/properties/ligtInWoonplaats/$ref`
standplaatsiohal	`/allOf/0/allOf/1/properties/_links/properties/heeftAlsHoofdAdres/$ref`
standplaatsiohalbasis	`/allOf/1/properties/_links/properties/heeftAlsHoofdAdres/$ref`
standplaatsiohalcollectionembedded	`/properties/standplaatsen/items/allOf/0/allOf/1/properties/_links/properties/heeftAlsHoofdAdres/$ref`
standplaatsiolvchalcollectionembedded	`/properties/voorkomens/items/allOf/0/allOf/1/properties/_links/properties/heeftAlsHoofdAdres/$ref`
verblijfsobjectiohal	`/allOf/0/allOf/1/properties/_links/allOf/0/properties/heeftAlsHoofdAdres/$ref`
verblijfsobjectiohalbasis	`/allOf/1/properties/_links/allOf/0/properties/heeftAlsHoofdAdres/$ref`
verblijfsobjectiohalcollectionembedded	`/properties/verblijfsobjecten/items/allOf/0/allOf/1/properties/_links/allOf/0/properties/heeftAlsHoofdAdres/$ref`
verblijfsobjectiolvchalcollectionembedded	`/properties/voorkomens/items/allOf/0/allOf/1/properties/_links/allOf/0/properties/heeftAlsHoofdAdres/$ref`
verblijfsobjectlinks	`/allOf/0/properties/heeftAlsHoofdAdres/$ref`
woonplaatslinks	`/properties/bronhouders/items/$ref`
zoekresultaathalcollection	`/properties/_links/allOf/1/properties/first/$ref`
zoekresultaatlinks	`/properties/adres/$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 contain leading or trailing whitespace	`/description`

Schema-register: hallink

Details van JSON Schema: hallink

Details van JSON Schema: hallink

Beschrijving