Appendix: Product Delivered Web Services

This appendix discusses the delivered Installed Product and Product Service web services, and provides guidelines on how to view message elements.

Delivered Web Services

This section discusses:

• The Installed Product web service.

• The Product Service web service.

See Also

Working with Business Processes and Web Services

Installed Product Web Service

PeopleSoft CRM delivers these service operations for the Installed Product web service:

• Create Installed Product

  This operation creates an installed product using the existing component interface (CI) in the CRM system. The component provides normal defaulting and processing. The return message indicates success or failure and includes the installed product ID and setID.

• Get Installed Product

  This operation requires a setID and installed product ID. The CI is used so that all security is enforced.

• Search Installed Product

  Similar to the agent-facing installed product search, you can send various types of data in your request. This operation returns a list of installed products that meet all the given criteria.

• Update Installed Product

  This operation updates an installed product using the existing CI in the CRM system. The component provides normal defaulting and processing. The return message indicates success or failure and includes the installed product ID and setID.

These usage rules apply to the Update Installed Product service operation:

• If no update is intended for any row in a child rowset (status, warranty, or attribute), you may omit all the rows for that child rowset and the existing child rows will be retained.

  For example, if there are five status rows and you send zero status rows in the update, the existing five status rows are retained without change. However, if there is an update needed for any single row in the status rowset or warranty rowset, you must provide all rows in that rowset, regardless of whether they all have an update or not. If there are five status rows and you want to change one, add one, and delete one, send the full set of final rows (the one that has the changed value, the three that remain unchanged, and the one new one).

• The attribute rowset is included to allow you to set and change values of attributes for existing installed products.

• No attributes can be deleted.

• Because we do not allow deletes for the attribute rowset, it is sufficient to send only the changed entries or the new entries if there is an update or add required for the attribute rowset.

  For example, if there are five attribute rows and one needs an update, you only need to send the row that has the update. The four other existing rows are retained and untouched.

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

Product Service Web Service

PeopleSoft delivers these service operations for the Product Service (CO_PRODUCT) web service:

• Get Product Details

  This operation takes a product ID and returns information about the matching product.

• Get Terms And Conditions Synchronization Search

  This operation takes a product ID and returns information about the terms and conditions that apply to the matching product.

• Get Catalog

  This operation takes a catalog ID and returns information about the matching catalog.

• Search Financial Product

  This operation takes search parameters (product ID, setID, product description, product package, arrangement, and coverage) that are entered for products and returns a list of matching financial products.

• Search Product

  This operation takes search parameters (product ID, setID, description, product type, and effective status) that are entered for products and returns a list of matching products.

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

Viewing 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 the name of the message you want to view in the Message Name field and click Search.

3. The Message Definition page appears. Click the message name link under the Parts grid.

   The system opens the Message Definition page in a new browser. This step is required only if you selected a container message. If you selected a parts message in step 2 above, proceed directly to step 4.

   Note. The system utilizes both container messages and parts messages. A container message may contain one or more parts. The parts message has the actual list of data fields.

4. 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.