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
•Sample ProvisionSite Data Service XML API Requests and Responses
•Sample ProvisionSubscriber Data Service XML API Requests and Responses
Sample ProvisionCustomer Data Service XML API Requests and Responses
For listCustomer, you have the option of retrieving the data of all customers or retrieving the data of only one customer.
Retrieving Data of All Customers
This section includes the following sample ProvisionCustomer data service XML API requests and responses to retrieve the data of all customers:
•Sample listCustomer XML Request
•Sample listCustomer XML Response
Sample listCustomer XML Request
<hcs:ListCustomerRequest xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd">
<!-- ***************** -->
<!-- List Customer: -->
<!-- CustomerID -->
<!-- ***************** -->
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<Customer>
<partyRoleId></partyRoleId>
</Customer>
</hcs:ListCustomerRequest>
Sample listCustomer XML Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<hcs:ListCustomerResponse>
<isSuccessful>true</isSuccessful>
<moreResults>false</moreResults>
<endsWithResultNumber>2</endsWithResultNumber>
<Customers>
<RootEntityDescribedBy>
<value>0</value>
<CharacteristicSpecification>
<name>InterSitePrefix</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<partyRoleId>Customer001</partyRoleId>
<PartyRoleContactableVia xsi:type="hcs:PostalContact" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<AbstractGeographicAddress xsi:type="hcs:UrbanPropertyAddress">
<country>USA</country>
</AbstractGeographicAddress>
</PartyRoleContactableVia>
</Customers>
<Customers>
<RootEntityDescribedBy>
<value>8</value>
<CharacteristicSpecification>
<name>InterSitePrefix</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>HWG_2</value>
<CharacteristicSpecification>
<name>HardwareGroupName</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<partyRoleId>Customer002</partyRoleId>
<PartyRoleContactableVia xsi:type="hcs:PostalContact" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<AbstractGeographicAddress xsi:type="hcs:UrbanPropertyAddress">
<country>USA</country>
<stateOrProvince>CA</stateOrProvince>
<streetAddress>123 Main Street</streetAddress>
<streetAddress>Suite 100</streetAddress>
<streetAddress>Attn: John</streetAddress>
<locality>Bedford</locality>
<postcode>998877</postcode>
</AbstractGeographicAddress>
</PartyRoleContactableVia>
<PartyRoleContactableVia xsi:type="hcs:EmailContact" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<eMailAddress>johndoe@customer002.com</eMailAddress>
</PartyRoleContactableVia>
<PartyRoleContactableVia xsi:type="hcs:TelephoneNumber" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<number>408 424 1234</number>
<type>Primary</type>
</PartyRoleContactableVia>
<PartyRoleAssociation>
<associationType>MainContact</associationType>
<PartyRole xsi:type="hcs:Contact" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Party xsi:type="hcs:Individual">
<IndividualINamedUsing>
<givenNames>John</givenNames>
<familyNames>Doe</familyNames>
</IndividualINamedUsing>
</Party>
</PartyRole>
</PartyRoleAssociation>
</Customers>
</hcs:ListCustomerResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Retrieving Data of One Customer
This section includes the following sample ProvisionCustomer data service XML API requests and responses to retrieve the data of only one customer:
•Sample listCustomer XML Request
•Sample listCustomer XML Response
Sample listCustomer XML Request
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>Customer002</partyRoleId>
<RootEntityDescribedBy>
<value>Customer002</value>
<CharacteristicSpecification>
<name>partyRoleId</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
</Customer>
</hcs:ListCustomerRequest>
Sample listCustomer XML Response
The following is a sample XML code of the listCustomer XML response.
<?xml version="1.0" encoding="UTF-8"?>
<prov:ListCustomerResponse xmlns:prov="http://www.cisco.hcs.com/HCSProvision.xsd">
<isSuccessful>true</isSuccessful>
<moreResults>false</moreResults>
<endsWithResultNumber>1</endsWithResultNumber>
<Customers>
<RootEntityDescribedBy>
<value>8</value>
<CharacteristicSpecification>
<name>InterSitePrefix</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>HWG_2</value>
<CharacteristicSpecification>
<name>HardwareGroupName</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<partyRoleId>Customer002</partyRoleId>
<PartyRoleContactableVia xsi:type="hcs:PostalContact" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<AbstractGeographicAddress xsi:type="hcs:UrbanPropertyAddress">
<country>USA</country>
<stateOrProvince>CA</stateOrProvince>
<streetAddress>123 Main Street</streetAddress>
<streetAddress>Suite 100</streetAddress>
<streetAddress>Attn: John</streetAddress>
<locality>Bedford</locality>
<postcode>998877</postcode>
</AbstractGeographicAddress>
</PartyRoleContactableVia>
<PartyRoleContactableVia xsi:type="hcs:EmailContact" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<eMailAddress>johndoe@customer002.com</eMailAddress>
</PartyRoleContactableVia>
<PartyRoleContactableVia xsi:type="hcs:TelephoneNumber" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<number>408 424 1234</number>
<type>Primary</type>
</PartyRoleContactableVia>
<PartyRoleAssociation>
<associationType>MainContact</associationType>
<PartyRole xsi:type="hcs:Contact" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Party xsi:type="hcs:Individual">
<IndividualINamedUsing>
<givenNames>John</givenNames>
<familyNames>Doe</familyNames>
</IndividualINamedUsing>
</Party>
</PartyRole>
</PartyRoleAssociation>
</Customers>
</prov:ListCustomerResponse>
Sample ProvisionSite Data Service XML API Requests and Responses
This section includes the following sample ProvisionSite data service XML API requests and responses:
Sample 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">
<RequestHeader>
<targetDomain>UnifiedCommunications</targetDomain>
</RequestHeader>
<GeographicSite>
<!-- Customer -->
<PlacePartyRoleAssoc>
<placeRole>Customer</placeRole>
<PartyRole xsi:type="hcs:Customer">
<partyRoleId>Customer002</partyRoleId>
</PartyRole>
</PlacePartyRoleAssoc>
</GeographicSite>
</hcs:ListSiteRequest>
Sample listSite XML Response
The following is a sample XML code for the listSite XML response.
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<hcs:ListSiteResponse>
<isSuccessful>true</isSuccessful>
<moreResults>false</moreResults>
<endsWithResultNumber>2</endsWithResultNumber>
<GeographicSite>
<RootEntityDescribedBy>
<value>false</value>
<CharacteristicSpecification>
<name>ErSupport</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<ID>SanJose_Site</ID>
<PlaceResourceAssoc>
<placeRole>Subnet</placeRole>
<Resource xsi:type="hcs:IPAddress" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<networkNumber>172.16.109.255</networkNumber>
<subnetMask>24</subnetMask>
</Resource>
</PlaceResourceAssoc>
<PlaceResourceAssoc>
<placeRole>DialPlan</placeRole>
<Resource xsi:type="hcs:LogicalResource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<RootEntityDescribedBy>
<value>212</value>
<CharacteristicSpecification>
<name>E164AreaCode</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>3</value>
<CharacteristicSpecification>
<name>ExtensionDigits</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>0</value>
<CharacteristicSpecification>
<name>ExternalAccessPrefix</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>CUCM-8</value>
<CharacteristicSpecification>
<name>PbxTemplate</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>00043</value>
<CharacteristicSpecification>
<name>SiteCode</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
</Resource>
</PlaceResourceAssoc>
<PlaceResourceAssoc>
<placeRole>HardwareGroup</placeRole>
<Resource xsi:type="hcs:LogicalDevice" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<commonName>2_HWG</commonName>
</Resource>
</PlaceResourceAssoc>
<PlaceResourceAssoc>
<placeRole>MediaService</placeRole>
<Resource xsi:type="hcs:LogicalResource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<commonName>None</commonName>
</Resource>
</PlaceResourceAssoc>
<AuthorizedProductSpecification>
<productId>Line</productId>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>lineType</ID>
<ProdSpecCharacteristicEnumeratedBy>
<value>Direct dial inward extensions</value>
<maxCardinality>5</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Emergency call back lines</value>
<maxCardinality>25</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Internal extensions</value>
<maxCardinality>25</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Analogue PSTN lines</value>
<maxCardinality>25</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Incoming lines</value>
<maxCardinality>3500</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Outgoing lines</value>
<maxCardinality>2500</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
</AuthorizedProductSpecification>
<AuthorizedProductSpecification>
<productId>Phone</productId>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>phoneType</ID>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 7905 SCCP</value>
<maxCardinality>1</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 7940 SCCP</value>
<maxCardinality>3</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 7941 SCCP</value>
<maxCardinality>25</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 7960 SCCP</value>
<maxCardinality>25</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 7960 SIP</value>
<maxCardinality>10</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 7961 SIP</value>
<maxCardinality>25</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 7962 SCCP</value>
<maxCardinality>25</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 7970 SCCP</value>
<maxCardinality>2</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 3911 SIP</value>
<maxCardinality>42</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 3951 SIP</value>
<maxCardinality>22</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
</AuthorizedProductSpecification>
<AuthorizedProductSpecification>
<productId>Location</productId>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>serviceType</ID>
<ProdSpecCharacteristicEnumeratedBy>
<value>Conferencing</value>
<maxCardinality>125</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Corporate phone book</value>
<maxCardinality>25</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Music on hold</value>
<maxCardinality>25</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Personal phone book</value>
<maxCardinality>25</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Operator console</value>
<maxCardinality>25</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>User mobility</value>
<maxCardinality>25</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Voicemail</value>
<maxCardinality>25</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
</AuthorizedProductSpecification>
</GeographicSite>
<GeographicSite>
<RootEntityDescribedBy>
<value>false</value>
<CharacteristicSpecification>
<name>ErSupport</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<ID>FinalLoc</ID>
<PlaceResourceAssoc>
<placeRole>Subnet</placeRole>
<Resource xsi:type="hcs:IPAddress" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<networkNumber>172.16.109.255</networkNumber>
<subnetMask>24</subnetMask>
</Resource>
</PlaceResourceAssoc>
<PlaceResourceAssoc>
<placeRole>DialPlan</placeRole>
<Resource xsi:type="hcs:LogicalResource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<RootEntityDescribedBy>
<value>212</value>
<CharacteristicSpecification>
<name>E164AreaCode</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>3</value>
<CharacteristicSpecification>
<name>ExtensionDigits</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>0</value>
<CharacteristicSpecification>
<name>ExternalAccessPrefix</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>CUCM-8</value>
<CharacteristicSpecification>
<name>PbxTemplate</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<RootEntityDescribedBy>
<value>00036</value>
<CharacteristicSpecification>
<name>SiteCode</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
</Resource>
</PlaceResourceAssoc>
<PlaceResourceAssoc>
<placeRole>HardwareGroup</placeRole>
<Resource xsi:type="hcs:LogicalDevice" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<commonName>Praga_HWG</commonName>
</Resource>
</PlaceResourceAssoc>
<PlaceResourceAssoc>
<placeRole>MediaService</placeRole>
<Resource xsi:type="hcs:LogicalResource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<commonName>None</commonName>
</Resource>
</PlaceResourceAssoc>
<AuthorizedProductSpecification>
<productId>Line</productId>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>lineType</ID>
<ProdSpecCharacteristicEnumeratedBy>
<value>Internal extensions</value>
<maxCardinality>10</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Direct dial inward extensions</value>
<maxCardinality>245</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Emergency call back lines</value>
<maxCardinality>518</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Incoming lines</value>
<maxCardinality>3500</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Outgoing lines</value>
<maxCardinality>2500</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Analogue PSTN lines</value>
<maxCardinality>2000</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
</AuthorizedProductSpecification>
<AuthorizedProductSpecification>
<productId>Phone</productId>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>phoneType</ID>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 7960 SCCP</value>
<maxCardinality>10</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 3911 SIP</value>
<maxCardinality>42</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 3951 SIP</value>
<maxCardinality>22</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 7905 SCCP</value>
<maxCardinality>99</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 7940 SCCP</value>
<maxCardinality>1200</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 7941 SCCP</value>
<maxCardinality>500</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 7960 SIP</value>
<maxCardinality>232</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 7961 SIP</value>
<maxCardinality>1000</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 7962 SCCP</value>
<maxCardinality>1000</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Cisco 7970 SCCP</value>
<maxCardinality>1020</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
</AuthorizedProductSpecification>
<AuthorizedProductSpecification>
<productId>Location</productId>
<ProductSpecCharUse>
<ProductSpecCharacteristic>
<ID>serviceType</ID>
<ProdSpecCharacteristicEnumeratedBy>
<value>Voicemail</value>
<maxCardinality>10</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Conferencing</value>
<maxCardinality>1015</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Corporate phone book</value>
<maxCardinality>1016</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Music on hold</value>
<maxCardinality>1000</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Personal phone book</value>
<maxCardinality>1000</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Operator console</value>
<maxCardinality>1000</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>User mobility</value>
<maxCardinality>1400</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Conferencing</value>
<maxCardinality>10</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Corporate phone book</value>
<maxCardinality>10</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>User mobility</value>
<maxCardinality>10</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Conferencing</value>
<maxCardinality>200</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Corporate phone book</value>
<maxCardinality>200</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Conferencing</value>
<maxCardinality>47</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Corporate phone book</value>
<maxCardinality>56</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Conferencing</value>
<maxCardinality>1</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Conferencing</value>
<maxCardinality>1</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Conferencing</value>
<maxCardinality>1</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>Corporate phone book</value>
<maxCardinality>1</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
<ProdSpecCharacteristicEnumeratedBy>
<value>User mobility</value>
<maxCardinality>1</maxCardinality>
</ProdSpecCharacteristicEnumeratedBy>
</ProductSpecCharacteristic>
</ProductSpecCharUse>
</AuthorizedProductSpecification>
</GeographicSite>
</hcs:ListSiteResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample ProvisionSubscriber Data Service XML API Requests and Responses
This section includes the following sample ProvisionSubscriber data service XML API requests and responses:
•Sample listSubscriber XML Request
•Sample listSubscriber XML Response
•Sample listSubscriberProduct XML Request
•Sample listSubscriberProduct XML Request
•Sample listSubscriberProduct XML Response
Sample listSubscriber XML Request
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>Customer002</partyRoleId>
</PartyRole>
</PartyRoleAssociation>
</Subscriber>
</hcs:ListSubscriberRequest>
Sample listSubscriber XML Response
The following is a sample XML code for the listSubscriber XML response.
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<hcs:ListSubscriberResponse>
<isSuccessful>true</isSuccessful>
<moreResults>false</moreResults>
<endsWithResultNumber>3</endsWithResultNumber>
<Subscriber>
<RootEntityDescribedBy>
<value>FeatGrp01</value>
<CharacteristicSpecification>
<name>FeatureGroupName</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<partyRoleId>subscriber001</partyRoleId>
<PartyRoleContactableVia xsi:type="hcs:PostalContact" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<AbstractGeographicAddress xsi:type="hcs:UrbanPropertyAddress">
<country>USA</country>
</AbstractGeographicAddress>
</PartyRoleContactableVia>
<Party xsi:type="hcs:Individual" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<IndividualINamedUsing>
<familyNames>subscriber1</familyNames>
</IndividualINamedUsing>
</Party>
</Subscriber>
<Subscriber>
<RootEntityDescribedBy>
<value>FeatGrp02</value>
<CharacteristicSpecification>
<name>FeatureGroupName</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<partyRoleId>subscriber002</partyRoleId>
<PartyRoleContactableVia xsi:type="hcs:PostalContact" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<AbstractGeographicAddress xsi:type="hcs:UrbanPropertyAddress">
<country>USA</country>
</AbstractGeographicAddress>
</PartyRoleContactableVia>
<Party xsi:type="hcs:Individual" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<IndividualINamedUsing>
<familyNames>subscriber2</familyNames>
</IndividualINamedUsing>
</Party>
</Subscriber>
<Subscriber>
<RootEntityDescribedBy>
<value>FeatGrp03</value>
<CharacteristicSpecification>
<name>FeatureGroupName</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
<partyRoleId>subscriber003</partyRoleId>
<PartyRoleContactableVia xsi:type="hcs:PostalContact" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<AbstractGeographicAddress xsi:type="hcs:UrbanPropertyAddress">
<country>USA</country>
</AbstractGeographicAddress>
</PartyRoleContactableVia>
<Party xsi:type="hcs:Individual" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<IndividualINamedUsing>
<familyNames>subscriber3</familyNames>
</IndividualINamedUsing>
</Party>
</Subscriber>
</hcs:ListSubscriberResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample listSubscriberProduct XML Request
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>Customer002</partyRoleId>
</PartyRole>
</ProductOfInterestTo>
<!-- Selection Criteria -->
<RootEntityDescribedBy>
<value>subscriber001</value>
<CharacteristicSpecification>
<name>subscriberPartyRoleId</name>
</CharacteristicSpecification>
</RootEntityDescribedBy>
</Product>
</hcs:ListSubscriberProductRequest>
Sample listSubscriberProduct XML Response
The following is a sample XML code for the listSubscriberProduct XML response.
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:hcs="http://www.cisco.hcs.com/HCSProvision.xsd">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<hcs:ListSubscriberProductResponse>
<isSuccessful>true</isSuccessful>
<moreResults>false</moreResults>
<Product>
<ProductCharacteristicValue>
<ProductCharacteristicValueRelationship>
<ProductCharacteristicValue>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>line_features</ID>
</ProdSpecCharDescribesProdCharacteristicValue>
</ProductCharacteristicValue>
</ProductCharacteristicValueRelationship>
<ProductCharacteristicValueRelationship>
<ProductCharacteristicValue>
<value>000302020</value>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>lines_fintNumber</ID>
</ProdSpecCharDescribesProdCharacteristicValue>
</ProductCharacteristicValue>
</ProductCharacteristicValueRelationship>
<ProductCharacteristicValueRelationship>
<ProductCharacteristicValue>
<value>1</value>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>lines_lineOrder</ID>
</ProdSpecCharDescribesProdCharacteristicValue>
</ProductCharacteristicValue>
</ProductCharacteristicValueRelationship>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>lines</ID>
</ProdSpecCharDescribesProdCharacteristicValue>
</ProductCharacteristicValue>
<ProductCharacteristicValue>
<ProductCharacteristicValueRelationship>
<ProductCharacteristicValue>
<value>SEP5324698250AB</value>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>deviceIdentifier</ID>
</ProdSpecCharDescribesProdCharacteristicValue>
</ProductCharacteristicValue>
</ProductCharacteristicValueRelationship>
<ProductCharacteristicValueRelationship>
<ProductCharacteristicValue>
<value>Device Name</value>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>deviceIdentifierType</ID>
</ProdSpecCharDescribesProdCharacteristicValue>
</ProductCharacteristicValue>
</ProductCharacteristicValueRelationship>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>deviceIdentifierData</ID>
</ProdSpecCharDescribesProdCharacteristicValue>
</ProductCharacteristicValue>
<ProductCharacteristicValue>
<value>Standard 7941 SCCP</value>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>buttonTemplateName</ID>
</ProdSpecCharDescribesProdCharacteristicValue>
</ProductCharacteristicValue>
<ProductCharacteristicValue>
<value>FeatGrp01</value>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>featureGroupName</ID>
</ProdSpecCharDescribesProdCharacteristicValue>
</ProductCharacteristicValue>
<ProductCharacteristicValue>
<value>auto</value>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>idleTimeout</ID>
</ProdSpecCharDescribesProdCharacteristicValue>
</ProductCharacteristicValue>
<ProductCharacteristicValue>
<value>None</value>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>idleUrl</ID>
</ProdSpecCharDescribesProdCharacteristicValue>
</ProductCharacteristicValue>
<ProductCharacteristicValue>
<value>auto</value>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>phoneLocale</ID>
</ProdSpecCharDescribesProdCharacteristicValue>
</ProductCharacteristicValue>
<ProductCharacteristicValue>
<value>7941 SCCP</value>
<ProdSpecCharDescribesProdCharacteristicValue>
<ID>phoneType</ID>
</ProdSpecCharDescribesProdCharacteristicValue>
</ProductCharacteristicValue>
<ProductSpecification>
<productId>Phone</productId>
</ProductSpecification>
</Product>
</hcs:ListSubscriberProductResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Feedback