Mews · Schema

CompanionshipFilterParameters

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.
CompanionshipIds	array	Unique identifiers of `Companionship`. Required if no other filter is provided.
Extent	object	Extent of data to be returned. E.g. it is possible to specify that together with the companionships, customers, reservations, and reservation groups should be also returned.
ReservationIds	array	Unique identifiers of `Reservation`. Required if no other filter is provided.
CustomerIds	array	Unique identifiers of `Customer`. Required if no other filter is provided.
ReservationGroupIds	array	Unique identifiers of `ReservationGroup`. Required if no other filter is provided.
UpdatedUtc	object	Interval in which the `Companionship` was updated. Must be used together with at least one another filter.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CompanionshipFilterParameters",
  "title": "CompanionshipFilterParameters",
  "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
    },
    "CompanionshipIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of `Companionship`. Required if no other filter is provided.",
      "nullable": true
    },
    "Extent": {
      "title": "Companionship extent",
      "allOf": [
        {
          "$ref": "#/components/schemas/CompanionshipExtent"
        }
      ],
      "description": "Extent of data to be returned. E.g. it is possible to specify that together with the companionships, customers, reservations, and reservation groups should be also returned."
    },
    "ReservationIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of `Reservation`. Required if no other filter is provided.",
      "nullable": true
    },
    "CustomerIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of `Customer`. Required if no other filter is provided.",
      "nullable": true
    },
    "ReservationGroupIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of `ReservationGroup`. Required if no other filter is provided.",
      "nullable": true
    },
    "UpdatedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval in which the `Companionship` was updated. Must be used together with at least one another filter.",
      "nullable": true,
      "x-max-interval-in-months": 3
    }
  },
  "additionalProperties": false,
  "x-schema-id": "CompanionshipFilterParameters"
}