Webex · Schema

HotelingGuestSettings

Hoteling guest settings for a person.

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.
hostAssociationLimitHours	integer	Time limit in hours configured by the host for guest associations.
hostEnforcedAssociationLimitEnabled	boolean	Indicates whether the host has enforced an association time limit.
hostFirstName	string	First name of the hoteling host.
hostLastName	string	Last name of the hoteling host.
hostId	string	Unique identifier of the hoteling host person or workspace.
hostPhoneNumber	string	Phone number of the hoteling host.
hostExtension	string	Extension of the hoteling host.
hostLocation	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HotelingGuestSettings",
  "title": "HotelingGuestSettings",
  "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."
    },
    "hostAssociationLimitHours": {
      "type": "integer",
      "minimum": 1,
      "maximum": 999,
      "example": 24,
      "description": "Time limit in hours configured by the host for guest associations."
    },
    "hostEnforcedAssociationLimitEnabled": {
      "type": "boolean",
      "example": false,
      "description": "Indicates whether the host has enforced an association time limit."
    },
    "hostFirstName": {
      "type": "string",
      "example": "John",
      "description": "First name of the hoteling host."
    },
    "hostLastName": {
      "type": "string",
      "example": "Smith",
      "description": "Last name of the hoteling host."
    },
    "hostId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hYmNkZWYxMi0zNDU2LTc4OTAtYWJjZC1lZjEyMzQ1Njc4OTA",
      "description": "Unique identifier of the hoteling host person or workspace."
    },
    "hostPhoneNumber": {
      "type": "string",
      "example": "+1234567890",
      "description": "Phone number of the hoteling host."
    },
    "hostExtension": {
      "type": "string",
      "example": "1234",
      "description": "Extension of the hoteling host."
    },
    "hostLocation": {
      "$ref": "#/components/schemas/HotelingHostLocation"
    }
  },
  "example": {
    "enabled": true,
    "associationLimitEnabled": true,
    "associationLimitHours": 12,
    "hostAssociationLimitHours": 24,
    "hostEnforcedAssociationLimitEnabled": false,
    "hostFirstName": "John",
    "hostLastName": "Smith",
    "hostId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hYmNkZWYxMi0zNDU2LTc4OTAtYWJjZC1lZjEyMzQ1Njc4OTA",
    "hostPhoneNumber": "+1234567890",
    "hostExtension": "1234",
    "hostLocation": {
      "id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzU0MDQ5NzQzLTIwM2MtNDM5OS1iN2NjLTU4ZmNkYzIwNjA3Zg",
      "name": "San Jose"
    }
  },
  "description": "Hoteling guest settings for a person."
}