The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This chapter describes the Mediation provision web service interfaces for HCM. You can provision and manage:
•Customer Data Services
•Infrastructure Data Services
•Site Data Services
•Subscriber Data Services
•Results Data Services
•Asynchronous Response Data Source
This chapter contains the following sections:
•Provision Customer Data Services
•Provision Infrastructure Data Services
•Provision Subscriber Data Services
•Provision Results Data Services
•Domain Manager-Specific Asynchronous Response Data Services
HCM 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.
All provision data service requests and response messages are extended from a common base complexType, called OperationRequest and OperationResponse.
All operation requests are documented with the elements defined in the specific extension. For example, see CreateCustomerRequest/UpdateCustomerRequest.
Because of the asynchronous nature of these operations, all operation responses are defined as extensions of OperationResponse. However, they do not have any specific elements defined as part of the extension.
This section includes:
Table 2-2 lists the Entity, Path/Attribute, and Data Types for the OperationRequest operation.
Table 2-3 lists the Logical Name, XPath, and Data Types for the OperationReponse operation.
The ProvisionCustomer data service exposes the HCM northbound interface and operations, enabling provision management of the customer infrastructure objects. See Figure 2-1.
Figure 2-1 Interface
The section describes the HCM XML API for the ProvisionCustomer data service, which contains the following operations:
•createCustomer
–CreateCustomerRequest—Appendix B, "Sample createCustomer XML Request"
–CreateCustomerResponse—Appendix B, "Sample createCustomer XML Response"
•syncCustomer
–SyncCustomerRequest—Appendix B, "Sample syncCustomer XML Request"
–SyncCustomerResponse—Appendix B, "Sample syncCustomer XML Response"
•updateCustomer
–UpdateCustomerRequest—Appendix B, "Sample updateCustomer XML Request"
–UpdateCustomerResponse—Appendix B, "Sample updateCustomer XML Response"
•deleteCustomer
–DeleteCustomerRequest—Appendix B, "Sample deleteCustomer XML Request"
–DeleteCustomerResponse—Appendix B, "Sample deleteCustomer XML Response"
•listCustomer
–ListCustomerRequest—Appendix B, "Sample listCustomer XML Request"
–ListCustomerResponse—Appendix B, "Sample listCustomer XML Response"
This section includes:
•CreateCustomerRequest/UpdateCustomerRequest
See Appendix A, "HCSProvisionCustomer.wsdl File" for the ProvisionCustomer WSDL file.
See Appendix B, "Sample ProvisionCustomer Data Service XML API Requests and Responses" for samples of outbound request message and inbound server response message.
Table 2-4 lists the Logical Name, XPath, Data Types, and Comments/Validation/Rules for the CreateCustomerRequest and UpdateCustomerRequest operations.
Table 2-5 lists the Entity, Path/Attribute, and Data Types for the SyncCustomerRequest operation.
Table 2-6 lists the Entity, Path/Attribute, and Data Types for the DeleteCustomerRequest operation.
Table 2-7 lists the Entity, Path/Attribute, and Data Types for the ListCustomerRequest operation.
The ProvisionInfrastructure data service exposes the HCM northbound interface and operations, enabling provision management of the infrastructure objects. See Figure 2-2.
Figure 2-2 Service Interface
The section describes the HCM XML API for the ProvisionInfrastructure data service that contains the following operations:
•createDevice
–CreateDeviceRequest—Appendix B, "Sample createDevice XML Request"
–CreateDeviceResponse—Appendix B, "Sample createDevice XML Response"
•deleteDevice
–DeleteDeviceRequest—Appendix B, "Sample deleteDevice XML Request"
–DeleteDeviceResponse—Appendix B, "Sample deleteCustomer XML Response"
•listDevice
–ListDeviceRequest—Appendix B, "Sample listDevice XML Request"
–ListDeviceResponse—Appendix B, "Sample listDevice XML Response"
•submitInfrastructureOrder
–SubmitInfrastructureOrderRequest—Appendix B, "Sample submitInfrastructureOrder XML Request"
–SubmitInfrastructureOrderResponse—Appendix B, "Sample submitInfrastructureOrder XML Response"
•submitTemplate
–SubmitTemplateRequest—Appendix B, "Sample submitTemplate XML Request"
–SubmitTemplateResponse—Appendix B, "Sample submitTemplate XML Response"
•syncDeviceRequest
–SyncDeviceRequest—Appendix B, "Sample syncDevice XML Request"
–SyncDeviceResponse—Appendix B, "Sample syncDevice XML Response"
•updateDeviceRequest
–UpdateDeviceRequest—Appendix B, "Sample updateDevice XML Request"
–UpdateDeviceResponse—Appendix B, "Sample updateDevice XML Response"
•listInfrastructureProduct
–ListInfrastructureProductRequest—Appendix B, "Sample listInfrastructureProduct Request"
–ListInfrastructureProductResponse—Appendix B, "Sample listInfrastructureProduct Response"
This section includes:
•CreateDeviceRequest/UpdateDeviceRequest
•SubmitInfrastructureOrderRequest
•ListInfrastructureProductRequest
See Appendix A, "HCSProvisionInfrastructure.wsdl File" for the ProvisionInfrastructure WSDL file.
See Appendix B, "Sample ProvisionInfrastructure Data Service XML API Requests and Responses" for samples of outbound request message and inbound server response message.
Table 2-8 lists the Entity, Path/Attribute, and Data Types for the CreateDeviceRequest and UpdateDeviceRequest operations.
Table 2-9 lists the Entity, Path/Attribute, and Data Types for the SyncDeviceRequest operation.
Table 2-10 lists the Entity, Path/Attribute, and Data Types for the DeleteDeviceRequest operation.
Table 2-11 lists the Entity, Path/Attribute, and Data Types of the SubmitTemplateRequest operation.
Table 2-12 lists the Entity, Path/Attribute, Data Types, and Comments/Valdiation/Rules for the SubmitInfrastructureOrderRequest and SubmitSubscriberOrderRequest operations.
Table 2-13 lists the Entity, Path/Attribute, and Data Types for the ListDeviceRequest operation.
Table 2-14 lists the Entity, Path/Attribute, and Data Types for the ListInfrastructureProductRequest operation.
The ProvisionSite data service exposes the HCM northbound interface and operations, enabling provision management of the Site service. See Figure 2-3.
Figure 2-3 Service Interface
This section describes the HCM XML API for the ProvisionSite data service that contains the following operations:
•createSite
–CreateSiteRequest—Appendix B, "Sample createSite XML Request"
–CreateSiteResponse—Appendix B, "Sample createSite XML Response"
•updateSite
–UpdateSiteRequest—Appendix B, "Sample updateSite XML Request"
–UpdateSiteResponse—Appendix B, "Sample updateSite XML Response"
•deleteSite
–DeleteSiteRequest—Appendix B, "Sample deleteSite XML Request"
–DeleteSiteResponse—Appendix B, "Sample deleteSite XML Request"
•listSite
–ListSiteRequest—Appendix B, "Sample listSite XML Request"
–ListSiteResponse—Appendix B, "Sample listSite XML Response"
This section includes:
•CreateSiteRequest/UpdateSiteRequest
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.
Table 2-15 lists the Entity, Path/Attribute, Data Types, and Comments/Validation/Rules for the CreateSiteRequest and UpdateSiteRequest operations.
Table 2-16 lists the Entity, Path/Attribute, and Data Types for the DeleteSiteRequest operation.
Table 2-17 lists the Entity, Path/Attribute, and Data Types for the ListSiteRequest operation.
The ProvisionSubscriber data service exposes the HCM northbound interface and operations, enabling provision management of the Subscriber service. See Figure 2-4.
Figure 2-4 Service Interface
This section describes the HCM XML API for the ProvisionSubscriber data service that contains the following operations:
•createSubscriber
–CreateSubscriberRequest—Appendix B, "Sample createSubscriber XML Request"
–CreateSubscriberResponse—Appendix B, "Sample createSubscriber XML Response"
•submitSubscriber
–SubmitSubscriberOrderRequest—Appendix B, "Sample submitSubscriberOrder XML Request"
–SubmitSubscriberOrderResponse—Appendix B, "Sample submitSubscriberOrder XML Response"
•updateSubscriber
–UpdateSubscriberRequest—Appendix B, "Sample updateSubscriber XML Request"
–UpdateSubscriberResponse—Appendix B, "Sample updateSubscriber XML Response"
•deleteSubscriber
–DeleteSubscriberRequest—Appendix B, "Sample deleteSubscriber XML Request"
–DeleteSubscriberResponse—Appendix B, "Sample deleteSubscriber XML Response"
•listSubscriber
–listSubscriberRequest—Appendix B, "Sample listSubscriber XML Request"
–listSubscriberResponse—Appendix B, "Sample listSubscriber XML Response"
•listOrder
–listOrderRequest—Appendix B, "Sample listOrder XML Request"
–listOrderResponse—Appendix B, "Sample listOrder XML Response"
•listSubscriberProduct
–listSubscriberProductRequest—Appendix B, "Sample listSubscriberProduct XML Request"
–listSubscriberProductResponse—Appendix B, "Sample listSubscriberProduct XML Response"
This section includes:
•CreateSubscriberRequest/UpdateSubscriberRequest
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.
Table 2-18 lists the Entity, Path/Attribute, Data Types, and Comments/Validation/Rules for the CreateSubscriberRequest and UpdateSubscriberRequest operations.
Table 2-19 lists the Entity, Path/Attribute, and Data Types for the DeleteSubscriberRequest operation.
The parameters are the same as SubmitInfrastructureOrderRequest. For more information, see SubmitInfrastructureOrderRequest
Table 2-20 lists the Entity, Path/Attribute, and Data Types of the ListSubscriberRequest operation.
Table 2-21 lists the Entity, Path/Attribute, and Data Types of the ListOrderRequest operation.
Table 2-22 lists the Entity, Path/Attribute, and Data Types of the ListSubscriberProductRequest operation.
The ProvisionResults data service exposes the HCM northbound interface and operations, enabling provision management of the Results service. See Figure 2-5.
Figure 2-5 Service Interface
This section describes the HCM XML API for the ProvisionResults data service that contains the following operations:
•getListResults
–GetListResultsRequest—Appendix B, "Sample getListResults XML Request"
–GetListResultsResponse—Appendix B, "Sample getListResults XML Response"
•getStatus
–GetStatusRequest—Appendix B, "Sample getStatus XML Request"
–GetStatusResponse—Appendix B, "Sample getStatus XML Response"
This section includes:
See Appendix A, "HCSProvisionResults.wsdl File" for the ProvisionResults WSDL file.
See Appendix B, "Sample ProvisionResults Data Service XML API Requests and Responses" for samples of outbound request message and inbound server response message.
getListResults returns the results for the specified CorrelationId. This section includes:
Table 2-23 lists the Entity, Path/Attribute, and Data Types for the GetListResultsRequest operation.
|
|
|
Rules |
---|---|---|---|
GetListResultsRequest |
|||
— |
correlationId |
String |
— |
— |
maxResults |
Integer |
— |
Table 2-24 lists the Entity, Path/Attribute, Data Types, and Comments/Validation/Rules for the GetListResultsResponse operation.
|
|
|
Rules |
---|---|---|---|
GetListResultsResponse |
|||
— |
moreResults |
Boolean |
— |
Result[*] |
Result |
Entity |
Contains the subclass of Entity corresponding to the data returned for the requested CorrelationId. |
Customer[*] |
...(xsi:type="Customer") |
Customer |
Response for CorrleationId corresponding to a List Customer Request. |
Sub-Structure of Customer will match the Structure of Customer defined in CreateCustomerRequest/UpdateCustomerRequest (1. Customer) |
— |
— |
|
PhysicalDevice [*] |
...(xsi:type="PhysicalDevice") |
PhysicalDevice |
Response for CorrleationId corresponding to a List Device Request. |
Sub-Structure of PhysicalDevice will match the Structure of PhysicalDevice defined in CreateDeviceRequest/UpdateDeviceRequest (1. PhysicalDevice) |
— |
— |
|
GeographicSite [*] |
...(xsi:type=" GeographicSite") |
GeographicSite |
Response for CorrleationId corresponding to a List Site Request. |
Sub-Structure of GeographicSite will match the Structure of GeographicSite defined in CreateSiteRequest/UpdateSiteRequest (1. GeographicSite) |
— |
— |
|
Subscriber [*] |
...(xsi:type=" Subscriber") |
Subscriber |
Response for CorrleationId corresponding to a List Subscriber Request. |
Sub-Structure of Subscriber will match the Structure of Subscriber defined in CreateSubscriberRequest/UpdateSubscriberRequest (1. Subscriber) |
— |
— |
|
ProductOrder [*] |
...(xsi:type=" ProductOrder") |
ProductOrder |
Response for CorrleationId corresponding to a List ProductOrder Request. |
Sub-Structure of ProductOrder will match the Structure of ProductOrder defined in SubmitInfrastructureOrderRequest |
— |
— |
|
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 |
LogicalResource |
— |
commonName |
String |
— |
getStatus operation returns the status for the specified CorrelationId. This section includes:
Table 2-25 lists the Entity, Path/Attribute, and Data Types of the GetStatusRequest operation.
|
|
|
Rules |
---|---|---|---|
GetStatusRequest |
|||
— |
correlationId |
String |
The ID of the request that is already submitted. |
Table 2-26 lists the Entity, Path/Attribute, and Data Types of the GetStatusResponse operation.
HCM implements individual domain manager-specific northbound data service interfaces, triggered by a generic WS-Notification service.
These interfaces can be invoked by any of the individual domain managers. These are mapped to the SID-Common Model and exposed southbound to OSS/BSS, using a SID-based ProvisionAsyncResponse data source.
HCM invokes a SID-based southbound Web Service data source interface. These will be implemented by the receiving OSS/BSS, based on the ProvisionAsyncResponse WSDL generated from HCM.
See Figure 2-6 for details.
Figure 2-6 Service Interface
If the OSS/BSS decides to make a getStatus call for the given correlationId, the structure is returned synchronously.
See GetStatusResponse section for description of the GetStatusResponse operation.