AbonnementenHalResponseType

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/kvk-nl/json-schema/kvk-nl-abonnementen-hal-response-type-schema.json",
  "title": "AbonnementenHalResponseType",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/kvk-nl-mutatieservice-openapi.yml#/components/schemas/AbonnementenHalResponseType",
  "allOf": [
    {
      "$ref": "#/$defs/AbonnementenDetailResponseType"
    },
    {
      "required": [
        "abonnementen"
      ],
      "type": "object",
      "properties": {
        "abonnementen": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AbonnementHal"
          }
        }
      }
    }
  ],
  "$defs": {
    "AbonnementDetail": {
      "required": [
        "actief",
        "contract",
        "id",
        "startDatum"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "contract": {
          "$ref": "#/$defs/ContractInfo"
        },
        "startDatum": {
          "type": "string",
          "description": "Het datum en tijdformaat moet voldoen aan RFC3339 op basis van ISO8601.",
          "format": "date-time"
        },
        "eindDatum": {
          "type": "string",
          "description": "Het datum en tijdformaat moet voldoen aan RFC3339 op basis van ISO8601.",
          "format": "date-time"
        },
        "actief": {
          "type": "boolean"
        }
      }
    },
    "AbonnementHal": {
      "allOf": [
        {
          "$ref": "#/$defs/AbonnementDetail"
        },
        {
          "$ref": "#/$defs/HateoasLinks"
        }
      ]
    },
    "AbonnementenDetailResponseType": {
      "required": [
        "klantId"
      ],
      "type": "object",
      "properties": {
        "klantId": {
          "type": "string"
        }
      }
    },
    "ContractInfo": {
      "required": [
        "id"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "HateoasLink": {
      "title": "Link Description",
      "required": [
        "href",
        "rel"
      ],
      "type": "object",
      "properties": {
        "href": {
          "type": "string",
          "description": "De volledige doel-URL. Om de bijbehorende aanroep te maken, combineert u de methode met deze [URI-sjabloon-geformatteerde](https://tools.ietf.org/html/rfc6570) link. Voor de voorbewerking voegt u de tekens `$`, `(` en `)` toe. De `href` is het belangrijkste HATEOAS-onderdeel dat een voltooide aanroep koppelt aan een volgende aanroep."
        },
        "rel": {
          "type": "string",
          "description": "Het [linkrelatietype](https://tools.ietf.org/html/rfc5988#section-4), dat dient als een ID voor een link die de semantiek van de link ondubbelzinnig beschrijft. Zie [Linkrelaties](https://www.iana.org/assignments/link-relations/link-relations.xhtml)."
        },
        "method": {
          "type": "string",
          "description": "De HTTP-methode die nodig is om de betreffende oproep te doen.",
          "enum": [
            "GET",
            "POST",
            "PUT",
            "DELETE",
            "HEAD",
            "CONNECT",
            "OPTIONS",
            "PATCH"
          ]
        }
      }
    },
    "HateoasLinks": {
      "required": [
        "links"
      ],
      "type": "object",
      "properties": {
        "links": {
          "maxItems": 10,
          "minItems": 1,
          "type": "array",
          "description": "Een array van HATEOAS links.",
          "items": {
            "$ref": "#/$defs/HateoasLink"
          }
        }
      }
    }
  }
}