Understanding Provision Web Service Interface
This chapter describes the Mediation provision web service interfaces for HCM. You can provision and manage:
•Customer Data Services
•Site Data Services
•Subscriber Data Services
This chapter contains the following sections:
•Provision Data Services
•Provision Customer Data Services
•Provision Site Data Services
•Provision Subscriber Data Services
Provision Data Services
The Mediation layer exposes SID-based northbound data service interfaces to provision and monitor Unified Communications (UC) services.
Table 2-1 lists the data services that you can provision and the description.
Table 2-1 Provision Data Services
|
|
Provision Customer |
Allows you to retrieve customer objects and application instances. |
Provision Site |
Allows you to retrieve customer site resources. |
Provision Subscriber |
Allows you to retrieve services for customer subscribers. |
Provision Customer Data Services
The ProvisionCustomer data service exposes the HCM northbound interface and operations, enabling provision management of the customer infrastructure objects. The section describes the HCM XML API for the ProvisionCustomer data service, which contains the following operations:
listCustomer
•ListCustomerRequest—Appendix B, "Sample listCustomer XML Request"
•ListCustomerResponse—Appendix B, "Sample listCustomer XML Response"
This section includes:
•ListCustomerRequest
•ListCustomerResponse
See Appendix A, "HCSProvisionCustomer.wsdl File" for the ProvisionCustomer WSDL file.
ListCustomerRequest
Table 2-2 lists the Entity, Path/Attribute, and Data Types for the ListCustomerRequest operation.
Table 2-2 ListCustomerRequest
|
|
|
Comments/Validation/Rules
|
ListCustomerRequest (VOSS sync) |
Customer |
ListCustomerRequest/Customer |
Customer |
— |
partyRoleId |
String |
Mandatory. This ID is used for dynamic routing only. You cannot use this ID for selection criteria. To select a particular customer, specify the corresponding criteria in the CharacteristicValue collection. For example, partyRoleId for VOSS. |
Customer CharacteristicValues [*] |
.../RootEntityDescribedBy |
List CharacteristicValue |
— |
CharacteristicSpecification/Name |
String |
The following are the VOSS filter attributes: •partyRoleId •locality |
Value |
String |
— |
ListCustomerResponse
Table 2-3 lists the Entity, Path/Attribute, and Data Types for the ListCustomerResponse operation.
Table 2-3 ListCustomerResponse
|
|
|
Comments/Validation/Rules
|
ListCustomerResponse (VOSS) |
Customer [*] |
.../ Customer |
List Customer |
VOSS. Customer corresponds to an Enterprise. |
partyRoleId |
String |
An identifier for the customer |
Customer CharacteristicValues [*] |
.../RootEntityDescribedBy |
List CharacteristicValue |
— |
Action |
ActionType (Create/Update/Delete) |
The operation that need to be performed. |
CharacteristicSpecification/Name |
String |
Example: CallProcessor, UnifiedMessageProcessor |
Value |
String |
— |
MainContact |
.../PartyRoleAssoc[associationType="MainContact"] /partyRole(xsi:type="Contact") |
Contact |
VOSS—Mandatory. |
Individual |
.../Party(xsi:type=Individual) |
Individual |
— |
Individual Name |
.../IndividualNamedUsing |
Individual Name |
— |
givenNames |
String |
First name(s) |
familyNames |
String |
Last name(s) |
PostalAddress |
.../PartyRoleContactableVia(xsi:type="PostalContact") /AbstractGeographicAddress (xsi:type="UrbanPropertyAddress") |
UrbanPropertyAddress |
VOSS |
streetAddress |
Array String |
VOSS. You can enter up to three lines. |
locality |
String |
City, town, village. |
stateOrProvince |
String |
— |
postcode |
String |
— |
country |
String |
Three character country code. For example, USA. |
Provision Site Data Services
The ProvisionSite data service exposes the HCM northbound interface and operations, enabling provision management of the Site service.
This section describes the HCM XML API for the ProvisionSite data service that contains the following operations:
•listSite
–ListSiteRequest—Appendix B, "Sample listSite XML Request"
–ListSiteResponse—Appendix B, "Sample listSite XML Response"
This section includes:
•ListSiteRequest
•ListSiteResponse
See Appendix A, "HCSProvisionSite.wsdl File" for the ProvisionSite WSDL file.
See Appendix B, "Sample ProvisionSite Data Service XML API Requests and Responses" for samples of the outbound request message and inbound server response message.
ListSiteRequest
Table 2-4 lists the Entity, Path/Attribute, and Data Types for the ListSiteRequest operation.
Table 2-4 ListSiteRequest
|
|
|
Comments/Validation/Rules
|
ListSiteRequest (VOSS sync) |
GeographicSite |
List GeographicSite Request/ GeographicSite |
GeographicSite |
— |
Customer |
.../PlacePartyRoleAssoc [placeRole = "Customer"]/PartyRole(xsi:type=Customer) |
Customer |
Mandatory. This is used as the selection criteria for sites in VOSS. |
partyRoleId |
String |
— |
GeographicSite CharacteristicValues [*] |
.../RootEntityDescribedBy |
List CharacteristicValue |
— |
CharacteristicSpecification/ Name |
String |
The following are the VOSS filter attributes: •siteID •locality •dialPlanSiteCode |
Value |
String |
— |
ListSiteResponse
Table 2-5 lists the Entity, Path/Attribute, and Data Types for the ListSiteResponse operation.
Table 2-5 ListSiteResponse
|
|
|
Comments/Validation/Rules
|
ListSiteResponse (VOSS) |
Geographic Site [*] |
.../GeographicSite |
List GeographicSite |
VOSS |
Sub-structure of GeographicSite matches the structure of GeographicSite defined in ListSiteRequest. |
— |
— |
Provision Subscriber Data Services
The ProvisionSubscriber data service exposes the HCM northbound interface and operations, enabling provision management of the Subscriber service.
This section describes the HCM XML API for the ProvisionSubscriber data service that contains the following operations:
•listSubscriber
–listSubscriberRequest—Appendix B, "Sample listSubscriber XML Request"
–listSubscriberResponse—Appendix B, "Sample listSubscriber XML Response"
•listSubscriberProduct
–listSubscriberProductRequest—Appendix B, "Sample listSubscriberProduct XML Request"
–listSubscriberProductResponse—Appendix B, "Sample listSubscriberProduct XML Response"
This section includes:
•ListSubscriberRequest
•ListSubscriberResponse
•ListSubscriberProductRequest
•ListSubscriberProductResponse
See Appendix A, "HCSProvisionSubscriber.wsdl File" for the ProvisionSubscriber WSDL file.
See Appendix B, "Sample ProvisionSubscriber Data Service XML API Requests and Responses" for samples of outbound request message and inbound server response message.
ListSubscriberRequest
Table 2-6 lists the Entity, Path/Attribute, and Data Types of the ListSubscriberRequest operation.
Table 2-6 ListSubscriberRequest
|
|
|
Comments/Validation/Rules
|
ListSubscriberRequest (VOSS sync) |
Subscriber |
List Subscriber Request/Subscriber |
Subscriber |
— |
Customer |
.../PartyRoleAssoc[associationType = "Customer"]/PartyRole(xsi:type= Customer) |
Customer |
Mandatory. This is used as the selection criteria for subscribers in VOSS. |
partyRoleId |
String |
— |
Subscriber CharacteristicValues [*] |
.../RootEntityDescribedBy |
List CharacteristicValue |
— |
CharacteristicSpecification/Name |
String |
The following are the VOSS filter attributes: •partyRoleId •siteId And one of the following: –givenNames –familyNames –Department |
Value |
String |
— |
ListSubscriberResponse
Table 2-7 lists the Entity, Path/Attribute, and Data Types of the ListSubscriberResponse operation.
Table 2-7 ListSubscriberResponse
|
|
|
Comments/Validation/Rules
|
ListSubscriberResponse (VOSS) |
Subscriber [*] |
.../Subscriber |
List Subscriber |
VOSS |
Subscriber |
CreateSubscriberRequest/Subscriber |
Subscriber |
The end user within the enterprise. |
partyRoleId |
String |
Mandatory. An identifier for the subscriber. |
Individual |
.../Party(xsi:type=Individual) |
Customer |
— |
IndividualName |
.../IndividualNamedUsing |
Individual Name |
Name of the subscriber. |
givenNames |
String |
VOSS—Madatory for the create operation. First names(s). |
familyNames |
String |
VOSS—Madatory for the create operation. Last names(s). |
Contact Medium [*] |
.../PartyRoleContactableVia |
Contact Medium [*] |
— |
Email |
...(xsi:type=EmailContact)/ eMailAddress |
String |
— |
Phone |
...(xsi:type=TelephoneNumber)/number |
List Telephone Number |
— |
type |
String |
VOSS—Primary |
number |
String |
— |
Postal Address |
locality |
String |
— |
stateOrProvince |
String |
— |
postcode |
String |
— |
country |
String |
VOSS—Mandatory for the create option. |
timeZone/name |
timeZone Enum |
For example, GMT-05:00, Eastern (New York) |
ListSubscriberProductRequest
Table 2-8 lists the Entity, Path/Attribute, and Data Types of the ListSubscriberProductRequest operation.
Table 2-8 ListSubscriberProductRequest
|
|
|
Comments/Validation/Rules
|
ListSubscriberProductRequest (VOSS sync) |
Product |
List Subscriber ProductRequest/Product |
Product |
— |
Customer |
.../ProductOfInterestTo(xsi:type = "PartyRoleProductInvolvement") [productInvolvementRole="Customer"]/PartyRole(xsi:type=Customer) |
Customer |
Mandatory |
partyRoleId |
String |
— |
Selection CharacteristicValues [*] |
.../RootEntityDescribedBy |
List CharacteristicValue |
The VOSS filter attribute is partyRoleId (Mandatory). |
CharacteristicSpecification/Name |
String |
— |
Value |
String |
— |
ListSubscriberProductResponse
Table 2-9 lists the Entity, Path/Attribute, and Data Types of the ListSubscriberProductResponse operation.
Table 2-9 ListSubscriberProductResponse
|
|
|
Comments/Validation/Rules
|
ListSubscriberProductResponse (VOSS) |
Product [*] |
.../ Product |
List Product |
VOSS |
Result[*] |
Result |
Entity |
Contains the subclass of Entity corresponding to the data returned for the requested CorrelationId. |
Product [*] |
... (xsi:type="Product") |
Product |
Response for CorrleationId corresponding to a List Infrastructure Product Request and List Subscriber Product Request. |
Geographic Site |
.../ProductLocatedVia (xsi:type="Geographic Site") |
Geographic Site |
— |
ID |
String |
— |
Customer |
.../ProductOfInterest [productInvolvementRole="Customer"] (xsi:type="PartyRoleProductInvolvement")/PartyRole (xsi:type="Customer) |
Customer |
— |
partyRoleId |
— |
— |
Subscriber |
.../ProductOfInterest [productInvolvementRole="Subscriber"] (xsi:type="PartyRoleProductInvolvement")/PartyRole (xsi:type="Subscriber) |
Subscriber |
— |
partyRoleId |
— |
— |
Product Specification |
.../ProductSpecification |
ProductSpecification |
— |
productId |
String |
— |
ProductCharacteristicValue [*] |
.../ProductCharacteristicValue |
List ProductCharacteristicValue |
Product characteristics for the product as specified in the order. |
Value |
String |
— |
Product Characteristic Type |
.../ProdCharSpecDescribesProductCharacteristicValue |
ProdCharSpecDescribersProductCharacteristicValue |
— |
ID |
String |
— |
Sub-Product CharacteristicValue [*] |
.../ ProductCharacteristicValueRelationship/ ProductCharacteristicValue |
List ProductCharacteristicValue |
— |
ProdSpecCharDescribesProdCharacteristicValue /ID |
String |
— |
value |
String |
— |
Physical Device |
.../BusinessInteractionInvolvesResource (xsi:type= Physical Device) |
PhysicalDevice |
— |
commonName |
String |
— |
Capability |
.../LogicalPhysicalResource [typeofLPDependency = "Capability"]/LogicalResource |
LogicalResource |
— |
commonName |
String |
— |