Mews · Schema

ServiceOrderNoteFilterParameters

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.
ServiceOrderIds	array	Unique identifiers of `Service order`. Reservation IDs or Order IDs can be used as service order identifiers.
ServiceOrderNoteIds	array	Unique identifiers of `Service order note`. Use this property if you want to fetch specific service order notes.
UpdatedUtc	object	Timestamp in UTC timezone ISO 8601 format when the service order note was updated.
Types	array	Type of the service order note. Defaults to `["General", "ChannelManager"]`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ServiceOrderNoteFilterParameters",
  "title": "ServiceOrderNoteFilterParameters",
  "required": [
    "AccessToken",
    "Client",
    "ClientToken",
    "Limitation",
    "ServiceOrderIds"
  ],
  "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
    },
    "ServiceOrderIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of `Service order`. Reservation IDs or Order IDs can be used as service order identifiers."
    },
    "ServiceOrderNoteIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of `Service order note`. Use this property if you want to fetch specific service order notes.",
      "nullable": true
    },
    "UpdatedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Timestamp in UTC timezone ISO 8601 format when the service order note was updated.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "Types": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderNoteTypeEnum"
      },
      "description": "Type of the service order note. Defaults to `[\"General\", \"ChannelManager\"]`.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "ServiceOrderNoteFilterParameters"
}