Mews · Schema

ServiceOverbookingLimitFilterParameters

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.
ServiceIds	array	Unique identifiers of `Service` associated with the service overbooking limits.
ServiceOverbookingLimitIds	array	Unique identifiers of the service overbooking limits.
CollidingUtc	object	Interval in which the service overbooking limit is active.
UpdatedUtc	object	Interval in which the service overbooking limits were updated.
ActivityStates	array	Whether to return only active, only deleted, or both types of record. If not specified, only active records will be returned.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ServiceOverbookingLimitFilterParameters",
  "title": "ServiceOverbookingLimitFilterParameters",
  "required": [
    "AccessToken",
    "Client",
    "ClientToken",
    "Limitation",
    "ServiceIds"
  ],
  "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
    },
    "ServiceIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of `Service` associated with the service overbooking limits."
    },
    "ServiceOverbookingLimitIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of the service overbooking limits.",
      "nullable": true
    },
    "CollidingUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval in which the service overbooking limit is active.",
      "nullable": true
    },
    "UpdatedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval in which the service overbooking limits were updated.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "ActivityStates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ActivityState"
      },
      "description": "Whether to return only active, only deleted, or both types of record. If not specified, only active records will be returned.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "ServiceOverbookingLimitFilterParameters"
}