Cisco Cisco Prime Collaboration Provisioning 11.2 User Guide

Page of 78
 
 
© 2012-2014 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public. 
Page 49 of 2 
</attributeValue> 
</item> 
<item> 
<attributeID>speeddialinfo_index</attributeID> 
<attributeValue> 
<v1:item>1</v1:item> 
</attributeValue> 
</item> 
</subAttribute> 
</item> 
 
getOrder Java Signature 
Returns an order object that was previously submitted. 
 
Syntax
public ResponseReturn getOrder (CUPMServiceStub stub, String nbiId, String orderId, String 
endPointReference, String ipPre); 
 
Parameters
•  nbiId—The key for specifying the work order object. This can retrieve only orders submitted by an NBI 
SubmitOrder request. 
•  orderId—Used to retrieve an order generated by the GUI or an NBI request. Note that nbiID or OrderID is 
required, but it is an error to include both. 
•  endPointReference—String to convert to an EndpointReference object that the asynchronous result 
notification will be sent to. 
•  ipPre—Precedes the NBI ID to be assigned to this get NBI request. 
 
Returns
CupmApiResponseValue—Object with NBI ID. 
 
Throws
GetOrderException—If server cannot execute NBI request. 
 
ASyncReturn
•  CupmApiResultValue—Contains CupmApiStatus and a CupmAPiList. The CupmApiList contains one 
object, the order selected. If the NBI order request is still retained, it will be returned. If its retention 
time is exceeded and it has been purged, a translation of the XMLEntity version of the work order 
object is returned. 
• 
CupmApiFaultType—Included if the NBI request fails.
 
listOrder Java Signature 
Returns all order details. 
When using this API, remember the following: 
•  This is a CPU intensive operation. It will impact performance. Keep the performance limitations in 
mind when using this API.