Appendix: Delivered Web Services and Service Operations

This appendix discusses the delivered web services and service operations for the financial service industries.

Delivered Web Services

This section discusses:

• The financial account web service.

• The policy web service.

• The claims web service.

• The at risk web service.

• How to view the message elements.

See Also

Working with Business Processes and Web Services

Financial Account Web Service

The Financial Account (RBF_FINACCOUNT) web service is available with the following operations:

• Create Account

  Takes financial account data as input and creates a financial account record and associated child records in the CRM system.

• Get Account

  Returns a financial account record and its associated child record based on a passed unique identifier.

• Search Account

  Returns a list of financial account records and the associated child records based on criteria field values passed via the input message.

• Update Account

  Modifies the attributes of the financial account data structure.

• Change Account Address

  Takes the account number and new address data as input and changes the address in the CRM system for that account.

This table provides the technical names, operation type, and messages names of the service operations that are related to the web services:

Policy Web Service

The Policy (RBI_POLICY) web service is available with the following operations:

• Create Policy

  Takes insurance policy data as input and creates an insurance policy record and associated child records in the CRM system.

• Get Policy

  Returns a policy record and its associated child record based on a passed unique identifier.

• Search Policy

  Returns a list of policy records and their associated child records based on criteria field values passed via the input message.

• Update Policy

  Modifies the attributes of the policy structure.

This table provides the technical names, operation type, and messages names of the service operations that are related to the web services:

Claims Web Service

The Claim (RBI_CLAIM) web service is available with the following operations:

• Create Claim

  Takes claim related data as input and creates a claim record and associated child records in the CRM system

• Update Claim

  Takes claim information as input and updates the claim data in the CRM system.

This table provides the technical names, operation type, and messages names of the service operations that are related to the web services:

At Risk Web Service

The At Risk (RBW_RISK ) web service contains the Create Client at Risk operation, which provides the ability to add an At Risk record for an existing wealth management client.

The Create Client at Risk operation assumes the user enters the BO_ID and ROLE_TYPE_ID to identify the client, as well as the RISK_REASON, RISK_PRIORITY, and RISK_STATUS codes that are to be associated to that client. If the RISK_REASON is Lost, then a value is also expected for the LOST_REASON element. The financial summary information for the specified client is calculated and returned in the response message.

This table provides the technical names, operation type, and messages names of the service operations that are related to the web service:

Viewing the Message Elements

You can view the elements and fields that are included in each operation message through PeopleTools.

To view a list of field names and aliases for a particular message:

1. Select PeopleTools, Integration Broker, Integration Setup, Messages.

2. Enter RBF, RBW, or RBI in the Message Name field and click Search.

   The system lists all the messages that are related to financial services or insurance.

3. Select the message you want to view.

4. Click the message name link under the Parts grid.

   The system opens the Message Definition page in a new browser.

5. Click the plus sign next to the table name at the bottom of the page to view the fields and aliases associated with the message.