Cisco Cisco Security Manager 4.11 Guía Del Usuario

 

 

 

  

All methods in this API take an XML object as an argument for the method request and response. The XML object 
passed as part of the request (and echoed in the response) are derived from the following class which includes the 
following attributes. 

 

Attribute 

Type 

Comment 

protVersion 

double 

identifies the version of the protocol associated with the particular 
request/response being sent 

reqId 

String 

identifies a unique token sent by the client in the request that the 
server will echo in the associated response 

startIndex 

Unsigned Long 

An optional start index that is specified by the “client” requests that 
are “paginated”. This is applicable for policies like firewall rules 
that might return a large number of rows of data. The client must set 
the startIndex equal to the end index of the previous response to 
fetch the next page of data. 

endIndex 

Unsigned Long 

An optional end index that is specified by the “server” when it has 
not returned “all the data”. 

totalCount 

Unsigned Long 

An optional total count  from the “server” that indicates the total 
number of rows in this policy. 

Error 

BaseError 

identifies any errors that may occur upon a request submitted to the 
server 

 

 

 

Some of the service calls (say fetching a list of access rules) might return a large set of data. To prevent such large 
fetches from causing performance issues on the server and client, these results will be ‘paginated’. Pagination is 

 

<

xs:complexType

 name

="BaseReqResp"

 

> 

 

 

<xs:sequence> 

 

 

 

<

xs:element

 name

="protVersion"

 type

="xs:double"

 minOccurs

="0"

 maxOccurs

="1"/> 

 

 

 

<

xs:element

 name

="reqId"

 type

="xs:string"

 minOccurs

="0"

 maxOccurs

="1"/> 

 

 

 

<

xs:element

 

name

="startIndex" 

type

="xs:unsignedLong" 

minOccurs

="0" maxOccurs="1"/> 

 

 

 

<

xs:element

 

name

="endIndex" 

type

="xs:unsignedLong" 

minOccurs

="0" maxOccurs="1"/> 

 

 

 

<

xs:element

 

name

="totalCount" 

type

="xs:unsignedLong" 

minOccurs

="0" maxOccurs="1"/> 

 

 

 

<

xs:element

 name

="error"

 type

="BaseError"

 minOccurs

="0"

 maxOccurs

="1"/> 

 

 

</xs:sequence> 

 

</xs:complexType>