Appendix: Business Object Delivered Web Services

This appendix discusses the following web services, and provides guidelines on how to view message elements:

• Customer

• Translate Field

• Interaction

See Also

Understanding Web Services

Customer

Oracle's PeopleSoft Enterprise CRM delivers these service operations for the Customer (RB_CUSTOMER) web service:

• Get Customer.

  This operation takes a BO ID (as well as Role Type ID, BO Rel ID, BO ID 2, and Role Type ID 2) and returns information of the corresponding customer.

  Note. Version 1 of this web service was delivered with PeopleSoft CRM 9.0. Use version 2 of the web service for enhanced retrieval of contact method data.

• Search Contact.

  This operation takes search criteria for company contacts or consumers, and returns the information of business objects that satisfy the search criteria.

• Search Customer.

  This operation takes search criteria for companies, consumers, sites or partners, and returns information of business objects that satisfy the search criteria.

• Search Worker.

  This operation takes search criteria for workers and returns the information of workers that satisfy the search criteria.

• Add Company

  This operation takes information regarding a desired new company, creates the entry in the system, and returns the Set ID, BO ID, Role Type ID, and CUST ID of the newly created company.

• Add Consumer

  This operation takes information regarding a desired new consumer, creates the entry in the system, and returns the Set ID, BO ID, Role Type ID, CUST ID, and Person ID of the newly created consumer.

• Activate Customer

  This operation takes the BO ID and Role Type ID of a customer and activates that entry. The BO ID and Role Type ID are also returned by the operation, along with an updated time stamp value for the Last Maintained Date and Time.

• Inactivate Customer

  This operation takes the BO ID and Role Type ID of a customer and inactivates that entry. The BO ID and Role Type ID are also returned by the operation, along with an updated time stamp value for the Last Maintained Date and Time.

• Update Customer for Company

  This operation takes information to be updated for an existing company, updates the entry in the system, and returns the Set ID, BO ID, Role Type ID, and CUST ID of the newly updated company.

• Update Customer for Consumer

  This operation takes information to be updated for an existing consumer, updates the entry in the system, and returns the Set ID, BO ID, Role Type ID, CUST ID, and Person ID of the newly updated consumer.

• Add Site

  This operation takes information regarding a desired new site, creates the entry in the system, and returns the Set ID, BO ID, Role Type ID, and Site ID of the newly created site.

• Add Business Contact

  This operation takes information regarding a desired new business contact, creates the entry in the system, and returns the BO ID, Role Type ID, and Person ID of the newly created business contact.

• Add Contact to Company

  This operation takes information regarding a customer and the business contact to be added to that customer, creates the relationship in the system, and returns the Count Total and BO Rel ID.

• Add Contact to Site

  This operation takes information regarding a siteand the business contact to be added to that site, creates the relationship in the system, and returns the Count Total and BO Rel ID.

• Add Account Team Member or Owner to Customer

  This operation takes information regarding a customer and the account team member or owner to be added to that customer, creates the relationship in the system, and returns the Count Total and BO Rel ID.

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

Translate Field

Oracle's PeopleSoft Enterprise CRM delivers the Get Translate Codes service operation for the Translate Field (RB_TRANSLATEFIELD) web service. This operation takes the name of a translate field and returns a list of translate codes for that field.

This table provides the technical names, operation type, and messages names of the service operation that is related to the Translate Field web services:

Interaction

Oracle's PeopleSoft Enterprise CRM delivers the Create Interaction with Note service operation for the Interaction (RI_INTERACTION ) web service. This operation provides the ability to create an interaction for a customer, contact or partner along with a note sub-interaction. The SetID, Interaction ID, and Sequence Number of the new transaction is returned in the response message.

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

Viewing Message Elements

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

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

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

• Enter the name of the message you want to view in the Message Name field and click Search.

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

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