{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/publiq/json-schema/publiq-kiosk-device-schema.json",
  "title": "KioskDevice",
  "description": "Representation of the kiosk entity",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/publiq-kiosk-devices-api-openapi.yml#/components/schemas/KioskDevice",
  "x-stoplight": {
    "id": "hh3kfd7lxxds9"
  },
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the kiosk. This field is always available in responses.",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "x-stoplight": {
        "id": "g2vr54zw4cq7o"
      },
      "description": "Name of the kiosk. This field is always available in responses.",
      "readOnly": true
    },
    "organizers": {
      "type": "array",
      "description": "Organizers linked to this kiosk",
      "items": {
        "$ref": "#/$defs/Organizer"
      }
    },
    "locations": {
      "type": "array",
      "x-stoplight": {
        "id": "m988ozti2dcka"
      },
      "description": "Locations linked to this kiosk",
      "items": {
        "$ref": "#/$defs/Location"
      }
    },
    "deviceId": {
      "type": "string",
      "x-stoplight": {
        "id": "7q3dpudb6iaay"
      },
      "description": "Device ID linked to this kiosk."
    },
    "cardSystem": {
      "$ref": "#/$defs/CardSystem"
    },
    "releaseTrack": {
      "type": "string",
      "x-stoplight": {
        "id": "af2qu41h1ry0m"
      },
      "description": "Release track of this kiosk",
      "enum": [
        "beta",
        "stable"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "deviceId",
    "cardSystem",
    "releaseTrack"
  ],
  "$defs": {
    "CardSystem": {
      "title": "CardSystem",
      "description": "A region, usually one or multiple municipalities in Belgium, that uses UiTPAS and provides discounts and/or rewards. For example \"Paspartoe\" (Brussels), UiTPAS Leuven, UiTPAS Hasselt, UiTPAS Gent, and so on.",
      "type": "object",
      "x-tags": [
        "Models"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "description": "ID of the card system"
        },
        "name": {
          "type": "string",
          "description": "Name of the card system. This field is always available in responses."
        },
        "branding": {
          "type": "object",
          "description": "Branding information of the card system",
          "properties": {
            "logo": {
              "type": "string",
              "description": "URL to the logo of the card system"
            },
            "primaryColor": {
              "type": "string",
              "description": "Color code of the primary branding color."
            },
            "secondaryColor": {
              "type": "string",
              "description": "Color code of the secondary branding color."
            }
          }
        },
        "links": {
          "type": "object",
          "description": "Links of the card system",
          "properties": {
            "website": {
              "type": "string",
              "description": "URL of the website of the card system"
            }
          }
        },
        "cities": {
          "type": "array",
          "description": "List of cities that are part of this card system",
          "items": {
            "$ref": "#/$defs/City"
          }
        },
        "permanent": {
          "type": "boolean",
          "description": "Indicates whether this is a permanent card system"
        },
        "allowsCardlessRegistration": {
          "type": "boolean",
          "description": "Indicates if cardless registration is enabled"
        },
        "cardlessRegistrationType": {
          "type": "string",
          "description": "Indicates the types of online cardless registrations this cardsystem supports.",
          "enum": [
            "ALL",
            "REGULAR",
            "SOCIALTARIFF",
            "NONE"
          ]
        },
        "socialTariffInfo": {
          "type": "string",
          "description": "Optional information about social tariff entitlement in this card system."
        }
      },
      "required": [
        "id"
      ]
    },
    "City": {
      "title": "City",
      "type": "object",
      "x-tags": [
        "Models"
      ],
      "properties": {
        "postalCode": {
          "type": "string",
          "description": "Postalcode of the city"
        },
        "name": {
          "type": "string",
          "description": "Name of the city"
        }
      },
      "required": [
        "postalCode",
        "name"
      ]
    },
    "Location": {
      "title": "Location",
      "x-stoplight": {
        "id": "jsek0i5fkc5ai"
      },
      "type": "object",
      "description": "Location model",
      "properties": {
        "id": {
          "type": "string",
          "description": "ID of the location"
        },
        "name": {
          "type": "string",
          "x-stoplight": {
            "id": "xqbdyntqozql8"
          },
          "description": "Name of the location"
        }
      },
      "required": [
        "id",
        "name"
      ]
    },
    "Organizer": {
      "title": "Organizer",
      "type": "object",
      "description": "An organisation that partners with UiTPAS to provide discounts and/or rewards, and/or allows points to be collected at their events.",
      "x-tags": [
        "Models"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique ID of an UiTPAS organizer. (Same as its ID in UiTdatabank)"
        },
        "name": {
          "type": "string",
          "description": "Human-readable name of an UiTPAS organizer."
        },
        "cardSystems": {
          "type": "array",
          "description": "Card systems linked to this organizer",
          "items": {
            "$ref": "#/$defs/CardSystem"
          }
        },
        "linkedLocationId": {
          "type": "string",
          "description": "ID of the location linked to this organizer.",
          "readOnly": true
        },
        "address": {
          "type": "object",
          "description": "Address of this organizer. This property is alway available in responses.",
          "required": [
            "city"
          ],
          "properties": {
            "street": {
              "type": "string",
              "description": "Street address of this organizer"
            },
            "postalCode": {
              "type": "string",
              "description": "Postal code of this organizer"
            },
            "city": {
              "type": "string",
              "description": "City of this organizer"
            }
          },
          "readOnly": true
        }
      },
      "required": [
        "id"
      ]
    }
  }
}