Webex · Schema

MacStatusObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
mac string MAC address.
state string State of the MAC address. * `AVAILABLE` - The requested MAC address is available. * `UNAVAILABLE` - The requested MAC address is unavailable. * `DUPLICATE_IN_LIST` - The requested MAC address is dupli
errorCode number MAC address validation error code.
message string Provides a status message about the MAC address.
View JSON Schema on GitHub

JSON Schema

webex-macstatusobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MacStatusObject",
  "title": "MacStatusObject",
  "type": "object",
  "required": [
    "mac",
    "state"
  ],
  "properties": {
    "mac": {
      "type": "string",
      "example": "00005E0053B4",
      "description": "MAC address."
    },
    "state": {
      "type": "string",
      "enum": [
        "AVAILABLE",
        "UNAVAILABLE",
        "DUPLICATE_IN_LIST",
        "INVALID"
      ],
      "description": "State of the MAC address.\n * `AVAILABLE` - The requested MAC address is available.\n * `UNAVAILABLE` - The requested MAC address is unavailable.\n * `DUPLICATE_IN_LIST` - The requested MAC address is duplicated.\n * `INVALID` - The requested MAC address is invalid.\n"
    },
    "errorCode": {
      "type": "number",
      "example": 5675,
      "description": "MAC address validation error code."
    },
    "message": {
      "type": "string",
      "example": "[Error 5675] MAC Address is in use.",
      "description": "Provides a status message about the MAC address."
    }
  }
}