Cisco Cisco Prime Collaboration 10.5 Developer's Guide

 

 

© 2014 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public. 

51 

Parameters: 

•  order—Creates a work order that is submitted to Prime Collaboration Provisioning if the NBI request is 

accepted. The order is never a prospect work order in Prime Collaboration Provisioning. 

•  validationType—An ENUM indicating whether a work order should be validated before being submitted. 

Values are VALIDATE_ONLY, SUBMIT_ONLY, VALIDATE_AND_SUBMIT. 

•  rollbackType—An ENUM describing how the order should be rolled back if it fails. Value is PARTIAL. 

•  notificationEpr—String to convert to an EndpointReference object that the synchronous result notification 

will be sent to. 

•  idPrefix—String that is added to the beginning of the NBI ID returned to the client. 

•  responseType (optional)— String to identify whether the API call should be synchronous or not. 

Returns: 

CupmApiResponseValue—Object with NBI ID. 

Throws: 

resetServicesException—If the server cannot execute the NBI request. 

SyncReturn: 

       • 

CupmApiResultValue—Contains CupmApiStatus only. 

• 

CupmApiFaultType—Included if the NBI request fails. 

 

 

Check Connectivity Request 

ping Java Signature 

Syntax: 

public ResponseReturn ping (CUPMServiceStub stub, String epr) 

Returns: 

Two strings, the Prime Collaboration Provisioning version and the Prime Collaboration Provisioning NBI version. 

AsyncReturn: 

A test string containing server status is sent to the specified notification consumer at the EPR provided. 

getOrderabilityStatus Request Signature 

Indicates whether Prime Collaboration Provisioning server is ready to accept any incoming request.