Cisco Cisco Evolved Programmable Network Manager 2.0 Developer's Guide

Page of 637
 
MTOSI Interface Details 
 
 
 
 
 
 
Cisco EPN Manager 2.0 MTOSI API Guide for OSS Integration  
 
 
37 
4.3.2.3.1 Input 
Request Parameter 
Data Type 
Description 
iteratorReferenceURI 
 String 
Iterator reference URI which must be present to retrieve 
next batch of equipment. 
Note: This information is set on the request message on 
the MTOSI header part. 
4.3.2.3.2 Output 
Response Data 
Data Type 
Description 
batchSequenceEndOf
Reply 
boolean 
Indicator of end of batched replies. 
iteratorReferenceURI 
String  
Iterator reference URI which can be used to retrieve the 
next batch. 
getEquipmentIterator
Response 
EquipmentOrEquipme
ntHolderListType 
 
Holder for containing list of equipment details. 
For equipment details, see the equipment data table 
above. 
4.3.2.3.3 Exceptions 
internalError: Indicates that an internal error or exception has occurred as part of this call. 
invalidInput: Indicates that the input given to the operation is invalid.  
4.3.2.4  getContainedEquipment 
This operation retrieves information about a specified contained equipment.  
4.3.2.4.1 Input 
Request Parameter 
Data Type 
Description 
ehRef 
 
NamingAttributeType  Set of RDN types representing the equipment holder in 
which to find the equipment. 
 
4.3.2.4.2 Output 
Response Data 
Data Type 
Description 
getContainedEquipmentR
esponse 
getContainedEquipmentRe
sponse 
Holder that contains list of equipment contained 
in equipment holder specified in the input.  
4.3.2.4.3 Exceptions 
internalError: Indicates that an internal error or exception has occurred as part of this call. 
invalidInput: Indicates that the input given to the operation is invalid.  
4.4  TerminationPointRetrieval  
This interface provides operations that retrieve information for a single or batch of Termination Points (TPs).  
 
4.4.1  Termination Point Data 
The following table lists the Termination Point data that can be retrieved by the interface.
 
Termination Point 
Data 
Data Type 
Description 
tp 
TerminationPointType 
 
Holder for the data returned for a termination point. 
(Details of data provided in the following rows of this 
table).