Sample XML API Requests and Responses · B-1 Programmer Guide for the Cisco Hosted Collaboration...

Programmer Guide for the CisOL-23809-01

A
P P E N D I X B Sample XML API Requests and Responses
This appendix contains sample XML API requests and responses. It includes the following sections:

• Sample ProvisionCustomer Data Service XML API Requests and Responses, page B-1

• Sample ProvisionInfrastructure Data Service XML API Requests and Responses, page B-7

• Sample ProvisionSite Data Service XML API Requests and Responses, page B-29

• Sample ProvisionSubscriber Data Service XML API Requests and Responses, page B-43

• Sample ProvisionResults Data Service XML API Requests and Responses, page B-59

• Sample ProductCatalog Data Service XML API Requests and Responses, page B-62

Sample ProvisionCustomer 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, page B-2

• Sample createCustomer XML Response, page B-2

• Sample updateCustomer XML Request, page B-3

• Sample updateCustomer XML Response, page B-4

• Sample syncCustomer XML Request, page B-5

• Sample syncCustomer XML Response, page B-5

• Sample deleteCustomer XML Request, page B-5

• Sample deleteCustomer XML Response, page B-6

• Sample listCustomer XML Request, page B-6

• Sample listCustomer XML Response, page B-7

B-1co Hosted Collaboration Mediation Interface

Appendix B Sample XML API Requests and Responses Sample ProvisionCustomer Data Service XML API Requests and Responses

Sample createCustomer XML RequestThe 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>


<value>CACCM-210.117</value>



<name>CallProcessor</name>




<value>CACCMBE-4.238</value>



<name>UnifiedMessageProcessor</name>



</Customer>

</hcs:CreateCustomerRequest>

Sample createCustomer XML ResponseThe 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>

B-2Programmer Guide for the Cisco Hosted Collaboration Mediation Interface

OL-23809-01


<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>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">CACCM-210.117</co-v1-3:item>



</domain:item>

<domain:item>

<domain:domainPropertyName>UnifiedMessageProcessor</domain:domainPropertyName>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">CACCMBE-4.238</co-v1-3:item>



</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>

Sample updateCustomer XML RequestThe following is a sample XML code for the updateCustomer XML request.

<hcs:UpdateCustomerRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd">

<RequestHeader>


</RequestHeader>

<Customer>









OL-23809-01




<value>CAUTY-4.200</value>






</Customer>

</hcs:UpdateCustomerRequest>

Sample updateCustomer XML ResponseThe following is a sample XML code for the updateCustomer XML response.


<domain:updateDomainRequest xmlns:domain="http://cupm.cucms.cisco.com/v1.0/Domain">

<domain:domain>


<domain:domainProperties>

<domain:item>

<domain:domainPropertyName>CallProcessor</domain:domainPropertyName>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">CACCM-4.198</co-v1-3:item>



</domain:item>

<domain:item>

<domain:domainPropertyName>UnifiedMessageProcessor</domain:domainPropertyName>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">CAUTY-4.200</co-v1-3:item>



</domain:item>

</domain:domainProperties>

</domain:domain>

<domain:epr>


</domain:epr>


</domain:updateDomainRequest>


OL-23809-01


Sample syncCustomer XML RequestThe following is a sample XML code of the syncCustomer XML request.

<hcs:SyncCustomerRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd">

<RequestHeader>


</RequestHeader>

<Customer>


</Customer>

</hcs:SyncCustomerRequest>

Sample syncCustomer XML ResponseThe 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:domain>

<domain:epr>


</domain:epr>


</domain:syncDomainRequest>

Sample deleteCustomer XML RequestThe following is a sample XML code of the deleteCustomer XML request.

<hcs:DeleteCustomerRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd">

<RequestHeader>


</RequestHeader>

<Customer>



OL-23809-01


</Customer>

</hcs:DeleteCustomerRequest>

Sample deleteCustomer XML ResponseThe following is a sample XML code of the deleteCustomer XML response.


<prov:DeleteCustomerResponse xmlns:prov="http://www.cisco.hcs.com/HCSProvision.xsd">


</prov:DeleteCustomerResponse>


<domain:deleteDomainRequest xmlns:domain="http://cupm.cucms.cisco.com/v1.0/Domain">

<domain:domain>


</domain:domain>

<domain:epr>


</domain:epr>


</domain:deleteDomainRequest>

Sample listCustomer XML RequestThe following is a sample XML code of the listCustomer XML request.

<hcs:ListCustomerRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd">









<RequestHeader>


</RequestHeader>

<Customer>


</Customer>

</hcs:ListCustomerRequest>


OL-23809-01

Appendix B Sample XML API Requests and Responses Sample ProvisionInfrastructure Data Service XML API Requests and Responses

Sample listCustomer XML ResponseThe following is a sample XML code of the listCustomer XML response.


<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>


</domain:epr>


</domain:listDomainRequest>

Sample ProvisionInfrastructure Data Service XML API Requests and Responses

This section includes the following sample ProvisionInfrastructure data service XML API requests and responses:

• Sample createDevice XML Request, page B-8

• Sample createDevice XML Response, page B-10

• Sample updateDevice XML Request, page B-11

• Sample updateDevice XML Response, page B-12

• Sample syncDevice XML Request, page B-13

• Sample syncDevice XML Response, page B-13

• Sample deleteDevice XML Request, page B-14

• Sample deleteDevice XML Response, page B-14

• Sample submitTemplate XML Request, page B-15

• Sample submitTemplate XML Response, page B-16

• Sample submitInfrastructureOrder XML Request, page B-17

• Sample submitInfrastructureOrder XML Response, page B-20

• Sample submitSubscriberOrder XML Request, page B-22

• Sample submitSubscriberOrder XML Response, page B-24

• Sample listDevice XML Request, page B-26

• Sample listDevice XML Response, page B-27

• Sample listInfrastructureProduct Request, page B-27

• Sample listInfrastructureProduct Response, page B-28


OL-23809-01


Sample createDevice XML RequestThe following is a sample XML code for the createDevice XML request.


<hcs:CreateDeviceRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<RequestHeader>


</RequestHeader>

<PhysicalDevice>

<commonName>ABC-dxDevice-01</commonName>

<ResourceSpecification xsi:type="hcs:PhysicalDeviceSpecification">

<commonName>MediaServer</commonName>

</ResourceSpecification>

<PartyRole xsi:type="hcs:Customer">


</PartyRole>


<value>ABC</value>


<name>DeviceUsername</name>




<value>Secret</value>


<name>DevicePassword</name>




<value>True</value>


<name>EnablePassword</name>





<LogicalPhysicalResource>

<typeOfLPDependency>IpAddress</typeOfLPDependency>

<LogicalResource xsi:type="hcs:IPAddress">

<hostNumber>172.16.108.255</hostNumber>

</LogicalResource>

</LogicalPhysicalResource>





OL-23809-01


<typeOfLPDependency>Protocol</typeOfLPDependency>

<LogicalResource xsi:type="hcs:Protocol">

<commonName>None</commonName>

</LogicalResource>





<typeOfLPDependency>Capability</typeOfLPDependency>

<LogicalResource>

<commonName>CiscoUnifiedCM</commonName>

<SupportsProtocol>

<commonName>HTTPS</commonName>

</SupportsProtocol>


<value>cmadmin</value>


<name>CapabilityUsername</name>




<value>CMadmin10</value>


<name>CapabilityPassword</name>




<value>Synchronization</value>


<name>LDAPDirectoryIntegration</name>




<value>8.0(3)</value>


<name>Version</name>



</LogicalResource>


</PhysicalDevice>

</hcs:CreateDeviceRequest>


OL-23809-01


Sample createDevice XML ResponseThe following is a sample XML code for the createDevice XML response.


<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>


OL-23809-01


<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>


</device:epr>

<device:idPrefix>ABC_</device:idPrefix>

</device:createDeviceRequest>

Sample updateDevice XML RequestThe following is a sample XML code for the updateDevice XML request.


<hcs:UpdateDeviceRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<RequestHeader>


</RequestHeader>

<PhysicalDevice>


<ResourceSpecification xsi:type="hcs:PhysicalDeviceSpecification">

<commonName>MediaServer</commonName>




</PartyRole>


<value>ABC</value>


<name>DeviceUsername</name>




<value>Secret</value>


<name>DevicePassword</name>







OL-23809-01


<typeOfLPDependency>IpAddress</typeOfLPDependency>

<LogicalResource xsi:type="hcs:IPAddress">

<hostNumber>172.16.109.255</hostNumber>

</LogicalResource>


</PhysicalDevice>

</hcs:UpdateDeviceRequest>

Sample updateDevice XML ResponseThe following is a sample XML code for the updateDevice XML response.


<device:updateDeviceRequest xmlns:device="http://cupm.cucms.cisco.com/v1.0/Device">

<device:device>


<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>


</device:epr>


</device:updateDeviceRequest>


OL-23809-01


Sample syncDevice XML RequestThe 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>


</RequestHeader>

<SyncOption>PerformSync</SyncOption>

<SyncScope>Infrastructure</SyncScope>

<PhysicalDevice>

<commonName>HCS_Device_01</commonName>



</PartyRole>

</PhysicalDevice>

</hcs:SyncDeviceRequest>

Sample syncDevice XML ResponseThe following is a sample XML code for the syncDevice XML response.


<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>


</device:epr>


</device:syncDeviceRequest>


OL-23809-01


Sample deleteDevice XML RequestThe 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">







<RequestHeader>


</RequestHeader>

<PhysicalDevice>




</PartyRole>

</PhysicalDevice>

</hcs:DeleteDeviceRequest>

Sample deleteDevice XML ResponseThe following is a sample XML code for the deleteDevice XML response.


<device:deleteDeviceRequest xmlns:device="http://cupm.cucms.cisco.com/v1.0/Device">

<device:device>


</device:device>

<device:epr>


</device:epr>


</device:deleteDeviceRequest>


OL-23809-01


Sample submitTemplate XML RequestThe following is a sample XML code for the submitTemplate XML request.


<hcs:SubmitTemplateRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<RequestHeader>


</RequestHeader>



<TemplateName>UC_Template_01</TemplateName>

<SubmitOption>ValidateAndSubmit</SubmitOption>

<PhysicalDevice>

<commonName>CCM35</commonName>



</PartyRole>





<LogicalResource>


</LogicalResource>




<LogicalResource>

<commonName>CiscoUnifiedCME</commonName>

</LogicalResource>


</PhysicalDevice>



<KeywordCharacteristicValue>

<value>xFF003984</value>

<action>Add</action>


<name>Big Router</name>


</KeywordCharacteristicValue>

<KeywordCharacteristicValue>

<value>22222</value>

<action>Add</action>


<name>Keyword2</name>



OL-23809-01


</KeywordCharacteristicValue>

</hcs:SubmitTemplateRequest>

Sample submitTemplate XML ResponseThe following is a sample XML code for the submitTemplate XML response.


<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>


</order:epr>

<order:idPrefix>ABC_</order:idPrefix>

</order:submitConfigTemplateRequest>


OL-23809-01


Sample submitInfrastructureOrder XML RequestThe 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">







<RequestHeader>


</RequestHeader>


<ProductOrder>



<BusinessInteractionInvolves xsi:type="hcs:PartyInteractionRole">

<interactionRole>Customer</interactionRole>

<PartyInteractionRoleIdentifiedBy xsi:type="hcs:Customer">


</PartyInteractionRoleIdentifiedBy>

</BusinessInteractionInvolves>



<BusinessInteractionType>

<name>Add</name>

</BusinessInteractionType>



<CustomerOrderComprisedOf>

<orderItemNumber>1</orderItemNumber>



<BusinessInteractionItemInvolvesProduct>

<ProductSpecification>

<productId>IC_CommonDeviceConfig</productId>

</ProductSpecification>



<ProductCharacteristicValue>

<ProdSpecCharDescribesProdCharacteristicValue>

<ID>IC_name</ID>

<isKey>false</isKey>

</ProdSpecCharDescribesProdCharacteristicValue>

<value>ART_CommonDeviceConfig</value>

</ProductCharacteristicValue>



OL-23809-01




<ID>IC_mlppDomainId</ID>



<value>0</value>





<ID>IC_mlppIndicationStatus</ID>



<value>On</value>





<ID>IC_networkHoldMOHAudioSourceId</ID>



<value>SampleAudioSource</value>





<ID>IC_preemption</ID>



<value>Default</value>





<ID>IC_softkeyTemplateName</ID>



<value>Standard Feature</value>





OL-23809-01



<ID>IC_userHoldMOHAudioSourceId</ID>



<value>SampleAudioSource</value>





<ID>IC_userLocale</ID>



<value>English United States</value>





<ID>IC_preemption</ID>







</BusinessInteractionItemInvolvesProduct>



<BusinessInteractionItemInvolvesResource xsi:type="hcs:PhysicalDevice">


OL-23809-01





<LogicalResource>


</LogicalResource>


</BusinessInteractionItemInvolvesResource>

</CustomerOrderComprisedOf>

</ProductOrder>

</hcs:SubmitInfrastructureOrderRequest>

Sample submitInfrastructureOrder XML ResponseThe following is a sample XML code for the submitInfrastructureOrder XML response.


<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>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">0</co-v1-3:item>


</order:item>

<order:item>

<order:attributeID>IC_mlppIndicationStatus</order:attributeID>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">On</co-v1-3:item>



OL-23809-01


</order:item>

<order:item>

<order:attributeID>IC_networkHoldMOHAudioSourceId</order:attributeID>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">SampleAudioSource</co-v1-3:item>


</order:item>

<order:item>

<order:attributeID>IC_preemption</order:attributeID>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Default</co-v1-3:item>


</order:item>

<order:item>

<order:attributeID>IC_softkeyTemplateName</order:attributeID>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Standard Feature</co-v1-3:item>


</order:item>

<order:item>

<order:attributeID>IC_userHoldMOHAudioSourceId</order:attributeID>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">SampleAudioSource</co-v1-3:item>


</order:item>

<order:item>

<order:attributeID>IC_userLocale</order:attributeID>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">English United States</co-v1-3:item>


</order:item>

<order:item>

<order:attributeID>IC_preemption</order:attributeID>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Default</co-v1-3:item>


</order:item>

</order:productAttribute>

<order:sequenceNumber>1</order:sequenceNumber>

</order:item>

</order:product>


OL-23809-01


<order:deviceName>ABC-dxDevice-01</order:deviceName>

<order:capabilityName>CiscoUnifiedCM</order:capabilityName>

</order:item>

</order:serviceDetail>

<order:orderType>Add</order:orderType>

</order:order>



<order:epr>


</order:epr>


</order:submitOrderRequest>

Sample submitSubscriberOrder XML RequestThe 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">



<RequestHeader>


</RequestHeader>


<ProductOrder>












<name>Add</name>







<BusinessInteractionItemInvolves xsi:type="hcs:PartyInteractionRole">

<interactionRole>Subscriber</interactionRole>

<PartyInteractionRoleIdentifiedBy xsi:type="hcs:Subscriber">

<partyRoleId>ABC-Subscriber-01</partyRoleId>


OL-23809-01



</BusinessInteractionItemInvolves>





<productId>Phone</productId>




<ProductLocatedVia xsi:type="hcs:GeographicSite">

<ID>ABC</ID>

</ProductLocatedVia>




<ID>macaddress</ID>



<value>DDDD0505EEEE</value>





<ID>usedummymacaddress</ID>



<value>False</value>





<ID>devicepool</ID>



<value>ABC</value>





<ID>type</ID>



<value>Cisco 7970</value>






OL-23809-01


<ID>protocol</ID>



<value>SCCP</value>





<ID>pbt</ID>



<value>Standard 7970 SCCP</value>





<ID>devicelocation</ID>



<value>ABC</value>




</ProductOrder>

</hcs:SubmitSubscriberOrderRequest>

Sample submitSubscriberOrder XML ResponseThe following is a sample XML code for the submitSubscriberOrder XML response.



<order:order>


<order:item>

<order:product>

<order:item>

<order:productID>Phone</order:productID>


<order:item>

<order:attributeID>macaddress</order:attributeID>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">DDDD0505EEEE</co-v1-3:item>


</order:item>


OL-23809-01


<order:item>

<order:attributeID>usedummymacaddress</order:attributeID>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">False</co-v1-3:item>


</order:item>

<order:item>

<order:attributeID>devicepool</order:attributeID>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">ABC</co-v1-3:item>


</order:item>

<order:item>

<order:attributeID>type</order:attributeID>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Cisco 7970</co-v1-3:item>


</order:item>

<order:item>

<order:attributeID>protocol</order:attributeID>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">SCCP</co-v1-3:item>


</order:item>

<order:item>

<order:attributeID>pbt</order:attributeID>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Standard 7970 SCCP</co-v1-3:item>


</order:item>

<order:item>

<order:attributeID>devicelocation</order:attributeID>




</order:item>



</order:item>

</order:product>

<order:serviceAreaID>ABC</order:serviceAreaID>


OL-23809-01


<order:subscriberID>ABC-Subscriber-01</order:subscriberID>

<order:domainID>ABC</order:domainID>

</order:item>



</order:order>



<order:epr>


</order:epr>



Sample listDevice XML RequestThe 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">









<RequestHeader>


</RequestHeader>

<PhysicalDevice>



</PartyRole>


<value>ABC-dxDevice-01</value>


<name>deviceName</name>



</PhysicalDevice>

</hcs:ListDeviceRequest>


OL-23809-01


Sample listDevice XML ResponseThe following is a sample XML code for the listDevice XML response.


<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>




</device:filter>

<device:epr>


</device:epr>


</device:listDeviceRequest>

Sample listInfrastructureProduct RequestThe 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>


</RequestHeader>

<Product>



<ProductOfInterestTo xsi:type="hcs:PartyRoleProductInvolvement">

<productInvolvementRole>Customer</productInvolvementRole>



OL-23809-01



</PartyRole>

</ProductOfInterestTo>




<value>ravmaderasip7912</value>


<name>subscriberID</name>



</Product>

</hcs:ListInfrastructureProductRequest>

Sample listInfrastructureProduct ResponseThe following is a sample XML code for the listInfrastructureProduct XML response.


<device:listConfiguredInfraProductRequest xmlns:device="http://cupm.cucms.cisco.com/v1.0/Device">

<device:filter>



<cmn:item>

<cmn:attributeName>subscriberID</cmn:attributeName>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">ravmaderasip7912</co-v1-3:item>


</cmn:item>






</device:filter>

<device:epr>


</device:epr>


</device:listConfiguredInfraProductRequest>


OL-23809-01

Appendix B Sample XML API Requests and Responses Sample ProvisionSite Data Service XML API Requests and Responses

Sample ProvisionSite Data Service XML API Requests and Responses

This section includes the following sample ProvisionSite data service XML API requests and responses:

• Sample createSite XML Request, page B-29

• Sample createSite XML Response, page B-33

• Sample updateSite XML Request, page B-35

• Sample updateSite XML Response, page B-38

• Sample deleteSite XML Request, page B-40

• Sample deleteSite XML Response, page B-41

• Sample listSite XML Request, page B-41

• Sample listSite XML Response, page B-42

Sample createSite XML RequestThe following is a sample XML code for the createSite XML request.


<hcs:CreateSiteRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">







<RequestHeader>


</RequestHeader>

<GeographicSite>

<ID>HCS_Site_East</ID>



<PlacePartyRoleAssoc>

<placeRole>Customer</placeRole>



</PartyRole>

</PlacePartyRoleAssoc>




<placeRole>OrganizationPost</placeRole>

<PartyRole xsi:type="hcs:OrganizationPost">

<jobTitle>Executive</jobTitle>

</PartyRole>



OL-23809-01







<jobTitle>Manager</jobTitle>

</PartyRole>




<PlaceResourceAssoc>

<placeRole>CallProcessor</placeRole>

<Resource xsi:type="hcs:LogicalDevice">


<value>CallProcessor-1</value>


<name>callProcessorName</name>






<value>ABC_CDevCFG</value>


<name>commonDeviceConfig</name>




<value>ABC</value>


<name>location</name>




<value>ABC_Part_International</value>



OL-23809-01


<name>routePartition</name>




<value>ABC</value>


<name>devicePool</name>





</Resource>

</PlaceResourceAssoc>




<placeRole>UnifiedMessageProcessor</placeRole>



<value>UnifiedMessageProcessor-1</value>


<name>unifiedMessageProcessorName</name>



</Resource>





<modifier>Create</modifier>

<placeRole>DirectoryNumberBlock</placeRole>

<Resource xsi:type="hcs:LogicalResource">


<value>10</value>


<name>firstNumber</name>




<value>20</value>



OL-23809-01


<name>lastNumber</name>




<value>100</value>


<name>minLength</name>




<value>NEED VALID VALUES !!!</value>


<name>name</name>




<value>NEED VALUID VALUES !!!</value>


<name>prefix</name>



</Resource>





<modifier>Create</modifier>

<placeRole>DirectoryNumberBlock</placeRole>

<Resource xsi:type="hcs:LogicalResource">


<value>20</value>


<name>firstNumber</name>




<value>200</value>


<name>lastNumber</name>




<value>1000</value>


<name>minLength</name>



OL-23809-01




<value>NEED VALID VALUES !!!</value>


<name>name</name>




<value>NEED VALUID VALUES !!!</value>


<name>prefix</name>



</Resource>


</GeographicSite>

</hcs:CreateSiteRequest>

Sample createSite XML ResponseThe following is a sample XML code for the createSite XML response.


<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>


OL-23809-01



</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:item>

<sa:item>

<sa:dnPropertyName>minLength</sa:dnPropertyName>


</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:item>

<sa:item>

<sa:dnPropertyName>lastNumber</sa:dnPropertyName>


</sa:item>

<sa:item>

<sa:dnPropertyName>minLength</sa:dnPropertyName>


</sa:item>

<sa:item>


OL-23809-01


<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>


</sa:epr>

<sa:idPrefix>ABC_</sa:idPrefix>

</sa:createServiceAreaRequest>

Sample updateSite XML RequestThe following is a sample XML code for the updateSite XML request.


<hcs:UpdateSiteRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">







<RequestHeader>


</RequestHeader>

<GeographicSite>

<ID>ABC</ID>




OL-23809-01






</PartyRole>







<jobTitle>Executive</jobTitle>

</PartyRole>







<jobTitle>Manager</jobTitle>

</PartyRole>





<placeRole>CallProcessor</placeRole>





<name>callProcessorName</name>






<value>ABC</value>


<name>callSearchSpacePhone</name>






<value>ABC</value>


<name>callSearchSpaceLine</name>







OL-23809-01


<value>ABC_CommonDevCfg</value>


<name>commonDeviceConfig</name>






<value>ABC</value>








<value>ABC_Part_International</value>


<name>routePartition</name>






<value>ABC</value>


<name>devicePool</name>






<value>SCCP</value>


<name>phoneProtocol</name>



</Resource>





<placeRole>UnifiedMessageProcessor</placeRole>



<value>CAUTY-4.200</value>


<name>unifiedMessageProcessorName</name>






OL-23809-01



<value>SubscriberTemplate3</value>


<name>subscriberTemplateWithTTSDisabled</name>






<value>CoS with UM</value>


<name>cosWithTTSEnabled</name>






<value>{Default Subscriber}</value>


<name>cosWithTTSDisabled</name>



</Resource>


</GeographicSite>

</hcs:UpdateSiteRequest>

Sample updateSite XML ResponseThe following is a sample XML code for the updateSite XML response.


<sa:updateServiceAreaRequest xmlns:sa="http://cupm.cucms.cisco.com/v1.0/ServiceArea">

<sa:serviceArea>

<sa:serviceAreaID>ABC</sa:serviceAreaID>


<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:item>

<sa:item>

<sa:cpPropertyName>callSearchSpaceLine</sa:cpPropertyName>


OL-23809-01



</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: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: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>


OL-23809-01


<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>


</sa:epr>


</sa:updateServiceAreaRequest>

Sample deleteSite XML RequestThe 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">







<RequestHeader>


</RequestHeader>

<GeographicSite>

<ID>ABC-CT</ID>







</PartyRole>


</GeographicSite>

</hcs:DeleteSiteRequest>


OL-23809-01


Sample deleteSite XML ResponseThe following is a sample XML code for the deleteSite XML response.


<sa:deleteServiceAreaRequest xmlns:sa="http://cupm.cucms.cisco.com/v1.0/ServiceArea">

<sa:serviceArea>

<sa:serviceAreaID>ABC-CT</sa:serviceAreaID>


</sa:serviceArea>

<sa:epr>


</sa:epr>


</sa:deleteServiceAreaRequest>

Sample listSite XML RequestThe following is a sample XML code for the listSite XML request.


<hcs:ListSiteRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">









<RequestHeader>


</RequestHeader>

<GeographicSite>

<ID>ABC</ID>







</PartyRole>





<value>ABC</value>


OL-23809-01






</GeographicSite>

</hcs:ListSiteRequest>

Sample listSite XML ResponseThe following is a sample XML code for the listSite XML response.


<sa:listServiceAreaRequest xmlns:sa="http://cupm.cucms.cisco.com/v1.0/ServiceArea">

<sa:filter>



<cmn:item>

<cmn:attributeName>location</cmn:attributeName>




</cmn:item>






</sa:filter>

<sa:epr>


</sa:epr>


</sa:listServiceAreaRequest>


OL-23809-01

Appendix B Sample XML API Requests and Responses Sample ProvisionSubscriber Data Service XML API Requests and Responses

Sample ProvisionSubscriber Data Service XML API Requests and Responses

This section includes the following sample ProvisionSubscriber data service XML API requests and responses:

• Sample createSubscriber XML Request, page B-43

• Sample createSubscriber XML Response, page B-45

• Sample updateSubscriber XML Request, page B-46

• Sample updateSubscriber XML Response, page B-47

• Sample deleteSubscriber XML Request, page B-49

• Sample deleteSubscriber XML Response, page B-49

• Sample submitSubscriberOrder XML Request, page B-50

• Sample submitSubscriberOrder XML Response, page B-52

• Sample listSubscriber XML Request, page B-54

• Sample listSubscriber XML Response, page B-55

• Sample listOrder XML Request, page B-55

• Sample listOrder XML Response, page B-56

• Sample listSubscriberProduct XML Request, page B-57

• Sample listSubscriberProduct XML Response, page B-58

Sample createSubscriber XML RequestThe following is a sample XML code for the createSubscriber XML request.


<hcs:CreateSubscriberRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">







<RequestHeader>


</RequestHeader>

<Subscriber>




<PartyRoleAssociation>

<associationType>Customer</associationType>



OL-23809-01



</PartyRole>

</PartyRoleAssociation>



<Party xsi:type="hcs:Individual">

<IndividualINamedUsing>

<familyNames>Collins</familyNames>

<givenNames>Jeffrey</givenNames>

</IndividualINamedUsing>

</Party>




<associationType>OrganizationPost</associationType>


<jobTitle>Senior Manager</jobTitle>

</PartyRole>







<jobTitle>Contractor</jobTitle>

</PartyRole>





<value>Engineering</value>


<name>Department</name>





<PartyRoleContactableVia xsi:type="hcs:EmailContact">

<eMailAddress>[email protected]</eMailAddress>

</PartyRoleContactableVia>

<PartyRoleContactableVia xsi:type="hcs:TelephoneNumber">

<number>678-111-1234</number>


</Subscriber>

</hcs:CreateSubscriberRequest>


OL-23809-01


Sample createSubscriber XML ResponseThe following is a sample XML code for the createSubscriber XML response.


<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>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">[email protected]</co-v1-3:item>


</sub:item>

<sub:item>

<sub:subscriberPropertyName>phone</sub:subscriberPropertyName>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">678-111-1234</co-v1-3:item>


</sub:item>

<sub:item>

<sub:subscriberPropertyName>firstName</sub:subscriberPropertyName>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Jeffrey</co-v1-3:item>


</sub:item>

<sub:item>

<sub:subscriberPropertyName>department</sub:subscriberPropertyName>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Engineering</co-v1-3:item>


</sub:item>


OL-23809-01


</sub:subscriberProperties>

</sub:subscriber>

<sub:epr>


</sub:epr>

<sub:idPrefix>ABC_</sub:idPrefix>

</sub:createSubscriberRequest>

Sample updateSubscriber XML RequestThe following is a sample XML code for the updateSubscriber XML request.


<hcs:UpdateSubscriberRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<RequestHeader>


</RequestHeader>

<Subscriber>








</PartyRole>




<Party xsi:type="hcs:Individual">

<IndividualINamedUsing>

<familyNames>Wang</familyNames>

<givenNames>Jeffrey</givenNames>

</IndividualINamedUsing>

</Party>






<jobTitle>Senior Manager</jobTitle>

</PartyRole>



OL-23809-01







<jobTitle>Contractor</jobTitle>

</PartyRole>





<value>Engineering</value>


<name>Department</name>





<PartyRoleContactableVia xsi:type="hcs:EmailContact">

<eMailAddress>[email protected]</eMailAddress>


<PartyRoleContactableVia xsi:type="hcs:TelephoneNumber">

<number>678-111-5678</number>


</Subscriber>

</hcs:UpdateSubscriberRequest>

Sample updateSubscriber XML ResponseThe following is a sample XML code for the updateSubscriber XML response.


<sub:updateSubscriberRequest xmlns:sub="http://cupm.cucms.cisco.com/v1.0/Subscriber">

<sub:subscriber>



<sub:lastName>Wang</sub:lastName>

<sub:subscriberProperties>

<sub:item>

<sub:subscriberPropertyName>subscriberRoles</sub:subscriberPropertyName>


<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:item>

<sub:item>


OL-23809-01


<sub:subscriberPropertyName>email</sub:subscriberPropertyName>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">[email protected]</co-v1-3:item>


</sub:item>

<sub:item>

<sub:subscriberPropertyName>phone</sub:subscriberPropertyName>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">678-111-5678</co-v1-3:item>


</sub:item>

<sub:item>

<sub:subscriberPropertyName>firstName</sub:subscriberPropertyName>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Jeffrey</co-v1-3:item>


</sub:item>

<sub:item>

<sub:subscriberPropertyName>department</sub:subscriberPropertyName>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Engineering</co-v1-3:item>


</sub:item>

</sub:subscriberProperties>

</sub:subscriber>

<sub:epr>


</sub:epr>


</sub:updateSubscriberRequest>


OL-23809-01


Sample deleteSubscriber XML RequestThe following is a sample XML code for the deleteSubscriber XML request.


<hcs:DeleteSubscriberRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">







<RequestHeader>


</RequestHeader>

<Subscriber>








</PartyRole>


</Subscriber>

</hcs:DeleteSubscriberRequest>

Sample deleteSubscriber XML ResponseThe following is a sample XML code for the deleteSubscriber XML response.


<sub:deleteSubscriberRequest xmlns:sub="http://cupm.cucms.cisco.com/v1.0/Subscriber">

<sub:subscriber>



<sub:subscriberProperties/>

</sub:subscriber>

<sub:epr>


</sub:epr>


</sub:deleteSubscriberRequest>


OL-23809-01


Sample submitSubscriberOrder XML RequestThe 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">



<RequestHeader>


</RequestHeader>


<ProductOrder>












<name>Add</name>







<BusinessInteractionItemInvolves xsi:type="hcs:PartyInteractionRole">

<interactionRole>Subscriber</interactionRole>

<PartyInteractionRoleIdentifiedBy xsi:type="hcs:Subscriber">



</BusinessInteractionItemInvolves>









<ProductLocatedVia xsi:type="hcs:GeographicSite">

<ID>ABC</ID>

</ProductLocatedVia>




<ID>macaddress</ID>



OL-23809-01



<value>DDDD0505EEEE</value>













<ID>devicepool</ID>



<value>ABC</value>





<ID>type</ID>



<value>Cisco 7970</value>





<ID>protocol</ID>



<value>SCCP</value>





<ID>pbt</ID>



<value>Standard 7970 SCCP</value>






OL-23809-01


<ID>devicelocation</ID>



<value>ABC</value>




</ProductOrder>

</hcs:SubmitSubscriberOrderRequest>

Sample submitSubscriberOrder XML ResponseThe following is a sample XML code for the submitSubscriberOrder XML response.



<order:order>


<order:item>

<order:product>

<order:item>

<order:productID>Phone</order:productID>


<order:item>

<order:attributeID>macaddress</order:attributeID>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">DDDD0505EEEE</co-v1-3:item>


</order:item>

<order:item>

<order:attributeID>usedummymacaddress</order:attributeID>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">False</co-v1-3:item>


</order:item>

<order:item>

<order:attributeID>devicepool</order:attributeID>




</order:item>

<order:item>

<order:attributeID>type</order:attributeID>



OL-23809-01


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Cisco 7970</co-v1-3:item>


</order:item>

<order:item>

<order:attributeID>protocol</order:attributeID>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">SCCP</co-v1-3:item>


</order:item>

<order:item>

<order:attributeID>pbt</order:attributeID>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">Standard 7970 SCCP</co-v1-3:item>


</order:item>

<order:item>

<order:attributeID>devicelocation</order:attributeID>




</order:item>



</order:item>

</order:product>

<order:serviceAreaID>ABC</order:serviceAreaID>

<order:subscriberID>ABC-Subscriber-01</order:subscriberID>

<order:domainID>ABC</order:domainID>

</order:item>



</order:order>



<order:epr>


</order:epr>




OL-23809-01


Sample listSubscriber XML RequestThe following is a sample XML code for the listSubscriber XML request.


<hcs:ListSubscriberRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">









<RequestHeader>


</RequestHeader>

<Subscriber>







</PartyRole>




</Subscriber>

</hcs:ListSubscriberRequest>


OL-23809-01


Sample listSubscriber XML ResponseThe following is a sample XML code for the listSubscriber XML response.


<prov:ListSubscriberResponse xmlns:prov="http://www.cisco.hcs.com/HCSProvision.xsd">


</prov:ListSubscriberResponse>


<sub:listSubscriberRequest xmlns:sub="http://cupm.cucms.cisco.com/v1.0/Subscriber">

<sub:filter>




</sub:filter>

<sub:epr>


</sub:epr>


</sub:listSubscriberRequest>

Sample listOrder XML RequestThe following is a sample XML code for the listOrder XML request.


<hcs:ListOrderRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">








<RequestHeader>


</RequestHeader>

<ProductOrder>







OL-23809-01







<value>ABC-Subscriber-01</value>





</ProductOrder>

</hcs:ListOrderRequest>

Sample listOrder XML ResponseThe following is a sample XML code for the listOrder XML response.


<prov:ListOrderResponse xmlns:prov="http://www.cisco.hcs.com/HCSProvision.xsd">


</prov:ListOrderResponse>


<order:listOrderRequest xmlns:order="http://cupm.cucms.cisco.com/v1.0/Order">

<order:filter>



<cmn:item>



<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">ABC-Subscriber-01</co-v1-3:item>


</cmn:item>






</order:filter>

<order:epr>


OL-23809-01



</order:epr>


</order:listOrderRequest>

Sample listSubscriberProduct XML RequestThe 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>


</RequestHeader>

<Product>



<ProductOfInterestTo xsi:type="hcs:PartyRoleProductInvolvement">

<productInvolvementRole>Customer</productInvolvementRole>



</PartyRole>

</ProductOfInterestTo>




<value>ravmaderasip7912</value>





</Product>

</hcs:ListSubscriberProductRequest>


OL-23809-01


Sample listSubscriberProduct XML ResponseThe following is a sample XML code for the listSubscriberProduct XML response.


<sub:listSubscriberServiceRequest xmlns:sub="http://cupm.cucms.cisco.com/v1.0/Subscriber">

<sub:filter>



<cmn:item>



<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">ravmaderasip7912</co-v1-3:item>


</cmn:item>






</sub:filter>

<sub:epr>


</sub:epr>


</sub:listSubscriberServiceRequest>


OL-23809-01

Appendix B Sample XML API Requests and Responses Sample ProvisionResults Data Service XML API Requests and Responses

Sample ProvisionResults Data Service XML API Requests and Responses

This section includes the following sample ProvisionResults data service XML API requests and responses:

• Sample getListResults XML Request, page B-59

• Sample getListResults XML Response, page B-59

• Sample getStatus XML Request, page B-61

• Sample getStatus XML Response, page B-61

Sample getListResults XML RequestThe following is a sample XML code for the getListResults XML request.

<hcs:GetListResultsRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd">

<RequestHeader>


</RequestHeader>

<correlationId>ABC_1434</correlationId>

<maxResults>25</maxResults>

</hcs:GetListResultsRequest>

Sample getListResults XML ResponseThe following is a sample XML code for the getListResults XML response.


<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">


<value>CAUTY- 4.235-CiscoUnity</value>






<value>CACCM-4.198-CiscoUnifiedCM</value>






OL-23809-01


<partyRoleId>CA_DOMAIN</partyRoleId>

</Result>








<partyRoleId>LDAPCA_DOMAIN</partyRoleId>

</Result>


<partyRoleId>Site 1 Users</partyRoleId>

</Result>



<value>ABC Bank</value>


<name>DomainDescription</name>




<value>CAUTY-4.200-CiscoUnity</value>












</Result>

</prov:GetListResultsResponse>


<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>


OL-23809-01


<tns:MaxElements>25</tns:MaxElements>

</tns:Pull>

Sample getStatus XML RequestThe following is a sample XML code for the getStatus XML request.

<hcs:GetStatusRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd">

<RequestHeader>


</RequestHeader>


</hcs:GetStatusRequest>

Sample getStatus XML ResponseThe following is a sample XML code for the getStatus XML response.


<prov:GetStatusResponse xmlns:prov="http://www.cisco.hcs.com/HCSProvision.xsd">


<status>COMPLETED_SUCCESSFULLY</status>

<statusMessage>Domain Sync of ABC is 100% done. syncinProgress=false</statusMessage>

</prov:GetStatusResponse>


<cmn:getApiStatusRequest xmlns:cmn="http://cupm.cucms.cisco.com/v1.0/Common">

<cmn:apiID>ABC_1655</cmn:apiID>

<cmn:epr>


</cmn:epr>

<cmn:idPrefix>ABC_</cmn:idPrefix>

</cmn:getApiStatusRequest>


OL-23809-01

Appendix B Sample XML API Requests and Responses Sample ProductCatalog Data Service XML API Requests and Responses

Sample ProductCatalog Data Service XML API Requests and Responses

This section includes the following sample ProductCatalog data service XML API requests and responses:

• Sample getProductSpecification XML Request, page B-62

• Sample getProductSpecification XML Response, page B-62

• Sample listDeviceSpecifications XML Request, page B-91

• Sample listDeviceSpecifications XML Response, page B-92

• Sample listLogicalResourceSpecifications XML Request, page B-93

• Sample listLogicalResourceSpecifications XML Response, page B-93

• Sample listProductCategories XML Request, page B-94

• Sample listProductCategories XML Response, page B-94

• Sample listProductSpecificationIds XML Request, page B-94

• Sample listProductSpecificationIds XML Response, page B-95

• Sample listProductSpecCharacteristicValues XML Request, page B-95

• Sample listProductSpecCharacteristicValues XML Response, page B-95

Sample getProductSpecification XML RequestThe following is a sample XML code of the getProductSpecification XML request.

hcs:GetProductSpecificationRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd">

<RequestHeader>


</RequestHeader>

<Customer>


</Customer>

<productId>Cisco_7960</productId>

</hcs:GetProductSpecificationRequest>

Sample getProductSpecification XML ResponseThe following is a sample XML code for the getProductSpecification XML response.


<catalog:GetProductSpecificationResponse xmlns:catalog="http://www.cisco.hcs.com/HCSProductCatalog.xsd">


<name>Cisco 7960</name>

<ProductSpecCharUse>

<ProductSpecCharacteristic>


OL-23809-01


<ID>digestUser</ID>

<name>Digest User</name>

<description>Digest User.It supports only SIP Phone Types</description>


<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>


</ProductSpecCharResourceSpecRelationship>

<maxCardinality>1</maxCardinality>

</ProductSpecCharacteristic>

</ProductSpecCharUse>



<ID>rerouteCallingSearchSpaceName</ID>

<name>Rerouting Calling Search Space</name>

<description>Rerouting Calling Search Space used by the phone.</description>




<ProdSpecCharacteristicEnumeratedBy>

<valueType>Dynamic</valueType>

</ProdSpecCharacteristicEnumeratedBy>


<Id>protocolspecificinformation</Id>

<Name>Protocol Specific Information</Name>






<SupportsProtocol>


OL-23809-01



</SupportsProtocol>








<ID>doNotDisturb</ID>

<name>Do Not Disturb</name>

<description>To enable Do Not Disturb on the phone.</description>


<valueType>BOOLEAN</valueType>



<valueType>Static</valueType>

<value>True</value>







<Id>dndInformation</Id>

<Name>Do Not Disturb</Name>






<SupportsProtocol>

<commonName>SCCP</commonName>

</SupportsProtocol>








<ID>dndOption</ID>

<name>DND Option</name>


OL-23809-01


<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>






<value>Ringer Off</value>




<value>Call Reject</value>




<value>Ringer Off</value>




<value>Use Common Phone Profile Setting</value>




<value>Call Reject</value>



<Id>dndInformation</Id>

<Name>Do Not Disturb</Name>






<SupportsProtocol>


</SupportsProtocol>









OL-23809-01


<ID>emenable</ID>

<name>Enable Extension Mobility</name>

<description>Enable Extension Mobility</description>






<value>True</value>





<isDefault>true</isDefault>



<Id>coreattributes</Id>

<Name>Core Attributes</Name>














<name>Use Dummy MAC Address</name>

<description>Use Dummy MAC Address</description>






<value>True</value>







OL-23809-01

















<ID>macaddress</ID>

<name>MAC Address</name>

<description>MAC Address</description>

<isKey>true</isKey>



<regexPattern>[0-9a-fA-F]{12}</regexPattern>










<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>











OL-23809-01


<value>Off</value>




<value>On</value>



<Id>mlppinformation</Id>

<Name>MLPP Information</Name>













<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>






<value>Disabled</value>




<value>Forceful</value>







<Id>mlppinformation</Id>

<Name>MLPP Information</Name>



OL-23809-01













<ID>pbt</ID>

<name>Phone Button Template</name>

<description>Phone Button Template</description>


<ProductSpecCharRelationship>

<charRelationshipType>DependsOn</charRelationshipType>


<ID>type</ID>


</ProductSpecCharRelationship>





















<ID>nhas</ID>

<name>Network Hold Audio Source</name>


OL-23809-01


<description>The audio source that plays when the network initiates a hold action.</description>








<Id>deviceinformation</Id>

<Name>Device Information</Name>













<ID>aarcss</ID>

<name>AAR Calling Search Space</name>

<description>Automated alternate routing (AAR) calling search space.</description>



















OL-23809-01






<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>






<value>Arabic Kuwait</value>




<value>Arabic Oman</value>




<value>Arabic Saudi Arabia</value>




<value>Arabic United Arab Emirates</value>




<value>Bulgarian Bulgaria</value>




<value>Catalan Spain</value>




<value>Chinese China</value>




<value>Chinese Hong Kong</value>





OL-23809-01


<value>Chinese Taiwan</value>




<value>Croatian Croatia</value>




<value>Czech Czech Republic</value>




<value>Danish Denmark</value>




<value>Dutch Netherlands</value>




<value>English United Kingdom</value>




<value>English United States</value>




<value>Finnish Finland</value>




<value>French France</value>




<value>German Germany</value>




<value>Greek Greece</value>




<value>Hebrew Israel</value>



OL-23809-01




<value>Hungarian Hungary</value>




<value>Indonesian Indonesia</value>




<value>Italian Italy</value>




<value>Japanese Japan</value>




<value>Korean Korea Republic</value>




<value>Malay Malaysia</value>




<value>Norwegian Norway</value>




<value>Polish Poland</value>




<value>Portuguese Brazil</value>




<value>Portuguese Portugal</value>




<value>Romanian Romania</value>





OL-23809-01


<value>Russian Russian Federation</value>




<value>Serbian Republic of Montenegro</value>




<value>Serbian Republic of Serbia</value>




<value>Serbian Serbia and Montenegro</value>




<value>Slovak Slovakia</value>




<value>Slovenian Slovenia</value>




<value>Spanish Spain</value>




<value>Swedish Sweden</value>




<value>Thai Thailand</value>




<value>Turkish Turkey</value>




<value>Vietnamese Vietnam</value>




<value>Welsh United Kingdom</value>



OL-23809-01

















<ID>uhas</ID>

<name>User Hold Audio Source</name>

<description>The audio source that plays when a user initiates a hold action.</description>






















<ID>pcport</ID>

<name>PC Port</name>


OL-23809-01


<description>Indicates whether the PC port on the phone is enabled or disabled.</description>






<value>Enabled</value>







<Id>productspecificconfigurationlayout</Id>

<Name>Product Specific Configuration Layout</Name>













<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>















OL-23809-01















<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>




























OL-23809-01


<ID>module1</ID>

<name>Module 1</name>

<description>Expansion module to use with device.</description>






<value>7914 14-Button Line Expansion Module</value>




















<value>CKEM 36-Button Line Expansion Module</value>



<Id>expansionmoduleinformation</Id>

<Name>Expansion Module Information</Name>













OL-23809-01



<ID>module2</ID>

<name>Module 2</name>

<description>Expansion module to use with device.</description>










































OL-23809-01




<ID>module1loadname</ID>

<name>Module 1 Load Name</name>

<description>Expansion module 1 load name.</description>





<regexPattern>[a-zA-Z0-9\\_\\.\\-]*</regexPattern>
















<ID>module2loadname</ID>

<name>Module 2 Load Name</name>

<description>Expansion module 2 load name.</description>




<regexPattern>[a-zA-Z0-9\\_\\.\\-]*</regexPattern>














OL-23809-01





























<ID>information</ID>

<name>Information URL</name>

<description>URL of the help text that appears on the phone.</description>






<Id>externaldatalocationsinformation</Id>

<Name>External Data Locations Information</Name>








OL-23809-01








<ID>directory</ID>

<name>Directory Server URL</name>

<description>URL of the server from which the phone obtains directory information.</description>




















<ID>messages</ID>

<name>Messages URL</name>

<description>URL of the server from which the phone obtains message services.</description>












OL-23809-01











<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>




















<ID>servicesURL</ID>

<name>Services URL</name>

<description>URL for Cisco IP Phone Services.</description>










OL-23809-01













<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>




















<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>







OL-23809-01
















<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>


<valueType>INTEGER</valueType>















<ProductSpecificationRelationship>

<type>KindOf</type>




</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>


OL-23809-01


</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>


</SupportsProtocol>

</SupportedResourceSpecification>



<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>



OL-23809-01




<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>

<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>



OL-23809-01


</SupportsProtocol>

<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>

<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>

<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>

<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>

<SupportsProtocol>


</SupportsProtocol>


OL-23809-01





<SupportsProtocol>


</SupportsProtocol>

<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>

<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>

<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>

<SupportsProtocol>


</SupportsProtocol>




OL-23809-01



<SupportsProtocol>


</SupportsProtocol>

<SupportsProtocol>


</SupportsProtocol>



<objectID>CCM702a</objectID>

<SupportsProtocol>


</SupportsProtocol>

<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>

<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>

<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>


OL-23809-01


<SupportsProtocol>


</SupportsProtocol>




<SupportsProtocol>


</SupportsProtocol>

<SupportsProtocol>


</SupportsProtocol>


<productId>Cisco_7960</productId>


</catalog:GetProductSpecificationResponse>

Sample listDeviceSpecifications XML RequestThe following is a sample XML code for the listDeviceSpecifications XML request.

<hcs:ListDeviceSpecificationsRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd">

<RequestHeader>


</RequestHeader>

<Customer>


</Customer>

<objectID>CiscoRouter-IAD2432</objectID>

</hcs:ListDeviceSpecificationsRequest>


OL-23809-01


Sample listDeviceSpecifications XML ResponseThe following is a sample XML code for the listDeviceSpecifications XML response.


<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>


</LogicalResourceSpec>

</LogicalPhysicalResourceSpec>























<objectID>GenericIOSRouter</objectID>



</PhysicalDeviceSpecification>

</catalog:ListDeviceSpecificationsResponse>


OL-23809-01


Sample listLogicalResourceSpecifications XML RequestThe following is a sample XML code for the listLogicalResourceSpecifications XML request.

<hcs:ListLogicalResourceSpecificationsRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd">

<RequestHeader>


</RequestHeader>

<Customer>


</Customer>


</hcs:ListLogicalResourceSpecificationsRequest>

Sample listLogicalResourceSpecifications XML ResponseThe following is a sample XML code for the listLogicalResourceSpecifications XML response.


<catalog:ListLogicalResourceSpecificationsResponse xmlns:catalog="http://www.cisco.hcs.com/HCSProductCatalog.xsd">


<commonName>GenericIOSRouter</commonName>


<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>


</catalog:ListLogicalResourceSpecificationsResponse>


OL-23809-01


Sample listProductCategories XML RequestThe following is a sample XML code for the listProductCategories XML request.

<hcs:ListProductCategoriesRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd">

<RequestHeader>


</RequestHeader>

<Customer>


</Customer>

<type>TM</type>

</hcs:ListProductCategoriesRequest>

Sample listProductCategories XML ResponseThe following is a sample XML code for the listProductCategories XML response.


<catalog:ListProductCategoriesResponse xmlns:catalog="http://www.cisco.hcs.com/HCSProductCatalog.xsd">

<ProductCategory>

<type>TM</type>

<description>Unified Communications Subscriber Products</description>

</ProductCategory>

</catalog:ListProductCategoriesResponse>

Sample listProductSpecificationIds XML RequestThe following is a sample XML code for the listProductSpecificationIds XML request.

<hcs:ListProductSpecificationIdsRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd">

<RequestHeader>


</RequestHeader>

<Customer>


</Customer>

<parentProductId>Line</parentProductId>

<productCategoryType>TM</productCategoryType>

</hcs:ListProductSpecificationIdsRequest>


OL-23809-01


Sample listProductSpecificationIds XML ResponseThe following is a sample XML code for the listProductSpecificationIds XML response.


<catalog:ListProductSpecificationIdsResponse xmlns:catalog="http://www.cisco.hcs.com/HCSProductCatalog.xsd">

<ProductIds>autoline</ProductIds>

<ProductIds>chosenline</ProductIds>

</catalog:ListProductSpecificationIdsResponse>

Sample listProductSpecCharacteristicValues XML RequestThe following is a sample XML code for the listProductSpecCharacteristicValues XML request.

<hcs:ListProductSpecCharacteristicValuesRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProductCatalog.xsd">

<RequestHeader>


</RequestHeader>

<Customer>


</Customer>


<productId>IC_CTIRoutePoint</productId>


<ProductSpecCharacteristicIds>IC_devicePoolName</ProductSpecCharacteristicIds>

<FilterCriteria>

<deviceName>ABC-dxDevice-01</deviceName>

<capabilityName>CiscoUnifiedCM</capabilityName>

</FilterCriteria>

</hcs:ListProductSpecCharacteristicValuesRequest>

Sample listProductSpecCharacteristicValues XML ResponseThe following is a sample XML code for the listProductSpecCharacteristicValues XML response.


<catalog:ListProductSpecCharacteristicValuesResponse xmlns:catalog="http://www.cisco.hcs.com/HCSProductCatalog.xsd">


</catalog:ListProductSpecCharacteristicValuesResponse>


<order:listProductAttributeChoiceRequest xmlns:order="http://cupm.cucms.cisco.com/v1.0/Order">


OL-23809-01


<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:item>

<cmn:attributeName>capabilityName</cmn:attributeName>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">CiscoUnifiedCM</co-v1-3:item>


</cmn:item>

<cmn:item>

<cmn:attributeName>deviceName</cmn:attributeName>


<co-v1-3:item xmlns:co-v1-3="http://ossj.org/xml/Common/v1-3">ABC-dxDevice-01</co-v1-3:item>


</cmn:item>



</order:filter>

<order:epr>


</order:epr>


</order:listProductAttributeChoiceRequest>


OL-23809-01

Date post:	13-Mar-2020
Category:	Documents
Upload:	others
View:	21 times
Download:	0 times

Sample XML API Requests and Responses · B-1 Programmer Guide for the Cisco Hosted Collaboration...

Documents