Webex · Schema

ServiceUnavailableError

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
code integer HTTP status code for Service Unavailable.
message string A detailed error message explaining the service unavailability.
trackingId string A unique identifier for this error that can be used for debugging purposes.
details object Additional details about the service unavailability.
View JSON Schema on GitHub

JSON Schema

webex-serviceunavailableerror-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ServiceUnavailableError",
  "title": "ServiceUnavailableError",
  "type": "object",
  "required": [
    "code",
    "message"
  ],
  "properties": {
    "code": {
      "type": "integer",
      "enum": [
        503
      ],
      "description": "HTTP status code for Service Unavailable.",
      "example": 503
    },
    "message": {
      "type": "string",
      "description": "A detailed error message explaining the service unavailability.",
      "example": "Service is temporarily unavailable due to maintenance."
    },
    "trackingId": {
      "type": "string",
      "description": "A unique identifier for this error that can be used for debugging purposes.",
      "example": "WXC-12345-67898"
    },
    "details": {
      "type": "object",
      "description": "Additional details about the service unavailability.",
      "properties": {
        "maintenanceWindow": {
          "type": "object",
          "description": "Information about planned maintenance",
          "properties": {
            "startTime": {
              "type": "string",
              "format": "date-time",
              "example": "2024-01-15T02:00:00Z"
            },
            "endTime": {
              "type": "string",
              "format": "date-time",
              "example": "2024-01-15T04:00:00Z"
            }
          }
        },
        "retryAfter": {
          "type": "integer",
          "description": "Number of seconds to wait before retrying",
          "example": 3600
        }
      }
    }
  },
  "example": {
    "code": 503,
    "message": "Service is temporarily unavailable due to maintenance.",
    "trackingId": "WXC-12345-67898",
    "details": {
      "maintenanceWindow": {
        "startTime": "2024-01-15T02:00:00Z",
        "endTime": "2024-01-15T04:00:00Z"
      },
      "retryAfter": 3600
    }
  }
}