Cisco Cisco Prime Collaboration Provisioning 11.5 Developer's Guide

Page 47 of 82

The service detail object contains device name, device capability, Service Area ID, subscriber ID, Domain ID, and

a set of products.

The product object contains the product ID, a sequence number, the assocWith flag, a set of key attributes, and

product attributes. The sequence number defines the order of creation for each product, and it must be unique

among products in the same order. The assocWith flag is used for the ADD order type. If a product that is created

in one order detail needs to be associated with another product created later in the same work order, the

assocWith attribute must be specified so the service being added references back to the service already added. An

example of using assocWith is an order that contains multiple dependent products such as Phone, Line, Email,

Voicemail, and Unified Messaging Service.

Key attributes are required in CHANGE or CANCEL order types. For key attributes, see

Table and Table

Note: The order will inherit the attribute settings of the Service Area specified in the order detail. The attributes

can be specified in the order itself, overriding the Service Area settings for that one step.

Add Order

If you are sending a single order request to order multiple products (for example, Phone-Line, Phone-

LineOnSharedPhone, EM_Access-EM_Line, Line-Voicemail-Email, and so on) that have a dependency, you must

use sequenceNumber and assocWith.

If you are using the assocWith attribute, other attributes, such as SelectedPhone for Line product, targetphone for

LineOnSharedPhone product, SelectedLine for Voicemail product, or SelectedVoicemail for Email product, must

not be specified.

Cancel Order

You must specify only the key attributes of the products to be canceled. Do not specify assocWith. You must

include sequenceNumber.

Change Order

The product’s key attributes must be specified along with the attributes that you want to change.

 To unset a product attribute that has no subattribute, in the change order request, use the product

attribute along with its empty value.

To unset a product attribute with subattributes, if you want to unset the entire provisioning attribute along with all of

its subattributes, specify the parent attribute with an empty value.

If you want to unset one of the subattributes, specify only the subattributes that you want to keep in the change

request.

The following example illustrates how to unset these complex provisioning attributes. This example consists of the

portion of the speeddialinfo attribute with its subattributes in an Add Phone Order request:

<ord:attributeID>speeddialinfo</ord:attributeID>

<ord:subAttribute>

<ord:item>

<ord:attributeID>speeddialinfo_index</ord:attributeID>

<ord:attributeValue>

<v1:item>1</v1:item>