Mews · Schema

AvailabilityBlockParameters

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.
Extent	object	Extent of data to be returned, e.g. it is possible to specify that related service orders (for example reservations) are returned.
ServiceIds	array	Unique identifiers of the `Services` to which `Availability blocks` are assigned.
AvailabilityBlockIds	array	Unique identifiers of the requested `Availability blocks`.
CreatedUtc	object	Interval in which the availability blocks were created.
UpdatedUtc	object	Interval in which the `Availability blocks` were updated.
CollidingUtc	object	Interval in which the `Availability blocks` are active.
ReleasedUtc	object	Interval in which the `Availability blocks`are released.
ExternalIdentifiers	array	Identifiers of `Availability blocks` from external systems.
States	array	States the availability blocks should be in.
ActivityStates	array	Whether to return only active, only deleted or both records.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AvailabilityBlockParameters",
  "title": "AvailabilityBlockParameters",
  "required": [
    "AccessToken",
    "Client",
    "ClientToken",
    "Extent",
    "Limitation"
  ],
  "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
    },
    "Extent": {
      "title": "Availability block extent",
      "allOf": [
        {
          "$ref": "#/components/schemas/AvailabilityBlockExtent"
        }
      ],
      "description": "Extent of data to be returned, e.g. it is possible to specify that related service orders (for example reservations) are returned."
    },
    "ServiceIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of the `Services` to which `Availability blocks` are assigned.",
      "nullable": true
    },
    "AvailabilityBlockIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of the requested `Availability blocks`.",
      "nullable": true
    },
    "CreatedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval in which the availability blocks were created.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "UpdatedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval in which the `Availability blocks` were updated.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "CollidingUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval in which the `Availability blocks` are active.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "ReleasedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval in which the `Availability blocks`are released.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "ExternalIdentifiers": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Identifiers of `Availability blocks` from external systems.",
      "nullable": true
    },
    "States": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AvailabilityBlockStateEnum"
      },
      "description": "States the availability blocks should be in.",
      "nullable": true
    },
    "ActivityStates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ActivityStates"
      },
      "description": "Whether to return only active, only deleted or both records.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "AvailabilityBlockParameters"
}