Mews · Schema

LoyaltyProgramFilterParameters

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.
ChainIds array Unique identifiers of the chain. If not specified, the operation returns data for all chains within scope of the Access Token.
CreatedUtc object Interval of `LoyaltyProgram` creation date and time.
UpdatedUtc object Interval of `LoyaltyProgram` last update date and time.
LoyaltyProgramIds array Unique identifiers of `LoyaltyProgram`.
ActivityStates array Whether to return only active, only deleted or both records.
Codes array Codes of `LoyaltyProgram`.
Limitation object Limitation on the quantity of data returned.
View JSON Schema on GitHub

JSON Schema

mews-loyaltyprogramfilterparameters-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LoyaltyProgramFilterParameters",
  "title": "LoyaltyProgramFilterParameters",
  "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."
    },
    "ChainIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of the chain. If not specified, the operation returns data for all chains within scope of the Access Token.",
      "nullable": true
    },
    "CreatedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval of `LoyaltyProgram` creation date and time.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "UpdatedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval of `LoyaltyProgram` last update date and time.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "LoyaltyProgramIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of `LoyaltyProgram`.",
      "nullable": true
    },
    "ActivityStates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ActivityStates"
      },
      "description": "Whether to return only active, only deleted or both records.",
      "nullable": true
    },
    "Codes": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Codes of `LoyaltyProgram`.",
      "nullable": true
    },
    "Limitation": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Limitation"
        }
      ],
      "description": "Limitation on the quantity of data returned."
    }
  },
  "additionalProperties": false,
  "x-schema-id": "LoyaltyProgramFilterParameters"
}