The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This appendix contains sample XML API requests and responses. It includes the following sections:
•Sample ProvisionCustomer Data Service XML API Requests and Responses
•Sample ProvisionInfrastructure Data Service XML API Requests and Responses
•Sample ProvisionSite Data Service XML API Requests and Responses
•Sample ProvisionSubscriber Data Service XML API Requests and Responses
•Sample ProvisionResults Data Service XML API Requests and Responses
•Sample ProductCatalog Data Service XML API Requests and Responses
This section includes the following sample ProvisionCustomer data service XML API requests and responses:
•Sample createCustomer XML Request
•Sample createCustomer XML Response
•Sample updateCustomer XML Request
•Sample updateCustomer XML Response
•Sample syncCustomer XML Request
•Sample syncCustomer XML Response
•Sample deleteCustomer XML Request
•Sample deleteCustomer XML Response
•Sample listCustomer XML Request
•Sample listCustomer XML Response
The following is a sample XML code for the createCustomer XML request.
<hcs:CreateCustomerRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<Customer>
<partyRoleId>
ABC</partyRoleId>
<RootEntityDescribedBy>
<value>
ABC Bank</value>
<action>Create</action>
<CharacteristicSpecification>
<name>DomainDescription</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>CACCM-210.117</value>
<action>Create</action>
<CharacteristicSpecification>
<name>CallProcessor</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>CACCMBE-4.238</value>
<action>Create</action>
<CharacteristicSpecification>
<name>UnifiedMessageProcessor</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
</Customer>
</hcs:CreateCustomerRequest>
The following is a sample XML code for the createCustomer XML response.
<?xml version="1.0" encoding="UTF-8"?>
<domain:createDomainRequest xmlns:domain="http://cupm.cucms.cisco.com/v1.0/Domain">
<domain:domain>
<domain:domainID>
ABC</domain:domainID>
<domain:domainProperties>
<domain:item>
<domain:domainPropertyName>DomainDescription</domain:domainPropertyName>
<domain:domainPropertyValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">
ABC Bank</co-v1-3:item>
</domain:domainPropertyValue>
<domain:domainPropertyAction>ADD</domain:domainPropertyAction>
</domain:item>
<domain:item>
<domain:domainPropertyName>CallProcessor</domain:domainPropertyName>
<domain:domainPropertyValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">CACCM-210.117</co-v1-3:item>
</domain:domainPropertyValue>
<domain:domainPropertyAction>ADD</domain:domainPropertyAction>
</domain:item>
<domain:item>
<domain:domainPropertyName>UnifiedMessageProcessor</domain:domainPropertyName>
<domain:domainPropertyValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">CACCMBE-4.238</co-v1-3:item>
</domain:domainPropertyValue>
<domain:domainPropertyAction>ADD</domain:domainPropertyAction>
</domain:item>
</domain:domainProperties>
</domain:domain>
<domain:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</domain:epr>
<domain:idPrefix>
ABC_</domain:idPrefix>
</domain:createDomainRequest>
The following is a sample XML code for the updateCustomer XML request.
<hcs:UpdateCustomerRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<Customer>
<partyRoleId>
ABC</partyRoleId>
<RootEntityDescribedBy>
<value>CACCM-4.198</value>
<action>Create</action>
<CharacteristicSpecification>
<name>CallProcessor</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>CAUTY-4.200</value>
<action>Create</action>
<CharacteristicSpecification>
<name>UnifiedMessageProcessor</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
</Customer>
</hcs:UpdateCustomerRequest>
The following is a sample XML code for the updateCustomer XML response.
<?xml version="1.0" encoding="UTF-8"?>
<domain:updateDomainRequest xmlns:domain="http://cupm.cucms.cisco.com/v1.0/Domain">
<domain:domain>
<domain:domainID>
ABC</domain:domainID>
<domain:domainProperties>
<domain:item>
<domain:domainPropertyName>CallProcessor</domain:domainPropertyName>
<domain:domainPropertyValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">CACCM-4.198</co-v1-3:item>
</domain:domainPropertyValue>
<domain:domainPropertyAction>ADD</domain:domainPropertyAction>
</domain:item>
<domain:item>
<domain:domainPropertyName>UnifiedMessageProcessor</domain:domainPropertyName>
<domain:domainPropertyValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">CAUTY-4.200</co-v1-3:item>
</domain:domainPropertyValue>
<domain:domainPropertyAction>ADD</domain:domainPropertyAction>
</domain:item>
</domain:domainProperties>
</domain:domain>
<domain:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</domain:epr>
<domain:idPrefix>
ABC_</domain:idPrefix>
</domain:updateDomainRequest>
The following is a sample XML code of the syncCustomer XML request.
<hcs:SyncCustomerRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<Customer>
<partyRoleId>
ABC</partyRoleId>
</Customer>
</hcs:SyncCustomerRequest>
The following is a sample XML code of the syncCustomer XML response.
Expected Result
<?xml version="1.0" encoding="UTF-8"?>
<prov:SyncCustomerResponse xmlns:prov="http://www.cisco.hcs.com/HCSProvision.xsd">
<CorrelationId>
ABC_95</CorrelationId>
</prov:SyncCustomerResponse>
Expected Value
<?xml version="1.0" encoding="UTF-8"?>
<domain:syncDomainRequest xmlns:domain="http://cupm.cucms.cisco.com/v1.0/Domain">
<domain:domain>
<domain:domainID>
ABC</domain:domainID>
</domain:domain>
<domain:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</domain:epr>
<domain:idPrefix>
ABC_</domain:idPrefix>
</domain:syncDomainRequest>
The following is a sample XML code of the deleteCustomer XML request.
<hcs:DeleteCustomerRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<Customer>
<partyRoleId>
ABC</partyRoleId>
</Customer>
</hcs:DeleteCustomerRequest>
The following is a sample XML code of the deleteCustomer XML response.
Expected Result
<?xml version="1.0" encoding="UTF-8"?>
<prov:DeleteCustomerResponse xmlns:prov="http://www.cisco.hcs.com/HCSProvision.xsd">
<CorrelationId>
ABC_70</CorrelationId>
</prov:DeleteCustomerResponse>
Expected Value
<?xml version="1.0" encoding="UTF-8"?>
<domain:deleteDomainRequest xmlns:domain="http://cupm.cucms.cisco.com/v1.0/Domain">
<domain:domain>
<domain:domainID>ABC</domain:domainID>
</domain:domain>
<domain:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</domain:epr>
<domain:idPrefix>ABC_</domain:idPrefix>
</domain:deleteDomainRequest>
The following is a sample XML code of the listCustomer XML request.
<hcs:ListCustomerRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd">
<!-- ***************** -->
<!-- List Customer: -->
<!-- CustomerID -->
<!-- ***************** -->
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<Customer>
<partyRoleId>
ABC</partyRoleId>
</Customer>
</hcs:ListCustomerRequest>
The following is a sample XML code of the listCustomer XML response.
<?xml version="1.0" encoding="UTF-8"?>
<domain:listDomainRequest xmlns:domain="http://cupm.cucms.cisco.com/v1.0/Domain">
<domain:filter>
<cmn:returnDataCriteria xmlns:cmn="http://cupm.cucms.cisco.com/v1.0/Common">
<cmn:returnDataType>ALL</cmn:returnDataType>
</cmn:returnDataCriteria>
</domain:filter>
<domain:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</domain:epr>
<domain:idPrefix>
ABC_</domain:idPrefix>
</domain:listDomainRequest>
This section includes the following sample ProvisionInfrastructure data service XML API requests and responses:
•Sample createDevice XML Request
•Sample createDevice XML Response
•Sample updateDevice XML Request
•Sample updateDevice XML Response
•Sample syncDevice XML Request
•Sample syncDevice XML Response
•Sample deleteDevice XML Request
•Sample deleteDevice XML Response
•Sample submitTemplate XML Request
•Sample submitTemplate XML Response
•Sample submitInfrastructureOrder XML Request
•Sample submitInfrastructureOrder XML Response
•Sample submitSubscriberOrder XML Request
•Sample submitSubscriberOrder XML Response
•Sample listDevice XML Request
•Sample listDevice XML Response
•Sample listInfrastructureProduct Request
•Sample listInfrastructureProduct Response
The following is a sample XML code for the createDevice XML request.
<?xml version="1.0" encoding="UTF-8"?>
<hcs:CreateDeviceRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<PhysicalDevice>
<commonName>
ABC-dxDevice-01</commonName>
<ResourceSpecification xsi:type="hcs:PhysicalDeviceSpecification">
<commonName>MediaServer</commonName>
</ResourceSpecification>
<PartyRole xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyRole>
<RootEntityDescribedBy>
<value>
ABC</value>
<CharacteristicSpecification>
<name>DeviceUsername</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>Secret</value>
<CharacteristicSpecification>
<name>DevicePassword</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>True</value>
<CharacteristicSpecification>
<name>EnablePassword</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<!-- IP Address -->
<LogicalPhysicalResource>
<typeOfLPDependency>IpAddress</typeOfLPDependency>
<LogicalResource xsi:type="hcs:IPAddress">
<hostNumber>172.16.108.255</hostNumber>
</LogicalResource>
</LogicalPhysicalResource>
<!-- Protocol -->
<LogicalPhysicalResource>
<typeOfLPDependency>Protocol</typeOfLPDependency>
<LogicalResource xsi:type="hcs:Protocol">
<commonName>None</commonName>
</LogicalResource>
</LogicalPhysicalResource>
<!-- Capability 1 -->
<LogicalPhysicalResource>
<typeOfLPDependency>Capability</typeOfLPDependency>
<LogicalResource>
<commonName>CiscoUnifiedCM</commonName>
<SupportsProtocol>
<commonName>HTTPS</commonName>
</SupportsProtocol>
<RootEntityDescribedBy>
<value>cmadmin</value>
<CharacteristicSpecification>
<name>CapabilityUsername</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>CMadmin10</value>
<CharacteristicSpecification>
<name>CapabilityPassword</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>Synchronization</value>
<CharacteristicSpecification>
<name>LDAPDirectoryIntegration</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>8.0(3)</value>
<CharacteristicSpecification>
<name>Version</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
</LogicalResource>
</LogicalPhysicalResource>
</PhysicalDevice>
</hcs:CreateDeviceRequest>
The following is a sample XML code for the createDevice XML response.
<?xml version="1.0" encoding="UTF-8"?>
<device:createDeviceRequest xmlns:device="http://cupm.cucms.cisco.com/v1.0/Device">
<device:device>
<device:deviceName>
ABC-dxDevice-01</device:deviceName>
<device:type>MediaServer</device:type>
<device:ipAddress>172.16.108.255</device:ipAddress>
<device:capability>
<device:item>
<device:capabilityName>CiscoUnifiedCM</device:capabilityName>
<device:capabilityProperty>
<device:item>
<device:capabilityPropertyName>CapabilityUsername</device:capabilityPropertyName>
<device:capabilityPropertyValue>cmadmin</device:capabilityPropertyValue>
</device:item>
<device:item>
<device:capabilityPropertyName>CapabilityPassword</device:capabilityPropertyName>
<device:capabilityPropertyValue>CMadmin10</device:capabilityPropertyValue>
</device:item>
<device:item>
<device:capabilityPropertyName>LDAPDirectoryIntegration</device:capabilityPropertyName>
<device:capabilityPropertyValue>Synchronization</device:capabilityPropertyValue>
</device:item>
<device:item>
<device:capabilityPropertyName>Version</device:capabilityPropertyName>
<device:capabilityPropertyValue>8.0(3)</device:capabilityPropertyValue>
</device:item>
</device:capabilityProperty>
<device:capabilityProtocol>HTTPS</device:capabilityProtocol>
</device:item>
</device:capability>
<device:deviceProperties>
<device:item>
<device:devicePropertyName>DeviceUsername</device:devicePropertyName>
<device:devicePropertyValue>
ABC</device:devicePropertyValue>
</device:item>
<device:item>
<device:devicePropertyName>DevicePassword</device:devicePropertyName>
<device:devicePropertyValue>Secret</device:devicePropertyValue>
</device:item>
<device:item>
<device:devicePropertyName>EnablePassword</device:devicePropertyName>
<device:devicePropertyValue>True</device:devicePropertyValue>
</device:item>
</device:deviceProperties>
<device:deviceProtocol>None</device:deviceProtocol>
</device:device>
<device:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</device:epr>
<device:idPrefix>
ABC_</device:idPrefix>
</device:createDeviceRequest>
The following is a sample XML code for the updateDevice XML request.
<?xml version="1.0" encoding="UTF-8"?>
<hcs:UpdateDeviceRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<PhysicalDevice>
<commonName>
ABC-dxDevice-01</commonName>
<ResourceSpecification xsi:type="hcs:PhysicalDeviceSpecification">
<commonName>MediaServer</commonName>
</ResourceSpecification>
<PartyRole xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyRole>
<RootEntityDescribedBy>
<value>
ABC</value>
<CharacteristicSpecification>
<name>DeviceUsername</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>Secret</value>
<CharacteristicSpecification>
<name>DevicePassword</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<!-- IP Address -->
<LogicalPhysicalResource>
<typeOfLPDependency>IpAddress</typeOfLPDependency>
<LogicalResource xsi:type="hcs:IPAddress">
<hostNumber>172.16.109.255</hostNumber>
</LogicalResource>
</LogicalPhysicalResource>
</PhysicalDevice>
</hcs:UpdateDeviceRequest>
The following is a sample XML code for the updateDevice XML response.
<?xml version="1.0" encoding="UTF-8"?>
<device:updateDeviceRequest xmlns:device="http://cupm.cucms.cisco.com/v1.0/Device">
<device:device>
<device:deviceName>
ABC-dxDevice-01</device:deviceName>
<device:type>MediaServer</device:type>
<device:ipAddress>172.16.109.255</device:ipAddress>
<device:deviceProperties>
<device:item>
<device:devicePropertyName>DeviceUsername</device:devicePropertyName>
<device:devicePropertyValue>
ABC</device:devicePropertyValue>
</device:item>
<device:item>
<device:devicePropertyName>DevicePassword</device:devicePropertyName>
<device:devicePropertyValue>Secret</device:devicePropertyValue>
</device:item>
</device:deviceProperties>
</device:device>
<device:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</device:epr>
<device:idPrefix>
ABC_</device:idPrefix>
</device:updateDeviceRequest>
The following is a sample XML code for the syncDevice XML request.
<hcs:SyncDeviceRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<SyncOption>PerformSync</SyncOption>
<SyncScope>Infrastructure</SyncScope>
<PhysicalDevice>
<commonName>HCS_Device_01</commonName>
<PartyRole xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyRole>
</PhysicalDevice>
</hcs:SyncDeviceRequest>
The following is a sample XML code for the syncDevice XML response.
<?xml version="1.0" encoding="UTF-8"?>
<device:syncDeviceRequest xmlns:device="http://cupm.cucms.cisco.com/v1.0/Device">
<device:device>
<device:deviceName>HCS_Device_01</device:deviceName>
</device:device>
<device:syncType>Infrastructure</device:syncType>
<device:executeOption>SYNC</device:executeOption>
<device:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</device:epr>
<device:idPrefix>
ABC_</device:idPrefix>
</device:syncDeviceRequest>
The following is a sample XML code for the deleteDevice XML request.
<hcs:DeleteDeviceRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<!-- ************* -->
<!-- Delete Device -->
<!-- ************* -->
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<PhysicalDevice>
<commonName>
ABC-dxDevice-02</commonName>
<PartyRole xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyRole>
</PhysicalDevice>
</hcs:DeleteDeviceRequest>
The following is a sample XML code for the deleteDevice XML response.
<?xml version="1.0" encoding="UTF-8"?>
<device:deleteDeviceRequest xmlns:device="http://cupm.cucms.cisco.com/v1.0/Device">
<device:device>
<device:deviceName>
ABC-dxDevice-02</device:deviceName>
</device:device>
<device:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</device:epr>
<device:idPrefix>
ABC_</device:idPrefix>
</device:deleteDeviceRequest>
The following is a sample XML code for the submitTemplate XML request.
<?xml version="1.0" encoding="UTF-8"?>
<hcs:SubmitTemplateRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<!--Optional:-->
<TemplateName>UC_Template_01</TemplateName>
<SubmitOption>ValidateAndSubmit</SubmitOption>
<PhysicalDevice>
<commonName>CCM35</commonName>
<PartyRole xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyRole>
<!--Zero or more repetitions:-->
<LogicalPhysicalResource>
<typeOfLPDependency>Capability</typeOfLPDependency>
<LogicalResource>
<commonName>CiscoUnifiedCM</commonName>
</LogicalResource>
</LogicalPhysicalResource>
<LogicalPhysicalResource>
<typeOfLPDependency>Capability</typeOfLPDependency>
<LogicalResource>
<commonName>CiscoUnifiedCME</commonName>
</LogicalResource>
</LogicalPhysicalResource>
</PhysicalDevice>
<!--Zero or more repetitions:-->
<KeywordCharacteristicValue>
<value>xFF003984</value>
<action>Add</action>
<CharacteristicSpecification>
<name>Big Router</name>
</CharacteristicSpecification>
</KeywordCharacteristicValue>
<KeywordCharacteristicValue>
<value>22222</value>
<action>Add</action>
<CharacteristicSpecification>
<name>Keyword2</name>
</CharacteristicSpecification>
</KeywordCharacteristicValue>
</hcs:SubmitTemplateRequest>
The following is a sample XML code for the submitTemplate XML response.
<?xml version="1.0" encoding="UTF-8"?>
<order:submitConfigTemplateRequest xmlns:order="http://cupm.cucms.cisco.com/v1.0/Order">
<order:configDetail>
<order:templateName>UC_Template_01</order:templateName>
<order:deviceName>CCM35</order:deviceName>
<order:capabilityName>CiscoUnifiedCM</order:capabilityName>
<order:capabilityName>CiscoUnifiedCME</order:capabilityName>
<order:keywordList>
<order:item>
<order:keyword>Big Router</order:keyword>
<order:value>xFF003984</order:value>
</order:item>
<order:item>
<order:keyword>Keyword2</order:keyword>
<order:value>22222</order:value>
</order:item>
</order:keywordList>
</order:configDetail>
<order:validate>VALIDATE_AND_SUBMIT</order:validate>
<order:rollback>PARTIAL_ROLLBACK</order:rollback>
<order:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</order:epr>
<order:idPrefix>
ABC_</order:idPrefix>
</order:submitConfigTemplateRequest>
The following is a sample XML code for the submitInfrastructureOrder XML request.
<hcs:SubmitInfrastructureOrderRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<!-- ******************************************* -->
<!-- Simple Infrastructure Order with One Device -->
<!-- ******************************************* -->
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<SubmitOption>ValidateAndSubmit</SubmitOption>
<ProductOrder>
<!-- Customer -->
<BusinessInteractionInvolves xsi:type="hcs:PartyInteractionRole">
<interactionRole>Customer</interactionRole>
<PartyInteractionRoleIdentifiedBy xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyInteractionRoleIdentifiedBy>
</BusinessInteractionInvolves>
<!--Transaction-->
<BusinessInteractionType>
<name>Add</name>
</BusinessInteractionType>
<!-- Customer Order Item -->
<CustomerOrderComprisedOf>
<orderItemNumber>1</orderItemNumber>
<!-- Product -->
<BusinessInteractionItemInvolvesProduct>
<ProductSpecification>
<productId>IC_CommonDeviceConfig</productId>
</ProductSpecification>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>IC_name</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>ART_CommonDeviceConfig</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>IC_mlppDomainId</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>0</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>IC_mlppIndicationStatus</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>On</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>IC_networkHoldMOHAudioSourceId</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>SampleAudioSource</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>IC_preemption</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>Default</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>IC_softkeyTemplateName</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>Standard Feature</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>IC_userHoldMOHAudioSourceId</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>SampleAudioSource</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>IC_userLocale</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>English United States</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>IC_preemption</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>Default</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value
<ProductCharacteristicValue>
<ProductCharacteristicValueRelationship>
<ProductCharacteristicValue>
<value>PCSub3</value>
<value>PCSub4</value>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>PCSubId34</ID>
</ProdSpecCharDescribesProdCharacteristicValue>
</ProductCharacteristicValue>
</ProductCharacteristicValueRelationship>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>PCParentId</ID>
</ProdSpecCharDescribesProdCharacteristicValue>
</ProductCharacteristicValue>
-->
</BusinessInteractionItemInvolvesProduct>
<!-- Device and Capability -->
<BusinessInteractionItemInvolvesResource xsi:type="hcs:PhysicalDevice">
<commonName>
ABC-dxDevice-01</commonName>
<LogicalPhysicalResource>
<typeOfLPDependency>Capability</typeOfLPDependency>
<LogicalResource>
<commonName>CiscoUnifiedCM</commonName>
</LogicalResource>
</LogicalPhysicalResource>
</BusinessInteractionItemInvolvesResource>
</CustomerOrderComprisedOf>
</ProductOrder>
</hcs:SubmitInfrastructureOrderRequest>
The following is a sample XML code for the submitInfrastructureOrder XML response.
<?xml version="1.0" encoding="UTF-8"?>
<order:submitOrderRequest xmlns:order="http://cupm.cucms.cisco.com/v1.0/Order">
<order:order>
<order:serviceDetail>
<order:item>
<order:product>
<order:item>
<order:productID>IC_CommonDeviceConfig</order:productID>
<order:productAttribute>
<order:item>
<order:attributeID>IC_name</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">ART_CommonDeviceConfig</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>IC_mlppDomainId</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">0</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>IC_mlppIndicationStatus</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">On</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>IC_networkHoldMOHAudioSourceId</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">SampleAudioSource</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>IC_preemption</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Default</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>IC_softkeyTemplateName</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Standard Feature</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>IC_userHoldMOHAudioSourceId</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">SampleAudioSource</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>IC_userLocale</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">English United States</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>IC_preemption</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Default</co-v1-3:item>
</order:attributeValue>
</order:item>
</order:productAttribute>
<order:sequenceNumber>1</order:sequenceNumber>
</order:item>
</order:product>
<order:deviceName>
ABC-dxDevice-01</order:deviceName>
<order:capabilityName>CiscoUnifiedCM</order:capabilityName>
</order:item>
</order:serviceDetail>
<order:orderType>Add</order:orderType>
</order:order>
<order:validate>VALIDATE_AND_SUBMIT</order:validate>
<order:rollback>PARTIAL_ROLLBACK</order:rollback>
<order:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</order:epr>
<order:idPrefix>
ABC_</order:idPrefix>
</order:submitOrderRequest>
The following is a sample XML code for the submitSubscriberOrder XML request.
<hcs:SubmitSubscriberOrderRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<!-- Simple Order with One Subscriber and Two Products -->
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<SubmitOption>ValidateAndSubmit</SubmitOption>
<ProductOrder>
<!-- Customer -->
<BusinessInteractionInvolves xsi:type="hcs:PartyInteractionRole">
<interactionRole>Customer</interactionRole>
<PartyInteractionRoleIdentifiedBy xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyInteractionRoleIdentifiedBy>
</BusinessInteractionInvolves>
<!--Transaction-->
<BusinessInteractionType>
<name>Add</name>
</BusinessInteractionType>
<!-- Customer Order Item -->
<CustomerOrderComprisedOf>
<orderItemNumber>1</orderItemNumber>
<!-- Subscriber -->
<BusinessInteractionItemInvolves xsi:type="hcs:PartyInteractionRole">
<interactionRole>Subscriber</interactionRole>
<PartyInteractionRoleIdentifiedBy xsi:type="hcs:Subscriber">
<partyRoleId>
ABC-Subscriber-01</partyRoleId>
</PartyInteractionRoleIdentifiedBy>
</BusinessInteractionItemInvolves>
<!-- Product -->
<BusinessInteractionItemInvolvesProduct>
<ProductSpecification>
<productId>Phone</productId>
</ProductSpecification>
<!-- Geographic Site -->
<ProductLocatedVia xsi:type="hcs:GeographicSite">
<ID>
ABC</ID>
</ProductLocatedVia>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>macaddress</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>DDDD0505EEEE</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>usedummymacaddress</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>False</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>devicepool</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>
ABC</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>type</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>Cisco 7970</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>protocol</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>SCCP</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>pbt</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>Standard 7970 SCCP</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>devicelocation</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>
ABC</value>
</ProductCharacteristicValue>
</BusinessInteractionItemInvolvesProduct>
</CustomerOrderComprisedOf>
</ProductOrder>
</hcs:SubmitSubscriberOrderRequest>
The following is a sample XML code for the submitSubscriberOrder XML response.
<?xml version="1.0" encoding="UTF-8"?>
<order:submitOrderRequest xmlns:order="http://cupm.cucms.cisco.com/v1.0/Order">
<order:order>
<order:serviceDetail>
<order:item>
<order:product>
<order:item>
<order:productID>Phone</order:productID>
<order:productAttribute>
<order:item>
<order:attributeID>macaddress</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">DDDD0505EEEE</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>usedummymacaddress</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">False</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>devicepool</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">
ABC</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>type</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Cisco 7970</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>protocol</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">SCCP</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>pbt</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Standard 7970 SCCP</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>devicelocation</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">
ABC</co-v1-3:item>
</order:attributeValue>
</order:item>
</order:productAttribute>
<order:sequenceNumber>1</order:sequenceNumber>
</order:item>
</order:product>
<order:serviceAreaID>
ABC</order:serviceAreaID>
<order:subscriberID>
ABC-Subscriber-01</order:subscriberID>
<order:domainID>
ABC</order:domainID>
</order:item>
</order:serviceDetail>
<order:orderType>Add</order:orderType>
</order:order>
<order:validate>VALIDATE_AND_SUBMIT</order:validate>
<order:rollback>PARTIAL_ROLLBACK</order:rollback>
<order:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</order:epr>
<order:idPrefix>
ABC_</order:idPrefix>
</order:submitOrderRequest>
The following is a sample XML code for the listDevice XML request.
<hcs:ListDeviceRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<!-- ***************** -->
<!-- List Device: -->
<!-- deviceName -->
<!-- ***************** -->
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<PhysicalDevice>
<PartyRole xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyRole>
<RootEntityDescribedBy>
<value>
ABC-dxDevice-01</value>
<CharacteristicSpecification>
<name>deviceName</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
</PhysicalDevice>
</hcs:ListDeviceRequest>
The following is a sample XML code for the listDevice XML response.
<?xml version="1.0" encoding="UTF-8"?>
<device:listDeviceRequest xmlns:device="http://cupm.cucms.cisco.com/v1.0/Device">
<device:filter>
<cmn:objectSelectionCriteria xmlns:cmn="http://cupm.cucms.cisco.com/v1.0/Common">
<cmn:selectionCriteria>
<cmn:item>
<cmn:attributeName>deviceName</cmn:attributeName>
<cmn:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">
ABC-dxDevice-01</co-v1-3:item>
</cmn:attributeValue>
</cmn:item>
</cmn:selectionCriteria>
</cmn:objectSelectionCriteria>
<cmn:returnDataCriteria xmlns:cmn="http://cupm.cucms.cisco.com/v1.0/Common">
<cmn:returnDataType>ALL</cmn:returnDataType>
</cmn:returnDataCriteria>
</device:filter>
<device:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</device:epr>
<device:idPrefix>
ABC_</device:idPrefix>
</device:listDeviceRequest>
The following is a sample XML code for the listInfrastructureProduct XML request.
<hcs:ListInfrastructureProductRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<Product>
<!-- Customer -->
<ProductOfInterestTo xsi:type="hcs:PartyRoleProductInvolvement">
<productInvolvementRole>Customer</productInvolvementRole>
<PartyRole xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyRole>
</ProductOfInterestTo>
<!-- Selection Criteria -->
<RootEntityDescribedBy>
<value>ravmaderasip7912</value>
<CharacteristicSpecification>
<name>subscriberID</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
</Product>
</hcs:ListInfrastructureProductRequest>
The following is a sample XML code for the listInfrastructureProduct XML response.
<?xml version="1.0" encoding="UTF-8"?>
<device:listConfiguredInfraProductRequest xmlns:device="http://cupm.cucms.cisco.com/v1.0/Device">
<device:filter>
<cmn:objectSelectionCriteria xmlns:cmn="http://cupm.cucms.cisco.com/v1.0/Common">
<cmn:selectionCriteria>
<cmn:item>
<cmn:attributeName>subscriberID</cmn:attributeName>
<cmn:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">ravmaderasip7912</co-v1-3:item>
</cmn:attributeValue>
</cmn:item>
</cmn:selectionCriteria>
</cmn:objectSelectionCriteria>
<cmn:returnDataCriteria xmlns:cmn="http://cupm.cucms.cisco.com/v1.0/Common">
<cmn:returnDataType>ALL</cmn:returnDataType>
</cmn:returnDataCriteria>
</device:filter>
<device:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</device:epr>
<device:idPrefix>
ABC_</device:idPrefix>
</device:listConfiguredInfraProductRequest>
This section includes the following sample ProvisionSite data service XML API requests and responses:
•Sample createSite XML Request
•Sample createSite XML Response
•Sample updateSite XML Request
•Sample updateSite XML Response
•Sample deleteSite XML Request
•Sample deleteSite XML Response
The following is a sample XML code for the createSite XML request.
<?xml version="1.0" encoding="UTF-8"?>
<hcs:CreateSiteRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<!-- ***************************** -->
<!-- Create Site for HCS_Site_East -->
<!-- ***************************** -->
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<GeographicSite>
<ID>HCS_Site_East</ID>
<!-- Customer -->
<PlacePartyRoleAssoc>
<placeRole>Customer</placeRole>
<PartyRole xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyRole>
</PlacePartyRoleAssoc>
<!-- Executive Role -->
<PlacePartyRoleAssoc>
<placeRole>OrganizationPost</placeRole>
<PartyRole xsi:type="hcs:OrganizationPost">
<jobTitle>Executive</jobTitle>
</PartyRole>
</PlacePartyRoleAssoc>
<!-- Manager Role -->
<PlacePartyRoleAssoc>
<placeRole>OrganizationPost</placeRole>
<PartyRole xsi:type="hcs:OrganizationPost">
<jobTitle>Manager</jobTitle>
</PartyRole>
</PlacePartyRoleAssoc>
<!-- CallProcessor -->
<PlaceResourceAssoc>
<placeRole>CallProcessor</placeRole>
<Resource xsi:type="hcs:LogicalDevice">
<RootEntityDescribedBy>
<value>CallProcessor-1</value>
<CharacteristicSpecification>
<name>callProcessorName</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<!--
<RootEntityDescribedBy>
<value>SEP79650909EBBE</value>
<CharacteristicSpecification>
<name>callSearchSpacePhone</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>38884033</value>
<CharacteristicSpecification>
<name>callSearchSpaceLine</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
-->
<RootEntityDescribedBy>
<value>
ABC_CDevCFG</value>
<CharacteristicSpecification>
<name>commonDeviceConfig</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>
ABC</value>
<CharacteristicSpecification>
<name>location</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>
ABC_Part_International</value>
<CharacteristicSpecification>
<name>routePartition</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>
ABC</value>
<CharacteristicSpecification>
<name>devicePool</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<!--
<RootEntityDescribedBy>
<value>SCCP</value>
<CharacteristicSpecification>
<name>phoneProtocol</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
-->
</Resource>
</PlaceResourceAssoc>
<!-- Unified Message Processor-->
<PlaceResourceAssoc>
<placeRole>UnifiedMessageProcessor</placeRole>
<Resource xsi:type="hcs:LogicalDevice">
<RootEntityDescribedBy>
<value>UnifiedMessageProcessor-1</value>
<CharacteristicSpecification>
<name>unifiedMessageProcessorName</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
</Resource>
</PlaceResourceAssoc>
<!-- DirectoryNumberBlockAssociation 1 -->
<PlaceResourceAssoc>
<modifier>Create</modifier>
<placeRole>DirectoryNumberBlock</placeRole>
<Resource xsi:type="hcs:LogicalResource">
<RootEntityDescribedBy>
<value>10</value>
<CharacteristicSpecification>
<name>firstNumber</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>20</value>
<CharacteristicSpecification>
<name>lastNumber</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>100</value>
<CharacteristicSpecification>
<name>minLength</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>NEED VALID VALUES !!!</value>
<CharacteristicSpecification>
<name>name</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>NEED VALUID VALUES !!!</value>
<CharacteristicSpecification>
<name>prefix</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
</Resource>
</PlaceResourceAssoc>
<!-- DirectoryNumberBlockAssociation 2 -->
<PlaceResourceAssoc>
<modifier>Create</modifier>
<placeRole>DirectoryNumberBlock</placeRole>
<Resource xsi:type="hcs:LogicalResource">
<RootEntityDescribedBy>
<value>20</value>
<CharacteristicSpecification>
<name>firstNumber</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>200</value>
<CharacteristicSpecification>
<name>lastNumber</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>1000</value>
<CharacteristicSpecification>
<name>minLength</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>NEED VALID VALUES !!!</value>
<CharacteristicSpecification>
<name>name</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>NEED VALUID VALUES !!!</value>
<CharacteristicSpecification>
<name>prefix</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
</Resource>
</PlaceResourceAssoc>
</GeographicSite>
</hcs:CreateSiteRequest>
The following is a sample XML code for the createSite XML response.
<?xml version="1.0" encoding="UTF-8"?>
<sa:createServiceAreaRequest xmlns:sa="http://cupm.cucms.cisco.com/v1.0/ServiceArea">
<sa:serviceArea>
<sa:serviceAreaID>HCS_Site_East</sa:serviceAreaID>
<sa:domainID>
ABC</sa:domainID>
<sa:callProcessorProperties>
<sa:item>
<sa:cpPropertyName>callProcessorName</sa:cpPropertyName>
<sa:cpPropertyValue>CallProcessor-1</sa:cpPropertyValue>
</sa:item>
<sa:item>
<sa:cpPropertyName>commonDeviceConfig</sa:cpPropertyName>
<sa:cpPropertyValue>
ABC_CDevCFG</sa:cpPropertyValue>
</sa:item>
<sa:item>
<sa:cpPropertyName>location</sa:cpPropertyName>
<sa:cpPropertyValue>
ABC</sa:cpPropertyValue>
</sa:item>
<sa:item>
<sa:cpPropertyName>routePartition</sa:cpPropertyName>
<sa:cpPropertyValue>
ABC_Part_International</sa:cpPropertyValue>
</sa:item>
<sa:item>
<sa:cpPropertyName>devicePool</sa:cpPropertyName>
<sa:cpPropertyValue>
ABC</sa:cpPropertyValue>
</sa:item>
</sa:callProcessorProperties>
<sa:unifiedMessageProcessorProperties>
<sa:item>
<sa:umpPropertyName>unifiedMessageProcessorName</sa:umpPropertyName>
<sa:umpPropertyValue>UnifiedMessageProcessor-1</sa:umpPropertyValue>
</sa:item>
</sa:unifiedMessageProcessorProperties>
<sa:directoryNumberBlockProperties>
<sa:item>
<sa:dnPropertyName>firstNumber</sa:dnPropertyName>
<sa:dnPropertyValue>10</sa:dnPropertyValue>
</sa:item>
<sa:item>
<sa:dnPropertyName>lastNumber</sa:dnPropertyName>
<sa:dnPropertyValue>20</sa:dnPropertyValue>
</sa:item>
<sa:item>
<sa:dnPropertyName>minLength</sa:dnPropertyName>
<sa:dnPropertyValue>100</sa:dnPropertyValue>
</sa:item>
<sa:item>
<sa:dnPropertyName>name</sa:dnPropertyName>
<sa:dnPropertyValue>NEED VALID VALUES !!!</sa:dnPropertyValue>
</sa:item>
<sa:item>
<sa:dnPropertyName>prefix</sa:dnPropertyName>
<sa:dnPropertyValue>NEED VALUID VALUES !!!</sa:dnPropertyValue>
</sa:item>
<sa:directoryNumberBlockAction>ADD</sa:directoryNumberBlockAction>
</sa:directoryNumberBlockProperties>
<sa:directoryNumberBlockProperties>
<sa:item>
<sa:dnPropertyName>firstNumber</sa:dnPropertyName>
<sa:dnPropertyValue>20</sa:dnPropertyValue>
</sa:item>
<sa:item>
<sa:dnPropertyName>lastNumber</sa:dnPropertyName>
<sa:dnPropertyValue>200</sa:dnPropertyValue>
</sa:item>
<sa:item>
<sa:dnPropertyName>minLength</sa:dnPropertyName>
<sa:dnPropertyValue>1000</sa:dnPropertyValue>
</sa:item>
<sa:item>
<sa:dnPropertyName>name</sa:dnPropertyName>
<sa:dnPropertyValue>NEED VALID VALUES !!!</sa:dnPropertyValue>
</sa:item>
<sa:item>
<sa:dnPropertyName>prefix</sa:dnPropertyName>
<sa:dnPropertyValue>NEED VALUID VALUES !!!</sa:dnPropertyValue>
</sa:item>
<sa:directoryNumberBlockAction>ADD</sa:directoryNumberBlockAction>
</sa:directoryNumberBlockProperties>
<sa:serviceAreaProperties>
<sa:item>
<sa:saPropertyName>subscriberRoles</sa:saPropertyName>
<sa:saPropertyValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Executive</co-v1-3:item>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Manager</co-v1-3:item>
</sa:saPropertyValue>
</sa:item>
</sa:serviceAreaProperties>
</sa:serviceArea>
<sa:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</sa:epr>
<sa:idPrefix>
ABC_</sa:idPrefix>
</sa:createServiceAreaRequest>
The following is a sample XML code for the updateSite XML request.
<?xml version="1.0" encoding="UTF-8"?>
<hcs:UpdateSiteRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<!-- ********************************************** -->
<!-- Simple update of Site
ABC Attributes -->
<!-- ********************************************** -->
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<GeographicSite>
<ID>
ABC</ID>
<!-- Customer -->
<PlacePartyRoleAssoc>
<placeRole>Customer</placeRole>
<PartyRole xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyRole>
</PlacePartyRoleAssoc>
<!-- Executive Role -->
<PlacePartyRoleAssoc>
<placeRole>OrganizationPost</placeRole>
<PartyRole xsi:type="hcs:OrganizationPost">
<jobTitle>Executive</jobTitle>
</PartyRole>
</PlacePartyRoleAssoc>
<!-- Manager Role -->
<PlacePartyRoleAssoc>
<placeRole>OrganizationPost</placeRole>
<PartyRole xsi:type="hcs:OrganizationPost">
<jobTitle>Manager</jobTitle>
</PartyRole>
</PlacePartyRoleAssoc>
<!-- CallProcessor -->
<PlaceResourceAssoc>
<placeRole>CallProcessor</placeRole>
<Resource xsi:type="hcs:LogicalDevice">
<RootEntityDescribedBy>
<value>CACCM-4.198</value>
<CharacteristicSpecification>
<name>callProcessorName</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<!-- Call Search Space Phone -->
<RootEntityDescribedBy>
<value>
ABC</value>
<CharacteristicSpecification>
<name>callSearchSpacePhone</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<!-- Call Search Space Line -->
<RootEntityDescribedBy>
<value>
ABC</value>
<CharacteristicSpecification>
<name>callSearchSpaceLine</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<!-- Common Device Config -->
<RootEntityDescribedBy>
<value>
ABC_CommonDevCfg</value>
<CharacteristicSpecification>
<name>commonDeviceConfig</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<!-- Location -->
<RootEntityDescribedBy>
<value>
ABC</value>
<CharacteristicSpecification>
<name>location</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<!-- Route Partition -->
<RootEntityDescribedBy>
<value>
ABC_Part_International</value>
<CharacteristicSpecification>
<name>routePartition</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<!-- Device Pool -->
<RootEntityDescribedBy>
<value>
ABC</value>
<CharacteristicSpecification>
<name>devicePool</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<!-- Phone Protocol -->
<RootEntityDescribedBy>
<value>SCCP</value>
<CharacteristicSpecification>
<name>phoneProtocol</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
</Resource>
</PlaceResourceAssoc>
<!-- Unified Message Processor-->
<PlaceResourceAssoc>
<placeRole>UnifiedMessageProcessor</placeRole>
<Resource xsi:type="hcs:LogicalDevice">
<RootEntityDescribedBy>
<value>CAUTY-4.200</value>
<CharacteristicSpecification>
<name>unifiedMessageProcessorName</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<!-- Subscriber Template With TTS Disabled -->
<RootEntityDescribedBy>
<value>SubscriberTemplate3</value>
<CharacteristicSpecification>
<name>subscriberTemplateWithTTSDisabled</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<!-- CoS With TTS Enabled -->
<RootEntityDescribedBy>
<value>CoS with UM</value>
<CharacteristicSpecification>
<name>cosWithTTSEnabled</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<!-- CoS With TTS Disabled -->
<RootEntityDescribedBy>
<value>{Default Subscriber}</value>
<CharacteristicSpecification>
<name>cosWithTTSDisabled</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
</Resource>
</PlaceResourceAssoc>
</GeographicSite>
</hcs:UpdateSiteRequest>
The following is a sample XML code for the updateSite XML response.
<?xml version="1.0" encoding="UTF-8"?>
<sa:updateServiceAreaRequest xmlns:sa="http://cupm.cucms.cisco.com/v1.0/ServiceArea">
<sa:serviceArea>
<sa:serviceAreaID>
ABC</sa:serviceAreaID>
<sa:domainID>
ABC</sa:domainID>
<sa:callProcessorProperties>
<sa:item>
<sa:cpPropertyName>callProcessorName</sa:cpPropertyName>
<sa:cpPropertyValue>CACCM-4.198</sa:cpPropertyValue>
</sa:item>
<sa:item>
<sa:cpPropertyName>callSearchSpacePhone</sa:cpPropertyName>
<sa:cpPropertyValue>
ABC</sa:cpPropertyValue>
</sa:item>
<sa:item>
<sa:cpPropertyName>callSearchSpaceLine</sa:cpPropertyName>
<sa:cpPropertyValue>
ABC</sa:cpPropertyValue>
</sa:item>
<sa:item>
<sa:cpPropertyName>commonDeviceConfig</sa:cpPropertyName>
<sa:cpPropertyValue>
ABC_CommonDevCfg</sa:cpPropertyValue>
</sa:item>
<sa:item>
<sa:cpPropertyName>location</sa:cpPropertyName>
<sa:cpPropertyValue>
ABC</sa:cpPropertyValue>
</sa:item>
<sa:item>
<sa:cpPropertyName>routePartition</sa:cpPropertyName>
<sa:cpPropertyValue>
ABC_Part_International</sa:cpPropertyValue>
</sa:item>
<sa:item>
<sa:cpPropertyName>devicePool</sa:cpPropertyName>
<sa:cpPropertyValue>
ABC</sa:cpPropertyValue>
</sa:item>
<sa:item>
<sa:cpPropertyName>phoneProtocol</sa:cpPropertyName>
<sa:cpPropertyValue>SCCP</sa:cpPropertyValue>
</sa:item>
</sa:callProcessorProperties>
<sa:unifiedMessageProcessorProperties>
<sa:item>
<sa:umpPropertyName>unifiedMessageProcessorName</sa:umpPropertyName>
<sa:umpPropertyValue>CAUTY-4.200</sa:umpPropertyValue>
</sa:item>
<sa:item>
<sa:umpPropertyName>subscriberTemplateWithTTSDisabled</sa:umpPropertyName>
<sa:umpPropertyValue>SubscriberTemplate3</sa:umpPropertyValue>
</sa:item>
<sa:item>
<sa:umpPropertyName>cosWithTTSEnabled</sa:umpPropertyName>
<sa:umpPropertyValue>CoS with UM</sa:umpPropertyValue>
</sa:item>
<sa:item>
<sa:umpPropertyName>cosWithTTSDisabled</sa:umpPropertyName>
<sa:umpPropertyValue>{Default Subscriber}</sa:umpPropertyValue>
</sa:item>
</sa:unifiedMessageProcessorProperties>
<sa:serviceAreaProperties>
<sa:item>
<sa:saPropertyName>subscriberRoles</sa:saPropertyName>
<sa:saPropertyValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Executive</co-v1-3:item>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Manager</co-v1-3:item>
</sa:saPropertyValue>
</sa:item>
</sa:serviceAreaProperties>
</sa:serviceArea>
<sa:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</sa:epr>
<sa:idPrefix>
ABC_</sa:idPrefix>
</sa:updateServiceAreaRequest>
The following is a sample XML code for the deleteSite XML request.
<hcs:DeleteSiteRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<!-- *********** -->
<!-- Delete Site -->
<!-- *********** -->
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<GeographicSite>
<ID>
ABC-CT</ID>
<!-- Customer -->
<PlacePartyRoleAssoc>
<placeRole>Customer</placeRole>
<PartyRole xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyRole>
</PlacePartyRoleAssoc>
</GeographicSite>
</hcs:DeleteSiteRequest>
The following is a sample XML code for the deleteSite XML response.
<?xml version="1.0" encoding="UTF-8"?>
<sa:deleteServiceAreaRequest xmlns:sa="http://cupm.cucms.cisco.com/v1.0/ServiceArea">
<sa:serviceArea>
<sa:serviceAreaID>
ABC-CT</sa:serviceAreaID>
<sa:domainID>
ABC</sa:domainID>
</sa:serviceArea>
<sa:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</sa:epr>
<sa:idPrefix>
ABC_</sa:idPrefix>
</sa:deleteServiceAreaRequest>
The following is a sample XML code for the listSite XML request.
<?xml version="1.0" encoding="UTF-8"?>
<hcs:ListSiteRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<!-- ********************* -->
<!-- List Site: -->
<!-- location -->
<!-- ********************* -->
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<GeographicSite>
<ID>
ABC</ID>
<!-- Customer -->
<PlacePartyRoleAssoc>
<placeRole>Customer</placeRole>
<PartyRole xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyRole>
</PlacePartyRoleAssoc>
<!-- Location -->
<RootEntityDescribedBy>
<value>
ABC</value>
<CharacteristicSpecification>
<name>location</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
</GeographicSite>
</hcs:ListSiteRequest>
The following is a sample XML code for the listSite XML response.
<?xml version="1.0" encoding="UTF-8"?>
<sa:listServiceAreaRequest xmlns:sa="http://cupm.cucms.cisco.com/v1.0/ServiceArea">
<sa:filter>
<cmn:objectSelectionCriteria xmlns:cmn="http://cupm.cucms.cisco.com/v1.0/Common">
<cmn:selectionCriteria>
<cmn:item>
<cmn:attributeName>location</cmn:attributeName>
<cmn:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">
ABC</co-v1-3:item>
</cmn:attributeValue>
</cmn:item>
</cmn:selectionCriteria>
</cmn:objectSelectionCriteria>
<cmn:returnDataCriteria xmlns:cmn="http://cupm.cucms.cisco.com/v1.0/Common">
<cmn:returnDataType>ALL</cmn:returnDataType>
</cmn:returnDataCriteria>
</sa:filter>
<sa:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</sa:epr>
<sa:idPrefix>
ABC_</sa:idPrefix>
</sa:listServiceAreaRequest>
This section includes the following sample ProvisionSubscriber data service XML API requests and responses:
•Sample createSubscriber XML Request
•Sample createSubscriber XML Response
•Sample updateSubscriber XML Request
•Sample updateSubscriber XML Response
•Sample deleteSubscriber XML Request
•Sample deleteSubscriber XML Response
•Sample submitSubscriberOrder XML Request
•Sample submitSubscriberOrder XML Response
•Sample listSubscriber XML Request
•Sample listSubscriber XML Response
•Sample listOrder XML Response
•Sample listSubscriberProduct XML Request
•Sample listSubscriberProduct XML Response
The following is a sample XML code for the createSubscriber XML request.
<?xml version="1.0" encoding="UTF-8"?>
<hcs:CreateSubscriberRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<!-- ***************** -->
<!-- Create Subscriber -->
<!-- ***************** -->
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<Subscriber>
<partyRoleId>
ABC-Subscriber-01</partyRoleId>
<!-- Customer -->
<PartyRoleAssociation>
<associationType>Customer</associationType>
<PartyRole xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyRole>
</PartyRoleAssociation>
<!-- Employee -->
<Party xsi:type="hcs:Individual">
<IndividualINamedUsing>
<familyNames>Collins</familyNames>
<givenNames>Jeffrey</givenNames>
</IndividualINamedUsing>
</Party>
<!-- Organization Post : Senior Manager -->
<PartyRoleAssociation>
<associationType>OrganizationPost</associationType>
<PartyRole xsi:type="hcs:OrganizationPost">
<jobTitle>Senior Manager</jobTitle>
</PartyRole>
</PartyRoleAssociation>
<!-- Organization Post : Contractor -->
<PartyRoleAssociation>
<associationType>OrganizationPost</associationType>
<PartyRole xsi:type="hcs:OrganizationPost">
<jobTitle>Contractor</jobTitle>
</PartyRole>
</PartyRoleAssociation>
<!-- Department -->
<RootEntityDescribedBy>
<value>Engineering</value>
<CharacteristicSpecification>
<name>Department</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<!-- Email Contact -->
<PartyRoleContactableVia xsi:type="hcs:EmailContact">
<eMailAddress>
user@domain.com</eMailAddress>
</PartyRoleContactableVia>
<PartyRoleContactableVia xsi:type="hcs:TelephoneNumber">
<number>678-111-1234</number>
</PartyRoleContactableVia>
</Subscriber>
</hcs:CreateSubscriberRequest>
The following is a sample XML code for the createSubscriber XML response.
<?xml version="1.0" encoding="UTF-8"?>
<sub:createSubscriberRequest xmlns:sub="http://cupm.cucms.cisco.com/v1.0/Subscriber">
<sub:subscriber>
<sub:subscriberID>
ABC-Subscriber-01</sub:subscriberID>
<sub:domainID>
ABC</sub:domainID>
<sub:lastName>Collins</sub:lastName>
<sub:subscriberProperties>
<sub:item>
<sub:subscriberPropertyName>subscriberRoles</sub:subscriberPropertyName>
<sub:subscriberPropertyValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Senior Manager</co-v1-3:item>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Contractor</co-v1-3:item>
</sub:subscriberPropertyValue>
</sub:item>
<sub:item>
<sub:subscriberPropertyName>email</sub:subscriberPropertyName>
<sub:subscriberPropertyValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">
user@domain.com</co-v1-3:item>
</sub:subscriberPropertyValue>
</sub:item>
<sub:item>
<sub:subscriberPropertyName>phone</sub:subscriberPropertyName>
<sub:subscriberPropertyValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">678-111-1234</co-v1-3:item>
</sub:subscriberPropertyValue>
</sub:item>
<sub:item>
<sub:subscriberPropertyName>firstName</sub:subscriberPropertyName>
<sub:subscriberPropertyValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Jeffrey</co-v1-3:item>
</sub:subscriberPropertyValue>
</sub:item>
<sub:item>
<sub:subscriberPropertyName>department</sub:subscriberPropertyName>
<sub:subscriberPropertyValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Engineering</co-v1-3:item>
</sub:subscriberPropertyValue>
</sub:item>
</sub:subscriberProperties>
</sub:subscriber>
<sub:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</sub:epr>
<sub:idPrefix>
ABC_</sub:idPrefix>
</sub:createSubscriberRequest>
The following is a sample XML code for the updateSubscriber XML request.
<?xml version="1.0" encoding="UTF-8"?>
<hcs:UpdateSubscriberRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<Subscriber>
<partyRoleId>
ABC-Subscriber-03</partyRoleId>
<!-- Customer -->
<PartyRoleAssociation>
<associationType>Customer</associationType>
<PartyRole xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyRole>
</PartyRoleAssociation>
<!-- Employee -->
<Party xsi:type="hcs:Individual">
<IndividualINamedUsing>
<familyNames>Wang</familyNames>
<givenNames>Jeffrey</givenNames>
</IndividualINamedUsing>
</Party>
<!-- Organization Post : Senior Manager -->
<PartyRoleAssociation>
<associationType>OrganizationPost</associationType>
<PartyRole xsi:type="hcs:OrganizationPost">
<jobTitle>Senior Manager</jobTitle>
</PartyRole>
</PartyRoleAssociation>
<!-- Organization Post : Contractor -->
<PartyRoleAssociation>
<associationType>OrganizationPost</associationType>
<PartyRole xsi:type="hcs:OrganizationPost">
<jobTitle>Contractor</jobTitle>
</PartyRole>
</PartyRoleAssociation>
<!-- Department -->
<RootEntityDescribedBy>
<value>Engineering</value>
<CharacteristicSpecification>
<name>Department</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<!-- Email Contact -->
<PartyRoleContactableVia xsi:type="hcs:EmailContact">
<eMailAddress>
user@domain.com</eMailAddress>
</PartyRoleContactableVia>
<PartyRoleContactableVia xsi:type="hcs:TelephoneNumber">
<number>678-111-5678</number>
</PartyRoleContactableVia>
</Subscriber>
</hcs:UpdateSubscriberRequest>
The following is a sample XML code for the updateSubscriber XML response.
<?xml version="1.0" encoding="UTF-8"?>
<sub:updateSubscriberRequest xmlns:sub="http://cupm.cucms.cisco.com/v1.0/Subscriber">
<sub:subscriber>
<sub:subscriberID>
ABC-Subscriber-03</sub:subscriberID>
<sub:domainID>
ABC</sub:domainID>
<sub:lastName>Wang</sub:lastName>
<sub:subscriberProperties>
<sub:item>
<sub:subscriberPropertyName>subscriberRoles</sub:subscriberPropertyName>
<sub:subscriberPropertyValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Senior Manager</co-v1-3:item>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Contractor</co-v1-3:item>
</sub:subscriberPropertyValue>
</sub:item>
<sub:item>
<sub:subscriberPropertyName>email</sub:subscriberPropertyName>
<sub:subscriberPropertyValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">
user@domain.com</co-v1-3:item>
</sub:subscriberPropertyValue>
</sub:item>
<sub:item>
<sub:subscriberPropertyName>phone</sub:subscriberPropertyName>
<sub:subscriberPropertyValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">678-111-5678</co-v1-3:item>
</sub:subscriberPropertyValue>
</sub:item>
<sub:item>
<sub:subscriberPropertyName>firstName</sub:subscriberPropertyName>
<sub:subscriberPropertyValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Jeffrey</co-v1-3:item>
</sub:subscriberPropertyValue>
</sub:item>
<sub:item>
<sub:subscriberPropertyName>department</sub:subscriberPropertyName>
<sub:subscriberPropertyValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Engineering</co-v1-3:item>
</sub:subscriberPropertyValue>
</sub:item>
</sub:subscriberProperties>
</sub:subscriber>
<sub:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</sub:epr>
<sub:idPrefix>
ABC_</sub:idPrefix>
</sub:updateSubscriberRequest>
The following is a sample XML code for the deleteSubscriber XML request.
<?xml version="1.0" encoding="UTF-8"?>
<hcs:DeleteSubscriberRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<!-- *********** -->
<!-- Create Site -->
<!-- *********** -->
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<Subscriber>
<partyRoleId>
ABC-Subscriber-99</partyRoleId>
<!-- Customer -->
<PartyRoleAssociation>
<associationType>Customer</associationType>
<PartyRole xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyRole>
</PartyRoleAssociation>
</Subscriber>
</hcs:DeleteSubscriberRequest>
The following is a sample XML code for the deleteSubscriber XML response.
<?xml version="1.0" encoding="UTF-8"?>
<sub:deleteSubscriberRequest xmlns:sub="http://cupm.cucms.cisco.com/v1.0/Subscriber">
<sub:subscriber>
<sub:subscriberID>
ABC-Subscriber-99</sub:subscriberID>
<sub:domainID>
ABC</sub:domainID>
<sub:subscriberProperties/>
</sub:subscriber>
<sub:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</sub:epr>
<sub:idPrefix>
ABC_</sub:idPrefix>
</sub:deleteSubscriberRequest>
The following is a sample XML code for the submitSubscriberOrder XML request.
<hcs:SubmitSubscriberOrderRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<!-- Simple Order with One Subscriber and Two Products -->
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<SubmitOption>ValidateAndSubmit</SubmitOption>
<ProductOrder>
<!-- Customer -->
<BusinessInteractionInvolves xsi:type="hcs:PartyInteractionRole">
<interactionRole>Customer</interactionRole>
<PartyInteractionRoleIdentifiedBy xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyInteractionRoleIdentifiedBy>
</BusinessInteractionInvolves>
<!--Transaction-->
<BusinessInteractionType>
<name>Add</name>
</BusinessInteractionType>
<!-- Customer Order Item -->
<CustomerOrderComprisedOf>
<orderItemNumber>1</orderItemNumber>
<!-- Subscriber -->
<BusinessInteractionItemInvolves xsi:type="hcs:PartyInteractionRole">
<interactionRole>Subscriber</interactionRole>
<PartyInteractionRoleIdentifiedBy xsi:type="hcs:Subscriber">
<partyRoleId>
ABC-Subscriber-01</partyRoleId>
</PartyInteractionRoleIdentifiedBy>
</BusinessInteractionItemInvolves>
<!-- Product -->
<BusinessInteractionItemInvolvesProduct>
<ProductSpecification>
<productId>Phone</productId>
</ProductSpecification>
<!-- Geographic Site -->
<ProductLocatedVia xsi:type="hcs:GeographicSite">
<ID>
ABC</ID>
</ProductLocatedVia>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>macaddress</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>DDDD0505EEEE</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>usedummymacaddress</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>False</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>devicepool</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>
ABC</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>type</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>Cisco 7970</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>protocol</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>SCCP</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>pbt</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>Standard 7970 SCCP</value>
</ProductCharacteristicValue>
<!-- Product Characteristic Value -->
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>devicelocation</ID>
<isKey>false</isKey>
</ProdSpecCharDescribesProdCharacteristicValue>
<value>
ABC</value>
</ProductCharacteristicValue>
</BusinessInteractionItemInvolvesProduct>
</CustomerOrderComprisedOf>
</ProductOrder>
</hcs:SubmitSubscriberOrderRequest>
The following is a sample XML code for the submitSubscriberOrder XML response.
<?xml version="1.0" encoding="UTF-8"?>
<order:submitOrderRequest xmlns:order="http://cupm.cucms.cisco.com/v1.0/Order">
<order:order>
<order:serviceDetail>
<order:item>
<order:product>
<order:item>
<order:productID>Phone</order:productID>
<order:productAttribute>
<order:item>
<order:attributeID>macaddress</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">DDDD0505EEEE</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>usedummymacaddress</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">False</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>devicepool</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">
ABC</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>type</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Cisco 7970</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>protocol</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">SCCP</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>pbt</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Standard 7970 SCCP</co-v1-3:item>
</order:attributeValue>
</order:item>
<order:item>
<order:attributeID>devicelocation</order:attributeID>
<order:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">
ABC</co-v1-3:item>
</order:attributeValue>
</order:item>
</order:productAttribute>
<order:sequenceNumber>1</order:sequenceNumber>
</order:item>
</order:product>
<order:serviceAreaID>
ABC</order:serviceAreaID>
<order:subscriberID>
ABC-Subscriber-01</order:subscriberID>
<order:domainID>
ABC</order:domainID>
</order:item>
</order:serviceDetail>
<order:orderType>Add</order:orderType>
</order:order>
<order:validate>VALIDATE_AND_SUBMIT</order:validate>
<order:rollback>PARTIAL_ROLLBACK</order:rollback>
<order:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</order:epr>
<order:idPrefix>
ABC_</order:idPrefix>
</order:submitOrderRequest>
The following is a sample XML code for the listSubscriber XML request.
<?xml version="1.0" encoding="UTF-8"?>
<hcs:ListSubscriberRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<!-- ********************* -->
<!-- List Subscriber: -->
<!-- subscriberID -->
<!-- ********************* -->
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<Subscriber>
<!-- Customer -->
<PartyRoleAssociation>
<associationType>Customer</associationType>
<PartyRole xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyRole>
</PartyRoleAssociation>
<!-- subscriberID
<RootEntityDescribedBy>
<value>
ABC-Subscriber</value>
<CharacteristicSpecification>
<name>subscriberID</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
-->
</Subscriber>
</hcs:ListSubscriberRequest>
The following is a sample XML code for the listSubscriber XML response.
Expected Result
<?xml version="1.0" encoding="UTF-8"?>
<prov:ListSubscriberResponse xmlns:prov="http://www.cisco.hcs.com/HCSProvision.xsd">
<CorrelationId>
ABC_101</CorrelationId>
</prov:ListSubscriberResponse>
Expected Value
<?xml version="1.0" encoding="UTF-8"?>
<sub:listSubscriberRequest xmlns:sub="http://cupm.cucms.cisco.com/v1.0/Subscriber">
<sub:filter>
<cmn:returnDataCriteria xmlns:cmn="http://cupm.cucms.cisco.com/v1.0/Common">
<cmn:returnDataType>ALL</cmn:returnDataType>
</cmn:returnDataCriteria>
</sub:filter>
<sub:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</sub:epr>
<sub:idPrefix>
ABC_</sub:idPrefix>
</sub:listSubscriberRequest>
The following is a sample XML code for the listOrder XML request.
<?xml version="1.0" encoding="UTF-8"?>
<hcs:ListOrderRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<!-- ********************* -->
<!-- List Order: -->
<!-- subscriberID -->
<!-- ********************* -->
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<ProductOrder>
<!-- Customer -->
<BusinessInteractionInvolves xsi:type="hcs:PartyInteractionRole">
<interactionRole>Customer</interactionRole>
<PartyInteractionRoleIdentifiedBy xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyInteractionRoleIdentifiedBy>
</BusinessInteractionInvolves>
<!-- subscriberID -->
<RootEntityDescribedBy>
<value>
ABC-Subscriber-01</value>
<CharacteristicSpecification>
<name>subscriberID</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
</ProductOrder>
</hcs:ListOrderRequest>
The following is a sample XML code for the listOrder XML response.
Expected Result
<?xml version="1.0" encoding="UTF-8"?>
<prov:ListOrderResponse xmlns:prov="http://www.cisco.hcs.com/HCSProvision.xsd">
<CorrelationId>
ABC_101</CorrelationId>
</prov:ListOrderResponse>
Expected Value
<?xml version="1.0" encoding="UTF-8"?>
<order:listOrderRequest xmlns:order="http://cupm.cucms.cisco.com/v1.0/Order">
<order:filter>
<cmn:objectSelectionCriteria xmlns:cmn="http://cupm.cucms.cisco.com/v1.0/Common">
<cmn:selectionCriteria>
<cmn:item>
<cmn:attributeName>subscriberID</cmn:attributeName>
<cmn:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">
ABC-Subscriber-01</co-v1-3:item>
</cmn:attributeValue>
</cmn:item>
</cmn:selectionCriteria>
</cmn:objectSelectionCriteria>
<cmn:returnDataCriteria xmlns:cmn="http://cupm.cucms.cisco.com/v1.0/Common">
<cmn:returnDataType>ALL</cmn:returnDataType>
</cmn:returnDataCriteria>
</order:filter>
<order:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</order:epr>
<order:idPrefix>
ABC_</order:idPrefix>
</order:listOrderRequest>
The following is a sample XML code for the listSubscriberProduct XML request.
<hcs:ListSubscriberProductRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<Product>
<!-- Customer -->
<ProductOfInterestTo xsi:type="hcs:PartyRoleProductInvolvement">
<productInvolvementRole>Customer</productInvolvementRole>
<PartyRole xsi:type="hcs:Customer">
<partyRoleId>
ABC</partyRoleId>
</PartyRole>
</ProductOfInterestTo>
<!-- Selection Criteria -->
<RootEntityDescribedBy>
<value>ravmaderasip7912</value>
<CharacteristicSpecification>
<name>subscriberID</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
</Product>
</hcs:ListSubscriberProductRequest>
The following is a sample XML code for the listSubscriberProduct XML response.
<?xml version="1.0" encoding="UTF-8"?>
<sub:listSubscriberServiceRequest xmlns:sub="http://cupm.cucms.cisco.com/v1.0/Subscriber">
<sub:filter>
<cmn:objectSelectionCriteria xmlns:cmn="http://cupm.cucms.cisco.com/v1.0/Common">
<cmn:selectionCriteria>
<cmn:item>
<cmn:attributeName>subscriberID</cmn:attributeName>
<cmn:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">ravmaderasip7912</co-v1-3:item>
</cmn:attributeValue>
</cmn:item>
</cmn:selectionCriteria>
</cmn:objectSelectionCriteria>
<cmn:returnDataCriteria xmlns:cmn="http://cupm.cucms.cisco.com/v1.0/Common">
<cmn:returnDataType>ALL</cmn:returnDataType>
</cmn:returnDataCriteria>
</sub:filter>
<sub:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</sub:epr>
<sub:idPrefix>
ABC_</sub:idPrefix>
</sub:listSubscriberServiceRequest>
This section includes the following sample ProvisionResults data service XML API requests and responses:
•Sample getListResults XML Request
•Sample getListResults XML Response
•Sample getStatus XML Response
The following is a sample XML code for the getListResults XML request.
<hcs:GetListResultsRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<correlationId>
ABC_1434</correlationId>
<maxResults>25</maxResults>
</hcs:GetListResultsRequest>
The following is a sample XML code for the getListResults XML response.
Expected Result
<?xml version="1.0" encoding="UTF-8"?>
<prov:GetListResultsResponse xmlns:prov="http://www.cisco.hcs.com/HCSProvision.xsd">
<moreResults>false</moreResults>
<Result xsi:type="hcs:Customer" xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<RootEntityDescribedBy>
<value>CAUTY- 4.235-CiscoUnity</value>
<CharacteristicSpecification>
<name>UnifiedMessageProcessor</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>CACCM-4.198-CiscoUnifiedCM</value>
<CharacteristicSpecification>
<name>CallProcessor</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<partyRoleId>CA_DOMAIN</partyRoleId>
</Result>
<Result xsi:type="hcs:Customer" xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<RootEntityDescribedBy>
<value>CACCM-4.74-CiscoUnifiedCM</value>
<CharacteristicSpecification>
<name>CallProcessor</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<partyRoleId>LDAPCA_DOMAIN</partyRoleId>
</Result>
<Result xsi:type="hcs:Customer" xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<partyRoleId>Site 1 Users</partyRoleId>
</Result>
<Result xsi:type="hcs:Customer" xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<RootEntityDescribedBy>
<value>
ABC Bank</value>
<CharacteristicSpecification>
<name>DomainDescription</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>CAUTY-4.200-CiscoUnity</value>
<CharacteristicSpecification>
<name>UnifiedMessageProcessor</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>CACCM-4.198-CiscoUnifiedCM</value>
<CharacteristicSpecification>
<name>CallProcessor</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<partyRoleId>
ABC</partyRoleId>
</Result>
</prov:GetListResultsResponse>
Expected Value
<?xml version="1.0" encoding="UTF-8"?>
<tns:Pull xmlns:tns="http://schemas.xmlsoap.org/ws/2004/09/enumeration">
<tns:EnumerationContext>
<soapenc:string xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
ABC_930</soapenc:string>
</tns:EnumerationContext>
<tns:MaxElements>25</tns:MaxElements>
</tns:Pull>
The following is a sample XML code for the getStatus XML request.
<hcs:GetStatusRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<CorrelationId>
ABC_1655</CorrelationId>
</hcs:GetStatusRequest>
The following is a sample XML code for the getStatus XML response.
Expected Result
<?xml version="1.0" encoding="UTF-8"?>
<prov:GetStatusResponse xmlns:prov="http://www.cisco.hcs.com/HCSProvision.xsd">
<CorrelationId>
ABC_101</CorrelationId>
<status>COMPLETED_SUCCESSFULLY</status>
<statusMessage>Domain Sync of
ABC is 100% done. syncinProgress=false</statusMessage>
</prov:GetStatusResponse>
Expected Value
<?xml version="1.0" encoding="UTF-8"?>
<cmn:getApiStatusRequest xmlns:cmn="http://cupm.cucms.cisco.com/v1.0/Common">
<cmn:apiID>
ABC_1655</cmn:apiID>
<cmn:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</cmn:epr>
<cmn:idPrefix>
ABC_</cmn:idPrefix>
</cmn:getApiStatusRequest>
This section includes the following sample ProductCatalog data service XML API requests and responses:
•Sample getProductSpecification XML Request
•Sample getProductSpecification XML Response
•Sample listDeviceSpecifications XML Request
•Sample listDeviceSpecifications XML Response
•Sample listLogicalResourceSpecifications XML Request
•Sample listLogicalResourceSpecifications XML Response
•Sample listProductCategories XML Request
•Sample listProductCategories XML Response
•Sample listProductSpecificationIds XML Request
•Sample listProductSpecificationIds XML Response
•Sample listProductSpecCharacteristicValues XML Request
•Sample listProductSpecCharacteristicValues XML Response
The following is a sample XML code of the getProductSpecification XML request.
hcs:GetProductSpecificationRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<Customer>
<partyRoleId>
ABC</partyRoleId>
</Customer>
<productId>Cisco_7960</productId>
</hcs:GetProductSpecificationRequest>
The following is a sample XML code for the getProductSpecification XML response.
<?xml version="1.0" encoding="UTF-8"?>
<catalog:GetProductSpecificationResponse xmlns:catalog="http://www.cisco.hcs.com/HCSProductCatalog.xsd">
<ProductSpecification>
<name>Cisco 7960</name>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>digestUser</ID>
<name>Digest User</name>
<description>Digest User.It supports only SIP Phone Types</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<maxLength>128</maxLength>
<ProductSpecCharacteristicType>
<Id>protocolspecificinformation</Id>
<Name>Protocol Specific Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
<SupportsProtocol>
<commonName>SIP</commonName>
</SupportsProtocol>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>rerouteCallingSearchSpaceName</ID>
<name>Rerouting Calling Search Space</name>
<description>Rerouting Calling Search Space used by the phone.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Dynamic</valueType>
</ProdSpecCharacteristicEnumeratedBy>
<ProductSpecCharacteristicType>
<Id>protocolspecificinformation</Id>
<Name>Protocol Specific Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
<SupportsProtocol>
<commonName>SIP</commonName>
</SupportsProtocol>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>doNotDisturb</ID>
<name>Do Not Disturb</name>
<description>To enable Do Not Disturb on the phone.</description>
<isKey>false</isKey>
<valueType>BOOLEAN</valueType>
<minCardinality>0</minCardinality>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>True</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>False</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProductSpecCharacteristicType>
<Id>dndInformation</Id>
<Name>Do Not Disturb</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>dndOption</ID>
<name>DND Option</name>
<description>When you enable DND on the phone, this parameter allows to specify how the DND features handle incoming calls.
This functionality is supported for CUCM version 6.x and above. Valid value for CUCM 6.x version is Ringer Off.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Ringer Off</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Call Reject</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Ringer Off</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Use Common Phone Profile Setting</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Call Reject</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProductSpecCharacteristicType>
<Id>dndInformation</Id>
<Name>Do Not Disturb</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>emenable</ID>
<name>Enable Extension Mobility</name>
<description>Enable Extension Mobility</description>
<isKey>false</isKey>
<valueType>BOOLEAN</valueType>
<minCardinality>0</minCardinality>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>True</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>False</value>
<isDefault>true</isDefault>
</ProdSpecCharacteristicEnumeratedBy>
<ProductSpecCharacteristicType>
<Id>coreattributes</Id>
<Name>Core Attributes</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>usedummymacaddress</ID>
<name>Use Dummy MAC Address</name>
<description>Use Dummy MAC Address</description>
<isKey>false</isKey>
<valueType>BOOLEAN</valueType>
<minCardinality>1</minCardinality>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>True</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>False</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProductSpecCharacteristicType>
<Id>coreattributes</Id>
<Name>Core Attributes</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>macaddress</ID>
<name>MAC Address</name>
<description>MAC Address</description>
<isKey>true</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<regexPattern>[0-9a-fA-F]{12}</regexPattern>
<ProductSpecCharacteristicType>
<Id>coreattributes</Id>
<Name>Core Attributes</Name>
</ProductSpecCharacteristicType>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>mlppindication</ID>
<name>MLPP Indication</name>
<description>Specifies whether a device that is capable of playing precedence tones will use the capability when it places an MLPP precedence call.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Default</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Off</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>On</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProductSpecCharacteristicType>
<Id>mlppinformation</Id>
<Name>MLPP Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>mlpppreemption</ID>
<name>MLPP Preemption</name>
<description>Specifies whether devices in the device pool that are capable of preempting calls in progress will use the capability when the devices place an MLPP precedence call.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Disabled</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Forceful</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Default</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProductSpecCharacteristicType>
<Id>mlppinformation</Id>
<Name>MLPP Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>pbt</ID>
<name>Phone Button Template</name>
<description>Phone Button Template</description>
<isKey>false</isKey>
<ProductSpecCharRelationship>
<charRelationshipType>DependsOn</charRelationshipType>
<ProductSpecCharacteristic>
<ID>type</ID>
</ProductSpecCharacteristic>
</ProductSpecCharRelationship>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Dynamic</valueType>
</ProdSpecCharacteristicEnumeratedBy>
<ProductSpecCharacteristicType>
<Id>coreattributes</Id>
<Name>Core Attributes</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>nhas</ID>
<name>Network Hold Audio Source</name>
<description>The audio source that plays when the network initiates a hold action.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Dynamic</valueType>
</ProdSpecCharacteristicEnumeratedBy>
<ProductSpecCharacteristicType>
<Id>deviceinformation</Id>
<Name>Device Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>aarcss</ID>
<name>AAR Calling Search Space</name>
<description>Automated alternate routing (AAR) calling search space.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Dynamic</valueType>
</ProdSpecCharacteristicEnumeratedBy>
<ProductSpecCharacteristicType>
<Id>deviceinformation</Id>
<Name>Device Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>userlocale</ID>
<name>User Locale</name>
<description>The user locale identifies a set of detailed information to support users, including language, font, date and time formatting, and alphanumeric keyboard text information.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Arabic Kuwait</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Arabic Oman</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Arabic Saudi Arabia</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Arabic United Arab Emirates</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Bulgarian Bulgaria</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Catalan Spain</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Chinese China</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Chinese Hong Kong</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Chinese Taiwan</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Croatian Croatia</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Czech Czech Republic</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Danish Denmark</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Dutch Netherlands</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>English United Kingdom</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>English United States</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Finnish Finland</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>French France</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>German Germany</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Greek Greece</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Hebrew Israel</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Hungarian Hungary</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Indonesian Indonesia</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Italian Italy</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Japanese Japan</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Korean Korea Republic</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Malay Malaysia</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Norwegian Norway</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Polish Poland</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Portuguese Brazil</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Portuguese Portugal</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Romanian Romania</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Russian Russian Federation</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Serbian Republic of Montenegro</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Serbian Republic of Serbia</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Serbian Serbia and Montenegro</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Slovak Slovakia</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Slovenian Slovenia</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Spanish Spain</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Swedish Sweden</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Thai Thailand</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Turkish Turkey</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Vietnamese Vietnam</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Welsh United Kingdom</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProductSpecCharacteristicType>
<Id>deviceinformation</Id>
<Name>Device Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>uhas</ID>
<name>User Hold Audio Source</name>
<description>The audio source that plays when a user initiates a hold action.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Dynamic</valueType>
</ProdSpecCharacteristicEnumeratedBy>
<ProductSpecCharacteristicType>
<Id>deviceinformation</Id>
<Name>Device Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>pcport</ID>
<name>PC Port</name>
<description>Indicates whether the PC port on the phone is enabled or disabled.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Enabled</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Disabled</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProductSpecCharacteristicType>
<Id>productspecificconfigurationlayout</Id>
<Name>Product Specific Configuration Layout</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>videocapabilities</ID>
<name>Video Capabilities</name>
<description>Indicates whether the phone can participate in video calls when connected to an appropriately equipped PC.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Enabled</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Disabled</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProductSpecCharacteristicType>
<Id>productspecificconfigurationlayout</Id>
<Name>Product Specific Configuration Layout</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>pcvoicevlanaccess</ID>
<name>PC Voice VLAN Access</name>
<description>Indicates whether the phone allows a device attached to the PC port to access the voice VLAN</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Enabled</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>Disabled</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProductSpecCharacteristicType>
<Id>productspecificconfigurationlayout</Id>
<Name>Product Specific Configuration Layout</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>module1</ID>
<name>Module 1</name>
<description>Expansion module to use with device.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>7914 14-Button Line Expansion Module</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>7915 12-Button Line Expansion Module</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>7915 24-Button Line Expansion Module</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>7916 12-Button Line Expansion Module</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>7916 24-Button Line Expansion Module</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>CKEM 36-Button Line Expansion Module</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProductSpecCharacteristicType>
<Id>expansionmoduleinformation</Id>
<Name>Expansion Module Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>module2</ID>
<name>Module 2</name>
<description>Expansion module to use with device.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>7914 14-Button Line Expansion Module</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>7915 12-Button Line Expansion Module</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>7915 24-Button Line Expansion Module</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>7916 12-Button Line Expansion Module</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>7916 24-Button Line Expansion Module</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>CKEM 36-Button Line Expansion Module</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProductSpecCharacteristicType>
<Id>expansionmoduleinformation</Id>
<Name>Expansion Module Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>module1loadname</ID>
<name>Module 1 Load Name</name>
<description>Expansion module 1 load name.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<maxLength>32</maxLength>
<regexPattern>[a-zA-Z0-9\\_\\.\\-]*</regexPattern>
<ProductSpecCharacteristicType>
<Id>expansionmoduleinformation</Id>
<Name>Expansion Module Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>module2loadname</ID>
<name>Module 2 Load Name</name>
<description>Expansion module 2 load name.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<regexPattern>[a-zA-Z0-9\\_\\.\\-]*</regexPattern>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>7914 14-Button Line Expansion Module</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>7915 12-Button Line Expansion Module</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>7915 24-Button Line Expansion Module</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>7916 12-Button Line Expansion Module</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>7916 24-Button Line Expansion Module</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<valueType>Static</valueType>
<value>CKEM 36-Button Line Expansion Module</value>
</ProdSpecCharacteristicEnumeratedBy>
<ProductSpecCharacteristicType>
<Id>expansionmoduleinformation</Id>
<Name>Expansion Module Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>information</ID>
<name>Information URL</name>
<description>URL of the help text that appears on the phone.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<maxLength>255</maxLength>
<ProductSpecCharacteristicType>
<Id>externaldatalocationsinformation</Id>
<Name>External Data Locations Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>directory</ID>
<name>Directory Server URL</name>
<description>URL of the server from which the phone obtains directory information.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<maxLength>255</maxLength>
<ProductSpecCharacteristicType>
<Id>externaldatalocationsinformation</Id>
<Name>External Data Locations Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>messages</ID>
<name>Messages URL</name>
<description>URL of the server from which the phone obtains message services.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<maxLength>255</maxLength>
<ProductSpecCharacteristicType>
<Id>externaldatalocationsinformation</Id>
<Name>External Data Locations Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>proxyserver</ID>
<name>Proxy Server URL</name>
<description>URL used to proxy HTTP requests for access to non-local host addresses from the phone HTTP client.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<maxLength>255</maxLength>
<ProductSpecCharacteristicType>
<Id>externaldatalocationsinformation</Id>
<Name>External Data Locations Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>servicesURL</ID>
<name>Services URL</name>
<description>URL for Cisco IP Phone Services.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<maxLength>255</maxLength>
<ProductSpecCharacteristicType>
<Id>externaldatalocationsinformation</Id>
<Name>External Data Locations Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>authenticationserver</ID>
<name>Authentication Server URL</name>
<description>The URL that the phone uses to validate requests that are made to the phone web server.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<maxLength>90</maxLength>
<ProductSpecCharacteristicType>
<Id>externaldatalocationsinformation</Id>
<Name>External Data Locations Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>idle</ID>
<name>Idle URL</name>
<description>URL that the phone displays when the phone has not been used for the time specified in the Idle URL timer.</description>
<isKey>false</isKey>
<valueType>STRING</valueType>
<minCardinality>0</minCardinality>
<maxLength>255</maxLength>
<ProductSpecCharacteristicType>
<Id>externaldatalocationsinformation</Id>
<Name>External Data Locations Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>idletimer</ID>
<name>Idle Timer</name>
<description>Amount of time in seconds that elapses before the URL specified in the Idle URL option appears.</description>
<isKey>false</isKey>
<valueType>INTEGER</valueType>
<minCardinality>0</minCardinality>
<ProductSpecCharacteristicType>
<Id>externaldatalocationsinformation</Id>
<Name>External Data Locations Information</Name>
</ProductSpecCharacteristicType>
<ProductSpecCharResourceSpecRelationship>
<relationshipType>Supported</relationshipType>
<ResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
</ResourceSpecification>
</ProductSpecCharResourceSpecRelationship>
<maxCardinality>1</maxCardinality>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
<ProductSpecificationRelationship>
<type>KindOf</type>
<ProductSpecification>
<productId>Phone</productId>
</ProductSpecification>
</ProductSpecificationRelationship>
<ProductSpecificationType xsi:type="hcs:ProductCategory" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<type>TM</type>
</ProductSpecificationType>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CME70</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CME42</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CME80</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CME71</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CME41</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CME40</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM413</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM432</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM423</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM421</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM801</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
<SupportsProtocol>
<commonName>SIP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM802</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
<SupportsProtocol>
<commonName>SIP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM803</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
<SupportsProtocol>
<commonName>SIP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM715</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
<SupportsProtocol>
<commonName>SIP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM713</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
<SupportsProtocol>
<commonName>SIP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM712</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
<SupportsProtocol>
<commonName>SIP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM512</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
<SupportsProtocol>
<commonName>SIP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM612</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
<SupportsProtocol>
<commonName>SIP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM613</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
<SupportsProtocol>
<commonName>SIP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM610</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
<SupportsProtocol>
<commonName>SIP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM513</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
<SupportsProtocol>
<commonName>SIP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM702a</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
<SupportsProtocol>
<commonName>SIP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM600</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
<SupportsProtocol>
<commonName>SIP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM702</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
<SupportsProtocol>
<commonName>SIP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM614</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
<SupportsProtocol>
<commonName>SIP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<SupportedResourceSpecification xsi:type="hcs:LogicalResourceSpec" xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<objectID>CCM615</objectID>
<SupportsProtocol>
<commonName>SCCP</commonName>
</SupportsProtocol>
<SupportsProtocol>
<commonName>SIP</commonName>
</SupportsProtocol>
</SupportedResourceSpecification>
<productId>Cisco_7960</productId>
</ProductSpecification>
</catalog:GetProductSpecificationResponse>
The following is a sample XML code for the listDeviceSpecifications XML request.
<hcs:ListDeviceSpecificationsRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<Customer>
<partyRoleId>ABC</partyRoleId>
</Customer>
<objectID>CiscoRouter-IAD2432</objectID>
</hcs:ListDeviceSpecificationsRequest>
The following is a sample XML code for the listDeviceSpecifications XML response.
<?xml version="1.0" encoding="UTF-8"?>
<catalog:ListDeviceSpecificationsResponse xmlns:catalog="http://www.cisco.hcs.com/HCSProductCatalog.xsd">
<PhysicalDeviceSpecification>
<commonName>IAD2432</commonName>
<objectID>CiscoRouter-IAD2432</objectID>
<description>Cisco Router</description>
<ResourceSpecType>
<commonName>CiscoRouter</commonName>
</ResourceSpecType>
<LogicalPhysicalResourceSpec>
<LogicalResourceSpec>
<objectID>CME41</objectID>
</LogicalResourceSpec>
</LogicalPhysicalResourceSpec>
<LogicalPhysicalResourceSpec>
<LogicalResourceSpec>
<objectID>CME70</objectID>
</LogicalResourceSpec>
</LogicalPhysicalResourceSpec>
<LogicalPhysicalResourceSpec>
<LogicalResourceSpec>
<objectID>CME71</objectID>
</LogicalResourceSpec>
</LogicalPhysicalResourceSpec>
<LogicalPhysicalResourceSpec>
<LogicalResourceSpec>
<objectID>CME80</objectID>
</LogicalResourceSpec>
</LogicalPhysicalResourceSpec>
<LogicalPhysicalResourceSpec>
<LogicalResourceSpec>
<objectID>CME42</objectID>
</LogicalResourceSpec>
</LogicalPhysicalResourceSpec>
<LogicalPhysicalResourceSpec>
<LogicalResourceSpec>
<objectID>GenericIOSRouter</objectID>
</LogicalResourceSpec>
</LogicalPhysicalResourceSpec>
</PhysicalDeviceSpecification>
</catalog:ListDeviceSpecificationsResponse>
The following is a sample XML code for the listLogicalResourceSpecifications XML request.
<hcs:ListLogicalResourceSpecificationsRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<Customer>
<partyRoleId>ABC</partyRoleId>
</Customer>
<objectID>GenericIOSRouter</objectID>
</hcs:ListLogicalResourceSpecificationsRequest>
The following is a sample XML code for the listLogicalResourceSpecifications XML response.
<?xml version="1.0" encoding="UTF-8"?>
<catalog:ListLogicalResourceSpecificationsResponse xmlns:catalog="http://www.cisco.hcs.com/HCSProductCatalog.xsd">
<LogicalResourceSpec>
<commonName>GenericIOSRouter</commonName>
<objectID>GenericIOSRouter</objectID>
<description>Generic IOS Router</description>
<version/>
<ResourceSpecType>
<commonName>GenericIOSRouter</commonName>
</ResourceSpecType>
<SupportsProtocol>
<commonName>Telnet</commonName>
</SupportsProtocol>
<SupportsProtocol>
<commonName>SSHv1</commonName>
</SupportsProtocol>
<SupportsProtocol>
<commonName>SSHv2</commonName>
</SupportsProtocol>
</LogicalResourceSpec>
</catalog:ListLogicalResourceSpecificationsResponse>
The following is a sample XML code for the listProductCategories XML request.
<hcs:ListProductCategoriesRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<Customer>
<partyRoleId>ABC</partyRoleId>
</Customer>
<type>TM</type>
</hcs:ListProductCategoriesRequest>
The following is a sample XML code for the listProductCategories XML response.
<?xml version="1.0" encoding="UTF-8"?>
<catalog:ListProductCategoriesResponse xmlns:catalog="http://www.cisco.hcs.com/HCSProductCatalog.xsd">
<ProductCategory>
<type>TM</type>
<description>Unified Communications Subscriber Products</description>
</ProductCategory>
</catalog:ListProductCategoriesResponse>
The following is a sample XML code for the listProductSpecificationIds XML request.
<hcs:ListProductSpecificationIdsRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<Customer>
<partyRoleId>ABC</partyRoleId>
</Customer>
<parentProductId>Line</parentProductId>
<productCategoryType>TM</productCategoryType>
</hcs:ListProductSpecificationIdsRequest>
The following is a sample XML code for the listProductSpecificationIds XML response.
<?xml version="1.0" encoding="UTF-8"?>
<catalog:ListProductSpecificationIdsResponse xmlns:catalog="http://www.cisco.hcs.com/HCSProductCatalog.xsd">
<ProductIds>autoline</ProductIds>
<ProductIds>chosenline</ProductIds>
</catalog:ListProductSpecificationIdsResponse>
The following is a sample XML code for the listProductSpecCharacteristicValues XML request.
<hcs:ListProductSpecCharacteristicValuesRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<Customer>
<partyRoleId>ABC</partyRoleId>
</Customer>
<ProductSpecification>
<productId>IC_CTIRoutePoint</productId>
</ProductSpecification>
<ProductSpecCharacteristicIds>IC_devicePoolName</ProductSpecCharacteristicIds>
<FilterCriteria>
<deviceName>ABC-dxDevice-01</deviceName>
<capabilityName>CiscoUnifiedCM</capabilityName>
</FilterCriteria>
</hcs:ListProductSpecCharacteristicValuesRequest>
The following is a sample XML code for the listProductSpecCharacteristicValues XML response.
Expected Result
<?xml version="1.0" encoding="UTF-8"?>
<catalog:ListProductSpecCharacteristicValuesResponse xmlns:catalog="http://www.cisco.hcs.com/HCSProductCatalog.xsd">
<CorrelationId>ABC_498</CorrelationId>
</catalog:ListProductSpecCharacteristicValuesResponse>
Expected Value
<?xml version="1.0" encoding="UTF-8"?>
<order:listProductAttributeChoiceRequest xmlns:order="http://cupm.cucms.cisco.com/v1.0/Order">
<order:product>
<order:productID>IC_CTIRoutePoint</order:productID>
</order:product>
<order:attributes>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">IC_devicePoolName</co-v1-3:item>
</order:attributes>
<order:filter>
<cmn:objectSelectionCriteria xmlns:cmn="http://cupm.cucms.cisco.com/v1.0/Common">
<cmn:selectionCriteria>
<cmn:item>
<cmn:attributeName>capabilityName</cmn:attributeName>
<cmn:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">CiscoUnifiedCM</co-v1-3:item>
</cmn:attributeValue>
</cmn:item>
<cmn:item>
<cmn:attributeName>deviceName</cmn:attributeName>
<cmn:attributeValue>
<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">ABC-dxDevice-01</co-v1-3:item>
</cmn:attributeValue>
</cmn:item>
</cmn:selectionCriteria>
</cmn:objectSelectionCriteria>
</order:filter>
<order:epr>
<tns:Address xmlns:tns="http://www.w3.org/2005/08/addressing">http://localhost:18090/AsyncNotification/services/NotificationConsumerService</tns:Address>
</order:epr>
<order:idPrefix>ABC_</order:idPrefix>
</order:listProductAttributeChoiceRequest>