Mews · Schema

IdentityDocumentFilterParameters

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.
ChainIds	array	Unique identifiers of `Chain`. If not specified, the operation returns data for all chains within scope of the Access Token.
IdentityDocumentIds	array	Unique identifiers of `Identity document`.
CustomerIds	array	Unique identifiers of `Customer`.
Types	array	Type of the identity document.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/IdentityDocumentFilterParameters",
  "title": "IdentityDocumentFilterParameters",
  "required": [
    "AccessToken",
    "Client",
    "ClientToken",
    "CustomerIds",
    "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."
    },
    "ChainIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of `Chain`. If not specified, the operation returns data for all chains within scope of the Access Token.",
      "nullable": true
    },
    "IdentityDocumentIds": {
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of `Identity document`.",
      "nullable": true
    },
    "CustomerIds": {
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of `Customer`."
    },
    "Types": {
      "uniqueItems": true,
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/IdentityDocumentTypeEnum"
      },
      "description": "Type of the identity document.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "IdentityDocumentFilterParameters"
}