Cisco Cisco Prime Collaboration 10.6 Guida Dello Sviluppatore

Page 46 of 82

submitOrder Java Signature

Submits a work order to Prime Collaboration Provisioning. If the work order is accepted by Prime Collaboration

Provisioning, and if it passes validation (if validation is specified), it will be submitted to Prime Collaboration

Provisioning for execution.

Syntax:

public ResponseReturn submitOrder (CUPMServiceStub stub, OrderValue order, ValidationType validationType,

RollbackType rollbackType, String endPointReference, String idPrefix);

Note: To execute this API in synchronous mode, you must set the responseType

attribute to “sync”.

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.



endPointReference

—String to convert to an EndpointReference object that the asynchronous result

notification will be sent to.



idPrefix

—String added to the beginning of the numeric value generated by the server that becomes the

NBI ID. Note that in this case, the NBI ID is also used as the Order ID.



removeDependentServices(optional)

—String to specify whether the associated lines and voicemails of an

endpoint have to be removed.



responseType (optional)

— String to identify whether the API call should be synchronous or not.

Note : While performing a cancel operation on endpoints, we have an option to remove its dependent services (line

and voicemail) along with the endpoint by specifying

the value ‘true’ for the parameter

‘removeDependentServices’.

Returns:

CupmApiResponseValue

—Object with NBI ID.

Throws:

SubmitOrderException

—If the server cannot execute the NBI request.

ASyncReturn:



CupmApiResultValue

—Contains CupmApiStatus only.



CupmApiFaultType

—Included if the NBI request fails.

Contents of Order Object

The order object contains the order type (ADD, CHANGE, or CANCEL), and a set of service details. These values

are defined in an enumeration and they specify creating, modifying, or deleting a set of services.