Activation Web Service Reference

8 Activation Web Service Reference

This chapter provides information about Oracle Communications MetaSolv Solution (MSS) Activation Web Service.

About the Activation Web Service

The Activation Web Service enables an external system to retrieve activation information from MSS. You use the Activation Web Service operation for the action that gets service data.

About the Activation Web Service Packaging

The Activation Web Service is packaged in the MSS_WebService.ear file, which contains the activation.war file. When the installer deploys the EAR file, the Activation Web Service is automatically deployed and ready to use.

Note:

The MSS_WebService.ear file also includes the other MSS web service operations. See "Web Services Overview" for information about these operations.

About the Activation WSDL, WAR, and Schema Files

The Activation Web Service is defined by the ServiceActivationAPI.wsdl file and is supported by numerous schema files. The WSDL file and supporting schema files are located in the activation.war file.

See "Understanding How MSS Defines Web Services" for more information about WSDL and WAR files, and about their directory locations in the EAR file.

About Activation Schema Files

Several schema files support the Activation Web Service. Within activation.war file, the schema files are located in the WEB-INF/wsdls directory. These schemas are categorized as common schemas, entity schemas, and data schemas.

Common Schemas

See "About Schema Files" for information about the common schema files.

Entity Schemas

The entity schemas define elements, such as keys and types, specific to the web service.

The Activation entity schemas are defined in the following files:

CustomerManagementEntities.xsd
InventoryManagementEntities.xsd
MIPCommonEntities.xsd
OrderManagementEntities.xsd
OrderManagementEvents.xsd
ServiceEntities.xsd

Data Schemas

The data schemas contain numerous complex type structures, enumerations, and simple types.

The Activation data schemas are defined in the following files:

CustomerManagementData.xsd
InventoryManagementData.xsd
OrderAncillaryManagementData.xsd
OrderManagementData.xsd
ServiceData.xsd

API Schemas

The API schemas contain the high-level response and request type definitions and exception definitions.

The Activation API schemas are defined in the following files:

InventoryManagementAPI.xsd
OrderManagementAPI.xsd

getActivationData Operation

The getActivationData operation enables external systems to get activation data for the given order that will be used for switch activation.

The following are the request and response structures:

Request Structure: getActivationData

Response Structure: getActivationDataResponse

getActivationData

The getActivationData element contains the input information for the operation. Each row in Table 8-1 describes the element or type name, the XSD declaration, the type description, and the file name that contains the item's definition.

Table 8-1 Payload Information for the Request

Name	Defined As	Type Description	File Name
getActivationData	element	getActivationDataByKeyRequest	ServiceActivationAPI.wsdl
getActivationDataByKeyRequest	element	Contains a list of fields	OrderManagementAPI.xsd

Table 8-2 describes the required fields for getActivationDataByKeyRequest.

Table 8-2 Required Fields

Field Name	Data Type	Field Description
orderKey	OrderKey	A system-assigned identifier for the document number.
serviceKey	MetaSolvServiceKey	A system-assigned identifier for the Service Item.

getActivationDataResponse

The getActivationDataResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 8-3 describes the returned information in the response.

Table 8-3 Payload Information for the Response

Name	Defined As	Type Description	File Name
getActivationDataResponse	element	getActivationDataByKeyResponse	ServiceActivationAPI.wsdl
getActivationDataByKeyResponse	element	metaSolveServiceActivationValue	OrderManagementAPI.xsd
metaSolvServiceActivationValue	element	MetaSolveServiceActivationType	ServiceEntities.xsd
MetaSolvServiceActivationType	complexType	Extension of ManagedEntityKey Includes the following: orderDetails switchActivation networkElements networkSystems	ServiceEntities.xsd

Table 8-4 describes the error messages for the operation.

Table 8-4 Error Messages for the Operation

Error Message	Cause	Resolution
Document Number is not populated	Document number is not populated in the input.	Populate the document number in the input structure.
Serv Item Id is a required parameter	Service item id is not populated in the input.	Populate the service item id in the input structure.