Mews · Schema

ResourceCategoryAssignmentFilterParameters

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.
ResourceCategoryAssignmentIds array Unique identifiers of [Resource category assignment](https://mews-systems.gitbook.io/connector-api/operations/resourcecategories/#resource-category-assignment).
ResourceCategoryIds array Unique identifiers of [Resource categories](https://mews-systems.gitbook.io/connector-api/operations/#resource-category) to which the resource category assignment belong.
UpdatedUtc object Interval in which the resource category assignments were updated.
ActivityStates array Whether to return only active, only deleted or both records. The `ActivityState` filter applies only to record’s own status. The `IsActive` response property also considers the parent’s status, so som
ResourceIds array Unique identifiers of resources to which the resource category assignments belong.
View JSON Schema on GitHub

JSON Schema

mews-resourcecategoryassignmentfilterparameters-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ResourceCategoryAssignmentFilterParameters",
  "title": "ResourceCategoryAssignmentFilterParameters",
  "required": [
    "AccessToken",
    "Client",
    "ClientToken",
    "Limitation",
    "ResourceCategoryIds"
  ],
  "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
    },
    "ResourceCategoryAssignmentIds": {
      "maxItems": 1000,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of [Resource category assignment](https://mews-systems.gitbook.io/connector-api/operations/resourcecategories/#resource-category-assignment).",
      "nullable": true
    },
    "ResourceCategoryIds": {
      "maxItems": 1000,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of [Resource categories](https://mews-systems.gitbook.io/connector-api/operations/#resource-category) to which the resource category assignment belong."
    },
    "UpdatedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval in which the resource category assignments were updated.",
      "nullable": true
    },
    "ActivityStates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ActivityStates"
      },
      "description": "Whether to return only active, only deleted or both records. The `ActivityState` filter applies only to record\u2019s own status. The `IsActive` response property also considers the parent\u2019s status, so some returned records may have `IsActive = false` if their parent is deleted.",
      "nullable": true
    },
    "ResourceIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of resources to which the resource category assignments belong.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "ResourceCategoryAssignmentFilterParameters"
}