Exceptions

All library exceptions inherit from AxlToolkitError, making it easy to catch any library error with a single except clause.

Hierarchy

AxlToolkitError
├── AXLAuthenticationError
├── AXLConnectionError
├── AXLError
│   ├── AXLNotFoundError
│   ├── AXLDuplicateError
│   ├── AXLValidationError
│   └── AXLSQLError
│       └── AXLSQLInjectionError
├── SXMLError
│   ├── RISPortError
│   ├── PerfMonError
│   ├── ServiceabilityError
│   └── LogCollectionError
├── PAWSError
└── WebdialerError

Reference

Exception hierarchy for axltoolkit.

All exceptions raised by the library inherit from :class:AxlToolkitError, making it easy to catch any library error with a single except clause::

try:
    result = client.get_phone(name="SEP001122334455")
except AxlToolkitError as e:
    print(f"AXL operation failed: {e}")

AxlToolkitError

Bases: Exception

Base exception for all axltoolkit errors.

AXLAuthenticationError

Bases: AxlToolkitError

Raised when authentication with the UCM server fails (HTTP 401).

AXLConnectionError

Bases: AxlToolkitError

Raised when the connection to the UCM server cannot be established.

AXLError

AXLError(message: str, *, fault_code: str | None = None, fault_message: str | None = None, axl_error_code: int | None = None, original_exception: Exception | None = None)

Bases: AxlToolkitError

Raised when an AXL SOAP operation returns a fault.

Attributes:

Name	Type	Description
fault_code		The AXL fault code string (e.g. "Item not valid").
fault_message		The human-readable fault detail message.
axl_error_code		Numeric AXL error code, if available.
original_exception		The underlying zeep.exceptions.Fault or other exception that triggered this error.

fault_code instance-attribute

fault_code = fault_code

fault_message instance-attribute

fault_message = fault_message

axl_error_code instance-attribute

axl_error_code = axl_error_code

original_exception instance-attribute

original_exception = original_exception

AXLNotFoundError

AXLNotFoundError(message: str, *, fault_code: str | None = None, fault_message: str | None = None, axl_error_code: int | None = None, original_exception: Exception | None = None)

Bases: AXLError

Raised when a requested object is not found in UCM (error 5007).

AXLDuplicateError

AXLDuplicateError(message: str, *, fault_code: str | None = None, fault_message: str | None = None, axl_error_code: int | None = None, original_exception: Exception | None = None)

Bases: AXLError

Raised when attempting to add an object that already exists.

AXLValidationError

AXLValidationError(message: str, *, fault_code: str | None = None, fault_message: str | None = None, axl_error_code: int | None = None, original_exception: Exception | None = None)

Bases: AXLError

Raised when an AXL request contains invalid data.

AXLSQLError

AXLSQLError(message: str, *, fault_code: str | None = None, fault_message: str | None = None, axl_error_code: int | None = None, original_exception: Exception | None = None)

Bases: AXLError

Raised when a Thin AXL SQL query or update fails.

AXLSQLInjectionError

AXLSQLInjectionError(message: str, *, fault_code: str | None = None, fault_message: str | None = None, axl_error_code: int | None = None, original_exception: Exception | None = None)

Bases: AXLSQLError

Raised when a potential SQL injection attempt is detected in input.

SXMLError

SXMLError(message: str, *, original_exception: Exception | None = None)

Bases: AxlToolkitError

Base exception for SXML (Serviceability XML) API errors.

original_exception instance-attribute

original_exception = original_exception

RISPortError

RISPortError(message: str, *, original_exception: Exception | None = None)

Bases: SXMLError

Raised when a RISPort70 API operation fails.

PerfMonError

PerfMonError(message: str, *, original_exception: Exception | None = None)

Bases: SXMLError

Raised when a PerfMon API operation fails.

ServiceabilityError

ServiceabilityError(message: str, *, original_exception: Exception | None = None)

Bases: SXMLError

Raised when a ControlCenter / Serviceability API operation fails.

LogCollectionError

LogCollectionError(message: str, *, original_exception: Exception | None = None)

Bases: SXMLError

Raised when a Log Collection API operation fails.

PAWSError

PAWSError(message: str, *, original_exception: Exception | None = None)

Bases: AxlToolkitError

Raised when a Platform Administrative Web Service (PAWS) operation fails.

original_exception instance-attribute

original_exception = original_exception

WebdialerError

WebdialerError(message: str, *, original_exception: Exception | None = None)

Bases: AxlToolkitError

Raised when a Webdialer API operation fails.

original_exception instance-attribute

original_exception = original_exception