Mews · Schema

CustomerResult

HospitalityHotelsPMSProperty Management

Properties

Name Type Description
Customers array The customers.
Documents array The identity documents of customers.
Cursor string Unique identifier of the last and hence oldest customer item returned. This can be used in [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) in a subsequent
View JSON Schema on GitHub

JSON Schema

mews-customerresult-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomerResult",
  "title": "CustomerResult",
  "required": [
    "Customers"
  ],
  "type": "object",
  "properties": {
    "Customers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Customer"
      },
      "description": "The customers."
    },
    "Documents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/IdentityDocument"
      },
      "description": "The identity documents of customers.",
      "nullable": true,
      "deprecated": true,
      "x-deprecatedMessage": "Use [Get all identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#get-all-identity-documents) to fetch identity documents."
    },
    "Cursor": {
      "type": "string",
      "description": "Unique identifier of the last and hence oldest customer item returned. This can be used in [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) in a subsequent request to fetch the next batch of older customers. If [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) is specified in the request message, then Cursor will always be included in the response message; this is true even when using Extents set to false so that no actual data is returned.",
      "format": "uuid",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "CustomerResult"
}