Using Web Services

1 Using Web Services

Learn how to use Oracle Communications Billing and Revenue Management (BRM) Web Services Manager, which enables BRM opcodes to be exposed through Web services. Web Services Manager supports SOAP Web services and is packaged as an integration pack.

Topics in this document:

About WSDL Files and BRM Opcodes

Web Services Manager exposes BRM opcodes as operations through different Web services. The Web services define the opcodes that can be called and the attributes to include.

The Web service APIs are grouped by functional area. For example, the BRMBillServices Web service defines the billing Web service APIs, and the BRMPymtServices Web service defines the payment Web service APIs. Web Services Manager includes one WSDL file for each Web service.

Web Services Manager contains two different types of WSDL files. One type is for Web services that support the payload as an XML string data type. The second type is for Web services that support the payload as an XML element data type. For example:

The BRMBalService Web service defines balances Web service APIs that take the payload as an XML string data type.
The BRMBalService_v2 Web service defines balances Web service APIs that take the payload as an XML element data type.

File names with a _v2 suffix support the payload as an XML element data type.

Note:

The WSDL and schema (XSD) files for Web services that support the payload as an XML string data type are included in the infranetwebsvc.war file. If you customize any Web services, copy the customized schema files and WSDL files to the infranetwebsvc.war file.

Web services that support the payload as an XML element data type describe the input in a well-defined structure. Any standards-compliant SOAP development application can generate a client stub.

Table 1-1 describes the Web services included that take the payload as an XML string.

Table 1-1 Web Services Included in Web Services Manager that Take the Payload as an XML String

Web Service Name	Description
BRMARServices	Defines the accounts receivable Web service, which includes the following opcodes: PCM_OP_AR_ACCOUNT_ADJUSTMENT PCM_OP_AR_BILL_ADJUSTMENT PCM_OP_AR_GET_ACCT_ACTION_ITEMS PCM_OP_AR_GET_ACCT_BAL_SUMMARY PCM_OP_AR_GET_ACCT_BILLS PCM_OP_AR_GET_BAL_SUMMARY PCM_OP_AR_GET_BILL_ITEMS PCM_OP_AR_ITEM_ADJUSTMENT PCM_OP_AR_EVENT_ADJUSTMENT PCM_OP_AR_GET_ACTION_ITEMS PCM_OP_AR_GET_BILLS PCM_OP_AR_RESOURCE_AGGREGATION See "Accounts Receivable FM Standard Opcodes" in BRM Opcode Guide for more information.
BRMBalServices	Defines the balances Web service, which includes the following opcodes: PCM_OP_BAL_GET_BALANCES PCM_OP_BAL_GET_BAL_GRP_AND_SVC PCM_OP_BAL_GET_ACCT_BAL_GRP_AND_SVC PCM_OP_BAL_GET_ACCT_BILLINFO PCM_OP_BAL_GET_ECE_BALANCES Note: You must perform configuration steps before calling this opcode. See "Configuring BRM to Use PCM_OP_BAL_GET_ECE_BALANCES". See "Balance FM Standard Opcodes" in BRM Opcode Guide for more information.
BRMBillServices	Defines the billing Web service, which includes the following opcodes: PCM_OP_BILL_GET_ITEM_EVENT_CHARGE_DISCOUNT PCM_OP_BILL_GROUP_MOVE_MEMBER PCM_OP_BILL_MAKE_BILL_NOW PCM_OP_BILL_DEBIT PCM_OP_BILL_GROUP_GET_PARENT See "Billing FM Standard Opcodes" in BRM Opcode Guide for more information.
BRMCollectionsServices	Defines the collections Web service, which includes the following opcode: PCM_OP_COLLECTIONS_SET_ACTION_STATUS See "Collections Manager FM Standard Opcodes" in BRM Opcode Guide for more information.
BRMCustcareServices	Defines the customer care Web service, which includes the following opcode: PCM_OP_CUSTCARE_MOVE_ACCT
BRMCustServices	Defines the customer Web service, which includes the following opcodes: PCM_OP_CUST_COMMIT_CUSTOMER PCM_OP_CUST_MODIFY_CUSTOMER PCM_OP_CUST_UPDATE_CUSTOMER PCM_OP_CUST_UPDATE_SERVICES PCM_OP_CUST_DELETE_ACCT PCM_OP_CUST_DELETE_PAYINFO PCM_OP_CUST_CREATE_PROFILE PCM_OP_CUST_MODIFY_PROFILE PCM_OP_CUST_DELETE_PROFILE See "Customer FM Standard Opcodes" in BRM Opcode Guide for more information.
BRMInvServices	Defines the invoicing Web service, which includes the following opcode: PCM_OP_INV_VIEW_INVOICE Important: You must configure your client application to convert the invoice data received from the PCM_OP_INV_VIEW_INVOICE opcode into the appropriate format. See "About Invoicing Output XML Data" in BRM JCA Resource Adapter. See "Invoicing FM Standard Opcodes" in BRM Opcode Guide for more information.
BRMPymtServices	Defines the payment Web service, which includes the following opcode: PCM_OP_PYMT_COLLECT See "Payment FM Standard Opcodes" in BRM Opcode Guide for more information.
BRMReadServices	Defines the read Web service, which includes the following opcodes: PCM_OP_READ_FLDS PCM_OP_READ_OBJ PCM_OP_SEARCH See "LDAP Base Opcodes" in BRM Opcode Guide for more information.
BRMSubscriptionServices	Defines the subscription Web service, which includes the following opcodes: PCM_OP_SUBSCRIPTION_CANCEL_PRODUCT PCM_OP_SUBSCRIPTION_CANCEL_DISCOUNT PCM_OP_SUBSCRIPTION_CANCEL_SUBSCRIPTION PCM_OP_SUBSCRIPTION_CHANGE_DEAL PCM_OP_SUBSCRIPTION_PURCHASE_DEAL PCM_OP_SUBSCRIPTION_SET_BUNDLE PCM_OP_SUBSCRIPTION_SET_DISCOUNT_STATUS PCM_OP_SUBSCRIPTION_SET_DISCOUNTINFO PCM_OP_SUBSCRIPTION_SET_PRODINFO PCM_OP_SUBSCRIPTION_SET_PRODUCT_STATUS PCM_OP_SUBSCRIPTION_TRANSFER_SUBSCRIPTION PCM_OP_SUBSCRIPTION_GET_PURCHASED_OFFERINGS See "Subscription Management FM Standard Opcodes" in BRM Opcode Guide for more information.

Table 1-2 describes the Web services that take the payload as an XML element.

Table 1-2 Web Services Included in Web Services Manager that Take the Payload as an XML Element

Web Service Name	Description
BRMACTServices_v2	Defines the activity Web service, which includes the following opcodes: PCM_OP_ACT_FIND PCM_OP_ACT_LOAD_SESSION See "Activity FM Standard Opcodes" in BRM Opcode Guide for more information.
BRMARServices_v2	Defines the accounts receivable Web service, which includes the following opcodes: PCM_OP_AR_ACCOUNT_ADJUSTMENT PCM_OP_AR_ACCOUNT_WRITEOFF PCM_OP_AR_BILL_ADJUSTMENT PCM_OP_AR_BILL_DISPUTE PCM_OP_AR_BILL_SETTLEMENT PCM_OP_AR_BILL_WRITEOFF PCM_OP_AR_BILLINFO_WRITEOFF PCM_OP_AR_EVENT_ADJUSTMENT PCM_OP_AR_EVENT_DISPUTE PCM_OP_AR_EVENT_SETTLEMENT PCM_OP_AR_GET_ACCT_ACTION_ITEMS PCM_OP_AR_GET_ACCT_BAL_SUMMARY PCM_OP_AR_GET_ACCT_BILLS PCM_OP_AR_GET_ACTION_ITEMS PCM_OP_AR_GET_BAL_SUMMARY PCM_OP_AR_GET_BILLS PCM_OP_AR_GET_BILL_ITEMS PCM_OP_AR_GET_DISPUTES PCM_OP_AR_GET_DISPUTE_DETAILS PCM_OP_AR_GET_ITEMS PCM_OP_AR_GET_ITEM_DETAILS PCM_OP_AR_ITEM_ADJUSTMENT PCM_OP_AR_ITEM_DISPUTE PCM_OP_AR_ITEM_SETTLEMENT PCM_OP_AR_ITEM_WRITEOFF PCM_OP_AR_RESOURCE_AGGREGATION See "Accounts Receivable FM Standard Opcodes" in BRM Opcode Guide for more information.
BRMBALServices_v2	Defines the balances Web service, which includes the following opcodes: PCM_OP_BAL_CHANGE_VALIDITY PCM_OP_BAL_GET_BALANCES PCM_OP_BAL_GET_ECE_BALANCES Note: You must perform configuration steps before calling this opcode. See "Configuring BRM to Use PCM_OP_BAL_GET_ECE_BALANCES". PCM_OP_BAL_GET_BAL_GRP_AND_SVC PCM_OP_BAL_GET_ACCT_BAL_GRP_AND_SVC PCM_OP_BAL_GET_ACCT_BILLINFO See "Balance FM Standard Opcodes" in BRM Opcode Guide for more information.
BRMBILLServices_v2	Defines the billing Web service, which includes the following opcodes: PCM_OP_BILL_DEBIT PCM_OP_BILL_FIND PCM_OP_BILL_GET_ITEM_EVENT_CHARGE_DISCOUNT PCM_OP_BILL_GROUP_GET_PARENT PCM_OP_BILL_GROUP_MOVE_MEMBER PCM_OP_BILL_ITEM_EVENT_SEARCH PCM_OP_BILL_ITEM_REFUND PCM_OP_BILL_MAKE_BILL_NOW PCM_OP_BILL_REVERSE PCM_OP_BILL_SET_LIMIT_AND_CR PCM_OP_BILL_VIEW_INVOICE See "Billing FM Standard Opcodes" in BRM Opcode Guide for more information.
BRMCOLLECTIONSServices_v2	Defines the collections Web service, which includes the following opcode: PCM_OP_COLLECTIONS_SET_ACTION_STATUS See "Collections Manager FM Standard Opcodes" in BRM Opcode Guide for more information.
BRMCUSTCAREServices_v2	Defines the customer care Web service, which includes the following opcode: PCM_OP_CUSTCARE_MOVE_ACCT
BRMCUSTServices_v2	Defines the customer Web service, which includes the following opcodes: PCM_OP_CUST_COMMIT_CUSTOMER PCM_OP_CUST_CREATE_PROFILE PCM_OP_CUST_DELETE_ACCT PCM_OP_CUST_DELETE_PAYINFO PCM_OP_CUST_DELETE_PROFILE PCM_OP_CUST_FIND PCM_OP_CUST_FIND_PAYINFO PCM_OP_CUST_FIND_PROFILE PCM_OP_CUST_GET_NOTE PCM_OP_CUST_MODIFY_CUSTOMER PCM_OP_CUST_MODIFY_PROFILE PCM_OP_CUST_SET_NOTE PCM_OP_CUST_SET_STATUS PCM_OP_CUST_SET_TAXINFO PCM_OP_CUST_UPDATE_CUSTOMER PCM_OP_CUST_UPDATE_SERVICES See "Customer FM Standard Opcodes" in BRM Opcode Guide for more information. PCM_OP_CUST_POL_GET_PLANS PCM_OP_CUST_POL_GET_DEALS PCM_OP_CUST_POL_GET_PRODUCTS PCM_OP_CUST_POL_READ_PLAN See "Customer FM Policy Opcodes" in BRM Opcode Guide for more information.
BRMINVServices_v2	Defines the invoicing Web service, which includes the following opcode: PCM_OP_INV_VIEW_INVOICE Important: You must configure your client application to convert the invoice data received from the PCM_OP_INV_VIEW_INVOICE opcode into the appropriate format. See "About Invoicing Output XML Data" in BRM JCA Resource Adapter. See "Invoicing FM Standard Opcodes" in BRM Opcode Guide for more information.
BRMPYMTServices_v2	Defines the payment Web service, which includes the following opcode: PCM_OP_PYMT_COLLECT See "Payment FM Standard Opcodes" in BRM Opcode Guide for more information.
BRMREADServices_v2	Defines the read Web service, which includes the following opcodes: PCM_OP_READ_FLDS PCM_OP_READ_OBJ PCM_OP_SEARCH PCM_OP_TEST_LOOPBACK See "LDAP Base Opcodes" in BRM Opcode Guide for more information.
BRMSUBSCRIPTIONServices_v2	Defines the subscription Web service, which includes the following opcodes: PCM_OP_SUBSCRIPTION_CANCEL_DEAL PCM_OP_SUBSCRIPTION_CANCEL_PRODUCT PCM_OP_SUBSCRIPTION_CANCEL_DISCOUNT PCM_OP_SUBSCRIPTION_CANCEL_SUBSCRIPTION PCM_OP_SUBSCRIPTION_CHANGE_DEAL PCM_OP_SUBSCRIPTION_GET_HISTORY PCM_OP_SUBSCRIPTION_PURCHASE_DEAL PCM_OP_SUBSCRIPTION_PURCHASE_FEES PCM_OP_SUBSCRIPTION_READ_ACCT_PRODUCTS PCM_OP_SUBSCRIPTION_SERVICE_BALGRP_TRANSFER PCM_OP_SUBSCRIPTION_SET_BUNDLE PCM_OP_SUBSCRIPTION_SET_DISCOUNT_STATUS PCM_OP_SUBSCRIPTION_SET_DISCOUNTINFO PCM_OP_SUBSCRIPTION_SET_PRODINFO PCM_OP_SUBSCRIPTION_SET_PRODUCT_STATUS PCM_OP_SUBSCRIPTION_TRANSFER_SUBSCRIPTION PCM_OP_SUBSCRIPTION_TRANSITION_DEAL PCM_OP_SUBSCRIPTION_TRANSITION_PLAN PCM_OP_SUBSCRIPTION_GET_PURCHASED_OFFERINGS See "Subscription Management FM Standard Opcodes" in BRM Opcode Guide for more information.

Configuring BRM to Use PCM_OP_BAL_GET_ECE_BALANCES

Before you can call the PCM_OP_BAL_GET_ECE_BALANCES opcode, you must configure BRM to support the opcode. To do so, add the following entry to your Connection Manager (CM) configuration file (BRM_home/sys/cm/pin.conf):

- cm em_group ece PCM_OP_BAL_GET_ECE_BALANCES

Stop and restart the CM for the changes to take effect.

About Validating Input and Output XML Data

Web Services Manager validates the input and output XML by comparing the XML fields and values against the opcode XML schema.

The opcode specifications, schemas, and WSDL files are packaged along with Web Services Manager. The package includes the opspec.xsd file and the pin_opspec_to_schema utility. Use the opspec.xsd file to write opcode specifications for custom opcodes that need to be exposed as a Web service. Use the pin_opspec_to_schema utility to generate the schema files from the opcode specification files.

To configure Web Services Manager to validate the input and output XML against the target opcode XML schema:

Open the local_dir/WEB-INF/classes/Infranet.properties file.
Add the following entries to the file:
- webservices.input.validation.enabled=true
- webservices.output.validation.enabled=true
Do one of the following:
- If you are using WebLogic Server, copy the schema files packaged as a part of Web Services Manager installation from the BRM_home/deploy/web_services/schemas directory to the local_dir/common/lib directory.
- If you are using any supported server, copy the schema files from the BRM_home/deploy/web_services/schemas directory to the local_dir/WEB-INF/classes directory.

About Developing and Testing Client Applications with Web Services Manager

You can develop custom applications that interact with BRM through Web Services Manager. Use a SOAP development environment that supports importing WSDL files (for example, SoapUI) to develop and test your custom Web service applications. SOAP development applications may have minor differences in product configuration. Consult your SOAP development application documentation for configuration information.

In general, do the following to develop and test your Web services applications:

Download and install a SOAP development application.
Configure a new project in your SOAP development application.
Write a client application that communicates with Web services using the SOAP protocol.
Import the Web service definitions using the WSDL files. See "About WSDL Files and BRM Opcodes" for more information on accessing WSDL files.
Run the required commands to set up your application server environment.
Configure the properties of the Web services operations in your SOAP development environment with valid credentials.
Send a Web service request to BRM from the SOAP development environment client.
View the Web service response in the SOAP development environment.

Example of Testing a Web Services Implementation Using a Client Application

To test your Web services implementation, write a client application that communicates with the Web service using the SOAP protocol.

This sample procedure demonstrates how to use the TestClient.java sample code with the PCM_OP_TEST_LOOPBACK opcode to verify communication between BRM and the Web service. The sample uses WebLogic Server, but you can apply the concepts to any other supported application server.

Do one of the following, which sets up the WebLogic Server environment:
- If WebLogic is installed on a Linux host, run WebLogic_home/wlserver/server/bin/setWLSEnv.sh
- If WebLogic is installed on a Windows host, run WebLogic_home/server/bin/setenv.exe
where WebLogic_home is the directory in which you installed the WebLogic Server.

Create an XML file (some_name_1.xml) using the following text:

<project name="buildWebservice" default="all">
<property name="buildDir" value="./myapps" />
<property name="jarFiles" value="jars" />
<target name="all" depends="jar" description="builds everything">
</target>
<target name="generate-client">
<clientgen wsdl="http://198.51.100.1:7001/infranetwebsvc/services/Infranet?wsdl"       
packageName="test_client"  
destDir= "./myapps"/>       
</target>
<target name="compile" depends="generate-client" description="compile source files">
    <echo> Compiling adapter files</echo>
    <javac  destdir="${buildDir}">
        <src path="${buildDir}"/>
    </javac>
</target>
<target name="jar" depends="compile" description="generate jar file(s)">
    <jar jarfile="clientStub.jar"  basedir="${buildDir}">
    <exclude name = "**/*.java"/>

    </jar>
</target>
<target name="clean" description="remove files created by target prepare">
    <delete dir="${buildDir}"/>
</target>
</project>

This XML file uses the WebLogic Server clientgen task to automatically generate a utility library that provides low-level SOAP communication (client stubs).

Run the following command, which creates the client stubs:

ant -file some_name_1.xml

This process generates the clientstubs.jar file, which contains stubs used by the client. The test client code (source_home/TestClient.java, where source_home is the directory where your source code files are stored) then creates an flist, converts it to XML, and calls the PCM_OP_TEST_LOOPBACK opcode.

The following is a sample listing of TestClient.java:

import java.io.IOException;
import test_client.*;  // corresponds to package name clientgen generated 

public class TestClient {

    public static void main(String[] args) {
        try {

            String wsdlUrl = 
"http://198.51.100.1:7001/infranetwebsvc/services/Infranet?wsdl"; 
            InfranetWebServiceService service = new InfranetServiceService_Impl( wsdlUrl );
            InfranetWebService port = service.getInfranet();

            // convert flist to XML representation
            String XMLInput="<flist xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"><POID>0.0.0.1 /account 80408 8</POID></flist>";
            System.out.println("Input: " + XMLInput);
            // invoke web service ‘opcode' method
            String result = port.opcode("TEST_LOOPBACK", XMLInput);
    
            System.out.println("result: "+ result);

        } catch (Exception ex) {
            ex.printStackTrace();    
        }
    }
}

Create another XML file (some_name_2.xml) using the following text:

Note:

Replace the paths for the JAR files as required.

<project name="test_client" default="all">

<target name="all" depends="run"/>

<path id="classpath">
    <pathelement path="clientstubs.jar"/>
    <pathelement path=".\classes"/>
    <pathelement path="D:\WebServices\webman\lib\jaxrpc.jar"/>
    <pathelement path="D:\bea\wlserver_10.3\server\lib\wseeclient.jar"/>
    <pathelement path="D:\bea\wlserver_10.3\server\lib\weblogic.jar"/>
</path>

c
<target name="compile">
    <mkdir dir="classes"/>
    <javac  srcdir="src" 
        destdir="classes"
        classpathref="classpath"
    />
</target>

<target name="run" depends="compile">
    <java classname="TestClient"
            fork="yes"
            classpathref="classpath">
    </java>
</target>

</project>

Build and run the test with the some_name_2.xml file using regular Ant tasks:
```
ant -file some_name_2.xml
```

Testing the Web Service

To test your Web services implementation, use a SOAP development application that supports importing WSDL files, for example SoapUI. SOAP development applications may have minor differences in project configuration. Consult your SOAP development environment documentation for configuration information.

To test your Web services implementation, write a client application that communicates with the Web service using the SOAP protocol.

Note:

You can test Web services using SoapUI version 4.6.3.

The sample procedures use WebLogic Server, but you can apply the concepts to any other supported server.

For example, with WebLogic Server:

Run one of the following commands, which set up the WebLogic Server environment:
- If WebLogic is installed on a Linux host: WebLogic_home/wlserver/server/bin/setWLSEnv.sh
- If WebLogic is installed on a Windows host: WebLogic_home/server/bin/setenv.exe
  
  where WebLogic_home is the directory in which you installed the WebLogic Server.

Create an XML file (some_name_1.xml) using the following text:

<project name="buildWebservice" default="all">
<property name="buildDir" value="./myapps" />
<property name="jarFiles" value="jars" />
<target name="all" depends="jar" description="builds everything">
</target>
<target name="generate-client">
<clientgen wsdl="http://198.51.100.1:7001/infranetwebsvc/services/Infranet?wsdl"       
packageName="test_client"  
destDir= "./myapps"/>       
</target>
<target name="compile" depends="generate-client" description="compile source files">
    <echo> Compiling adapter files</echo>
    <javac  destdir="${buildDir}">
        <src path="${buildDir}"/>
    </javac>
</target>
<target name="jar" depends="compile" description="generate jar file(s)">
    <jar jarfile="clientStub.jar"  basedir="${buildDir}">
    <exclude name = "**/*.java"/>

    </jar>
</target>
<target name="clean" description="remove files created by target prepare">
    <delete dir="${buildDir}"/>
</target>
</project>

This XML file uses the WebLogic Server clientgen task to automatically generate a utility library that provides low-level SOAP communication (client stubs).

Run the following command, which creates the client stubs:

ant -file some_name_1.xml

This process generates the clientstubs.jar file, which contains stubs used by the client. The test client code (src\TestClient.java) then creates an flist, converts it to XML, and calls the PCM_OP_TEST_LOOPBACK opcode.

The following is a sample listing of TestClient.java:

import java.io.IOException;
import test_client.*;  // corresponds to package name clientgen generated 

public class TestClient {

public static void main(String[] args) {
        try {

            String wsdlUrl = 
"http://198.51.100.1:7001/infranetwebsvc/services/Infranet?wsdl"; 
            InfranetWebServiceService service = new InfranetServiceService_Impl( wsdlUrl );
            InfranetWebService port = service.getInfranet();

            // convert flist to XML representation
            String XMLInput="<flist xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"><POID>0.0.0.1 /account 80408 8</POID></flist>";
            System.out.println("Input: " + XMLInput);
            // invoke web service ‘opcode' method
            String result = port.opcode("TEST_LOOPBACK", XMLInput);
    
            System.out.println("result: "+ result);

        } catch (Exception ex) {
            ex.printStackTrace();    
        }
    }
}

Create another XML file (some_name_2.xml) using the following text:

Note:

Replace the paths for the JAR files as required.

<project name="test_client" default="all">

<target name="all" depends="run"/>

<path id="classpath">
    <pathelement path="clientstubs.jar"/>
    <pathelement path=".\classes"/>
    <pathelement path="D:\WebServices\webman\lib\jaxrpc.jar"/>
    <pathelement path="D:\bea\wlserver_10.3\server\lib\wseeclient.jar"/>
    <pathelement path="D:\bea\wlserver_10.3\server\lib\weblogic.jar"/>
</path>

c
<target name="compile">
    <mkdir dir="classes"/>
    <javac  srcdir="src" 
        destdir="classes"
        classpathref="classpath"
    />
</target>

<target name="run" depends="compile">
    <java classname="TestClient"
            fork="yes"
            classpathref="classpath">
    </java>
</target>

</project>

Build and run the test with the some_name_2.xml file using regular Ant tasks:
```
ant -file some_name_2.xml
```

Using Sample Web Services Programs

Web Services Manager includes sample programs that demonstrate how to write code for various tasks when customizing Web services. For example, the sample program InfranetBALTestClient.java creates an flist, converts it to XML, and calls the PCM_OP_BAL_GET_BALANCES opcode.

Example of Reading an Account Object in BRM Using Web Services

This section describes an example of reading an account object using Web services. It shows the sample SOAP request and a response message.

To read an account object in BRM using Web services, you call the pcmOpReadObj Web service API that maps to the PCM_OP_READ_OBJ opcode. The pcmOpReadObj Web service API is included in the BRMReadServices_v2 Web service, which contains Web service APIs that are related to read accounts. See "About WSDL Files and BRM Opcodes" for more information about the Web services included in the Web Services Manager package.

You use URLs to create SOAP clients for Web services. The URL is generated by the JAX-WS in Oracle WebLogic Server.

To generate the URL for a Web service:

Log in to the WebLogic Server Administration Console.
Go to the deployments section.
Click BrmWebServices link.

The Settings page for the deployment appears and all the web services are listed in the Modules and Components section.
Click the web service in the Modules and Components section.
Click the Testing tab.
The WebLogic Server Administration console displays a URL for the BRM web services.

A sample URL for the BRMReadServices_v2 Web service is as follows:

http://hostIPAddress:port/BrmWebServices/BRMReadServices_v2?wsdl

To call a Web service, users are required to authenticate using a valid user name and a password. Users can call only those Web services that they are authorized to call.

Sample SOAP Request Input XML File

The following sample shows a SOAP request for the pcmOpReadObj Web service API:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:bus="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">
   <soapenv:Header/>
   <soapenv:Body>
      <bus:pcmOpReadObjRequest>
         <bus:PCM_OP_READ_OBJ_Request>
            <bus:flags>0</bus:flags>
            <bus:PCM_OP_READ_OBJ_inputFlist>
               <bus:POID>0.0.0.1 /account 1 0</bus:POID>
            </bus:PCM_OP_READ_OBJ_inputFlist>
         </bus:PCM_OP_READ_OBJ_Request>
      </bus:pcmOpReadObjRequest>
   </soapenv:Body>
</soapenv:Envelope>

Sample SOAP Response Output XML File

The following sample shows a SOAP response message for the pcmOpReadObj Web service API:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <pcmOpReadObjResponse xmlns="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">
         <brm:AAC_ACCESS xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes"/>
         <brm:AAC_PACKAGE xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes"/>
         <brm:AAC_PROMO_CODE xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes"/>
         <brm:AAC_SERIAL_NUM xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes"/>
         <brm:AAC_SOURCE xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes"/>
         <brm:AAC_VENDOR xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes"/>
         <brm:ACCESS_CODE1 xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes"/>
         <brm:ACCESS_CODE2 xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes"/>
         <brm:ACCOUNT_NO xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">ROOT</brm:ACCOUNT_NO>
         <brm:ACCOUNT_TAG xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes"/>
         <brm:ACCOUNT_TYPE xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">2</brm:ACCOUNT_TYPE>
         <brm:ATTRIBUTE xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">0</brm:ATTRIBUTE>
         <brm:BAL_GRP_OBJ xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">0.0.0.1 /balance_group 1 0</brm:BAL_GRP_OBJ>
         <brm:BRAND_OBJ xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">0.0.0.1 /account 1 0</brm:BRAND_OBJ>
         <brm:BUSINESS_TYPE xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">0</brm:BUSINESS_TYPE>
         <brm:CLOSE_WHEN_T xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">1970-01-01T00:00:00Z</brm:CLOSE_WHEN_T>
         <brm:CONTEXT_INFO xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">
            <brm:CORRELATION_ID>1724742721778T49</brm:CORRELATION_ID>
         </brm:CONTEXT_INFO>
         <brm:CREATED_T xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">2024-05-05T15:26:19Z</brm:CREATED_T>
         <brm:CURRENCY xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">840</brm:CURRENCY>
         <brm:CURRENCY_SECONDARY xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">0</brm:CURRENCY_SECONDARY>
         <brm:CUSTOMER_SEGMENT_LIST xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes"/>
         <brm:EFFECTIVE_T xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">2024-05-05T15:26:19Z</brm:EFFECTIVE_T>
         <brm:GL_SEGMENT xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes"/>
         <brm:GROUP_OBJ xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">0.0.0.0  0 0</brm:GROUP_OBJ>
         <brm:INCORPORATED_FLAG xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">0</brm:INCORPORATED_FLAG>
         <brm:INTERNAL_NOTES flags="0x00" offset="0" size="0" xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes"/>
         <brm:ITEM_POID_LIST xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">0.0.0.1|/item/misc 1 0</brm:ITEM_POID_LIST>
         <brm:LASTSTAT_CMNT xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes"/>
         <brm:LAST_STATUS_T xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">2024-05-05T15:26:19Z</brm:LAST_STATUS_T>
         <brm:LINEAGE xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">/</brm:LINEAGE>
         <brm:LOCALE xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes"/>
         <brm:MOD_T xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">2024-05-05T15:26:19Z</brm:MOD_T>
         <brm:NAME xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">Brand Host</brm:NAME>
         <brm:NAMEINFO elem="1" xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">
            <brm:ADDRESS/>
            <brm:CANON_COMPANY/>
            <brm:CANON_COUNTRY/>
            <brm:CITY/>
            <brm:COMPANY/>
            <brm:CONTACT_TYPE/>
            <brm:COUNTRY/>
            <brm:EMAIL_ADDR/>
            <brm:FIRST_CANON>system</brm:FIRST_CANON>
            <brm:FIRST_NAME>System</brm:FIRST_NAME>
            <brm:GEOCODE/>
            <brm:LAST_CANON>administrator</brm:LAST_CANON>
            <brm:LAST_NAME>Administrator</brm:LAST_NAME>
            <brm:MIDDLE_CANON/>
            <brm:MIDDLE_NAME/>
            <brm:SALUTATION/>
            <brm:SERVICE_OBJ>0.0.0.0  0 0</brm:SERVICE_OBJ>
            <brm:STATE/>
            <brm:TAXPKG_TYPE>0</brm:TAXPKG_TYPE>
            <brm:TITLE/>
            <brm:ZIP/>
         </brm:NAMEINFO>
         <brm:NEXT_ITEM_POID_LIST xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes"/>
         <brm:OBJECT_CACHE_TYPE xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">0</brm:OBJECT_CACHE_TYPE>
         <brm:POID xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">0.0.0.1 /account 1 1</brm:POID>
         <brm:READ_ACCESS xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">L</brm:READ_ACCESS>
         <brm:RESIDENCE_FLAG xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">0</brm:RESIDENCE_FLAG>
         <brm:STATUS xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">10100</brm:STATUS>
         <brm:STATUS_FLAGS xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">0</brm:STATUS_FLAGS>
         <brm:TIMEZONE_ID xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes"/>
         <brm:VAT_CERT xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes"/>
         <brm:WRITE_ACCESS xmlns:brm="http://xmlns.oracle.com/BRM/schemas/BusinessOpcodes">L</brm:WRITE_ACCESS>
      </pcmOpReadObjResponse>
   </S:Body>
</S:Envelope>

About Data Masking in Web Services Responses

SOAP output response XML files may contain masked fields as configured by your BRM implementation. Subscriber fields, including payment information and user credentials, may be hidden in responses for securing sensitive subscriber data.

See "Masking Sensitive Customer Data" in BRM Managing Customers for more information on configuring data masking.