generiekzoekobject | Schema-register

Generiek zoekobject voor mapbox bevragingen voor objecten.

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
objectType	`string`	Ja	- Enum: GebiedsaanwijzingZoekobject, OmgevingsnormNormwaardeZoekobject, OmgevingswaardeNormwaardeZoekobject, RegeltekstActiviteitlocatieaanduidingZoekobject, KaartKaartlaagZoekobject, WerkingsgebiedZoekobject, RegelingsgebiedZoekobject, VergunningsgebiedZoekobject, OntwerpGebiedsaanwijzingZoekobject, OntwerpOmgevingsnormNormwaardeZoekobject, OntwerpOmgevingswaardeNormwaardeZoekobject, OntwerpRegeltekstActiviteitlocatieaanduidingZoekobject, OntwerpKaartKaartlaagZoekobject, OntwerpWerkingsgebiedZoekobject, OntwerpRegelingsgebiedZoekobject
primairObjectIdentificator	`object`	Ja	- oneOf: 2 schema's
primairObjectIdentificator.oneOf[1].primairObjectIdentificatie	`string`	Nee	-
primairObjectIdentificator.oneOf[2].primairObjectTechnischId	`string`	Nee	-
secundaireObjectIdentificatoren	`array`	Nee	Een lijst identificaties van het bij het objecttype ondergelegen objecten, verplicht m.u.v. gebiedsaanwijzingen. Voor het WerkingsgebiedZoekobject en OntwerpWerkingsgebiedZoekobject zijn SecundaireIdentificatoren optioneel in te vullen met werkingsgebied identificaties en/of technischId voor het verbeelden van specifieke werkingsgebieden. Items type: string

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/omgevingsdocumenten-verbeelden-ibyvejgdg/generiekzoekobject",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Generiek zoekobject voor mapbox bevragingen voor objecten.",
  "properties": {
    "objectType": {
      "enum": [
        "GebiedsaanwijzingZoekobject",
        "OmgevingsnormNormwaardeZoekobject",
        "OmgevingswaardeNormwaardeZoekobject",
        "RegeltekstActiviteitlocatieaanduidingZoekobject",
        "KaartKaartlaagZoekobject",
        "WerkingsgebiedZoekobject",
        "RegelingsgebiedZoekobject",
        "VergunningsgebiedZoekobject",
        "OntwerpGebiedsaanwijzingZoekobject",
        "OntwerpOmgevingsnormNormwaardeZoekobject",
        "OntwerpOmgevingswaardeNormwaardeZoekobject",
        "OntwerpRegeltekstActiviteitlocatieaanduidingZoekobject",
        "OntwerpKaartKaartlaagZoekobject",
        "OntwerpWerkingsgebiedZoekobject",
        "OntwerpRegelingsgebiedZoekobject"
      ],
      "type": "string"
    },
    "primairObjectIdentificator": {
      "oneOf": [
        {
          "properties": {
            "primairObjectIdentificatie": {
              "title": "primairObjectIdentificatie",
              "type": "string"
            }
          }
        },
        {
          "properties": {
            "primairObjectTechnischId": {
              "title": "primairObjectTechnischId",
              "type": "string"
            }
          }
        }
      ],
      "title": "primairObjectIdentificator",
      "type": "object"
    },
    "secundaireObjectIdentificatoren": {
      "description": "Een lijst identificaties van het bij het objecttype ondergelegen objecten, verplicht m.u.v. gebiedsaanwijzingen. Voor het WerkingsgebiedZoekobject en OntwerpWerkingsgebiedZoekobject zijn SecundaireIdentificatoren optioneel in te vullen met werkingsgebied identificaties en/of technischId voor het verbeelden van specifieke werkingsgebieden.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "objectType",
    "primairObjectIdentificator"
  ],
  "type": "object",
  "x-derived-from": [
    "https://service.omgevingswet.overheid.nl/publiek/omgevingsdocumenten/api/verbeelden/v3/openapi.json#/components/schemas/generiekZoekobject"
  ]
}

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
mapboxzoekobject	`/properties/zoekObjecten/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
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/objectType/enum – /properties/objectType/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/secundaireObjectIdentificatoren/description`

Schema-register: generiekzoekobject

Details van JSON Schema: generiekzoekobject

Details van JSON Schema: generiekzoekobject

Beschrijving