Cisco Unity Express -- Common Base Classes REST PI Service Operation

From DocWiki

(Difference between revisions)
Jump to: navigation, search
m (1 revision)
 
Line 5: Line 5:
'''Next page:''' [[Cisco Unity Express -- User and Group Management REST PI Service Operation]]
'''Next page:''' [[Cisco Unity Express -- User and Group Management REST PI Service Operation]]
 +
 +
 +
'''Search the Cisco Unity Express documentation on the DocWiki:'''
 +
<html><div id="cse" style="width:25%;">Loading</div>
 +
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
 +
<script type="text/javascript">
 +
  google.load('search', '1', {language : 'en'});
 +
  google.setOnLoadCallback(function(){
 +
    var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
 +
    customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
 +
    customSearchControl.draw('cse');
 +
  }, true);
 +
</script>
 +
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
 +
</html>

Latest revision as of 01:34, 3 May 2010

Main page: Cisco Unity Express -- REST PI Service Operations

Previous page: Cisco Unity Express -- XML Schema Download REST PI Service Operation

Next page: Cisco Unity Express -- User and Group Management REST PI Service Operation


Search the Cisco Unity Express documentation on the DocWiki:

Loading




Contents

Common Base Classes

This section provides details about various common classes defined by the CUE PI service data model. These classes do not represent any specific resource in the system; therefore, no operations are defined in this section.


Figure 4: Common Base Classes

CUE80 Common Base Classes.jpg


BaseElement

Class Name

BaseElement

Description

This abstract class is the base entity in which all the other classes within the CUE PI service data model extend. It serves as a marker interface to identify a class as part of the CUE PI service data model.

XML Namespace

http://base.model.rest.aesop.cisco.com


ManagedBaseElement

Class Name

ManagedBaseElement

Extends From

BaseElement

Description

This abstract class is the base class representing all uniquely addressable resources in the CUE PI service data model. All elements in the data model having a resource URI extend from this class directly or indirectly.

Field Name Type Constraints Comments

resourceURI

String

Max length - 2000

Resource URI for this resource


BaseElementList

Class Name

BaseElementList

Extends From
Description

This class serves as container for collection of BaseElement objects. Most GET operations returning a collection of objects package the result as an instance of BaseElementList.

Field Name Type Constraints Comments

baseElement

BaseElement (collection)

minOccurs="0" maxOccurs="unbounded"

Collection of BaseElement objects


ErrorResponse

Class Name

ErrorResponse

Extends From

BaseElement

Description

This class is used for reporting error when server fails to process the client request. The information provided through this class is in addition to the HTTP status code provided for the client request.

XML Namespace

http://base.model.rest.aesop.cisco.com

Field Name Type Constraints Comments

errorCode

int

minOccurs="0"

Error code assigned by the CUE PI service. These error codes are defined specific to the CUE PI service and are not to be confused with the HTTP status code provided by the service separately.

errorMessage

String

minOccurs="0"

Message description of the error condition and possible cause.

additionalInfo

String

minOccurs="0"

Used for providing root cause information if available.

Rating: 0.0/5 (0 votes cast)

Personal tools