API Fault Codes

Available Languages

Download Options

PDF (69.2 KB)
View with Adobe Reader on a variety of devices

Updated:January 22, 2010

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Fault Codes

Table Of Contents

Fault Codes

Fault Codes

API errors return major and minor fault codes. The major fault codes are described in the following table:

Fault Code

Description

AUTHENTICATION_FAILED

User authentication failed. Invalid credentials.

COMMAND_FAILURE

The command could not be invoked.

CPAM_CONNECTION_FAILURE

The Cisco PAM connection failed.

DATA_ACCESS_EXCEPTION

An error occurred when accessing data in the database.

GENERIC_FAILURE

A generic function failure.

INCOMPATIBLE_DEV_STATE

The device state is incompatible for the command.

INVALID_BADGE_PROPERTY

Invalid badge property value is specified.

INVALID_DEV_TYPE

Device type specified is invalid.

INVALID_METHOD_PARAM

An method argument contains an invalid parameter.

INVALID_PERSON_PROPERTY

Invalid person property value is specified.

INVALID_SECURITY_CONTEXT

The security context object is invalid. The object may be expired or incorrect.

METHOD_NOT_IMPLEMENTED

The requested method is not yet implemented.

TARGET_DEVICE_NOT_FOUND

The specified target device could not be found.

WSAPI_NO_LICENSE

The WSAPI Feature License is not found.

Fault Code	Description
AUTHENTICATION_FAILED	User authentication failed. Invalid credentials.
COMMAND_FAILURE	The command could not be invoked.
CPAM_CONNECTION_FAILURE	The Cisco PAM connection failed.
DATA_ACCESS_EXCEPTION	An error occurred when accessing data in the database.
GENERIC_FAILURE	A generic function failure.
INCOMPATIBLE_DEV_STATE	The device state is incompatible for the command.
INVALID_BADGE_PROPERTY	Invalid badge property value is specified.
INVALID_DEV_TYPE	Device type specified is invalid.
INVALID_METHOD_PARAM	An method argument contains an invalid parameter.
INVALID_PERSON_PROPERTY	Invalid person property value is specified.
INVALID_SECURITY_CONTEXT	The security context object is invalid. The object may be expired or incorrect.
METHOD_NOT_IMPLEMENTED	The requested method is not yet implemented.
TARGET_DEVICE_NOT_FOUND	The specified target device could not be found.
WSAPI_NO_LICENSE	The WSAPI Feature License is not found.

Was this Document Helpful?

Feedback

Contact Cisco

Open a Support Case
(Requires a Cisco Service Contract)