9 SOA Web Service Reference
This chapter provides information about Oracle Communications MetaSolv Solution (MSS) Service Order Activation (SOA) Web Service.
About the SOA Web Service
The SOA Web Service enables an external system to activate services for previously placed orders in MetaSolv Solution. SOA Web Service operations enable you to:
-
Create a service order activation message.
-
Get service order activation information and defaults.
-
Get service order activation telephone numbers for an order.
-
Set a telephone number for service activation order completion.
About the SOA Web Service Packaging
The SOA Web Service is packaged in the MSS_WebService.ear file, which contains the soa.war file. When the installer deploys the EAR file, the SOA Web Service is automatically deployed and ready to use.
Note:
The MSS_WebService.ear file includes all of the other provided web service operations as well. See "Web Services Overview" for information about the full list of these operations.
About the SOA WSDL, WAR, and Schema Files
The SOA Web Service is defined by the SOAAPI.wsdl file and is supported by numerous schema files. The WSDL file and supporting schema files are located in the soa.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 SOA Schema Files
Several schema files support the SOA Web Service. Within soa.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.
Entity Schemas
The entity schemas define elements, such as keys and types, specific to the web service.
The SOA entity schemas are defined in the following files:
-
CustomerManagementEntities.xsd
-
InventoryManagementEntities.xsd
-
MIPCommonEntities.xsd
-
OrderManagementEntities.xsd
-
OrderManagementEvents.xsd
-
ServiceEntities.xsd
-
ServiceOrderActivationEntities.xsd
Data Schemas
The data schemas contain numerous complex type structures, enumerations, and simple types.
The SOA data schemas are defined in the following files:
-
CustomerManagementData.xsd
-
InventoryManagementData.xsd
-
OrderAncillaryManagementData.xsd
-
OrderManagementData.xsd
-
ServiceData.xsd
-
ServiceOrderActivationData.xsd
createSoaMessageRequest Operation
The createSoaMessageRequest operation enables you to create and to save a SOA transaction request or response. It takes in a SOATransactionType object, validates it, and saves it to the database. The value of requestType or reponseType within the SOATransactionType indicates if a SOA transaction request or SOA transaction response is created. The value returned is the internal transaction ID or SOATransactionKey object.
The following are the request and response structures:
Request Structure: createSoaMessageRequest
Response Structure: createSoaMessageRequestResponse
createSoaMessageRequest
The createSoaMessageRequest element contains the input information for the operation. Each row in Table 9-1 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.
Table 9-1 Payload Information for the Request
| Name | Defined As | Type Description | File Name |
|---|---|---|---|
|
createSoaMessageRequest |
element |
msoaCreateSOAMessageRequest |
SOAAPI.wsdl |
|
msoaCreateSOAMessageRequest |
element |
Contains the following:
|
ServiceOrderActivationAPI.xsd |
|
orderKey |
element |
OrderKey |
ServiceOrderActivationAPI.xsd |
|
transaction |
element |
SOATransactionType |
ServiceOrderActivationAPI.xsd |
|
SOATransactionType |
complexType |
Extension of ManagedEntityValue Contains a list of fields |
ServiceOrderActivationEntities.xsd |
|
transactionId |
element |
SOATransactionKey |
ServiceOrderActivationEntities.xsd |
|
SOATransactionKey |
complexType |
Extension of ManagedEntityKey Contains a list of fields |
ServiceOrderActivationEntities.xsd |
|
lrn |
element |
LocalRoutingNumberType |
ServiceOrderActivationEntities.xsd |
|
LocalRoutingNumberType |
complexType |
Contains a list of fields |
ServiceOrderActivationData.xsd |
Required fields for createSoaMessageRequest
The following tables describe the required fields for the createSoaMessageRequest operation.
Table 9-2 describes the required fields for SOATransactionType.
Table 9-2 Required Fields for SOATransactionType
| Field Name | Data Type | Field Description |
|---|---|---|
|
requestType |
Enum |
Valid values of SOAMessageRequestEnumType. The request type of the SOA transaction. If this field is populated, the message type is a request. |
|
responseType |
Enum |
Valid values of SOAMessageResponseEnumType. The response type of the SOA transaction. |
|
telephoneNumber |
string |
Telephone number for which the SOA transaction exists. |
|
svId |
string |
Subscription version identifier. This is from Number Portability Administration Center (NPAC). |
|
sendIndicator |
boolean |
MetaSolv specific field that a user can mark a request as ready to send. If true it is ready to send. If this value is not provided, it will default to false. |
|
messageDate |
CbeDateTime |
Date the request was sent, or the response was received. |
|
tnActivityIndicator |
Enum |
Valid values of SOATelNumActivityIndEnumType. Indicates the activity operation on the telephone number for the order. |
|
supplementType |
Enum |
Valid values of SupplementTypeEnum. Identifies the reason a supplement is being issued for a particular order. |
|
telephoneNumberTypeCode |
Enum |
Valid values of TelephoneNumberTypeEnumType. Determines the type of telephone number. |
|
portType |
Enum |
Valid values of SOAPortTypeEnumType. Indicates the port type of the SOA telephone number. |
|
portToOriginal |
boolean |
Indicates if the telephone number is being ported to the original service provider. |
|
lnpType |
Enum |
Valid values of LnpTypeEnumType. Identifies whether a subscription version is inter-service provider ported (LSPP) or intra-service provider ported (LISP) or Pooled Block Number Port (POOL). |
|
svStatus |
Enum |
Valid values of SOASvStatusEnumType. Indicator set by the old Service Provider to indicate authorization or denial of Transfer of Service for the Subscription Version to the new Service Provider. |
|
conflictDate |
CbeDateTime |
Date and time the Subscription Version was last placed in conflict. |
|
activationRequestDate |
CbeDateTime |
Date and time the Subscription Version activation request was made by the new Service Provider. |
|
preCancellationStatus |
Enum |
Valid values of SOASvStatusEnumType. Status of the Subscription Version before cancellation. |
|
timerType |
Enum |
Valid values of TimerTypeEnumType. Timer type used for the subscription version. |
|
businessHour |
Enum |
Valid values of BusinessHourEnumType. Business Hours used for the subscription version. |
|
mslvRequestStatus |
string |
String that represents an internal status value for SOA transactions. |
|
categoryId |
string |
Telephone number inventory value for the category. |
|
subCategoryId |
string |
Telephone number inventory value for the sub category. |
Table 9-3 describes the required fields for OrderKey.
Table 9-3 Required Fields for OrderKey
| Field Name | Data Type | Field Description |
|---|---|---|
|
primaryKey |
string |
Document number for the order |
Table 9-4 describes the required fields for SOATransactionKey.
Table 9-4 Required Fields for SOATransactionKey
| Field Name | Data Type | Field Description |
|---|---|---|
|
primaryKey |
string |
This primary key is a SOATransactionKey and uniquely identifies a SOA transaction request or response. |
Table 9-5 describes the required fields for LocalRoutingNumberType.
Table 9-5 Required Fields for LocalRoutingNumberType
| Field Name | Data Type | Field Description |
|---|---|---|
|
Npa |
string |
Simple type representing the format for the NPA portion of a telephone number. |
|
Nxx |
string |
Simple type representing the format for the NPA portion of a telephone number. |
|
line |
string |
Simple type representing the format for the LINE portion of a telephone number. |
createSoaMessageRequestResponse
The createSoaMessageRequestResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 9-6 describes the returned information in the response.
Table 9-6 Payload Information for the Response
| Name | Defined As | Type Description | File Name |
|---|---|---|---|
|
createSoaMessageRequestResponse |
element |
createSOAMessageResponse |
SOAAPI.wsdl |
|
createSOAMessageResponse |
element |
SOAtransactionKey |
ServiceOrderActivationAPI.xsd |
|
SOATransactionKey |
complexType |
Extension of ManagedEntityKey Contains a list of fields |
ServiceOrderActivationEntities.xsd |
getSoaDefaultsRequest Operation
The getSoaDefaultsRequest operation enables you to retrieve the SOA defaults for the NPAC transaction from the database. The value returned is the SOADefaultsType object.
The following are the request and response structures:
Request Structure: getSoaDefaultsRequest
Response Structure: getSoaDefaultsRequestResponse
getSoaDefaultsRequest
The getSoaDefaultsRequest element contains the input information for the operation. Each row in Table 9-7 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.
Table 9-7 Payload Information for the Request
| Name | Defined As | Type Definition | File Name |
|---|---|---|---|
|
getSoaDefaultsRequest |
element |
msoaGetSOADefaultsRequest |
SOAAPI.wsdl |
|
msoaGetSOADefaultsRequest |
element |
Contains the following:
|
ServiceOrderActivationAPI.xsd |
|
orderKey |
element |
OrderKey |
ServiceOrderActivationAPI.xsd |
|
telephoneNumber |
element |
SOATelephoneNumberType |
ServiceOrderActivationAPI.xsd |
|
SOATelephoneNumberType |
complexType |
Contains a list of fields |
ServiceOrderActivationData.xsd |
Table 9-8 describes the required fields for SOATelephoneNumberType.
Table 9-8 Required Fields for SOATelephoneNumberType
| Field Name | Data Type | Field Description |
|---|---|---|
|
Npa |
string |
Simple type representing the format for the NPA portion of a telephone number. |
|
Nxx |
string |
Simple type representing the format for the NPA portion of a telephone number. |
|
line |
string |
Simple type representing the format for the LINE portion of a telephone number. |
|
suffix |
string |
Simple type representing the format for the suffix portion of a telephone number. |
getSoaDefaultsRequestResponse
The getSoaDefaultsRequestResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 9-9 describes the returned information in the response.
Table 9-9 Payload Information for the Response
| Name | Defined As | Type Definition | File Name |
|---|---|---|---|
|
getSoaDefaultsRequestResponse |
element |
getSOADefaultsResponse |
SOAAPI.wsdl |
|
getSOADefaultsResponse |
element |
defaults |
ServiceOrderActivationAPI.xsd |
|
defaults |
element |
SOADefaultsType |
ServiceOrderActivationAPI.xsd |
|
SOADefaultsType |
complexType |
Contains a list of fields |
ServiceOrderActivationEntities.xsd |
getSoaInformationRequest Operation
The getSoaInformationRequest operation enables you to retrieve SOA information for:
-
Telephone numbers including telephone number inventory information
-
Existing SOA requests
-
Existing SOA responses
The value returned is a SOAInformationType.
The following are the request and response structures:
Request Structure: getSoaInformationRequest
Response Structure: getSoaInformationRequestResponse
getSoaInformationRequest
The getSoaInformationRequest element contains the input information for the operation. Each row in Table 9-10 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.
Table 9-10 Payload Information for the Request
| Name | Defined As | Type Definition | File Name |
|---|---|---|---|
|
getSoaInformationRequest |
element |
msoaGetSOAInformationRequest |
SOAAPI.wsdl |
|
msoaGetSOAInformationRequest |
complexType |
Contains the following:
|
ServiceOrderActivationAPI.xsd |
|
orderKey |
element |
OrderKey |
ServiceOrderActivationAPI.xsd |
|
telephoneNumber |
element |
SOATelephoneNumberType |
ServiceOrderActivationAPI.xsd |
|
SOATelephoneNumberType |
complexType |
Contains a list of fields |
ServiceOrderActivationData.xsd |
getSoaInformationRequestResponse
The getSoaInformationRequestResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 9-11 describes the returned information in the response.
Table 9-11 Payload Information for the Response
| Name | Defined As | Type Description | File Name |
|---|---|---|---|
|
getSoaInformationRequestResponse |
element |
getSOAInformationResponse |
SOAAPI.wsdl |
|
getSOAInformationResponse |
element |
SOAInformation |
ServiceOrderActivationAPI.xsd |
|
SOAInformation |
element |
SOAInformationType |
ServiceOrderActivationAPI.xsd |
|
SOAInformationType |
complexType |
Contains the following SOATransactionTypes
|
ServiceOrderActivationEntities.xsd |
|
defaultTransactionInfo |
element |
SOATransactionType |
ServiceOrderActivationEntities.xsd |
|
requests |
element |
SOATransactionType |
ServiceOrderActivationEntities.xsd |
|
responses |
element |
SOATransactionType |
ServiceOrderActivationEntities.xsd |
|
SOATransactionType |
complexType |
Extension of ManagedEntityValue Contains a list of fields |
ServiceOrderActivationEntities.xsd |
getSoaMessageToSendRequest Operation
This operation retrieves SOA transaction requests. Key inputs for this operation are the following:
-
Order Number
-
Telephone Number
-
Gateway Event Reactivated Indicator
If the request indicator checkGatewayEventReactivated is true, the operation only returns SOA transaction requests where the gateway event has been activated. The order number is an optional input value. If the order number is not provided then all SOA transaction requests that match the telephone number input are returned. The operation returns a list of SOATransactionType objects.
The following are the request and response structures:
Request Structure:getSoaMessageToSendRequest
Response Structure:getSoaMessageToSendRequestResponse
getSoaMessageToSendRequest
The getSoaMessageToSendRequest element contains the input information for the operation. Each row in Table 9-12 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.
Table 9-12 Payload Information for the Request
| Name | Defined As | Type Definition | File Name |
|---|---|---|---|
|
getSoaMessageToSendRequest |
element |
msoaGetSOAInformationRequest |
SOAAPI.wsdl |
|
msoaGetSOAInformationRequest |
element |
Contains the following:
|
ServiceOrderActivationAPI.xsd |
|
orderKey |
element |
OrderKey |
ServiceOrderActivationAPI.xsd |
|
telephoneNumber |
element |
SOATelephoneNumberType |
ServiceOrderActivationAPI.xsd |
|
SOATelephoneNumberType |
complexType |
Contains a list of fields |
ServiceOrderActivationData.xsd |
Table 9-13 describes the required fields for getSOAMessagesToSendRequest.
Table 9-13 Required Fields for getSOAMessagesToSendRequest
| Field Name | Data Type | Field Description |
|---|---|---|
|
checkGatewayEventReactivated |
boolean |
This flag determines if the requests returned are only requests when the gateway event has been reactivated. |
getSoaMessageToSendRequestResponse
The getSoaMessageToSendRequestResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 9-14 describes the returned information in the response.
Table 9-14 Payload Information for the Response
| Name | Defined As | Type Definition | File Name |
|---|---|---|---|
|
getSoaMessageToSendRequestResponse |
element |
getSOAMessagesToSendResponse |
SOAAPI.wsdl |
|
getSOAMessagesToSendResponse |
element |
transactions |
ServiceOrderActivationAPI.xsd |
|
transactions |
element |
SOATransactionType |
ServiceOrderActivationAPI.xsd |
|
SOATransactionType |
complexType |
Extension of ManagedEntityValue Contains a list of fields |
ServiceOrderActivationEntities.xsd |
getSoaTnsForOrderRequest Operation
This operation retrieves SOA telephone numbers for an order. The value returned is a list of existing SOA telephone numbers.
The following are the request and response structures:
Request Structure: getSoaTnsForOrderRequest
Response Structure: getSoaTnsForOrderRequestResponse
getSoaTnsForOrderRequest
The getSoaTnsForOrderRequest element contains the input information for the operation. Each row in Table 9-15 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.
Table 9-15 Payload Information for the Request
| Name | Defined As | Type Definition | File Name |
|---|---|---|---|
|
getSoaTnsForOrderRequest |
element |
msoaGetSOATNsForOrderRequest |
SOAAPI.wsdl |
|
msoaGetSOATNsForOrderRequest |
element |
Contains orderKey |
ServiceOrderActivationAPI.xsd |
|
orderKey |
element |
OrderKey |
ServiceOrderActivationAPI.xsd |
getSoaTnsForOrderRequestResponse
The getSoaTnsForOrderRequestResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 9-16 describes the returned information in the response.
Table 9-16 Payload Information for the Response
| Name | Defined As | Type Definition | File Name |
|---|---|---|---|
|
getSoaTnsForOrderRequestResponse |
element |
getSOATNsForOrderResponse |
SOAAPI.wsdl |
|
getSOATNsForOrderResponse |
element |
SOAtelephoneNumbers |
ServiceOrderActivationAPI.xsd |
|
SOAtelephoneNumbers |
element |
SOATelephoneNumberType |
ServiceOrderActivationAPI.xsd |
|
SOATelephoneNumberType |
complexType |
Contains a list of fields |
ServiceOrderActivationData.xsd |
setTnSoaCompleteRequest Operation
This operation sets the MetaSolv request status value on the last request to indicate that processing is complete for this telephone number.
The following are the request and response structures:
Request Structure: setTnSoaCompleteRequest
Response Structure: setTnSoaCompleteRequestResponse
setTnSoaCompleteRequest
The setTnSoaCompleteRequest element contains the input information for the operation. Each row in Table 9-17 describes the element or type name, the XSD declaration, the type description, and the file that contains the item's definition.
Table 9-17 Payload Information for the Request
| Name | Defined As | Type Description | File Name |
|---|---|---|---|
|
setTnSoaCompleteRequest |
element |
msoaSetTNSOACompleteRequest |
SOAAPI.wsdl |
|
msoaSetTNSOACompleteRequest |
complexType |
Contains the following:
|
ServiceOrderActivationAPI.xsd |
|
orderKey |
element |
OrderKey |
ServiceOrderActivationAPI.xsd |
|
telephoneNumber |
element |
SOATelephoneNumberType |
ServiceOrderActivationAPI.xsd |
|
SOATelephoneNumberType |
complexType |
Contains a list of fields |
ServiceOrderActivationData.xsd |
setTnSoaCompleteRequestResponse
The setTnSoaCompleteRequestResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 9-18 describes the returned information in the response.
Table 9-18 Payload Information for the Response
| Name | Defined As | Type Description | File Name |
|---|---|---|---|
|
setTnSoaCompleteRequestResponse |
element |
setTNSOACompleteResponse |
SOAAPI.wsdl |
|
setTNSOACompleteResponse |
element |
successfulCompletion |
ServiceOrderActivationAPI.xsd |