Mews · Schema

Resource block parameters

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.
ResourceBlockIds	array	Unique identifiers of the requested resource block.
AssignedResourceIds	array	Unique identifiers of the requested Assigned `Resource`.
ActivityStates	array	Whether to return only active, only deleted or both records. Defaults to `Active` if not specified.
CollidingUtc	object	Interval in which the resource block is active.
CreatedUtc	object	Interval in which the resource block was created.
UpdatedUtc	object	Interval in which the resource block was updated.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ResourceBlockParameters",
  "title": "Resource block parameters",
  "required": [
    "AccessToken",
    "Client",
    "ClientToken",
    "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": "Resource block extent",
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceBlockExtent"
        }
      ],
      "description": "Extent of data to be returned.",
      "nullable": true,
      "deprecated": true,
      "x-deprecatedMessage": "Use ActivityStates with `[\"Active\", \"Deleted\"]` instead."
    },
    "ResourceBlockIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of the requested resource block.",
      "nullable": true
    },
    "AssignedResourceIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of the requested Assigned `Resource`.",
      "nullable": true
    },
    "ActivityStates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ActivityStates"
      },
      "description": "Whether to return only active, only deleted or both records. Defaults to `Active` if not specified.",
      "nullable": true
    },
    "CollidingUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval in which the resource block is active.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "CreatedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval in which the resource block was created.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "UpdatedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval in which the resource block was updated.",
      "nullable": true,
      "x-max-interval-in-months": 3
    }
  },
  "additionalProperties": false,
  "x-schema-id": "ResourceBlockParameters"
}