Webex · Schema

HotelingGuestSettingsUpdate

Hoteling guest settings update request.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
enabled boolean Enable/Disable hoteling guest functionality for the person. When enabled, the person can associate themselves with a hoteling host device.
associationLimitEnabled boolean When enabled, the person's hoteling guest association will be automatically removed after the specified time period.
associationLimitHours integer Time limit in hours for the hoteling guest association (1-999). Applicable when associationLimitEnabled is true.
hostId string Unique identifier of the hoteling host person or workspace to associate with. Required when enabling hoteling guest functionality.
View JSON Schema on GitHub

JSON Schema

webex-hotelingguestsettingsupdate-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HotelingGuestSettingsUpdate",
  "title": "HotelingGuestSettingsUpdate",
  "type": "object",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/Disable hoteling guest functionality for the person. When enabled, the person can associate themselves with a hoteling host device."
    },
    "associationLimitEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When enabled, the person's hoteling guest association will be automatically removed after the specified time period."
    },
    "associationLimitHours": {
      "type": "integer",
      "minimum": 1,
      "maximum": 999,
      "example": 12,
      "description": "Time limit in hours for the hoteling guest association (1-999). Applicable when associationLimitEnabled is true."
    },
    "hostId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hYmNkZWYxMi0zNDU2LTc4OTAtYWJjZC1lZjEyMzQ1Njc4OTA",
      "description": "Unique identifier of the hoteling host person or workspace to associate with. Required when enabling hoteling guest functionality."
    }
  },
  "example": {
    "enabled": true,
    "associationLimitEnabled": true,
    "associationLimitHours": 12,
    "hostId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hYmNkZWYxMi0zNDU2LTc4OTAtYWJjZC1lZjEyMzQ1Njc4OTA"
  },
  "description": "Hoteling guest settings update request."
}