Mews · Schema

VoucherCodeFilterParameters

HospitalityHotelsPMSProperty Management

Properties

Name Type Description
ClientToken string Token identifying the client application.
AccessToken string Access token of the client application.
Client string Name and version of the client application.
Limitation object Limitation on the quantity of data returned and optional Cursor for the starting point of data.
EnterpriseIds array Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
VoucherCodeIds array Unique identifiers of the voucher codes.
VoucherIds array Unique identifiers of vouchers.
UpdatedUtc object Interval of voucher code's last update date and time.
View JSON Schema on GitHub

JSON Schema

mews-vouchercodefilterparameters-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VoucherCodeFilterParameters",
  "title": "VoucherCodeFilterParameters",
  "required": [
    "AccessToken",
    "Client",
    "ClientToken",
    "Limitation",
    "VoucherIds"
  ],
  "type": "object",
  "properties": {
    "ClientToken": {
      "minLength": 1,
      "type": "string",
      "description": "Token identifying the client application."
    },
    "AccessToken": {
      "minLength": 1,
      "type": "string",
      "description": "Access token of the client application."
    },
    "Client": {
      "minLength": 1,
      "type": "string",
      "description": "Name and version of the client application."
    },
    "Limitation": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Limitation"
        }
      ],
      "description": "Limitation on the quantity of data returned and optional Cursor for the starting point of data."
    },
    "EnterpriseIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.",
      "nullable": true
    },
    "VoucherCodeIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of the voucher codes.",
      "nullable": true
    },
    "VoucherIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of vouchers."
    },
    "UpdatedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval of voucher code's last update date and time.",
      "nullable": true,
      "x-max-interval-in-months": 3
    }
  },
  "additionalProperties": false,
  "x-schema-id": "VoucherCodeFilterParameters"
}