Cisco Cisco Security Manager 4.11 Guía Del Usuario
Cisco Security Manager 4.11 API Specification (Version 2.3)
Page 32
2.1.6 BaseError
The common class for all request errors is defined by the BaseError class. It has the following attributes:
Attribute
Type
Comment
Code
Unsigned Long
A unique error code that identifies the type of error that occurred
with the request.
with the request.
Description
String
A description of the error that occurred
Table 8: BaseError Class Attributes
Figure 9: BaseError XML Schema
The following general error codes are currently defined:
Code
Description
0
Reserved
1
General Failure
2
Lack of resources
3
Object Creation Failure
4
Authorization Failure: No session found
5
Authorization Failure: Invalid or expired session
6
Internal communication failure
13
XML request payload contains no data.
15
XML request is invalid. (This error is caused if the XML request does not adhere to
the published XML schema or if the XML is illformed or invalid. Though this is a
system wide error, this error is usually set inside a specific response object if the
application is able to parse the request method that is being called)
the published XML schema or if the XML is illformed or invalid. Though this is a
system wide error, this error is usually set inside a specific response object if the
application is able to parse the request method that is being called)
17
protVersion is optional, and if an unsupported version is specified, then this error is
returned. In this release, the supported version is Version 1.0.
returned. In this release, the supported version is Version 1.0.
21
Internal Error
25
API Service is disabled
26
API license is not applied
Table 9: System Error Codes
Additional method specific errors codes are defined in the respective sections. All response objects extend from the
Base Error object. The error content is set in cases the CSM API encounters any error when servicing a method.
Base Error object. The error content is set in cases the CSM API encounters any error when servicing a method.
<
xs:complexType
name
="BaseError">
<xs:sequence>
<
xs:element
name
="code"
type
="xs:unsignedLong"
maxOccurs
="1"></
xs:element
>
<
xs:element
name
="description"
type
="xs:string"
maxOccurs
="1"></
xs:element
>
</xs:sequence>
</xs:complexType>