Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

Transcription

1 May 2015 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact Release 9

2 Copyright 2005, 2014 Oracle and/or its affiliates. All rights reserved. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are commercial computer software pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government. This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services. Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at Access to Oracle Support Oracle customers have access to electronic support through My Oracle Support. For information, visit or visit if you are hearing impaired.

3 Contents 1 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact... 9 Overview of Oracle Sales Cloud Web Services... 9 Overview of Simplified SOAP Web Services... 9 Understanding the Process Flow for Consuming a SOAP Web Service Searching for Relevant Web Services Using the OER Accessing WSDL URL Determining Which Web service to Use to Implement Your Use Case Prototyping Payloads and Evaluating if a Web Service Meets Your Business Requirements Using the Fusion Service Tester Prototyping Payloads and Evaluating Web Services Using the JDeveloper HTTP Analyzer Prototyping Payloads and Evaluating Web Services Using Third Party Tools How do I? Managing Accounts Using the Simplified Sales Cloud Account Web Service (AccountService) Create an Account Programmatically Using createaccount Search for an Account Programmatically Using findaccount Update an Account and its Primary Address Programmatically Using updateaccount Delete an Account Programmatically Using deleteaccount Retrieve an Account Programmatically Using getaccount Merge an account Programmatically Using mergeaccount Perform a Specific Operation (Create, Update, Delete, or Merge) on a List of Accounts Using processaccount Managing Contacts Using the Simplified Sales Cloud Contact Web Service (ContactService) Create a Contact Programmatically Using createcontact Search for a Contact Programmatically Using findcontact Update a Contact and its Primary Address Programmatically Using updatecontact Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 3

4 Contents Delete a Contact Programmatically Using deletecontact Retrieve a Contact Programmatically Using getcontact Merge a Contact Programmatically Using mergecontact Perform a Specific Operation (Create, Update, Delete, or Merge) on a List of Contacts Using processcontact Managing Households Using the Simplified Sales Cloud Household Web Service Create a Household Programmatically Using createhousehold Search for a Household Programmatically Using findhousehold Update a Household and its Primary Address Programmatically Using updatehousehold Delete a Household Programmatically Using deletehousehold Retrieve a Household Programmatically Using gethousehold Merge a Household Programmatically Using mergehousehold Perform a Specific Operation (Create, Update, Delete, or Merge) on a List of Households Using processhousehold Managing Addresses Using the Simplified Sales Cloud Address Web Service (AddressService) Create an Address Programmatically Using createaddress Search for an Address Programmatically Using findaddress Update an Address and Address Purpose Programmatically Using updateaddress Delete an Address Programmatically Using deleteaddress Retrieve an Address Programmatically Using getaddress Merge an Address Programmatically Using mergeaddress Managing Relationships Using the Simplified Sales Cloud Relationship Web Service Create a Relationship Programmatically Using createrelationship Search for a Relationship Programmatically Using findrelationship Update a Relationship and its Primary Address Programmatically Using updaterelationship Merge a Relationship Programmatically Using mergerelationship Perform a Specific Operation (Create, Update, Delete, or Merge) on a List of Relationships Using processrelationship Invoking A Simplified Web Service Using Web Service Proxy Clients Points to Consider While Designing Web Service Proxy Clients Invoking A Simplified Web Service Using A Static Proxy Authentication Sales Cloud Account Simplified Web Services Interface Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

5 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact Overview of Oracle Sales Cloud Web Services Operations createaccount deleteaccount findaccount getaccount mergeaccount processaccount processcsaccount updateaccount Sales Cloud Account SDO Sales Cloud Contact Simplified Web Services Interface Operations getcontact createcontact updatecontact deletecontact mergecontact findcontact processcontact processcscontact Sales Cloud Contact SDO Sales Cloud Household Simplified Web Services Interface Operations gethousehold createhousehold updatehousehold deletehousehold mergehousehold findhousehold processhousehold processcshousehold Sales Cloud Household SDO Sales Cloud Relationship Simplified Web Services Interface Operations createrelationship updaterelationship deleterelationship Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 5

6 Contents mergerelationship findrelationship processrelationship processcsrelationship Sales Cloud Relationship SDO Sales Cloud Address Simplified Web Services Interface Operations getaddress createaddress updateaddress mergeaddress deleteaddress findaddress processaddress processcsaddress Sales Cloud Address SDO Sales Cloud Address Purpose SDO Sales Cloud Primary Address SDO Appendix A: Downloading and Setting Up the Fusion Service Tester Installing JAVA on Windows machine Downloading the Fusion Service Tester Running the Fusion Service Tester Client Importing a New certificate in the keystore (for IE) Appendix B: Sample Code: Static Web Service Proxy JAX-WS Style Appendix C: Extracting Oracle Public Certificate from Fusion WSDL Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

7 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact Overview of Oracle Sales Cloud Web Services Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 7

8

9 1 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact Overview of Oracle Sales Cloud Web Services Oracle Sales Cloud comes with SOAP Web services that you can use to: Develop cloud applications that call on and integrate with Oracle Sales Cloud to deliver some of their functionality. You could sell these applications in the Oracle Cloud Marketplace. These applications might deliver other functionality independently or by integrating with third-party applications. Integrate suites of applications from third party vendors to Oracle Sales Cloud. Integrate different types of Oracle applications suites, such as Oracle E-Business Suite, with Oracle Sales Cloud. Customize and extend Oracle Sales Cloud applications to your business needs. Overview of Simplified SOAP Web Services The new and simplified SOAP Web services are a subset of Oracle Sales Cloud Web Services. These Web services make it easy to integrate accounts, contacts and households with other spoke systems. Simplified object structures represent logical views of accounts, contacts and households. You don t need to know the full data model to use the services correctly. Instead of calling multiple granular web services to orchestrate a set of customer record updates, you can now perform the most common customer data management actions with new APIs. For example, you can use one API call to create account with locations and associate the account with existing contacts. The following top level SOAP services are available: Sales Cloud Account Sales Cloud Contact Sales Cloud Household Use these services to create, edit, find, merge, and delete account, contact, and household objects. The services support commonly used profile attributes: one set of industry classification and parent node information attributes required to create an account hierarchy, address attributes, and one instance of different contact point type attributes such as phone, mobile, fax, and . The following child services are also available and allow you to manage multiple addresses and relationships for the three top level objects: Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 9

10 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact Understanding the Process Flow for Consuming a SOAP Web Service Sales Cloud Address Sales Cloud Relationship Steps to Enable There are no steps necessary to enable these enhancements. Tips and Considerations Attributes that are available on the simplified pages by default are available within each of the top-level services. The Sales Cloud Account service supports the management of an account hierarchy for a given account. The Sales Cloud Address service can be used only if there is more than one address related to the top level object. The top-level services do not support any relationships. Use the Sales Cloud Relationship service to manage relationships between any two top-level objects. Key Resources For more information about using Web Services in Oracle Sales Cloud, see: Getting Started with Web Services Sales Cloud Web Services: (MOS article ) Import Web-Service Guide: ( ) Understanding the Process Flow for Consuming a SOAP Web Service The following figure illustrates the typical stages of the process for consuming a SOAP Web Service: These stages are described below: Identifying the web services relevant to your business use case: Review the available services, for the object you want to work with, in Oracle Enterprise Repository and 10 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

11 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact Searching for Relevant Web Services Using the OER decide which service you want to use. For more information, see Searching for Web Services in OER. Prototyping payloads and evaluating if a web service meets your business requirements: You can do it by prototyping payloads and testing if the web service can actually perform the operations per your business requirements. You can prototype payloads and evaluate results using the Fusion Service Tester or the Oracle JDeveloper HTTP Analyzer. Alternatively, you can use third party tools, such as WebInject, SoapUI, and Strom, to test the Sales Cloud web services. For more information, see Determining Which Web service to Use to Implement Your Use Case. Building Web service clients using an IDE: You can use an appropriate IDE to develop a proxy client on a platform of your choice such as Java,.Net, or ASP to call Web services and integrate applications with Oracle Sales Cloud. You can build a static proxy, dynamic proxy, or a dynamic-static proxy depending on your business requirements. For more information, see Building Web Service Clients Using an IDE. Generating Keystore certificates: You have to generate keystore certificates only for running standalone JDK applications. You do not need to generate keystore certificates if you are running within the Weblogic Server. For more information, see Generating Keystore certificates: Points to Consider. Searching for Relevant Web Services Using the OER The simplified Web services let you perform simple operations. For example, the Sales Cloud Account service lets you manage (create, update, and delete) only simple organization accounts. You cannot use the Sales Cloud Account Web service to manage organization accounts with additional names and identifiers, multiple sets of addresses, contacts, industry classification information, and phone, and resources associated with the sales profile. To perform complex operations, you can use related services. For example, to manage complex accounts you could use Sales Party, Sales Account Service, and so on. You can identify the Web services relevant to your business use case by reviewing the available services, for the object you want to work with, in the Oracle Enterprise Repository (OER). The Oracle Enterprise Repository contains reference guides with detailed information on individual Web services. The OER includes all information about web services such as the LBA information, operations available, related service data objects (SDOs), and the Web service invocation methods. The following types of assets can be accessed in the repository: ADF Business Components services ADF Business Components service data objects Service Oriented Architecture (SOA) composites SOA composite services To access the information for a web service, follow these steps. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 11

12 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact Accessing WSDL URL 1. Using your browser, enter Sign in as a user or a guest to Oracle Enterprise Repository. 2. Search for assets, using the Web service name for your Search String. 3. Navigate to the results, and click the Documentation tab. The Detail tab includes the service WSDL URL and an abstract WSDL URL. You can modify the service WSDL URL to obtain the endpoint URL for the service. Accessing WSDL URL To get logical end point: Launch the OER ( and login as Guest. Search for the Web service that you need using an appropriate search string and type. For example, for the Sales Cloud Account Web service, use the following combination: Search String: Sales Cloud Account Type: ADF Service Select the service from the results section and see the Details tab in the bottom. That will have service logical end point as below. Service Path: The part " is dynamic for every environment where as "/crmcommonsalesparties/accountservice" is static for a given service version. To get physical end point of any given instance: Launch Oracle Sales Cloud home page and login as a functional user. Navigate to an application's dashboard/workarea page that belongs to Sales Cloud Account. For example: In case of Financial Util Service navigate to Payables or in case of Purchase Order Service navigate to Procurement. Let s take the Payables Invoice workbench as an example, you will see a URL in the browser similar to The <domainname> might be like In this URL, take the " For example, in case of Payables Invoice workbench URL just take till "payables". Then append the static context root that we extracted from OER - "/crmcommonsalesparties/accountservice" to it. is the WSDL URL for Sales Cloud Account. Determining Which Web service to Use to Implement Your Use Case Before you invest time and resources in building a custom proxy client application to call an Oracle Sales Cloud Web service, you much ascertain whether that Web services can meet your business requirements. This section outlines how you can identify the Web 12 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

13 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact Determining Which Web service to Use to Implement Your Use Case service that you need to use to implement your specific use case. The section describes the different options available to you for evaluating Oracle Sales Cloud Web services, by prototyping their input payloads and evaluating output payloads and results. You can test Oracle Sales Cloud Web services using the following tools: Fusion Service Tester Oracle JDeveloper HTTP Analyzer Third party tools Prototyping Payloads and Evaluating if a Web Service Meets Your Business Requirements Using the Fusion Service Tester You can use Oracle s Fusion Service Tester application to test Oracle Sales Cloud services. Review Appendix A to find out how to download it from the OER ( and set it up. After completing the setup steps, you can run the startfusionservicetester.bat to launch the Fusion Service Tester application. Evaluating the Simplified Account Service Use this procedure to evaluate the simplified Account service (AccountService). Prerequisites Ensure that the user credentials used to invoke the service has the required privilege to create an account in Oracle Sales Cloud Applications. Optionally, if you want to designate an account owner to any account you must ensure that the account owner exists. Identifying the Appropriate Web Service 1. Log in to Oracle Enterprise Repository. 2. Enter Account Service as the search string and select ADF Service in the Type field, and click Search. 3. Click Sales Cloud Account. 4. Note down the service interface name of the Web service oracle.apps.crmcommon.salesparties.accountservice.accountservice. Extracting the Web Services URL After you have identified the appropriate Web service in the Identify the Appropriate Web Service section, perform the following steps. Launch Oracle Sales Cloud home page and login as a functional user. Navigate to an application's dashboard/workarea page that belongs to Sales Cloud Account. For example: Navigator > Customers > Create Account. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 13

14 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact Determining Which Web service to Use to Implement Your Use Case Review the URL of the dashboard/workarea. You will see a URL in the browser similar to The <domainname> might be like In this URL, take the " Then append the static context root that we extracted from OER - "/crmcommonsalesparties/accountservice" to it. is the WSDL URL for Sales Cloud Account. If you have access to Oracle Enterprise Manager Fusion Applications Control, you can use the following steps: 1. Log in to the Oracle Enterprise Manager Fusion Applications Control using the Web Logic Server credentials. 2. Select Oracle Fusion Customer Relationship Management from the navigation tree, and then select Fusion Applications. 3. From the tree, select CrmCommonApp, and then select CrmCommonApp (CRMCommonServer_1). 4. In the Web Services pane on the right side of the page, scroll to the service name that you had noted down in the Identifying the Appropriate Web Service section, and click Test. 5. In the Test Web Service pane, copy the URL of a WSDL that appears in the WSDL field until "?wsdl", and then paste to a notepad. Deriving the Input Payload Perform the following steps, after you have launched the WSDL URL in a web browser. 1. In the AccountsService endpoint page, select createaccount from the Operation list. 2. In the Parameters pane, under Account, enter the name of the account in the OrganizationName field. 3. In the Parameters pane, under Account, enter an appropriate account type (ZCA_PROSPECT or ZCA_CUSTOMER) in the Type field. 4. Uncheck all the other fields. 5. Click the XML Source option that is next to the Operation list. 6. Copy the XML source and paste to a notepad. Invoking the Web Service Follow the below steps to invoke the Web service using Fusion Service Tester: Note: You can also use your custom proxy client application, JDeveloper HTTP Analyzer, and third party tools, such as SoapUI, to call a simplified Oracle Sales Cloud Web service. 1. Launch the Fusion Service Tester. Review Appendix A to find out how to download it from OER ( and set it up. 14 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

15 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact Determining Which Web service to Use to Implement Your Use Case 2. In the WebService URL field, paste the WSDL URL that you derived following the steps in the "Extracting the Web Services URL" section. 3. Enter the username and password credentials. 4. In the Input Payload pane, paste the XML source that you derived following the steps in the "Deriving the Input Payload" section. 5. Click Invoke. The Output Payload pane displays the output payload. Testing the Results 1. Copy and paste the output payload to a notepad. 2. Verify if the account has been created. 3. Log in to Oracle Sales Cloud Applications. 4. In the Customers work area, search for the new account you have created using the Manage Customers Classic UI page. You can also search using the Accounts simplified UI page. 5. Verify the account details. Evaluating the Simplified Contact Service Use this procedure to evaluate the simplified Contact service (ContactService). Prerequisites Ensure that the user credentials used to invoke the service has the required privilege to create a contact in Oracle Sales Cloud Applications. Identifying the Appropriate Web Service 1. Log in to Oracle Enterprise Repository. 2. Enter ContactService as the search string and select ADF Service in the Type field, and click Search. 3. Click Sales Cloud Contact. 4. Note down the service interface name of the Web service: oracle.apps.crmcommon.salesparties.contactservice.contactservice. Extracting the Web Services URL After you have identified the appropriate Web service in the Identify the Appropriate Web Service section, perform the following steps. Launch Oracle Sales Cloud home page and login as a functional user. Navigate to an application's dashboard/workarea page that belongs to Sales Cloud Contact. For example: Navigator > Customers > Create Contact. Review the URL of the dashboard/workarea. You will see a URL in the browser similar to The <domainname> might be like Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 15

16 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact Determining Which Web service to Use to Implement Your Use Case In this URL, take the " Then append the static context root that we extracted from OER - "/crmcommonsalesparties/contactservice" to it. is the WSDL URL for Sales Cloud Contact. If you have access to Oracle Enterprise Manager Fusion Applications Control, use the following steps: 1. Log in to the Oracle Enterprise Manager Fusion Applications Control using the Web Logic Server credentials. 2. Select Oracle Fusion Customer Relationship Management from the navigation tree, and then select Fusion Applications. 3. From the tree, select CrmCommonApp, and then select CrmCommonApp (CRMCommonServer_1). 4. In the Web Services pane on the right side of the page, scroll to the service name that you had noted down in the Identifying the Appropriate Web Service section, and click Test. 5. In the Test Web Service pane, copy the URL of a WSDL that appears in the WSDL field until "?wsdl", and then paste to a notepad. Deriving the Input Payload Perform the following steps, after you have launched the WSDL URL in a web browser. 1. In the ContactService endpoint page, select createcontact from the Operation list. 2. In the Parameters pane, under Contact, enter the first name and last name in the FirstName and LastName fields, respectively. 3. In the Parameters pane, under Contact, enter HZ_WS in the CreatedByModule field. Note: HZ_WS is the inbuilt code for Web Services. 4. Uncheck all the other fields. Note: In this example, the Type field is also unchecked. If you don t enter a value in the Type field, then the type is Business Contact, by default. 5. Click the XML Source option. Note: This option appears next to the Operation list. 6. Copy the XML source and paste to a notepad. Invoking the Web Service Follow the below steps to invoke the Web service using Fusion Service Tester: Note: You can also use your custom proxy client application, JDeveloper HTTP Analyzer, and third party tools, such as SoapUI, to call a simplified Oracle Sales Cloud Web service. 1. Launch the Fusion Service Tester. Review Appendix A to find out how to download it from OER ( and set it up. 16 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

17 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact Determining Which Web service to Use to Implement Your Use Case 2. In the WebService URL field, paste the WSDL URL that you derived following the steps in the "Extracting the Web Services URL" section. 3. Enter the username and password credentials. 4. In the Input Payload pane, paste the XML source that you derived following the steps in the "Deriving the Input Payload" section. 5. Click Invoke. The Output Payload pane displays the output payload. Evaluating the Results 1. Copy and paste the output payload to a notepad. 2. Verify if ZCA_Contact is assigned in the Type field, which is the default value for Contact. 3. Log in to Oracle Sales Cloud Applications. 4. In the Customers work area, search for the new contact that you have created using the Manage Contacts Classic UI page. You can also search using the Contacts simplified UI page. 5. Enter the first or last name in the Keywords field to search for the contact. 6. Verify the contact details. Evaluating the Simplified Household Service Use this procedure to evaluate the simplified Household service (HouseholdService). Prerequisites Ensure that the user credentials used to invoke the service has the required privilege to create a household in Oracle Sales Cloud Applications. Identifying the Appropriate Web Service 1. Log in to Oracle Enterprise Repository. 2. Enter HouseholdService as the search string and select ADF Service in the Type field, and click Search. 3. Click Sales Cloud Household. 4. Note down the service interface name of the Web service: oracle.apps.crmcommon.salesparties.householdservice.householdservice. Extracting the Web Services URL After you have identified the appropriate Web service in the Identify the Appropriate Web Service section, perform the following steps. Launch Oracle Sales Cloud home page and login as a functional user. Navigate to an application's dashboard/workarea page that belongs to Sales Cloud Account. For example: Navigator > Customers > Create Household. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 17

18 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact Determining Which Web service to Use to Implement Your Use Case Review the URL of the dashboard/workarea. You will see a URL in the browser similar to The <domainname> might be like In this URL, take the " Then append the static context root that we extracted from OER - "/crmcommonsalesparties/householdservice" to it. is the WSDL URL for Sales Cloud Household. If you have access to Oracle Enterprise Manager Fusion Applications Control, you can use the following steps: 1. Log in to the Oracle Enterprise Manager Fusion Applications Control using the Web Logic Server credentials. 2. Select Oracle Fusion Customer Relationship Management from the navigation tree, and then select Fusion Applications. 3. From the tree, select CrmCommonApp, and then select CrmCommonApp (CRMCommonServer_1). 4. In the Web Services pane on the right side of the page, scroll to the service name that you had noted down in the Identifying the Appropriate Web Service section, and click Test. 5. In the Test Web Service pane, copy the URL of a WSDL that appears in the WSDL field until "?wsdl", and then paste to a notepad. Deriving the Input Payload After you have identified the appropriate web service in the Identifying the Appropriate Web Service section, perform the following steps. 1. Navigate to the HouseholdService endpoint page, as explained in the Extracting the Web Services URL section. 2. Select the createhousehold operation from the operation drop-down list. 3. Provide valid values to the mandatory fields. 4. In the parameters section, select the Include in Message checkbox if a parameter is not mandatory and you're providing a value for it. 5. Click the XML Source radio button. This generates the input payload. 6. Copy the XML source and paste to a notepad. Invoking the Web Service Follow the below steps to invoke the Web service using Fusion Service Tester: Note: You can also use your custom proxy client application, JDeveloper HTTP Analyzer, and third party tools, such as SoapUI, to call a simplified Oracle Sales Cloud Web service. 18 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

19 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact Determining Which Web service to Use to Implement Your Use Case 1. Launch the Fusion Service Tester. Review Appendix A to find out how to download it from OER ( and set it up. 2. In the Web Service URL field, paste the WSDL URL that you derived following the steps in "Identifying the Appropriate Web Service" section. 3. Enter the username and password credentials. 4. In the Input Payload pane, paste the XML source that you derived from "Generating the Payload" section. 5. Click Invoke. The Output Payload pane displays the output payload. Evaluating the Results You can evaluate the results of the Web service call by verifying the creation of the household in your Oracle Sales Cloud instance as follows: 1. Copy and paste the output payload to a notepad window. 2. Log in to Oracle Sales Cloud Applications. 3. In the Customers work area, search for the new household you have created using the Manage Customer Classic UI page. You can also search for it using the Households simplified UI page. 4. Verify the household details. This confirms that the household has been created. Evaluating the Simplified Relationship Service Use this procedure to evaluate the simplified Relationship service (RelationshipService). Prerequisites Ensure that the user credentials used to invoke the service has the required privilege to create a relationship in Oracle Sales Cloud Applications. Identifying the Appropriate Web Service 1. Log in to Oracle Enterprise Repository. 2. Enter RelationshipService as the search string and select ADF Service in the Type field, and click Search. 3. Click Sales Cloud Relationship. 4. Note down the service interface name of the Web service: oracle.apps.crmcommon.salesparties.relationshipservice.relationshipservice. Extracting the Web Services URL After you have identified the appropriate Web service in the Identify the Appropriate Web Service section, perform the following steps. Launch Oracle Sales Cloud home page and login as a functional user. Navigate to an application's dashboard/workarea page that is related to Sales Cloud Relationship. For example: Navigator > Customers. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 19

20 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact Determining Which Web service to Use to Implement Your Use Case Review the URL of the dashboard/workarea. You will see a URL in the browser similar to The <domainname> might be like In this URL, take the " Then append the static context root that we extracted from OER - "/crmcommonsalesparties/relationshipservice" to it. is the WSDL URL for Sales Cloud Relationship. If you have access to Oracle Enterprise Manager Fusion Applications Control, you can use the following steps: 1. Log in to the Oracle Enterprise Manager Fusion Applications Control using the Web Logic Server credentials. 2. Select Oracle Fusion Customer Relationship Management from the navigation tree, and then select Fusion Applications. 3. From the tree, select CrmCommonApp, and then select CrmCommonApp (CRMCommonServer_1). 4. In the Web Services pane on the right side of the page, scroll to the service name that you had noted down in the Identifying the Appropriate Web Service section, and click Test. 5. In the Test Web Service pane, copy the URL of a WSDL that appears in the WSDL field until "?wsdl", and then paste to a notepad. Deriving the Input Payload After you have identified the appropriate web service in the Identifying the Appropriate Web Service section, perform the following steps. 1. Navigate to the RelationshipService endpoint page, as explained in the Identifying the Appropriate Web Service section. 2. Select the createrelationshp operation from the operation drop-down list. 3. Provide valid values to the mandatory fields. 4. In the parameters section, select the Include in Message checkbox if a parameter is not mandatory and you're providing a value for it. 5. Click the XML Source radio button. This generates the input payload. 6. Copy the XML source and paste to a notepad. Invoking the Web Service Follow the below steps to invoke the Web service using Fusion Service Tester: Note: You can also use your custom proxy client application, JDeveloper HTTP Analyzer, and third party tools, such as SoapUI, to call a simplified Oracle Sales Cloud Web service. 20 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

21 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact Determining Which Web service to Use to Implement Your Use Case 1. Launch the Fusion Service Tester. Review Appendix A to find out how to download it from OER ( and set it up. 2. In the Web Service URL field, paste the WSDL URL that you derived following the steps in the "Identifying the Service" section. 3. Enter the username and password credentials. 4. In the Input Payload pane, paste the XML source that you derived following the steps in the "Deriving the Input the Payload" section. 5. Click Invoke. The Output Payload pane displays the output payload. Evaluating the Results You can evaluate the results of the Web service call by verifying the creation of the relationship in your Oracle Sales Cloud instance as follows: 1. Copy and paste the output payload to a notepad window 2. Log in to Oracle Sales Cloud Applications. 3. In the Customers work area, search for the customer (account or contact) for which you created the relationship using the Manage Customer or the Manage Contact Classic UI page. You can also search for it using the Account or Contact simplified UI page. 4. Verify the relationship details. This confirms that the relationship has been created. Evaluating the Simplified Address Service Use this procedure to evaluate the simplified Address service (AddressService). Prerequisites Ensure that the user credentials used to invoke the service has the required privilege to create an address in Oracle Sales Cloud Applications. Identifying the Appropriate Web Service 1. Log in to Oracle Enterprise Repository. 2. Enter AddressService as the search string and select ADF Service in the Type field, and click Search. 3. Click Sales Cloud Address. 4. Note down the service interface name of the Web service: oracle.apps.crmcommon.salesparties.addressservice.addressservice. Extracting the Web Services URL After you have identified the appropriate Web service in the Identify the Appropriate Web Service section, perform the following steps. Launch Oracle Sales Cloud home page and login as a functional user. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 21

22 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact Determining Which Web service to Use to Implement Your Use Case Navigate to an application's dashboard/workarea page that is related to Sales Cloud Address. For example: Navigator > Customers. Review the URL of the dashboard/workarea. You will see a URL in the browser similar to The <domainname> might be like From this URL, take the " Then append the static context root that we extracted from OER - "/crmcommonsalesparties/addressservice" to it. is the WSDL URL for Sales Cloud Address. If you have access to Oracle Enterprise Manager Fusion Applications Control, you can use the following steps: 1. Log in to the Oracle Enterprise Manager Fusion Applications Control using the Web Logic Server credentials. 2. Select Oracle Fusion Customer Relationship Management from the navigation tree, and then select Fusion Applications. 3. From the tree, select CrmCommonApp, and then select CrmCommonApp (CRMCommonServer_1). 4. In the Web Services pane on the right side of the page, scroll to the service name that you had noted down in the Identifying the Appropriate Web Service section, and click Test. 5. In the Test Web Service pane, copy the URL of a WSDL that appears in the WSDL field until "?wsdl", and then paste to a notepad. Deriving the Input Payload After you have identified the appropriate web service in the Identifying the Appropriate Web Service section, perform the following steps. 1. Navigate to the AddressService endpoint page as explained in the Extracting the Web Services URL section. 2. Select the createaddress operation from the operation drop-down list. 3. Provide valid values to the mandatory fields. 4. In the parameters section, select the Include in Message checkbox if a parameter is not mandatory and you're providing a value for it. 5. Click the XML Source radio button. This generates the input payload. 6. Copy the XML source and paste to a notepad. Invoking the Web Service Follow the below steps to invoke the Web service using the Fusion Service Tester: 22 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

23 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact Determining Which Web service to Use to Implement Your Use Case Note: You can also use your custom proxy client application, JDeveloper HTTP Analyzer, and third party tools, such as SoapUI, to call a simplified Oracle Sales Cloud Web service Web service. 1. Launch the Fusion Service Tester. Review Appendix A to find out how to download it from OER ( and set it up. 2. In the Web Service URL field, paste the WSDL URL that you derived following the steps in the "Identifying the Service" section. 3. Enter the username and password credentials. 4. In the Input Payload pane, paste the XML source that you derived following the steps in the "Deriving the Input Payload" section. 5. Click Invoke. The Output Payload pane displays the output payload. Evaluating the Results You can evaluate the results of the Web service call by verifying the creation of the address in your Oracle Sales Cloud instance as follows: 1. Copy and paste the output payload to a notepad window. 2. Verify the relationship details. This confirms that the household has been created. 3. Log in to Oracle Sales Cloud Applications. 4. In the Customers work area, search for the customer (account or contact) for which you created the address using the Manage Customer or the Manage Contact Classic UI page. You can also search for it using the Account or Contact simplified UI page. 5. Verify the address details. This confirms that the address has been created. Prototyping Payloads and Evaluating Web Services Using the JDeveloper HTTP Analyzer Use this procedure to prototype payloads and evaluate Web service call results using the JDeveloper HTTP Analyzer: 1. Launch JDeveloper IDE in Default role. 2. Click Tools and select the HTTP Analyzer 3. Click the Create A New Request icon. 4. In the HTTP Analyzer: Unsent Message page, Click Open WSDL button on the top right 5. Enter WSDL URL. 6. Click OK and wait for the JDeveloper to fetch the WSDL docum ent. 7. Select an appropriate Web service operation. 8. Click on HTTP Content tab and paste an appropriate request payload. 9. Click SOAP Structure tab and click Request HTTP Headers Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 23

24 Introduction to Simplified Sales Cloud Web Services for Account, Household, and Contact Determining Which Web service to Use to Implement Your Use Case 10. Click on the + (Add headers menu) icon (Sometimes, the + icon may not be visible. You may have to expand the Request HTTP Headers panel by dragging the splitter bar to the right. 11. Select Authorization basic. 12. Enter Basic username:password such as Basic Sales_Admin: Welcome 13. Click Send Request. 14. Review the response and verify the operation result in your instance of Oracle Sales Cloud. Prototyping Payloads and Evaluating Web Services Using Third Party Tools You can use third party tools, such as SoapUI, WebInject and Strom, to test the Sales Cloud Web services. You can perform various types of Web service testing, based on the third party tool you are using. For more information, see: Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

25 2 How do I? Managing Accounts Using the Simplified Sales Cloud Account Web Service (AccountService) An account is an organization or company that you want in your records for sales purposes. Accounts include organizations to which you sell, but do not include individuals. Call the Sales Cloud Account service (AccountService) to create, update, find, and delete organization accounts. When performing these operations, you can include only one address in the payload. You must use the Address web service to create an address for an account. Create an Account Programmatically Using createaccount You can create accounts of the following types in Oracle Sales Cloud by calling the createaccount method: Customer: An account to whom you are actively selling or to whom you have sold previously. This was a Sales Account in Oracle Sales Cloud Release 7. Prospect: A new account to whom you plan to sell. The sample code and payload for calling the createaccount method are as follows. Sample XML Payload Sample WSDL call for createaccount Payload to create an account of the type prospect (ZCA_PROSPECT) <soap:envelope xmlns:soap=" xmlns:xsi=" <soap:body> <ns1:createaccount xmlns:ns1=" ice/types/"> <ns1:account xmlns:ns2=" ice/"> <ns2:organizationname>responsys California</ns2:OrganizationName> <ns2:type>zca_prospect</ns2:type> <ns2:createdbymodule>hz_ws</ns2:createdbymodule> <ns2:phonecountrycode>1</ns2:phonecountrycode> Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 25

26 Contents <ns2:phoneareacode>650</ns2:phoneareacode> <ns2:phonenumber> </ns2:phonenumber> <ns2:phoneextension>123</ns2:phoneextension> </ns1:account> </ns1:createaccount> </soap:body> </soap:envelope> This payload contains the minimum information to create a prospect. It creates a new prospect account with an organization name and contact phone number. Payload to create an account of the type customer (ZCA_CUSTOMER) This payload contains the information to create a customer. It creates a new customer account with profile and contact information, a new address, and a relationship between the newly created account and address to indicate the address is the primary address for the customer. <soap:envelope xmlns:soap=" xmlns:xsi=" <soap:body> <ns1:createaccount xmlns:ns1=" ice/types/"> <ns1:account xmlns:ns2=" ice/"> <ns2:sourcesystem>csv</ns2:sourcesystem> <ns2:sourcesystemreferencevalue>sbs_acct_ssr_23417</ns2:sourcesystemrefere ncevalue> <ns2:organizationname>materials Process Engineering LLC</ns2:OrganizationName> <ns2:ceoname>bob Doyle</ns2:CEOName> <ns2:type>zca_customer</ns2:type> <ns2:industrycodetype>one VOICE</ns2:IndustryCodeType> <ns2:industrycode>2700</ns2:industrycode> <ns2:createdbymodule>hz_ws</ns2:createdbymodule> <ns2:phonecountrycode>1</ns2:phonecountrycode> <ns2:phoneareacode>650</ns2:phoneareacode> <ns2:phonenumber> </ns2:phonenumber> <ns2:faxcountrycode>1</ns2:faxcountrycode> <ns2:faxareacode>650</ns2:faxareacode> <ns2:faxnumber> </ns2:faxnumber> <ns2: address>contactus@oracle.com</ns2: address> 26 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

27 How do I? Managing Accounts Using the Simplified Sales Cloud Account Web Service (AccountService) <ns2:url> <ns2:primaryaddress xmlns:ns3=" ce/"> <ns3:sourcesystem>csv</ns3:sourcesystem> <ns3:sourcesystemreferencevalue>sbs_acct_add_ssr_419</ns3:sourcesystemrefe rencevalue> <ns3:addressline1>4578 El Camino Real</ns3:AddressLine1> <ns3:city>san Mateo</ns3:City> <ns3:country>us</ns3:country> <ns3:county>san Mateo</ns3:County> <ns3:postalcode>94401</ns3:postalcode> <ns3:state>ca</ns3:state> </ns2:primaryaddress> </ns1:account> </ns1:createaccount> </soap:body> </soap:envelope> Search for an Account Programmatically Using findaccount You can search for accounts using the findaccount method. The sample payload for calling the findaccount method is as follows. This sample payload finds all accounts that contain Alcoa in the organization name. <soap:envelope xmlns:soap=" <soap:body> <ns1:findaccount xmlns:ns1=" ice/types/"> <ns1:findcriteria xmlns:ns2=" <ns2:filter> <ns2:conjunction>and</ns2:conjunction> <ns2:group> <ns2:conjunction>and</ns2:conjunction> <ns2:item> <ns2:conjunction>and</ns2:conjunction> <ns2:attribute>organizationname</ns2:attribute> <ns2:operator>contains</ns2:operator> <ns2:value>alcoa</ns2:value> </ns2:item> Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 27

28 Contents </ns2:group> </ns2:filter> </ns1:findaccount> </soap:body> </soap:envelope> Update an Account and its Primary Address Programmatically Using updateaccount You can update an account and its primary address by using the updateaccount method. When updating an account, you must provide the partyid of the account. The sample payload for calling the updateaccount method is as follows. This sample payload updates the profile information, contact information, and the primary address for the account with the PartyId <soap:envelope xmlns:soap=" <soap:body> <ns1:updateaccount xmlns:ns1=" ice/types/"> <ns1:account xmlns:ns2=" ice/"> <ns2:partyid> </ns2:partyid> <ns2:ceoname>mike Burns</ns2:CEOName> <ns2:ceotitle>mr</ns2:ceotitle> <ns2:comments>updating the organization information based on recent changes as of 04/28/2104</ns2:Comments> <ns2:phonecountrycode>1</ns2:phonecountrycode> <ns2:phoneareacode>605</ns2:phoneareacode> <ns2:phonenumber> </ns2:phonenumber> <ns2:phoneextension>311</ns2:phoneextension> <ns2:primaryaddress xmlns:ns3=" ce/"> <ns3:addressline1>21 El Camino Real</ns3:AddressLine1> <ns3:addressline2>suite 3001</ns3:AddressLine2> <ns3:addressline3>west Wing</ns3:AddressLine3> </ns2:primaryaddress> </ns1:account> </ns1:updateaccount> </soap:body> </soap:envelope> 28 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

29 How do I? Managing Accounts Using the Simplified Sales Cloud Account Web Service (AccountService) Delete an Account Programmatically Using deleteaccount You can delete an account by using the deletecontact method. When deleting an account, you must provide any identifier of the account. The sample payload for calling the deleteaccount method is as follows. In this sample payload, we are providing the origin system and the origin system reference to identify the account. <soap:envelope xmlns:soap=" <soap:body> <ns1:deleteaccount xmlns:ns1=" ice/types/"> <ns1:account xmlns:ns2=" ice/"> <ns2:sourcesystem>csv</ns2:sourcesystem> <ns2:sourcesystemreferencevalue>sbs_acct_ssr_245401</ns2:sourcesystemrefer encevalue> </ns1:account> </ns1:deleteaccount> </soap:body> </soap:envelope> Retrieve an Account Programmatically Using getaccount You can retrieve an account by using the getcontact method. When retrieving an account, you must provide the PartyId of the account. The sample payload for calling the getaccount method is as follows. In this sample payload, we are retrieving the account with the partyid <soap:envelope xmlns:soap=" <soap:body> <ns1:getaccount xmlns:ns1=" ice/types/"> <ns1:partyid> </ns1:partyid> </ns1:getaccount> </soap:body> </soap:envelope> Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 29

30 Contents Merge an account Programmatically Using mergeaccount You can merge attribute information in an account using the mergeaccount method. The service updates the object if it exists, else creates a new account. The sample payload for calling the mergeaccount method is as follows. In this sample payload, we are updating the account with the partyid The method will update the account if it exists, else it will create a new account. <soap:envelope xmlns:soap=" <soap:body> <ns1:mergeaccount xmlns:ns1=" ice/types/"> <ns1:account xmlns:ns2=" ice/"> <ns2:sourcesystem>csv</ns2:sourcesystem> <ns2:sourcesystemreferencevalue> </ns2:sourcesystemreference Value> <ns2:organizationname>alcoa Systems</ns2:OrganizationName> <ns2:ownerpartyid> </ns2:ownerpartyid> <ns2:ownerpartynumber>55748</ns2:ownerpartynumber> <ns2:owner address>bob.boyle@alcoa.com</ns2:owner address> <ns2:yearestablished>1980</ns2:yearestablished> <ns2:yearincorporated>1981</ns2:yearincorporated> <ns2:primaryaddress xmlns:ns3=" ce/"> <ns3:addressline1>#24823</ns3:addressline1> <ns3:addressline2>alcoa Drive</ns3:AddressLine2> <ns3:addressline3>redmond</ns3:addressline3> <ns3:addressline4>ca</ns3:addressline4> </ns2:primaryaddress> </ns1:account> </ns1:mergeaccount> </soap:body> </soap:envelope> 30 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

31 How do I? Managing Accounts Using the Simplified Sales Cloud Account Web Service (AccountService) Perform a Specific Operation (Create, Update, Delete, or Merge) on a List of Accounts Using processaccount You can perform create, update, delete, or merge operation on a list of accounts in Oracle Sales Cloud by calling the processaccount method. The sample payload for calling the processaccount method is as follows. This sample payload creates two accounts using one API call. <soap:envelope xmlns:soap=" <soap:body> <ns1:processaccount xmlns:ns1=" ice/types/"> <ns1:changeoperation>create</ns1:changeoperation> <ns1:account xmlns:ns2=" ice/"> <ns2:organizationname>pinnacle Energy Inc </ns2:organizationname> <ns2:createdbymodule>hz_ws</ns2:createdbymodule> <ns2:type>zca_prospect</ns2:type> </ns1:account> <ns1:account xmlns:ns2=" ice/"> <ns2:organizationname>pinnacle Financials</ns2:OrganizationName> <ns2:ceoname>john Smith</ns2:CEOName> <ns2:type>zca_customer</ns2:type> <ns2:createdbymodule>hz_ws</ns2:createdbymodule> </ns1:account> <ns1:processcontrol xmlns:ns2=" <ns2:returnmode>full</ns2:returnmode> <ns2:exceptionreturnmode>full</ns2:exceptionreturnmode> <ns2:partialfailureallowed>true</ns2:partialfailureallowed> </ns1:processcontrol> </ns1:processaccount> </soap:body> </soap:envelope> Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 31

32 Contents Managing Contacts Using the Simplified Sales Cloud Contact Web Service (ContactService) A contact is a person who either has a relationship to other objects like account and household or is a customer or prospect you directly sell to. Contacts can be of the following types: Business contacts: People related to accounts or households Customer: People to whom you sell directly Prospect: A new contact to whom you plan to sell A contact could be either contact of an account or household in a B2B scenario or a buying customer in a B2C scenario. Call the Sales Cloud Contact service (ContactService) to create, find, update, retrieve, delete, get, and merge contacts. When performing these operations, you can include only one (primary) address in the payload. When creating a contact with multiple addresses you must use the PrimaryAddress child entity for one (primary) address and the Address service for the rest of the addresses. Create a Contact Programmatically Using createcontact You can create contacts of the type, business, customer, or prospect, in Oracle Sales Cloud by calling the createcontact method. The sample payload for calling the createcontact method is as follows. Sample XML Payload Payload to create an contact of the type business contact (ZCA_CONTACT) <soap:envelope xmlns:soap=" <soap:body> <ns1:createcontact xmlns:ns1=" ice/types/"> <ns1:contact xmlns:ns2=" ice/"> <ns2:sourcesystem>csv</ns2:sourcesystem> <ns2:sourcesystemreferencevalue>sbs_cnt_24616</ns2:sourcesystemreferenceva lue> <ns2:firstname>sbs_fn</ns2:firstname> <ns2:lastname>sbs_ln</ns2:lastname> <ns2:workphonecountrycode>1</ns2:workphonecountrycode> <ns2:workphoneareacode>650</ns2:workphoneareacode> <ns2:workphonenumber> </ns2:workphonenumber> <ns2:workphoneextension>001</ns2:workphoneextension> <ns2:mobilecountrycode>1</ns2:mobilecountrycode> 32 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

33 How do I? Managing Contacts Using the Simplified Sales Cloud Contact Web Service (ContactService) <ns2:mobileareacode>650</ns2:mobileareacode> <ns2:mobilenumber> </ns2:mobilenumber> <ns2:mobileextension>002</ns2:mobileextension> <ns2:faxcountrycode>1</ns2:faxcountrycode> <ns2:faxareacode>650</ns2:faxareacode> <ns2:faxnumber> </ns2:faxnumber> <ns2:faxextension>003</ns2:faxextension> <ns2:createdbymodule>hz_ws</ns2:createdbymodule> <ns2:classificationcategory>customer_category</ns2:classificationcategory> <ns2:classificationcode>broker</ns2:classificationcode> <ns2:primaryaddress xmlns:ns3=" ce/"> <ns3:addressline1>commerce at Mantri</ns3:AddressLine1> <ns3:country>in</ns3:country> </ns2:primaryaddress> </ns1:contact> </ns1:createcontact> </soap:body> </soap:envelope> Payload to create an contact of the type prospect (ZCA_PROSPECT) <soap:envelope xmlns:soap=" <soap:body> <ns1:createcontact xmlns:ns1=" ice/types/"> <ns1:contact xmlns:ns2=" ice/"> <ns2:sourcesystem>csv</ns2:sourcesystem> <ns2:sourcesystemreferencevalue>sbs_cnt_cust_24620_1</ns2:sourcesystemrefe rencevalue> <ns2:firstname>sbs_fn</ns2:firstname> <ns2:lastname>sbs_ln</ns2:lastname> <ns2:contactname>sbs FN LN</ns2:ContactName> <ns2:type>zca_prospect</ns2:type> <ns2:favoritecontactflag>true</ns2:favoritecontactflag> <ns2:createdbymodule>ams</ns2:createdbymodule> <ns2:classificationcategory>customer_category</ns2:classificationcategory> Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 33

34 Contents <ns2:classificationcode>broker</ns2:classificationcode> <ns2:primaryaddress xmlns:ns3=" ce/"> <ns3:addressline1>ptp</ns3:addressline1> <ns3:city>bengaluru</ns3:city> <ns3:country>in</ns3:country> <ns3:state>ka</ns3:state> </ns2:primaryaddress> </ns1:contact> </ns1:createcontact> </soap:body> </soap:envelope> Payload to create an contact of the type customer (ZCA_CUSTOMER) <soap:envelope xmlns:soap=" <soap:body> <ns1:createcontact xmlns:ns1=" ice/types/"> <ns1:contact xmlns:ns2=" ice/"> <ns2:sourcesystem>csv</ns2:sourcesystem> <ns2:sourcesystemreferencevalue>sbs_cnt_cust_24620</ns2:sourcesystemrefere ncevalue> <ns2:firstname>sbs_fn</ns2:firstname> <ns2:lastname>sbs_ln</ns2:lastname> <ns2:contactname>sbs FN LN</ns2:ContactName> <ns2:type>zca_customer</ns2:type> <ns2:favoritecontactflag>true</ns2:favoritecontactflag> <ns2:createdbymodule>ams</ns2:createdbymodule> <ns2:classificationcategory>customer_category</ns2:classificationcategory> <ns2:classificationcode>broker</ns2:classificationcode> <ns2:primaryaddress xmlns:ns3=" ce/"> <ns3:addressline1>ptp</ns3:addressline1> <ns3:city>bengaluru</ns3:city> <ns3:country>in</ns3:country> <ns3:state>ka</ns3:state> </ns2:primaryaddress> 34 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

35 How do I? Managing Contacts Using the Simplified Sales Cloud Contact Web Service (ContactService) </ns1:contact> </ns1:createcontact> </soap:body> </soap:envelope> Search for a Contact Programmatically Using findcontact You can find contacts in Oracle Sales Cloud by calling the findcontact method. The sample payload for calling the findcontact method is as follows. Sample XML Payload <soap:envelope xmlns:soap=" <soap:body> <ns1:findcontact xmlns:ns1=" ice/types/"> <ns1:findcriteria xmlns:ns2=" <ns2:fetchstart>0</ns2:fetchstart> <ns2:fetchsize>-1</ns2:fetchsize> <ns2:filter> <ns2:conjunction>and</ns2:conjunction> <ns2:group> <ns2:conjunction>and</ns2:conjunction> <ns2:uppercasecompare></ns2:uppercasecompare> <ns2:item> <ns2:conjunction>and</ns2:conjunction> <ns2:uppercasecompare></ns2:uppercasecompare> <ns2:attribute>partyid</ns2:attribute> <ns2:operator>=</ns2:operator> <ns2:value> </ns2:value> </ns2:item> </ns2:group> </ns2:filter> <ns2:excludeattribute></ns2:excludeattribute> </ns1:findcriteria> </ns1:findcontact> </soap:body> </soap:envelope> Update a Contact and its Primary Address Programmatically Using updatecontact You can update a contact and its primary address in Oracle Sales Cloud by calling the updatecontact method. The sample payload for calling the updatecontact method is as follows. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 35

36 Contents Sample XML Payload <soap:envelope xmlns:soap=" <soap:body> <ns1:updatecontact xmlns:ns1=" ice/types/"> <ns1:contact xmlns:ns2=" ice/"> <ns2:sourcesystem>csv</ns2:sourcesystem> <ns2:sourcesystemreferencevalue>sbs_cnt_225607</ns2:sourcesystemreferencev alue> <ns2:firstname>sbs_fn_ssr</ns2:firstname> <ns2:lastname>sbs_ln_ssr</ns2:lastname> <ns2:department>research</ns2:department> <ns2:primaryaddress xmlns:ns3=" ce/"> <ns3:addressline1>update SSR LINE1</ns3:AddressLine1> </ns2:primaryaddress> </ns1:contact> </ns1:updatecontact> </soap:body> </soap:envelope> Delete a Contact Programmatically Using deletecontact You can delete a contact and its relationship with the contact s primary address in Oracle Sales Cloud by calling the deletecontact method. The sample payload for calling the deletecontact method is as follows. Sample XML Payload Party ID <soap:envelope xmlns:soap=" <soap:body> <ns1:deletecontact xmlns:ns1=" ice/types/"> <ns1:contact xmlns:ns2=" ice/"> <ns2:partyid> </ns2:partyid> </ns1:contact> </ns1:deletecontact> 36 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

37 How do I? Managing Contacts Using the Simplified Sales Cloud Contact Web Service (ContactService) </soap:body> </soap:envelope> Party Number <soap:envelope xmlns:soap=" <soap:body> <ns1:deletecontact xmlns:ns1=" ice/types/"> <ns1:contact xmlns:ns2=" ice/"> <ns2:partynumber>cdrm_737311</ns2:partynumber> </ns1:contact> </ns1:deletecontact> </soap:body> </soap:envelope> SSR Value <soap:envelope xmlns:soap=" <soap:body> <ns1:deletecontact xmlns:ns1=" ice/types/"> <ns1:contact xmlns:ns2=" ice/"> <ns2:sourcesystem>csv</ns2:sourcesystem> <ns2:sourcesystemreferencevalue>sbs_cnt_225710</ns2:sourcesystemreferencev alue> </ns1:contact> </ns1:deletecontact> </soap:body> </soap:envelope> Retrieve a Contact Programmatically Using getcontact You can retrieve a contact in Oracle Sales Cloud by calling the getcontact method. The sample payload for calling the getcontact method is as follows. Sample XML Payload <soap:envelope xmlns:soap=" Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 37

38 Contents <soap:body> <ns1:getcontact xmlns:ns1=" ice/types/"> <ns1:partyid> </ns1:partyid> </ns1:getcontact> </soap:body> </soap:envelope> Merge a Contact Programmatically Using mergecontact You can replace the existing contact details or create a new contact if it doesn t already exist in Oracle Sales Cloud by calling the mergecontact method. The sample payload for calling the mergecontact method is as follows: Sample XML Payload <soap:envelope xmlns:soap=" <soap:body> <ns1:mergecontact xmlns:ns1=" ice/types/"> <ns1:contact xmlns:ns2=" ice/"> <ns2:sourcesystem>csv</ns2:sourcesystem> <ns2:sourcesystemreferencevalue>sbs_cnt_225607</ns2:sourcesystemreferencev alue> <ns2:firstname>sbs_fn_ssr_merge</ns2:firstname> <ns2:lastname>sbs_ln_ssr_merge</ns2:lastname> <ns2:department>research</ns2:department> <ns2: address>ssr.value@oracle.com</ns2: address> <ns2:primaryaddress xmlns:ns3=" ce/"> <ns3:addressline2>update SSR LINE1 MERGE</ns3:AddressLine2> </ns2:primaryaddress> </ns1:contact> </ns1:mergecontact> </soap:body> </soap:envelope> 38 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

39 How do I? Managing Households Using the Simplified Sales Cloud Household Web Service Perform a Specific Operation (Create, Update, Delete, or Merge) on a List of Contacts Using processcontact You can perform a create, update, delete, or merge operation on a list of contact rows in Oracle Sales Cloud by calling the processcontact method. The sample payload for calling the processcontact method is as follows. Sample XML Payload <soap:envelope xmlns:soap=" <soap:body> <ns1:processcontact xmlns:ns1=" ice/types/"> <ns1:changeoperation>create</ns1:changeoperation> <ns1:contact xmlns:ns2=" ice/"> <ns2:firstname>john</ns2:firstname> <ns2:lastname>smith</ns2:lastname> <ns2: address>john.smith@oracle.com</ns2: address> </ns1:contact> <ns1:contact xmlns:ns2=" ice/"> <ns2:firstname>george</ns2:firstname> <ns2:lastname>clooney</ns2:lastname> <ns2: address>george.clooney@oracle.com</ns2: address> </ns1:contact> <ns1:processcontrol xmlns:ns2=" <ns2:returnmode>full</ns2:returnmode> <ns2:exceptionreturnmode>full</ns2:exceptionreturnmode> <ns2:partialfailureallowed>true</ns2:partialfailureallowed> </ns1:processcontrol> </ns1:processcontact> </soap:body> </soap:envelope> Managing Households Using the Simplified Sales Cloud Household Web Service You can use household to track information about a groups of contacts, including: Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 39

40 Contents Household members Sales Teams Relationships Leads and opportunities Assets Notes, tasks, and appointments Conversations Call the Sales Cloud Household service (HouseholdService) to create, update, find, and delete the parties of type household. When performing these operations, you can include only one address in the payload. You must use the Address web service to create an address for a household. Create a Household Programmatically Using createhousehold You can create households in Oracle Sales Cloud by calling the createhousehold method. The sample payload for calling the createhousehold method is as follows. Sample XML Payload Payload to create a household of the type prospect (ZCA_PROSPECT) <soap:envelope xmlns:soap=" <soap:body> <ns1:createhousehold xmlns:ns1=" rvice/types/"> <ns1:household xmlns:ns2=" rvice/"> <ns2:householdname>sbs_hld</ns2:householdname> <ns2:householdsize>3</ns2:householdsize> <ns2:uniquenamesuffix>abc</ns2:uniquenamesuffix> <ns2:averageage>30</ns2:averageage> <ns2:annualincome> </ns2:annualincome> <ns2:child0to6num>1</ns2:child0to6num> <ns2:child13to18num>0</ns2:child13to18num> <ns2:child7to12num>0</ns2:child7to12num> <ns2:dependentsnum>2</ns2:dependentsnum> <ns2:medianage>30</ns2:medianage> <ns2:wealthamt> </ns2:wealthamt> <ns2:createdbymodule>ams</ns2:createdbymodule> <ns2:sourcesystem>csv</ns2:sourcesystem> <ns2:sourcesystemreferencevalue>sbs_hld_131250</ns2:sourcesystemreferencev alue> 40 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

41 How do I? Managing Households Using the Simplified Sales Cloud Household Web Service <ns2:classificationcategory>customer_category</ns2:classificationcategory> <ns2:classificationcode>broker</ns2:classificationcode> <ns2:phonecountrycode>1</ns2:phonecountrycode> <ns2:phoneareacode>650</ns2:phoneareacode> <ns2:phonenumber> </ns2:phonenumber> <ns2:phoneextension>001</ns2:phoneextension> <ns2:primaryaddress xmlns:ns3=" ce/"> <ns3:addressline1>300 Oracle Parkway</ns3:AddressLine1> <ns3:city>bengaluru</ns3:city> <ns3:postalcode>94065</ns3:postalcode> <ns3:country>in</ns3:country> </ns2:primaryaddress> </ns1:household> </ns1:createhousehold> </soap:body> </soap:envelope> Search for a Household Programmatically Using findhousehold You can find household in Oracle Sales Cloud by calling the findhousehold method. The payload for calling the findhousehold method is as follows: Sample XML Payload <soap:envelope xmlns:soap=" <soap:body> <ns1:findhousehold xmlns:ns1=" rvice/types/"> <ns1:findcriteria xmlns:ns2=" <ns2:fetchstart></ns2:fetchstart> <ns2:fetchsize></ns2:fetchsize> <ns2:filter> <ns2:conjunction>and</ns2:conjunction> <ns2:group> <ns2:conjunction>and</ns2:conjunction> <ns2:uppercasecompare></ns2:uppercasecompare> <ns2:item> <ns2:conjunction>and</ns2:conjunction> <ns2:uppercasecompare></ns2:uppercasecompare> <ns2:attribute>partynumber</ns2:attribute> Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 41

42 Contents <ns2:operator>=</ns2:operator> <ns2:value>cdrm_747827</ns2:value> </ns2:item> </ns2:group> </ns2:filter> <ns2:excludeattribute></ns2:excludeattribute> </ns1:findcriteria> <ns1:findcontrol xmlns:ns2=" <ns2:retrievealltranslations></ns2:retrievealltranslations> </ns1:findcontrol> </ns1:findhousehold > </soap:body> </soap:envelope> Update a Household and its Primary Address Programmatically Using updatehousehold You can update a household and its primary address in Oracle Sales Cloud by calling the updatehousehold method. The sample payload for calling the updatehousehold method is as follows: Sample XML Payload <soap:envelope xmlns:soap=" <soap:body> <ns1:updatehousehold xmlns:ns1=" rvice/types/"> <ns1:household xmlns:ns2=" rvice/"> <ns2:householdname>updated_sbs_hld_227259</ns2:householdname> <ns2:phonenumber> </ns2:phonenumber> <ns2:sourcesystem>csv</ns2:sourcesystem> <ns2:sourcesystemreferencevalue>sbs_hld_131250</ns2:sourcesystemreferencev alue> <ns2:primaryaddress xmlns:ns3=" ce/"> <ns3:addressline1>500 Oracle Parkway</ns3:AddressLine1> <ns3:addressline2>commerce at Mantri</ns3:AddressLine2> 42 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

43 How do I? Managing Households Using the Simplified Sales Cloud Household Web Service <ns3:city>shimoga</ns3:city> <ns3:postalcode>560086</ns3:postalcode> </ns2:primaryaddress> </ns1:household> </ns1:updatehousehold> </soap:body> </soap:envelope> Delete a Household Programmatically Using deletehousehold You can delete a household and its relationship with the household s primary address in Oracle Sales Cloud by calling the deletehousehold method. The sample payload for calling the deletehousehold method is as follows: Sample XML Payload Party ID <soap:envelope xmlns:soap=" <soap:body> <ns1:deletehousehold xmlns:ns1=" rvice/types/"> <ns1:household xmlns:ns2=" rvice/"> <ns2:partyid> </ns2:partyid> </ns1:household> </ns1:deletehousehold> </soap:body> </soap:envelope> Party Number <soap:envelope xmlns:soap=" <soap:body> <ns1:deletehousehold xmlns:ns1=" rvice/types/"> <ns1:household xmlns:ns2=" rvice/"> <ns2:partynumber>cdrm_789827</ns2:partynumber> </ns1:household> </ns1:deletehousehold> </soap:body> </soap:envelope> Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 43

44 Contents SSR <soap:envelope xmlns:soap=" <soap:body> <ns1:deletehousehold xmlns:ns1=" rvice/types/"> <ns1:household xmlns:ns2=" rvice/"> <ns2:sourcesystem>csv</ns2:sourcesystem> <ns2:sourcesystemreferencevalue>sbs_hld_227103</ns2:sourcesystemreferencev alue> </ns1:household> </ns1:deletehousehold> </soap:body> </soap:envelope> Retrieve a Household Programmatically Using gethousehold You can retrieve a household based on the primary key identifier in Oracle Sales Cloud by calling the gethousehold method. The sample payload for calling the gethousehold method is as follows: Sample XML Payload <soap:envelope xmlns:soap=" <soap:body> <ns1:gethousehold xmlns:ns1=" rvice/types/"> <ns1:partyid> </ns1:partyid> </ns1:gethousehold> </soap:body> </soap:envelope> Merge a Household Programmatically Using mergehousehold You can create a household or update a household if it already exists in Oracle Sales Cloud by calling the mergehousehold method. The sample payload for calling the mergehousehold method is as follows: Sample XML Payload <soap:envelope xmlns:soap=" <soap:body> 44 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

45 How do I? Managing Households Using the Simplified Sales Cloud Household Web Service <ns1:mergehousehold xmlns:ns1=" rvice/types/"> <ns1:household xmlns:ns2=" rvice/"> <ns2:partynumber>cdrm_747827</ns2:partynumber> <ns2:householdname>updated_sbs_hld_227421</ns2:householdname> <ns2:primaryaddress xmlns:ns3=" ce/"> <ns3:sourcesystem>csv</ns3:sourcesystem> <ns3:sourcesystemreferencevalue>add_sbs_227421</ns3:sourcesystemreferencev alue> <ns3:addressline1>600 Oracle Parkway</ns3:AddressLine1> <ns3:addressline2>commerce at Mantri</ns3:AddressLine2> <ns3:city>shimoga</ns3:city> <ns3:postalcode>560086</ns3:postalcode> </ns2:primaryaddress> </ns1:household> </ns1:mergehousehold> </soap:body> </soap:envelope> Perform a Specific Operation (Create, Update, Delete, or Merge) on a List of Households Using processhousehold You can perform create, update, delete, or merge operation on a list of household rows in Oracle Sales Cloud by calling the processhousehold method. The sample payload for calling the processhousehold method is as follows: Sample XML Payload <soap:envelope xmlns:soap=" <soap:body> <ns1:processhousehold xmlns:ns1=" rvice/types/"> <ns1:changeoperation>create</ns1:changeoperation> <ns1:household xmlns:ns2=" rvice/"> <ns2:householdname>household1</ns2:householdname> <ns2:householdsize>3</ns2:householdsize> Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 45

46 Contents </ns1:household> <ns1:household xmlns:ns2=" rvice/"> <ns2:householdname>household2</ns2:householdname> <ns2:householdsize>4</ns2:householdsize> </ns1:household> <ns1:processcontrol xmlns:ns2=" <ns2:returnmode>full</ns2:returnmode> <ns2:exceptionreturnmode>full</ns2:exceptionreturnmode> <ns2:partialfailureallowed>true</ns2:partialfailureallowed> </ns1:processcontrol> </ns1:processhousehold> </soap:body> </soap:envelope> Managing Addresses Using the Simplified Sales Cloud Address Web Service (AddressService) Call the Sales Cloud Address service (AddressService) to provide a representation of the Address entity in Oracle Sales Cloud. Create an Address Programmatically Using createaddress You can create addresses in Oracle Sales Cloud by calling the createaddress method. The sample payload for calling the createaddress method is as follows. Sample XML Payload Payload to create an address <soap:envelope xmlns:soap=" <soap:body> <ns1:createaddress xmlns:ns1=" ice/types/"> 46 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

47 How do I? Managing Addresses Using the Simplified Sales Cloud Address Web Service (AddressService) <ns1:address xmlns:ns2=" ice/"> <ns2:primaryflag>true</ns2:primaryflag> <ns2:partyid> </ns2:partyid> <ns2:address1>300 Oracle Parkway</ns2:Address1> <ns2:city>redwood City</ns2:City> <ns2:state>ca</ns2:state> <ns2:country>us</ns2:country> <ns2:createdbymodule>ams</ns2:createdbymodule> <ns2:postalcode>94341</ns2:postalcode> <ns2:addressnumber>sbs </ns2:addressnumber> <ns2:sourcesystem>dnb</ns2:sourcesystem> <ns2:sourcesystemreferencevalue>add </ns2:sourcesystemreferenc evalue> <ns2:addresspurpose> <ns2:purpose>bill_to</ns2:purpose> </ns2:addresspurpose> <ns2:addresspurpose> <ns2:purpose>pay_to</ns2:purpose> </ns2:addresspurpose> </ns1:address> </ns1:createaddress> </soap:body> </soap:envelope> Search for an Address Programmatically Using findaddress You can find address in Oracle Sales Cloud by calling the findaddress method. The sample payload for calling the findaddress method is as follows. Sample XML Payload <soap:envelope xmlns:soap=" <soap:body> <ns1:findaddress xmlns:ns1=" ice/types/"> <ns1:findcriteria xmlns:ns2=" <ns2:fetchstart>0</ns2:fetchstart> <ns2:fetchsize>-1</ns2:fetchsize> <ns2:filter> <ns2:group> <ns2:uppercasecompare></ns2:uppercasecompare> <ns2:item> Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 47

48 Contents <ns2:conjunction>and</ns2:conjunction> <ns2:uppercasecompare></ns2:uppercasecompare> <ns2:attribute>partyid</ns2:attribute> <ns2:operator>=</ns2:operator> <ns2:value> </ns2:value> </ns2:item> </ns2:group> </ns2:filter> <ns2:excludeattribute></ns2:excludeattribute> </ns1:findcriteria> <ns1:findcontrol xmlns:ns2=" <ns2:retrievealltranslations>true</ns2:retrievealltranslations> </ns1:findcontrol> </ns1:findaddress> </soap:body> </soap:envelope> Update an Address and Address Purpose Programmatically Using updateaddress You can update an address and Address Purpose in Oracle Sales Cloud by calling the updateaddress method. The sample payload for calling the updateaddress method is as follows: Sample XML Payload Address ID <soap:envelope xmlns:soap=" <soap:body> <ns1:updateaddress xmlns:ns1=" ice/types/"> <ns1:address xmlns:ns2=" ice/"> <ns2:addressid> </ns2:addressid> <ns2:donotmailflag>true</ns2:donotmailflag> <ns2:address1>400 Commerce at Mantri</ns2:Address1> <ns2:city>bengaluru</ns2:city> 48 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

49 How do I? Managing Addresses Using the Simplified Sales Cloud Address Web Service (AddressService) <ns2:description>updating the Addressline1</ns2:Description> </ns1:address> </ns1:updateaddress> </soap:body> </soap:envelope> Address Number <soap:envelope xmlns:soap=" <soap:body> <ns1:updateaddress xmlns:ns1=" ice/types/"> <ns1:address xmlns:ns2=" ice/"> <ns2:addressnumber>sbs129102</ns2:addressnumber> <ns2:donotmailflag>false</ns2:donotmailflag> <ns2:address1>400 PTP</ns2:Address1> <ns2:city>bdvt</ns2:city> <ns2:description>updating the Addressline1</ns2:Description> <ns2:addresspurpose> <ns2:addressid> </ns2:addressid> <ns2:purpose>pay_to</ns2:purpose> </ns2:addresspurpose> </ns1:address> </ns1:updateaddress> </soap:body> </soap:envelope> Update with SSR <soap:envelope xmlns:soap=" <soap:body> <ns1:updateaddress xmlns:ns1=" ice/types/"> <ns1:address xmlns:ns2=" ice/"> <ns2:primaryflag>false</ns2:primaryflag> <ns2:address1>400 Oracle Parkway</ns2:Address1> <ns2:address2>updated</ns2:address2> <ns2:sourcesystem>dnb</ns2:sourcesystem> Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 49

50 Contents <ns2:sourcesystemreferencevalue>add129103</ns2:sourcesystemreferencevalue> </ns1:address> </ns1:updateaddress> </soap:body> </soap:envelope> Delete an Address Programmatically Using deleteaddress You can delete an address in Oracle Sales Cloud by calling the deleteaddress method. The sample payload for calling the deleteaddress method is as follows: Sample XML Payload Address ID <soap:envelope xmlns:soap=" <soap:body> <ns1:deleteaddress xmlns:ns1=" ice/types/"> <ns1:address xmlns:ns2=" ice/"> <ns2:addressid> </ns2:addressid> </ns1:address> </ns1:deleteaddress> </soap:body> </soap:envelope> Address Number <soap:envelope xmlns:soap=" <soap:body> <ns1:deleteaddress xmlns:ns1=" ice/types/"> <ns1:address xmlns:ns2=" ice/"> <ns2:addressnumber>sbs00112</ns2:addressnumber> </ns1:address> </ns1:deleteaddress> </soap:body> </soap:envelope> 50 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

51 How do I? Managing Addresses Using the Simplified Sales Cloud Address Web Service (AddressService) Address SSR <soap:envelope xmlns:soap=" <soap:body> <ns1:deleteaddress xmlns:ns1=" ice/types/"> <ns1:address xmlns:ns2=" ice/"> <ns2:sourcesystem>dnb</ns2:sourcesystem> <ns2:sourcesystemreferencevalue>addssr01122</ns2:sourcesystemreferencevalu e> </ns1:address> </ns1:deleteaddress> </soap:body> </soap:envelope> Retrieve an Address Programmatically Using getaddress You can retrieve an address in Oracle Sales Cloud by calling the getaddress method. The sample payload for calling the getaddress method is as follows: Sample XML Payload <soap:envelope xmlns:soap=" <soap:body> <ns1:getaddress xmlns:ns1=" ice/types/"> <ns1:addressid> </ns1:addressid> </ns1:getaddress> </soap:body> </soap:envelope> Merge an Address Programmatically Using mergeaddress You can merge an address in Oracle Sales Cloud by calling the mergeaddress method. The sample payload for calling the mergeaddress method is as follows: Sample XML Payload Address ID <soap:envelope xmlns:soap=" Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 51

52 Contents <soap:body> <ns1:mergeaddress xmlns:ns1=" ice/types/"> <ns1:address xmlns:ns2=" ice/"> <ns2:addressid> </ns2:addressid> <ns2:donotmailflag>true</ns2:donotmailflag> <ns2:address1>400 Commerce at Mantri_using merge</ns2:address1> <ns2:city>bengaluru</ns2:city> <ns2:description>updating the Addressline1</ns2:Description> <ns2:addresspurpose> <ns2:addressid> </ns2:addressid> <ns2:purpose>bill_to</ns2:purpose> </ns2:addresspurpose> </ns1:address> </ns1:mergeaddress> </soap:body> </soap:envelope> Address Number <soap:envelope xmlns:soap=" <soap:body> <ns1:mergeaddress xmlns:ns1=" ice/types/"> <ns1:address xmlns:ns2=" ice/"> <ns2:addressnumber>sbs129102</ns2:addressnumber> <ns2:donotmailflag>true</ns2:donotmailflag> <ns2:address1>400 PTP UPDATE USING MERGE</ns2:Address1> <ns2:city>bdvt</ns2:city> <ns2:description>updating the Addressline1</ns2:Description> <ns2:addresspurpose> <ns2:addressid> </ns2:addressid> <ns2:purpose>pay_to</ns2:purpose> </ns2:addresspurpose> </ns1:address> </ns1:mergeaddress> 52 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

53 How do I? Managing Relationships Using the Simplified Sales Cloud Relationship Web Service </soap:body> </soap:envelope> Update with SSR <soap:envelope xmlns:soap=" <soap:body> <ns1:updateaddress xmlns:ns1=" ice/types/"> <ns1:address xmlns:ns2=" ice/"> <ns2:primaryflag>true</ns2:primaryflag> <ns2:address1>400 Oracle Parkway</ns2:Address1> <ns2:address2>updated USING MERGE</ns2:Address2> <ns2:sourcesystem>dnb</ns2:sourcesystem> <ns2:sourcesystemreferencevalue>add129103</ns2:sourcesystemreferencevalue> <ns2:addresspurpose> <ns2:addressid> </ns2:addressid> <ns2:purpose>bill_to</ns2:purpose> </ns2:addresspurpose> </ns1:address> </ns1:updateaddress> </soap:body> </soap:envelope> Managing Relationships Using the Simplified Sales Cloud Relationship Web Service Call the Sales Cloud Relationship service (RelationshipService) to create, update, retrieve, and delete relationships. Create a Relationship Programmatically Using createrelationship You can create relationship in Oracle Sales Cloud by calling the createrelationship method. The sample payload for calling the createrelationship method is as follows. Sample XML Payload Payload to create a relationship between a contact to account with Primary key and Alt Key Primary Key <soap:envelope xmlns:soap=" <soap:body> Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 53

54 Contents <ns1:createrelationship xmlns:ns1=" pservice/types/"> <ns1:relationship xmlns:ns2=" pservice/"> <ns2:objectpartyid> </ns2:objectpartyid> <ns2:subjectpartyid> </ns2:subjectpartyid> <ns2:relationshiptype>contact</ns2:relationshiptype> <ns2:relationshipcode>contact_of</ns2:relationshipcode> <ns2:startdate> </ns2:startdate> <ns2:enddate> </ns2:enddate> <ns2:createdbymodule>hz_ws</ns2:createdbymodule> <ns2:comments>future DATE RELATIONSHIP</ns2:Comments> </ns1:relationship> </ns1:createrelationship> </soap:body> </soap:envelope> Alternate Key <soap:envelope xmlns:soap=" <soap:body> <ns1:createrelationship xmlns:ns1=" pservice/types/"> <ns1:relationship xmlns:ns2=" pservice/"> <ns2:relationshiptype>contact</ns2:relationshiptype> <ns2:relationshipcode>contact_of</ns2:relationshipcode> <ns2:enddate> </ns2:enddate> <ns2:createdbymodule>hz_ws</ns2:createdbymodule> <ns2:comments>current DATE</ns2:Comments> <ns2:subjectpartynumber>cdrm_414573</ns2:subjectpartynumber> <ns2:objectpartynumber>sbs_aact_ </ns2:objectpartynumber> </ns1:relationship> </ns1:createrelationship> </soap:body> </soap:envelope> 54 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

55 How do I? Managing Relationships Using the Simplified Sales Cloud Relationship Web Service Search for a Relationship Programmatically Using findrelationship You can find relationship in Oracle Sales Cloud by calling the findrelationship method. The sample payload for calling the findrelationship method is as follows. Sample XML Payload <soap:envelope xmlns:soap=" <soap:body> <ns1:findrelationship xmlns:ns1=" pservice/types/"> <ns1:findcriteria xmlns:ns2=" <ns2:fetchstart>0</ns2:fetchstart> <ns2:fetchsize>-1</ns2:fetchsize> <ns2:filter> <ns2:conjunction>and</ns2:conjunction> <ns2:group> <ns2:conjunction>and</ns2:conjunction> <ns2:uppercasecompare></ns2:uppercasecompare> <ns2:item> <ns2:conjunction>and</ns2:conjunction> <ns2:uppercasecompare></ns2:uppercasecompare> <ns2:attribute>subjectpartyid</ns2:attribute> <ns2:operator>=</ns2:operator> <ns2:value> </ns2:value> </ns2:item> <ns2:item> <ns2:conjunction>and</ns2:conjunction> <ns2:uppercasecompare></ns2:uppercasecompare> <ns2:attribute>objectpartyid</ns2:attribute> <ns2:operator>=</ns2:operator> <ns2:value> </ns2:value> </ns2:item> </ns2:group> </ns2:filter> <ns2:excludeattribute></ns2:excludeattribute> </ns1:findcriteria> <ns1:findcontrol xmlns:ns2=" <ns2:retrievealltranslations></ns2:retrievealltranslations> </ns1:findcontrol> Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 55

56 Contents </ns1:findrelationship> </soap:body> </soap:envelope> Update a Relationship and its Primary Address Programmatically Using updaterelationship You can update a relationship and its primary address in Oracle Sales Cloud by calling the updaterelationship method. The sample payload for calling the updaterelationship method is as follows: Sample XML Payload <soap:envelope xmlns:soap=" <soap:body> <ns1:updaterelationship xmlns:ns1=" pservice/types/"> <ns1:relationship xmlns:ns2=" pservice/"> <ns2:objectpartyid> </ns2:objectpartyid> <ns2:subjectpartyid> </ns2:subjectpartyid> <ns2:relationshiptype>contact</ns2:relationshiptype> <ns2:relationshipcode>contact_of</ns2:relationshipcode> <ns2:enddate> </ns2:enddate> <ns2:comments>updating End Date</ns2:Comments> </ns1:relationship> </ns1:updaterelationship> </soap:body> </soap:envelope> Merge a Relationship Programmatically Using mergerelationship You can merge a relationship by calling the mergerelationship method. The sample payload for calling the mergerelationship method is as follows. Sample XML Payload Primary Key <soap:envelope xmlns:soap=" <soap:body> <ns1:mergerelationship xmlns:ns1=" pservice/types/"> 56 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

57 How do I? Managing Relationships Using the Simplified Sales Cloud Relationship Web Service <ns1:relationship xmlns:ns2=" pservice/"> <ns2:objectpartyid> </ns2:objectpartyid> <ns2:subjectpartyid> </ns2:subjectpartyid> <ns2:relationshiptype>membership</ns2:relationshiptype> <ns2:relationshipcode>member_of</ns2:relationshipcode> <ns2:startdate> </ns2:startdate> <ns2:enddate> </ns2:enddate> <ns2:createdbymodule>hz_ws</ns2:createdbymodule> <ns2:comments>future DATE RELATIONSHIP WITH CONTACT</ns2:Comments> </ns1:relationship> </ns1:mergerelationship> </soap:body> </soap:envelope> Alternate Key <soap:envelope xmlns:soap=" <soap:body> <ns1:mergerelationship xmlns:ns1=" pservice/types/"> <ns1:relationship xmlns:ns2=" pservice/"> <ns2:relationshiptype>membership</ns2:relationshiptype> <ns2:relationshipcode>member_of</ns2:relationshipcode> <ns2:enddate> </ns2:enddate> <ns2:createdbymodule>hz_ws</ns2:createdbymodule> <ns2:comments>current DATE</ns2:Comments> <ns2:subjectpartynumber>cdrm_414607</ns2:subjectpartynumber> <ns2:objectpartynumber>cdrm_415617</ns2:objectpartynumber> </ns1:relationship> </ns1:mergerelationship> </soap:body> </soap:envelope> Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 57

58 Contents Perform a Specific Operation (Create, Update, Delete, or Merge) on a List of Relationships Using processrelationship You can perform a create, update, delete, or merge operation on a list of relationship rows in Oracle Sales Cloud by calling the processrelationship method. The sample payload for calling the processrelationship method is as follows. Sample XML Payload <soap:envelope xmlns:soap=" <soap:body> <ns1:processrelationship xmlns:ns1=" pservice/types/"> <ns1:changeoperation>create</ns1:changeoperation> <ns1:relationship xmlns:ns2=" pservice/"> <ns2:objectpartyid> </ns2:objectpartyid> <ns2:subjectpartyid> </ns2:subjectpartyid> <ns2:relationshiptype>contact</ns2:relationshiptype> <ns2:relationshipcode>contact_of</ns2:relationshipcode> </ns1:relationship> <ns1:processcontrol xmlns:ns2=" <ns2:returnmode>full</ns2:returnmode> <ns2:exceptionreturnmode>full</ns2:exceptionreturnmode> <ns2:partialfailureallowed>true</ns2:partialfailureallowed> </ns1:processcontrol> </ns1:processrelationship> </soap:body> </soap:envelope> 58 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

59 3 Invoking A Simplified Web Service Using Web Service Proxy Clients You can use an appropriate IDE to develop a proxy client on a platform of your choice such as Java,.Net, or ASP to call Web services and integrate applications with Oracle Sales Cloud using Web services. You can use any IDE that supports the SOAP standards and conforms to WS Security 1.1 policies to develop the client application. You can build a static proxy, dynamic proxy, or a dynamic-static proxy depending on your business requirements. Points to Consider While Designing Web Service Proxy Clients You must consider the pros and cons of static proxies: Pros: Proxy compiled at design time Collection of classes usually generated (e.g. JAX-B), helps with the development Quick and easy for POCs and implementations where the server contract doesn t change dramatically, or uses standard fields Cons If a developer adds a field to the Oracle Sales Cloud then these fields are added to the WSDL. Unless the proxy is re-generated then these fields won t be seen by the code You should also keep in mind the benefits of dynamic proxies: Compile nothing at development time, all resolved at runtime Application retrieves WSDL, dynamically constructs calls Able to manage customizations and dynamicity in WSDL More robust for production use However, dynamic proxies are more complex to develop. Some other factors that could impact your choice of Web service proxy type are follows: The need to add new custom fields or custom child objects changes the payload The need to integrate with multiple sales Cloud tenants, each having different customizations Publishing applications to Oracle Marketplace, you want to make sure your web service works on everyone's tenant instance Static Web Service proxies may not be able to manipulate new custom fields easily Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 59

60 Contents Invoking A Simplified Web Service Using A Static Proxy Some of the IDEs that you can use to build We b service static proxy clients are JDeveloper, Eclipse, and NetBeans. The following procedure describes how to build a Web service proxy client using Oracle JDeveloper. 1. Launch Oracle JDeveloper IDE in Default role. 2. Click on the File menu and select New 3. In the New Gallery dialog, select Generic Project and Click OK 4. In the Create Generic Project Dialog, specify the Project Name and Directory, and then click Finish. 60 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

61 Invoking A Simplified Web Service Using Web Service Proxy Clients Invoking A Simplified Web Service Using A Static Proxy 5. Right click on the project and click on new (CTRL+N). 6. In the New Gallery dialog, under Business Tier select Web Services and then Web Service Proxy 7. Click OK. 8. In the Create Web Service Proxy wizard, click Next. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 61

62 Contents 9. Select JAX-WS Style and click Next. 10. Enter URL of the WSDL in the format : WSDL. 62 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

63 Invoking A Simplified Web Service Using Web Service Proxy Clients Invoking A Simplified Web Service Using A Static Proxy 11. Deselect Copy WSDL into Project. 12. Click Next. 13. Click Next. 14. Click Next. 15. Select oracle/wss11_saml_token_with_message_protection_client_policy Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 63

64 Contents 16. Click Next. 17. Click Finish and wait for proxy generation. 18. Double Click on AccountServiceSoapHttpPortClient.java which is basically the file to be edited to invoke the service. 19. Add your custom code to call the desired methods, such as createaccount, updateaccount, or deleteaccount, or with the required input parameters. Note: See Appendix B for sample code to call the different methods. The appendix contains code for a sample a static Web Service Proxy -J A X -WS Style built with Oracle JDeveloper Studio for the Sales Cloud Account Web service. Authentication In order to authenticate to the Sales Cloud application, one of the 2 security policies listed below have to be adhered to. The policies are managed by Oracle Web Services Manager. oracle/wss_username_token_over_ssl_client_policy This policy includes credentials in the WS-Security UsernameToken header in the SOAP request messages. The plain text mechanism is supported. The policy uses SSL for achieving transport layer security. The following is an example of an authentication mechanism to Sales Cloud. This is a code snippet written in the Java programming language, demonstrating the authentication code to login to a Fusion environment using the username token over SSL policy. In order for this code snippet to run, the OWSM agent should be present and 64 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

65 Invoking A Simplified Web Service Using Web Service Proxy Clients Authentication running. In this approach the OWSM agent is embedded in weblogic 11g or JDeveloper 11g. Authentication - Username token over SSL oracle/wss11_username_token_with_message_protection_client_policy The username_token_message_protection policy requires that the public Oracle certificate (Service Public key) is referenced by the client as rcpt-key alias. rcpt-key-alias : Service Public key Encrypting symmetric key which is used for SAML+Body signature/encryption One approach is to leverage the OWSM agent. In such an approach, a keystore needs to be generated by the client and stored on the client machine. A keystore holds the user alias, the appropriate keys and its corresponding values which are required in order to authenticate to the Fusion environment. The public Oracle certificate file can be obtained from the Fusion WSDL and can be imported to the keystore under the rcpt-key-alias. The Oracle certificate file can be imported to the keystore using the keytool commands listed below. Import Oracle certificate to a keystore file keytool -importcert -alias nameoforaclekey -file oraclecertificatefile.cer -keystore oracle-keystore.jks -storepass keystorepassword List the contents of a keystore keytool -list -keystore ".oracle-keystore.jks" The client should store the keystore file to their local machine and reference the keystore file in their client application in order to authenticate to the Fusion environment. The following is an example of an authentication mechanism to Sales Cloud. This is a code snippet written in the Java programming language, demonstrating the authentication code to login to a Fusion environment using the username token with message protection policy. In order for this code snippet to run, the OWSM agent should Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 65

66 Contents be present and running. In this approach the OWSM agent is embedded in weblogic 11g or JDeveloper 11g. Authentication -- Username token and message protection Note: The above examples represent a single approach to authenticate to Sales Cloud web services using Java as the programming language and JDeveloper 11g as the IDE. Any development platform which complies with WS Security policies 1.1 can be used to authenticate to Sales Cloud web services. For further information regarding extracting Oracle public certificate from a Fusion WSDL, please refer to Appendix C: Extracting Oracle Public Certificate from Fusion WSDL 66 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

67 4 Sales Cloud Account Simplified Web Services Interface Call the Sales Cloud Account service to create, update, find, and delete organization accounts. Organization accounts contain the following information: organization profile, sales profile, contact information (primary address, phone, fax, and URL), industry classification and account hierarchy. This service manages simple organization accounts, and does not support organization accounts with additional names and identifiers, multiple sets of addresses, contacts, industry classification information, and phone and resources associated with the sales profile. Related Services: Sales Cloud Address: This service can be used to add additional address to the organization account, once it is created using the Sales Cloud Account service. Sales Cloud Relationship: This service can be used, in combination with the Contact service, to define additional contacts on the organization account, once it is created using the Sales Cloud Account service. Sales Cloud Household: If you have requirements to create a household account rather than an organization account, use this service instead. Sales Cloud Contact: If you have requirements to create a contact account rather than an organization account, use this service instead. Sales Party: This service is similar to the Sales Cloud Account service in that it creates organization accounts. However, it is used for more complex organization accounts, has prerequisite invocation steps, and has a more complex hierarchical service interface rather than flattened structure. If organization account requirements are met by the Sales Cloud Account service, then use the Sales Cloud Account service because it is easier to use. Sales Account Service: This service is used to add sales accounts to existing accounts in a multiple sales account scenarios. Although this service name is similar, this service is used for a different use case scenario. Life Cycle Active QName { vice Relationships Type Relationship To Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 67

68 Sales Cloud Account Simplified Web Services Interface Type Handles Handles Body Text Relationship To Sales Cloud Account SDO Sales Cloud Primary Address SDO Body Text Operations Available Operations: createaccount deleteaccount findaccount getaccount mergeaccount processaccount processcsaccount updateaccount createaccount Creates an organization account and its primary address. Life Cycle Active Request Payload Element Name account Type Sales Cloud Account SDO Description The account to create. 68 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

69 Sales Cloud Account Simplified Web Services Interface Operations Response Payload Name Type Description result Sales Cloud Account SDO The account which is created. deleteaccount Deletes an account and the relationship between the account and address objects indicating the address is a primary address. The address object cannot be deleted using this operation. To delete the address, use the Sales Cloud Address service. Life Cycle Active Request Payload Element Name account Type Sales Cloud Account SDO Description The account to delete. Response Payload Name Type Description result MethodR esult Not applicable. findaccount Finds a list of accounts based matching the supplied criteria pertaining to the object. Life Cycle Active Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 69

70 Sales Cloud Account Simplified Web Services Interface Operations Request Payload Element Name Type Description findcriteria FindCriteria The criteria used to find the account, such as the filter, the fetch size, and so on. findcontrol FindControl Response Payload Name Type Description result Sales Cloud Account SDO The list of accounts that match the filter criteria. getaccount Retrieves the account based on the primary key identifier. Life Cycle Active Request Payload Element Name Type Description PartyId Long The identifier of the account you want to retrieve. Response Payload Name Type Description result Sales Cloud Account SDO The account matching the party Id specified. 70 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

71 Sales Cloud Account Simplified Web Services Interface Operations mergeaccount Merges an account with another account. The service updates the object if it exists, else inserts the object. Life Cycle Active Request Payload Element Name account Type Sales Cloud Account SDO Description The account to merge. Response Payload Name Type Description result AccountR esult Not applicable. processaccount Creates, updates, deletes, or merges a list of account rows. It performs the specified operation on the accounts. Life Cycle Active Request Payload Element Name changeopera tion account Type string Sales Cloud Description The action to perform on the account such as Create, Update, Merge, or Delete. A list of accounts to be processed. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 71

72 Sales Cloud Account Simplified Web Services Interface Operations Account SDO processcontro l ProcessC ontrol Attribute to manage the account processing such as whether the valid data will be committed if there are other invalid data in the same batch, or whether the outbound will contain the key attributes only or the full object. Response Payload Name Type Description result Sales Cloud Account SDO A list of Accounts that are successfully processed. processcsaccount Creates, updates, or deletes a list of accounts. The operation and objects depend on the ChangeSummary object specified. Life Cycle Active Request Payload Element Name processdata processcontro l Type ProcessD ata ProcessC ontrol Description The object that is used to represent the changes that have been made. Attribute to manage the account processing such as whether the valid data will be committed if there are other invalid data in the same batch, or whether the outbound will contain the key attributes only or the full object. 72 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

73 Sales Cloud Account Simplified Web Services Interface Operations Response Payload Name Type Description result ProcessD ata Result of the operation including the list of objects created or updated. This also lists all warning and informational messages. updateaccount An operation to update an account and primary address. When updating the primary address information it is not necessary to include the primary or alternate keys for the primary address. There is a one-to-one correspondence between the account and primary address. If the alternate keys SourceSystem and SourceSystemReferenceValue in the primary address are specified and they do not match the values in the existing primary address, then a new source system reference is created with the existing primary address values and values specified in the request payload, and the primary address is updated to point to the newly created address object. Life Cycle Active Request Payload Element Name account Type Sales Cloud Account SDO Description The account to update. Response Payload Name Type Description result AccountR esult The account which is updated. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 73

74 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO Sales Cloud Account SDO An account for a customer or prospect. This object is an aggregation of primary account profile, and contact information, and references a single primary address. QName { Relationships Type Contains Handled by Relationship To Sales Cloud Primary Address SDO Sales Cloud Account Attributes (Alternate 1 Keys/Label/ sections with description) Name Type Description AnalysisFiscalY ear The fiscal year used as the source for financial information. BusinessReport BusinessScope string The Dun & Bradstreet business information report. CEOName string The class of business to which the account belongs, such as local, national, or international. 74 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

75 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO CEOTitle string The name of the organization s chief executive officer. The formal title of the chief executive officer. CertificationLe vel string CertificationR easoncode string The certification level the organization. A list of valid certification level codes is defined using the lookup HZ_PARTY_CERT_LEVEL. Review the Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. The reason for the contact's current certification level assignment. A list of valid certification reason codes are defined using the lookup HZ_PARTY_CERT_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. Comments string The corporate charter of the organization. Congressional DistrictCode String The U.S. Congressional district code for the account. ControlYear Number Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 75

76 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO The year when current ownership gained control of the organization. CorpCurrency Code CorporationCl ass String string The corporate currency code used by the CRM Extensibility framework. It is defaulted to the value set in the profile option ZCA_COMMON_CORPORATE_CURRENCY. The taxation classification for corporation entities such as Chapter S in the US. CreatedBy String The user who created the account record. CreatedByMo dule String Creatable The module that created the account record. CreationDate Date The date when the record was created. CurcyConvRa tetype CurrencyCod e CurrentFiscalY earpotentialr evenueamou String String Number The currency conversion rate type. This attribute is used by CRM Extensibility framework. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. The currency code. This attribute is used by CRM Extensibility framework. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. 76 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

77 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO nt DataCloudSta tus String The estimated revenues that can be earned by the organization during its current fiscal year. Disadvantage Indicator boolean The enrichment status of the contact record from Data-as-a-Service. A list of valid values are defined in the lookup DATA_CLOUD_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. DomesticUltim atedunsnum ber number Indicates whether the organization is considered disadvantaged by the US government under Title 8A. If the value is Yes, the organization is considered disadvantaged under Title 8A. The default value is No. DoNotConfus e With string The DUNS Number for the Domestic Ultimate. A Domestic Ultimate is the highest member of the same country in the organization's hierarchy. An organization can be its own Domestic Ultimate. DUNSCreditRa ting string Indicates that there is an organization that is similarly named. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 77

78 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO DUNSNumber number The Dun & Bradstreet credit rating. Address string The DUNS Number in freeform text format. The value not restricted to nine digit number. Format string The address of the contact point for the organization. The preferred format for addressed to this organization, such as HTML or ASCII. EmployeesAtP rimaryaddress Number EmployeesAtP rimaryaddress Estimation String The qualifier to calculate the estimated number of employees at the primary address. A list of valid qualifier codes are defined using the lookup EMP_AT_PRIMARY_ADR_EST_IND. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. The estimated minimum number of employees at the primary address. A list of accepted values are defined in the lookup type EMP_AT_PRIMARY_ADR_MIN_IND. Review and update the values using the Setup and Maintenance work area, Manage Trading 78 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

79 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO Community Common Lookups task. EmployeesAtP rimaryaddress Minimum Number EmployeesAtP rimaryaddress Text String The qualifier to qualify calculation of employees at the primary address as minimum. EmployeesTot al Number The number of employees at the referenced address in text format. ExportIndicato r Boolean The total number of employees in the organization. Indicates whether the organization is an exporter. If the value is Y, then the organization is an exporter. The default value is N. FaxAreaCode Number The area code for the fax number. FaxCountryCo de Number The international country code for a fax number, such as 33 for France. FaxExtension Number Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 79

80 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO FaxNumber Number The extension to the fax number of the organization. The fax number of the organization in the local format. The number should not include area code, country code, or extension. FiscalYearend Month String FormattedFax Number FormattedPho nenumber GeneralServic esadministrati onflag GlobalUltimat edunsnumbe r Number Number Boolean Number The last month of a fiscal year for the organization. The list of accepted values is defined in the lookup type MONTH. The formatted fax number of the organization. The formatted phone number of the organization. Indicates whether organization is a US federal agency supported by the General Services Administration (GSA). If the value is Y, then the organization is supported by GSA. The default value is N. The DUNS Number for the Global Ultimate. A Global Ultimate is the highest member in the organization's hierarchy. An organization can be its own Global Ultimate. 80 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

81 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO GrowthStrateg ydescription String The user-defined description of growth strategy. HomeCountry String The home country of the organization. HQBranchIndi cator String ImportIndicat or Boolean The status of this site, such as HQ, a branch, or a single location. A list of accepted values are defined in the lookup type HQ_BRANCH_IND. Indicates whether the organization is an importer. If the value is Y, then the organization is an importer. The default value is N. IndustryCode String The Industry classification code. The classification codes are defined for every classification category as specified in IndustryCodeType attribute. Review and update the codes using the Setup and Maintenance work area, Manage Classification Categories task. IndustryCodeT ype String The industry classification category code type. It is defaulted to the value of profile option MOT_INDUSTRY_CLASS_CATEGORY. Review and update the codes using the Setup and Maintenance work area, Manage Classification Categories task. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 81

82 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO LaborSurplusIn dicator Boolean LastEnrichmen tdate Date Indicates whether the organization operates in an area with a labor surplus. If the value is Y, then the organization operates in an area with a labor surplus. The default value is N. LastUpdateDa te LastUpdatedB y LastUpdateLo gin Date String String The date when the record was last enriched. The date when the record was last updated. The user who last updated the record. The login of the user who last updated the record. LegalStatus String LineOfBusiness String The legal structure of the organization such as partnership, corporation, and so on. The type of business activities performed at this site. LocalActivityC ode String The local activity classification code. LocalActivityC String 82 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

83 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO odetype LocalBusinessI dentifier String The local activity classification code type identifier. LocalBusinessI dentifiertype String The primary identifier assigned to a businesses by a government agency such as Chamber of Commerce, or other authority. It is often used by countries other than USA. MinorityOwne dindicator Boolean The lookup that represents most common business identifier in a country such as Chamber of Commerce Number in Italy, Government Registration Number in Taiwan. A list of accepted values is defined in the lookup type LOCAL_BUS_IDEN_TYPE. MinorityOwne dtype String Indicates whether the organization is primarily owned by ethnic or racial minorities. If the value is Y, then the organization is owned by ethnic or racial minorities. The default value is N. MissionStatem ent String The type of minority-owned firm. The corporate charter of organization in user- Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 83

84 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO NamedFlag Boolean defined text format. Indicates if the sales account is a named sales account. If the value is True, then the account is a named account. The default value is False. NextFiscalYear PotentialReve nueamount Number OrganizationN ame String The estimated revenue of the organization to be earned during its next fiscal year. Creatable, Required, Updateable OrganizationSi ze String The name of the account. OrganizationT ype String The size of an organization based on revenue, number of employees, and so on. The accepted values are defined in the lookup type HZ_ORGANIZATION_SIZE. OutOfBusinessI ndicator Boolean The organization type value such as region, division, and department. Indicates whether the organization is out of business. If the value is Y, then the organization is 84 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

85 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO out of business. The default value is N. Owner A ddress String The address of the employee resource that owns and manages the sales account. The owner is a valid employee resource defined within Sales Cloud. To assign an owner to the sales account, user can provide one of the following attributes of the resource: PartyID, PartyNumber or Address. This is provided if user wants to change the owner of the account or create account with a different owner than the login user. If provided then OwnerPartyID, OwnerPartyNumber, and Owner Address are used in this order to determine the owner of the account. OwnerPartyId String The unique identifier of a valid employee resource who owns and manages the sales account. To assign an owner to the sales account, user can provide one of the following attributes of the resource: PartyID, PartyNumber or Address. This is provided if user wants to change the owner of the account or create account with a different owner than the login user. The OwnerPartyID, OwnerPartyNumber, and Owner Address are used in this order to determine the owner for the account. During create, if OwnerPartyID, OwnerPartyNumber or Owner Address are not provided, then the account is assigned by default to the login user's partyid. OwnerPartyNu mber Number Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 85

86 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO The party number of a valid employee resource who owns and manages the sales account. To assign an owner to the sales account, user can provide one of the following attributes of the resource: PartyID, PartyNumber or Address. This is provided if user wants to change the owner of the account or create account with a different owner than the login user. The OwnerPartyID, OwnerPartyNumber, and Owner Address are used in this order to determine the owner for the account. ParentAccoun tpartyid String ParentAccoun tpartynumber Number The party Id of the parent account within the hierarchy. To assign a parent account to a sales account, you must provide the parent account's party ID, party number, or source system reference. The party number of the parent account within the hierarchy. ParentAccoun tsourcesystem String To assign a parent account to the given account, provide parent account's Party Id, PartyNumber, or Source System Reference and SourceSystem. The account hierarchy is updated based on the identified parent account. The source system of the parent account within the hierarchy. 86 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

87 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO To assign a parent account to the given account, provide Party ID, PartyNumber, or Source System Reference and SourceSystem. The account hierarchy is updated based on the identified parent account. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task and editing the lookup type HZ_ORIG_SYSTEMS_VL. ParentAccoun tsourcesystem ReferenceVal ue String The source system reference of the parent account within the hierarchy. ParentDUNSN umber Number To assign a parent account to an account, provide the parent account's Party ID, PartyNumber, or Source System Reference and SourceSystem. The account hierarchy is updated based on the identified parent account. The DUNS Number of the organization or the parent entity that owns a majority stake of the organization's capital stock. The parent entity can be a subsidiary of another corporation. If the parent also has branches, then it is regarded as headquarters as well as a parent company. A headquarters is a business establishment that has branches or divisions reporting to it, and is financially responsible for those branches or divisions. If the headquarters has more than 50% of capital stock owned by another corporation, it also will be a subsidiary. If it owns more than 50% of capital stock of another corporation, then it is also a parent. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 87

88 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO ParentOrSubsi diaryindicator String Indicates whether the organization is a parent or subsidiary. PartyId String The unique identifier of the account. PartyNumber String The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. PartyStatus String Indicates the status of the account. This is an internally-used column and the values are defined in the lookup HZ_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. PartyUniqueN ame PhoneAreaCo de String Number The unique account name displayed on account related screens. The default value is the concatenation of attributes AccountName and UniqueNameSuffix. If the attribute UniqueNameSuffix is nil, then the AccountName is concatenated with a system generated number. PhoneCountry Code Number The area code for the telephone number. The international country code for a telephone 88 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

89 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO number, such as 33 for France. PhoneExtensio n Number The extension to the phone number of the organization. PhoneNumber Number The phone number of the organization in the local format. The number should not include area code, country code, or extension. PreferredCont actmethod String PreferredFunc tionalcurrenc y String The preferred contact method of the organization. The accepted values are defined in the lookup type HZ_PREFERRED_CONTACT_METHOD. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. PrimaryAddres s String The organization's default currency code. A list of valid currency codes are defined during the application setup. PrincipalNam e String The primary address of the account. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 89

90 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO PrincipalTitle String The name of the highest ranking person in the organization. The title of the highest ranking person in the organization. PublicPrivate OwnershipFla g Boolean RegistrationTy pe String Indicates whether the organization is publically or privately owned. If the value is Y, then the organization is a privately owned organization. The default value is N. RentOrOwnIn dicator String Indicates the type of registration, such as nonprofit. The accepted values are defined in the lookup type REGISTRATION_TYPE. SiebelLocatio n String Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease are defined in the lookup OWN_RENT_IND. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. The location of account. This is an optional part of User Primary Key. 90 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

91 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO SmallBusinessI ndicator Boolean Indicates whether the organization is considered as a small business. If the value is Y, then the organization is considered as a small business. The default value is N. SourceSystem String Creatable The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System. SourceSystem ReferenceVal ue String Creatable The unique identifier for the account party from the external source system specified in the attribute SourceSystem. StockSymbol String The corporate stock symbol of the organization as listed in stock exchanges. TaxpayerIdent ificationnumb er String TotalEmploye esestimatedin dicator String The taxpayer identification number that is often a unique identifier of the organization, such as income taxpayer Id in USA and fiscal code or NIF in Europe. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 91

92 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO Indicates if the employee total is estimated. The accepted values are defined in the lookup type TOTAL_EMP_EST_IND. TotalEmploye esindicator String TotalEmploye esminimumind icator String Indicates if subsidiaries are included in the calculation of total employees. The accepted values are defined in the lookup type TOTAL_EMPLOYEES_INDICATOR. TotalEmploye estext String Indicates if the number is a minimum, maximum, or average number of total employees. The accepted values are defined in the lookup type TOTAL_EMP_MIN_IND. TotalPayment Amount Number The total number of employees in text format. The total amount of payment collected from the organization. Type String The account type that defines if the account is a sales account or a prospect or any other party type. The accepted values are defined in the lookup type ZCA_ACCOUNT_TYPE. It is defaulted to ZCA_CUSTOMER if no value is provided. 92 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

93 Sales Cloud Account Simplified Web Services Interface Sales Cloud Account SDO UniqueNameS uffix String The suffix used to generate the attribute PartyUniqueName. The suffix is concatenated to the OrganizationName attribute to generate the PartyUniqueName. The primary address is defaulted as the suffix. URL String The uniform resource locator or a website containing information about the organization. WomanOwne dindicator String YearEstablishe d Number Indicates whether the organization is primarily owned by women. If the value is Y, then the organization is primarily owned by women. The default value is N. YearIncorpora ted String The year that the organization started it business operations. The year that the business was formally incorporated. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 93

94

95 5 Sales Cloud Contact Simplified Web Services Interface Call the Sales Cloud Contact service (ContactService) to create, update, retrieve, and delete contacts. The service includes attributes related to contact profile, sales profile, contact information, such as primary address, phone, fax, and URL, and classification. This service covers all frequently used operations for contact. However, this service does not support relationships, additional address, contact preferences, and multiple instances of other child objects such as additional names, identifiers, classification, phone, fax, , etc. Related Services: Sales Cloud Address: Service to add additional address to an existing contact. Sales Cloud Relationship: Service to define additional account relationships for an existing contact that can be used in combination with the Account and Household service. Similarly, it can be used in combination with the Household service to create members or contact relationships for a given household. Sales Location and Person Service: Service to manage contacts and their addresses. Sales Party: Service similar to the Sales Cloud Account service that creates organization accounts. However, it is used for more complex organization accounts, has prerequisite invocation steps, and has a more complex hierarchical service interface rather than flattened structure. If organization account requirements are met by the Sales Cloud Account service, then use the Sales Cloud Account service because it is easier to use. Sales Account Service: Service to add sales accounts to existing accounts in a multiple sales account scenarios. Although this service name is similar, this service is used for a different use case scenario. Life Cycle Active QName { ce Relationships Type Handles Handles Relationship To Sales Cloud Contact SDO Sales Cloud Primary Address SDO Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 95

96 Sales Cloud Contact Simplified Web Services Interface Operations Operations Available Operations: getcontact createcontact updatecontact deletecontact mergecontact findcontact processcontact processcscontact getcontact Retrieves the contact based on the primary key identifier. Life Cycle Active Request Payload Element Name Type Description PartyId long The party identifier used to retrieve the contact. Response Payload Name Type Description result Sales Cloud Contact SDO Contact that matches the inbound key attributes. 96 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

97 Sales Cloud Contact Simplified Web Services Interface Operations createcontact Creates a contact and its primary address. Life Cycle Active Request Payload Element Name contact Type Sales Cloud Contact SDO Description The contact to be created along with its primary address. Response Payload Name Type Description result { le.com/apps/crm C ommon/salesparti es/contactservic e/ }ContactResult The created contact. updatecontact Updates a contact and its primary address. When updating the primary address information it is not necessary to include the primary or alternate keys for the primary address. There is a one-to-one correspondence between the contact and primary address. If the alternate keys SourceSystem and SourceSystemReferenceValue in the primary address are specified and they do not match the values in the existing primary address, then no new address object is created. However, new SourceSystem or SourceSystemReferenceValue are created for the existing primary address. Life Cycle Active Request Payload Element Type Description Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 97

98 Sales Cloud Contact Simplified Web Services Interface Operations Name contact Sales Cloud Contact SDO The contact to be updated along with its primary address. Response Payload Name Type Description result { lns.oracle. com/app s/crmc ommon/s alespartie s/contact Service/ }Contact Result The updated contact. deletecontact Deletes a contact and the relationship between the contact and address objects indicating the address is a primary address. The address object cannot be deleted using this operation. To delete the address, use the Sales Cloud Address service. Life Cycle Active Request Payload Element Name contact Type Sales Cloud Contact SDO Description The contact to be deleted along with its relationship with address objects. 98 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

99 Sales Cloud Contact Simplified Web Services Interface Operations Response Payload Name Type Description result { lns.oracle. com/adf/ svc/type s/}metho dresult mergecontact Performs a merge on the contact. It will perform an update if the object exists or an insert if the object doesn't exist. Life Cycle Active Request Payload Element Name contact Type Sales Cloud Contact SDO Description The contact to be merged. Response Payload Name Type Description result { lns.oracle. com/app s/crmc ommon/s alespartie s/contact Service/ }Contact The merged contact. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 99

100 Sales Cloud Contact Simplified Web Services Interface Operations Result findcontact Finds a list of contacts based on matching the supplied criteria pertaining to the object. Life Cycle Active Request Payload Element Name findcriteria findcontrol Type { lns.oracle. com/adf/ svc/type s/}findcrit eria { lns.oracle. com/adf/ svc/type s/}findco ntrol Description The criteria used to limit your query result, such as the filter (where clause), the fetch size, and so on. The find control. Not currently used. Response Payload Name Type Description result Sales Cloud Contact SDO A list of contact that satisfy the inbound criteria. processcontact Performs a create, update, delete, or merge operation on a list of contact rows. It performs the specified operation on the contacts. 100 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

101 Sales Cloud Contact Simplified Web Services Interface Operations Life Cycle Active Request Payload Element Name changeopera tion contact processcontro l Type string Sales Cloud Contact SDO { lns.oracle. com/adf/ svc/type s/}process Control Description Indicates the action to be performed, such as Create, Update, Merge, or Delete. Unbounded A list of contact to be processed. Control your bulk upload behavior, such as whether the valid data will be committed if there are other invalid data in the same batch, and whether the outbound will contain the key attributes only or the full object. Response Payload Name Type Description result Sales Cloud Contact SDO A list of contact that are successfully processed. processcscontact Performs a create, update, or delete operation on a list of contact rows. The operation and objects depend on the ChangeSummary object specified. Life Cycle Active Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 101

102 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO Request Payload Element Name processdata processcontro l Type { lns.oracle. com/adf/ svc/type s/}process Data { lns.oracle. com/adf/ svc/type s/}process Control Description The object that is used to represent the changes that have been made. Control your bulk upload behavior, such as whether the valid data will be committed if there are other invalid data in the same batch, and whether the outbound will contain the key attributes only or the full object. Response Payload Name Type Description result { lns.oracle. com/adf/ svc/type s/}process Data Result of the operation including a list of created/updated data objects, and all warning and informational messages. Sales Cloud Contact SDO A contact is a person who either has a relationship to other objects like account and household or is a customer or prospect you directly sell to. A contact could be either a buying customer in a B2C scenario or contact of an account in a B2B scenario. This object is an aggregation of person profile, and contact information, and references a single primary address. QName { 102 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

103 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO Relationships Type Contains Handled by Relationship To Sales Cloud Primary Contact SDO Sales Cloud Contact Attributes (Alternate 1 Keys/Label/ sections with description) Name Type Description AcademicTitle string The part of the person s title that denotes the academic qualification, such as Dr. Jane Smith. AccountName string The name of the sales account that this contact belongs to. AccountPartyId long The unique identifier of sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference. AccountPartyNu mber string AccountSourceSy stem string The party number of the sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 103

104 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO The source system code of the sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference. AccountSourceSy stemreferenceva lue string AssignmentExcep tionflag boolean The source system reference value of the sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference. Indicates whether the sales account has the required dimensions to allow assignment manager to assign territories to the sales account. If the value is True, then the sales account has the required dimensions. The default is false. CertificationLevel string The certification level of a contact. A list of accepted values are defined in the lookup HZ_PARTY_CERT_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. CertificationReas oncode string The reason for the contact's current certification level assignment. A list of accepted values are defined using the lookup HZ_PARTY_CERT_REASON. Review and update the value for this attribute 104 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

105 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. ClassificationCate gory string ClassificationCod e string A valid classification category code for the contact. This is defined by an admin and is marked as primary. A valid classification code corresponding to the classification category, which is marked as primary. Comments string The textual comments about a contact. ContactIsPrimaryF oraccount string The preferred contact for the account. ContactName string The derived name of the contact. ContactUniqueN ame string The unique contact name displayed on contact related screens. The default value for ContactUniqueName is the concatenation of attributes ContactName and UniqueNameSuffix. If the attribute UniqueNameSuffix is nil, then the ContactName is concatenated with a system generated number. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 105

106 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO CorpCurrencyCo de string The corporate currency code associated with the contact. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. CreatedBy string The user who created the contact record. CreatedByModul e string Creatable The application module that created this contact record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. Review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task. CreationDate timestamp The date and time when the contact record was created. CurcyConvRateTy pe string The currency conversion rate type associated with the contact. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. CurrencyCode string The currency code associated with the contact. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. DataCloudStatus string 106 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

107 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO DateOfBirth date The enrichment status of the contact record from Data cloud. A list of accepted values are defined in the lookup DATA_CLOUD_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. DateOfDeath date The date when the person was born. DeceasedFlag boolean The date when the person died. DeclaredEthnicity string Indicates whether the person is deceased or not. If the value is True, then the person is deceased. The default is False. Department string The declared ethnicity of the person. DepartmentCode string The free form text used to name the department for the contact. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 107

108 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO DoNotCallFlag boolean The department code for the contact. A list of accepted values is defined in the lookup DEPARTMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. Indicates if the user can call the person or not. If the value is True, then the user must not call the person. The default is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. DoNotContactFla g boolean Indicates if the user can contact the person or not by phone, , or mail. If the value is True, then the user must not contact the person. The default is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. DoNot Flag boolean Indicates if the user can the person or not. If the value is True, then the user must not contact the person by . The default is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. 108 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

109 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO DoNotMailFlag boolean Address string Indicates if the user can send mail to the person or not. If the value is True, then the user must not contact the person by mail. The default is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. Format string The address of the contact point. The preferred format for addressed to this address such as HTML or ASCII. A list of accepted values is defined using the lookup _FORMAT. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. ExistingCustomerFl ag boolean ExistingCustomerFl aglastupdatedat e boolean Indicates whether there is an existing selling or billing relationship with the sales account. If the value is true, then there is an existing relationship with the sales account. The default value is False. Such relationships are defined by the existence of a Sell_To or Bill_To address. The date when the ExistingCustomerFlag was last Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 109

110 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO modified. It is internally populated by the application. FavoriteContactFl ag boolean Indicates whether the person is a key contact. If the value is true, then person is a key contact. The default value is False. FaxAreaCode string FaxCountryCode string The area code within a country code. FaxExtension string The international country code for a telephone number, such as 33 for France. FaxNumber string The additional number addressed after initial connection to an internal telephone system. FirstName string A telephone number formatted in the local format without the area code, country code, or extension. First name of the person. 110 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

111 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO FormattedFaxNu mber FormattedMobile Number FormattedWorkPh onenumber string string string The formatted fax number information. The formatted mobile phone number information. The formatted work phone number information. Gender string The gender of the person, such as male, female, and unknown. A list of accepted values are defined in the lookup HZ_GENDER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. HeadOfHousehol dflag boolean HomePhoneArea Code string Indicates if the person is the head of the household. If the value is True, then the person is the head of the household. The default value is False. HomePhoneCoun trycode string The area code within a country code. HomePhoneNum ber string The international country code for a telephone number, such as 33 for France. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 111

112 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO The home phone number formatted in the local format without the area code, country code, or extension. HouseholdIncom eamount string The income of the household that this person is a part of. HouseholdSize bigdecimal Initials string The size of the household this person is a part of. JobTitle string The initials in the contact s name. JobTitleCode string The free form text for job title. The code given to the job title. LastAssignmentD ate timestamp The date when the Sales Account Territory Assignment was last run by Assignment Manager. LastAssignmentD timestamp The date and time when the Sales Account Territory Assignment was last run by Assignment 112 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

113 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO atetime Manager. LastContactDate timestamp The date when the contact was last contacted. LastEnrichmentDa te date The date when the contact record was last enriched with data from external sources by using Data-as-a-Service. LastName string LastNamePrefix string The last name of the person. The prefix for the last name of a person, such as fon, van. For example, if a person s name is Hans Van, the last name of the person is captured using this attribute. LastUpdateDate timestamp The date and time when the contact was last updated. LastUpdatedBy string The user who last updated the contact record. LastUpdateLogin string The session login associated to the user who last updated the contact record. MaritalStatus string The marital status of the person. A list of accepted values is defined in the lookup MARITAL_STATUS. Review and update the value for this attribute Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 113

114 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO using the Setup and Maintenance work area, Manage Standard Lookups task. MaritalStatusEffec tivedate date The date when the person's marital status was changed. MiddleName string MobileAreaCode string The middle name of the person. The area code for the contact's mobile phone. MobileCountryCo de string The international country code for a contact s mobile phone number, such as 33 for France. MobileExtension string MobileNumber string The additional number addressed after initial connection to an internal telephone system. The mobile phone number formatted in the local format. The number should not include area code, country code, or extension. MyBusinessConta boolean Indicates if searching on business contact belongs 114 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

115 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO ct to login user. If the value is True, then the business contact belongs to login user. The default is false. NamedFlag string NameSuffix string Indicates whether a sales account is a named sales account. If the value is true, then the sales account is a named sales account. The default value is False. Note string The place in a family structure. For example, in "Tom Jones III", the "III". The note about the contact. Owner Addr ess string The address of a valid employee resource who owns and manages the sales account. To assign an owner to the sales account, user can provide one of the following attributes pertaining to the owner: PartyID, PartyNumber or Address. This is provided if user wants to change the owner of the contact or create contact with a different owner than the login user. If provided, then OwnerPartyID, OwnerPartyNumber, and Owner Address are honored in this order to determine the owner for the contact. OwnerName string The name of the sales account owner. OwnerPartyId long Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 115

116 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO The unique identifier of a valid employee resource who owns and manages the sales account. The owner is a valid employee resource defined within Sales Cloud. To assign an owner to the sales account, user can provide one of the following attributes pertaining to the owner: PartyID, PartyNumber, or Address. This is provided if user wants to change the owner of the contact or create contact with a different owner than the login user. If provided, then OwnerPartyID, OwnerPartyNumber, and Owner Address are honored in this order to determine the owner for the contact. During create, if none of the OwnerPartyID, OwnerPartyNumber, or Owner Address is provided, then the contact is assigned by default to the login user. The login user's partyid is used to populate OwnerPartyID. OwnerPartyNumb er string The party number of a valid employee resource who owns and manages the sales account. To assign an owner to the sales account, user can provide one of the following attributes pertaining to the owner: PartyID, PartyNumber, or Address. This is provided if user wants to change the owner of the contact or create contact with a different owner than the login user. If provided, then OwnerPartyID, OwnerPartyNumber, and Owner Address are honored in this order to determine the owner for the contact. PartyId long Keys Primary Key PartyNumber string Keys The unique internal identifier of a contact party. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact party. 116 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

117 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO Alternate Key Label Registry ID (this would show when UI hint is specified) Updateable, Creatable The unique alternate identifier for the contact party. The default value for PartyNumber is the value specified in the profile option HZ_GENERATE_PARTY_NUMBER. You can update the PartyNumber depending on the profile option HZ_GENERATE_PARTY_NUMBER. A list of accepted values is defined in the profile option HZ_GENERATE_PARTY_NUMBER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. PartyStatus string The status of the contact. A list of valid values are defined in the lookup HZ_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. PersonalIncomeA mount string The estimated gross annual income of the person. PlaceOfBirth string The place where the person was born, such as city or country. PreferredContact Method string Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 117

118 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO The preferred method to contact the person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Point Lookups task. PreferredFunction alcurrency string PreviousLastNam e string The default currency code for this contact. A list of accepted values is defined using the Setup and Maintenance work area, Manage Currencies task. The previous last name or surname of the person. PrimaryAddress string RecordSet string The primary address of the contact. The search results displayed under the selected record set. RentOrOwnIndica tor string Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease is defined in the lookup OWN_RENT_IND. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. 118 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

119 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO SalesAffinityCode string The affinity of a contact to the deploying organization. A list of accepted values are defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. SalesBuyingRoleC ode string The roles played by a contact in the buying process, for example, decision maker or supporting role. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. SalesProfileStatus string A valid user defined status of the sales account. SalesTeamMemb er string The unique alternate identifier of the sales team member. Salutation string The size of the household this person is a part of. SalutoryIntroducti on string Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 119

120 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO SecondLastName string The title or a salutary introduction for a contact, such as Mr., Herr, and so on. A list of accepted values is defined in the lookup CONTACT_TITLE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. SourceSystem string Keys The second last name for a person. A list of accepted values is defined in the lookup HZ_PERSON_PROFILES. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. Composite Alternate Key [SourceSystem and SourceSystemReference] Creatable The name of external source system where the contact party is imported from. The values are configured in Setup and Maintenance work area, Manage Trading Community Source Systems task. SourceSystemRef erencevalue string Keys Composite Alternate Key [SourceSystem, SourceSystemReference] Creatable The alternate unique identifier for the contact party from the external source system specified in the attribute SourceSystem. 120 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

121 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO TaxpayerIdentific ationnumber string The taxpayer identification number, which is often a unique identifier of the contact. The typical values are taxpayer Id in USA or fiscal code or NIF in Europe. Title string Type string A professional or family title, such as Don or The Right Honorable. The contact party type that defines whether the contact is a sales account, a prospect, a contact or any other user-defined party type. The default value is ZCA_CUSTOMER. A list of accepted values is defined in the lookup ZCA_CONTACT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. UniqueNameSuffi x string WorkPhoneAreaC ode string The system generated or manually overridden suffix. The suffix is used to generate the PartyUniqueName attribute and is concatenated to the ContactName attribute to generate the PartyUniqueName. The primary address is defaulted as the suffix. The area code for the contact's work phone. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 121

122 Sales Cloud Contact Simplified Web Services Interface Sales Cloud Contact SDO WorkPhoneCount rycode string WorkPhoneExtensi on string The international country code for a contact s work phone number, such as 33 for France. WorkPhoneNumb er string The additional number addressed after initial connection to an internal telephone system. The work phone number formatted in the local format without the area code, country code, or extension. 122 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

123 6 Sales Cloud Household Simplified Web Services Interface Call the Sales Cloud Household service (HouseholdService) to create, update, find, and delete the parties of type household. A household is a group that has accounts or contacts as its members. This service covers attributes related to household profile, sales profile, contact information (primary address, phone, and ) and industry classification. It does not support attributes for additional names and identifiers or multiple sets of addresses, industry classifications, and phone numbers or additional resources associated with the sales profile. Related Services: Sales Cloud Address: This service can be used to add additional address to an existing household. Sales Cloud Relationship: This service is used with the contact service to define members or contacts for a household. It can be used with the account service to define members for a household. Trading Community Location Service and Trading Community Group Service: These services are used to manage households and their addresses. Life Cycle Active QName { Service Relationships Type Handles Handles Relationship To Sales Cloud Household SDO Sales Cloud Primary Address SDO Operations Available Operations: gethousehold createhousehold updatehousehold Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 123

124 Sales Cloud Household Simplified Web Services Interface Operations deletehousehold mergehousehold findhousehold processhousehold processcshousehold gethousehold Retrieves the household based on the primary key identifier. Life Cycle Active Request Payload Element Name Type Description PartyId long The party identifier used to retrieve the household. Response Payload Name Type Description Return Sales Cloud Househol d SDO The household that matches the inbound key attributes. createhousehold Creates a household and, optionally, its primary address. Life Cycle Active Request Payload Element Name Type Description household Sales The household to be created. 124 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

125 Sales Cloud Household Simplified Web Services Interface Operations Cloud Househol d SDO Response Payload Name Type Description result { racle.com/ap ps/crmcomm on/salespartie s/householdse rvice/}househ oldresult The household that is created. updatehousehold Updates a household and its primary address. When updating the primary address information it is not necessary to include the primary or alternate keys for the primary address. There is a one-to-one correspondence between the account and primary address. SourceSystem and SourceSystemReferenceValue are the alternate keys. If SourceSystem and SourceSystemReferenceValue in the primary address are specified and they don t match the values in the existing primary address, then a new SourceSystem/SourceSystemReferenceValue gets created for the existing primary address. Life Cycle Active Request Payload Element Name household Type Sales Cloud Househol d SDO Description The household to be updated. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 125

126 Sales Cloud Household Simplified Web Services Interface Operations Response Payload Name Type Description Result { acle.com/apps /crmc ommon/salespa rties/households erv ice/}household Result The household that is updated. deletehousehold Deletes a household and its relationship with the primary address. The address object can't be deleted using this operation. You can use the Sales Cloud Address service to delete an address. Life Cycle Active Request Payload Element Name household Type Sales Cloud Househol d SDO Description The household to be deleted. Response Payload Name Type Description Result { le.com/adf/svc/ty pe s/}methodresult Not applicable. 126 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

127 Sales Cloud Household Simplified Web Services Interface Operations mergehousehold Merges the household and updates the record. If the household doesn t exist, then the operation inserts the household. Life Cycle Active Request Payload Element Name household Type Sales Cloud Househol d SDO Description The household to be merged. Response Payload Name Type Description result { cle.com/apps/cr mc ommon/salespar ties/householdse rv ice/}householdr esult The household that is merged. findhousehold Finds a list of households matching the supplied criteria pertaining to the object. Life Cycle Active Request Payload Element Name Type Description Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 127

128 Sales Cloud Household Simplified Web Services Interface Operations findcriteria findcontrol { oracle.com/ adf/svc/type s/}findcriteria { oracle.com/ adf/svc/type s/}findcontro l The criteria used to limit the query result. For example, the filter, such as the where clause, the fetch size, and so on. Find Control. Not currently used. Response Payload Name Type Description result Sales Cloud Househol d SDO A list of households meeting the criteria. processhousehold Performs bulk load operation for household. Life Cycle Active Request Payload Element Name Type Description changeoperat ion household processcontrol String Sales Cloud Househol d SDO { mlns.ora cle.com/ adf/svc/t Indicates what action shall be performed, such as Create, Update, Merge, or Delete. A list of households that should be processed. Control your bulk upload behavior, such as whether the valid data will be committed if there are other invalid data in the same batch, and whether the outbound will contain the key 128 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

129 Sales Cloud Household Simplified Web Services Interface Operations ype s/}proces scontrol attributes only or the full object. Response Payload Name Type Description Result Sales Cloud Househol d SDO A list of households that are successfully processed. processcshousehold Creates, updates, deletes, or merges a list of households. It performs the specified operation on the households. Life Cycle Active Request Payload Element Name processdat a processcon trol Type { /adf/svc/typ e s/}processda ta { /adf/svc/typ e s/}processc ontrol Description The object that is used to represent the changes that have been made. Control your bulk upload behavior, such as whether the valid data will be committed if there are other invalid data in the same batch, and whether the outbound will contain the key attributes only or the full object. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 129

130 Sales Cloud Household Simplified Web Services Interface Sales Cloud Household SDO Response Payload Name Type Description result { lns.oracle. com/adf/ svc/type s/}process Data Result of the operation including a list of created/updated data objects, and all warning and informational messages. Sales Cloud Household SDO An object that includes attributes used to store values while creating or updating a household. A household is a group that has a relationship with either an account or a contact. QName { Relationships Type Contains Handled By Relationship To Sales Cloud Primary Address SDO Sales Cloud Household Attributes (Alternate 1 Keys/Label/ sections with description) Name Type Description PartyId long Keys Primary Key The unique internal identifier of a household party. This attribute is generated internally by the application. PartyNumber strin g Keys Alternate Key 130 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

131 Sales Cloud Household Simplified Web Services Interface Sales Cloud Household SDO Label Registry ID (this would show when UI hint is specified) Updateable, Creatable The unique alternate identifier for the household party. The default value is the value specified in the profile option ZCA_PUID_PREFIX concatenated with a unique generated sequence number. The value is updateable depending on the profile option HZ_GENERATE_PARTY_NUMBER. A list of valid values is defined in the profile option HZ_GENERATE_PARTY_NUMBER. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. AnnualIncome long AssignmentExcepti onflag bool ean The annual income of the household. If not provided, then the value is NULL. Read-only Indicates whether the sales account had the required dimensions to allow assignment manager to assign territories to the sales account. Possible values are True or False. AverageAge long The average age of the members of the Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 131

132 Sales Cloud Household Simplified Web Services Interface Sales Cloud Household SDO household. CertificationLevel strin g CertificationReason Code strin g The certification level of a household. A list of valid certification level codes is defined in the lookup HZ_PARTY_CERT_LEVEL. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. The reason for the household current certification level assignment. A list of valid certification reason codes are defined using the lookup HZ_PARTY_CERT_REASON. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. Child0to6Number long Child13to18Number long The number of children in the household less than 6 years of age. Child7to12Number long The number of children in the household between 13 and 18 years of age. ClassificationCateg strin The number of children in the household between 7 and 12 year of age 132 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

133 Sales Cloud Household Simplified Web Services Interface Sales Cloud Household SDO ory g A valid classification category code for the household which will be marked as primary and is defined by an admin. ClassificationCode Strin g Comments Strin g A valid classification code corresponding to the classification category and which will be marked as primary. CorpCurrencyCod e CreatedBy CreationDate CurcyConvRateTyp e CurrencyCode strin g strin g strin g strin g strin g The textual comments about the household. The corporate currency code. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. This attribute is used by CRM Extensibility framework. The user who created the record. Date and time when the record was created. The currency conversion rate type associated with the household. This attribute is used by CRM Extensibility framework. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. The currency code attribute is used by CRM Extensibility framework. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 133

134 Sales Cloud Household Simplified Web Services Interface Sales Cloud Household SDO and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. DependentsNumbe r long Address Strin g The number of dependents in the household. Format Strin g The address of the contact point. ExistingCustomerFla g Bool ean Indicates the preferred format for , such as HTML or ASCII. Read-only ExistingCustomerFla glastupdatedate Dat e Indicates whether there is an existing selling or billing relationship with the sales account. If the value is true, then there is an existing relationship with the sales account. The default value is False. Read-only FormattedPhoneNu mber strin g The date when the ExistingCustomerFlag was last modified. It is internally populated by the application. The formatted phone number information. 134 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

135 Sales Cloud Household Simplified Web Services Interface Sales Cloud Household SDO HouseholdName Strin g The unique identification number for this party. Data stored in this attribute comes from PARTY_NUMBER in HZ_PARTIES. HouseholdSize Long The size of the household or group. LastAssignmentDat e Dat e Read-only LastUpdateDate Time stam p The date when the Sales Account Territory Assignment was last run by Assignment Manager. Required, Searchable LastUpdatedBy strin g The date and time when the record was last updated. Required, Searchable LastUpdateLogin strin g The user who last updated the record. Searchable The user who last updated the record. MedianAge Long Creatable, Searchable, Updateable The median age of the members of the Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 135

136 Sales Cloud Household Simplified Web Services Interface Sales Cloud Household SDO household. NamedFlag Owner Address Bool ean strin g Indicates whether a sales account is a named sales account. Possible values are True or False. If the value is True, then the sales account is a named sales account. The address of valid employee resource that owns and manages the sales account. To assign an owner to the sales account, you can either provide owner's party ID, PartyNumber, or Address. OwnerPartyId Long OwnerPartyNumber Strin g The unique identifier of a valid employee resource who owns and manages the sales account. To assign an owner to the sales account, you must provide either owner's party identifier, party number, or address. PartyStatus Strin g Party Number of a valid employee resource who owns and manages the sales account. To assign an owner to the sales account, you can either provide owner's party ID, PartyNumber, or Address. The status of the household. This is an internal column and you are not expected to pass in a value. A list of valid statuses are defined in the lookup HZ_STATUS. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. 136 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

137 Sales Cloud Household Simplified Web Services Interface Sales Cloud Household SDO PartyUniqueName PhoneAreaCode strin g strin g The unique household name displayed on household related screens. This is the derived column. For Organization, it is concatenation of unique_name_alias and suffix. For Person, this is concatenation of person_name and suffix. PhoneCountryCod e Strin g The area code within a country code. PhoneExtension Strin g The International country code for a telephone number, such as 33 for France. PhoneNumber strin g The additional number addressed after initial connection to an internal telephone system. PreferredContactM ethod Strin g A telephone number formatted in the local format. The number should not include area code, country code, or extension. Indicates how a household prefers to be contacted. Validated against lookup type PREFERRED_CONTACT_METHOD. A list of valid codes is defined in the lookup HZ_PREFERENCE. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 137

138 Sales Cloud Household Simplified Web Services Interface Sales Cloud Household SDO PreferredFunctional Currency Strin g PrimaryAddress SourceSystem orac le.a pps. crm Co mm on.s ales Parti es.c om mon Servi ce.p rima ryad dres s Strin g The household s default currency code. A list of valid currency codes are defined using the Setup and Maintenance work area, Manage Currency Profile Options task. The primary address of the household. Address attributes of the household are grouped under a PrimaryAddress entity for clarity. Creatable SourceSystemRefer encevalue strin g The name of external source system, which is defined by an admin as part of system setup. It is part of Alternate Key (along with SourceSystemReference), and is mandatory if Primary Key or PartyNumberBusinessKey is not passed in update. Creatable The unique identifier for the household party from the external source system specified in the attribute SourceSystem. It is part of Alternate Key 138 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

139 Sales Cloud Household Simplified Web Services Interface Sales Cloud Household SDO (along with SourceSystemReference), and is mandatory if Primary Key or PartyNumberBusinessKey is not passed in update. Type strin g UniqueNameSuffix Strin g The household party type that defines whether the household is a sales account or a prospect or any other user-defined party type as specified using the lookup type ZCA_ HOUSEHOLD _TYPE. It is defaulted to ZCA_CUSTOMER if no value is provided. Possible values are CUSTOMER or PROSPECT. A list of valid values is defined in the lookup ZCA_HOUSEHOLD_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. WealthAmount {http ://x mlns.ora cle. com /adf /svc /typ e s/}a mou ntty pe The suffix used to generate the attribute PartyUniqueName. The suffix is concatenated to the householdname attribute to generate the PartyUniqueName. The primary address is defaulted as the suffix. The household's wealth amount or net worth. The value is NULL if not given. LastAssignmentDat time The date and time when the Sales Account Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 139

140 Sales Cloud Household Simplified Web Services Interface Sales Cloud Household SDO etime Note stam p Strin g Territory Assignment was last run by Assignment Manager. OwnerName PrimaryContactEm ail PrimaryContactNa me PrimaryContactPart yid Strin g Strin g Strin g Strin g The note about the household. The name of a valid employee resource who owns and manages the sales account. The address of the primary contact. The name of the primary contact. PrimaryContactPart ynumber Strin g The unique identifier of the primary contact. To specify the contact for a household, you can provide Contact s party ID, PartyNumber, or a combination of SourceSystem and SourceSystemReference. The party number of the primary contact. To specify the contact for a household, you can either provide Contact's party ID, PartyNumber, or a combination of SourceSystem and SourceSystemReference. PrimaryContactPho ne PrimaryContactSou rcesystem Strin g Strin g The phone number of the primary contact. 140 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

141 Sales Cloud Household Simplified Web Services Interface Sales Cloud Household SDO The SourceSystem of the primary contact. To specify the contact for a household, you can either provide Contact's party ID, PartyNumber, or a combination of SourceSystem and SourceSystemReference. PrimaryContactSou rcesystemreferenc evalue Strin g RecordSet SalesProfileStatus Strin g Strin g The SourceSystemReference of the primary contact. To specify the contact for a household, you can either provide Contact's party ID, PartyNumber, or a combination of SourceSystem and SourceSystemReference. The selected record set under which the search results are displayed. SalesTeamMember Strin g A valid user-defined status of the sales account that this household belongs to. The sales team member who is associated to a sales account. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 141

142

143 7 Sales Cloud Relationship Simplified Web Services Interface Call the Sales Cloud Relationship service (RelationshipService) to create, update, retrieve, and delete relationships. Accounts, contacts and household could have various types of predefined relationships within Oracle Sales Cloud. A contact can have a contact relationship with an account or household while it could also be a member of a household. Other such relationships could exist between two contacts or between two accounts or households. This service is used to manage all such relationships between two parties. It is often used in conjunction with the Account, Contact or Household service to create the subject and object participating in the relationship before using this service to actually create the relationship. Related Services Trading Community Organization Service and trading Community Person Service are two other services that could be used to manage relationships. Life Cycle Active QName shipservice Relationships Type Handles Relationship To Sales Cloud Relationship SDO Operations Available Operations: createrelationship updaterelationship deleterelationship mergerelationship findrelationship processrelationship processcsrelationship getdfltobjattrhints Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 143

144 Sales Cloud Relationship Simplified Web Services Interface Operations getservicelastupdatetime getentitylist createrelationship Creates a relationship. Life Cycle Active Request Payload Element Name relationship Type Sales Cloud Relationsh ip SDO Description The relationship to be created. Response Payload Name Type Description result Sales Cloud Relationsh ip SDO The relationship which is created. updaterelationship Updates a relationship. Life Cycle Active 144 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

145 Sales Cloud Relationship Simplified Web Services Interface Operations Request Payload Element Name Type Description relationship Sales Cloud Relationsh ip SDO The relationship to be updated. Response Payload Name Type Description Result Sales Cloud Relationsh ip SDO The relationship which is updated. deleterelationship Deletes a relationship. Life Cycle Active Request Payload Element Name relationship Type Sales Cloud Relationsh ip SDO Description The relationship to be deleted. Response Payload Name Type Description Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 145

146 Sales Cloud Relationship Simplified Web Services Interface Operations Result void Not applicable mergerelationship Merges a relationship. It will perform an update if the object exists or an insert if the object doesn't already exist. Life Cycle Active Request Payload Element Name Relationship Type Sales Cloud Relationsh ip SDO Description The relationship to be merged. Response Payload Name Type Description Result Sales Cloud Relationsh ip SDO Merged Relationship findrelationship Finds a relationship. Life Cycle Active Request Payload Element Name Type Description 146 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

147 Sales Cloud Relationship Simplified Web Services Interface Operations findcriteria findcontrol { lns.oracle. com/adf/ svc/type s/}findcrit eria { lns.oracle. com/adf/ svc/type s/}findco ntrol The criteria used to limit your query result, such as the filter (where clause), the fetch size, etc. Find Control. Not currently used. Response Payload Name Type Description result Sales Cloud Relationsh ip SDO Unbounded A list of Relationship that satisfy the inbound criteria. processrelationship Performs a bulk load of relationship. Life Cycle Active Request Payload Element Name changeopera tion Type string Description Indicates what action shall be performed, such as Create, Update, Merge, or Delete. Relationship Sales Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 147

148 Sales Cloud Relationship Simplified Web Services Interface Operations processcontro l Cloud Relationsh ip SDO { lns.oracle. com/adf/ svc/type s/}process Control Unbounded A list of Relationship to be processed. Control your bulk upload behavior, such as whether the valid data will be committed if there are other invalid data in the same batch, and whether the outbound will contain the key attributes only or the full object. Response Payload Name Type Description Result Sales Cloud Relationsh ip SDO Unbounded A list of Relationship that are successfully processed. processcsrelationship Applies the changes back to the data source for a relationship. Life Cycle Active Request Payload Element Name processdata Type { lns.oracle. com/adf/ svc/type s/}process Data Description The object that is used to represent the changes that have been made. 148 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

149 Sales Cloud Relationship Simplified Web Services Interface Sales Cloud Relationship SDO processcontro l { lns.oracle. com/adf/ svc/type s/}process Control Control your bulk upload behavior, such as whether the valid data will be committed if there are other invalid data in the same batch, and whether the outbound will contain the key attributes only or the full object. Response Payload Name Type Description result { lns.oracle. com/adf/ svc/type s/}process Data Result of the operation including a list of related/updated data objects, and all warning and informational messages. Sales Cloud Relationship SDO An object that includes attributes used to store values while creating or updating a relationship. Relationship is an object that stores attributes that define and categorize a relationship between 2 entities such as account, contact and household. QName { ship Relationships Type Handled by Relationship To Sales Cloud Relationship Attributes (Alternate 1 Keys/Label/ sections with description) Name Type Description Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 149

150 Sales Cloud Relationship Simplified Web Services Interface Sales Cloud Relationship SDO ObjectPartyId Long Creatable, Required, Searchable The primary key identifier of the object in this relationship. Either one of ObjectPartyId, ObjectPartyNumber and ObjectSourceSystem along with ObjectSourceSystemReferenceValue combination is used to identify the object party of the relationship. SubjectPartyId Long Creatable, Required, Searchable RelationshipType Strin g The primary key identifier of the subject in this relationship. Either one of SubjectPartyId, SubjectPartyNumber and SubjectSourceSystem along with SubjectSourceSystemReferenceValue combination is used to identify the subject party of the relationship. Creatable, Required, Searchable The relationship type name. For example, CUSTOMER_SUPPLIER. A list of valid relationship types is defined in the lookup HZ_RELATIONSHIP_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups. RelationshipCode StartDate strin g Dat e Creatable, Required, Searchable Indicates if this is a forward or a backward relationship code. A list of valid relationship codes is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups. Creatable, Required, Searchable The date when the relationship was established. 150 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

151 Sales Cloud Relationship Simplified Web Services Interface Sales Cloud Relationship SDO Defaulted to the system date. EndDate CreatedByModule Comments Status CreatedBy CreationDate Dat e strin g strin g strin g Strin g Dat etim e Creatable, Required, Searchable, Updateable The date when the relationship ends. Creatable, Searchable Application module that created this relationship record. It is defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. Creatable, Searchable, Updateable The user comments for this relationship. Read-only Indicates whether this is an active or inactive relationship. A for active, I for inactive. This is an internal column and you are not expected to pass in a value. A list of valid values is defined in the lookup HZ_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. Required, Searchable The user who created the record. Required, Searchable The date and time when the record was created. LastUpdateDate Dat Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 151

152 Sales Cloud Relationship Simplified Web Services Interface Sales Cloud Relationship SDO LastUpdateLogin LastUpdatedBy SubjectPartyNumb er SubjectSourceSyste m SubjectSourceSyste mreferencevalue etim e Strin g Strin g Strin g Strin g strin g Required, Searchable The date and time when the record was last updated. Searchable The date and time when the record was last updated. Required, Searchable The user who last updated the record. Creatable, Required, Searchable, Updateable The alternate key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. Creatable, Searchable, Updateable The name of external source system for the subject party in the relationship, which are defined by an admin as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. Creatable, Searchable, Updateable The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and 152 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

153 Sales Cloud Relationship Simplified Web Services Interface Sales Cloud Relationship SDO SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. ObjectSourceSyste m ObjectSourceSyste mreferencevalue ObjectPartyNumbe r RelationshipSourceS ystem RelationshipSourceS ystemreferenceval Strin g Strin g Strin g Strin g Strin g Creatable, Searchable, Updateable The name of external source system for the object party in the relationship, which are defined by an admin as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. Creatable, Searchable, Updateable The identifier for the object party in the relationship from external source system. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. Creatable, Required, Searchable, Updateable The unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The name of external source system for the relationship, which is defined by an admin as part of the system setup. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 153

154 Sales Cloud Relationship Simplified Web Services Interface Sales Cloud Relationship SDO ue The identifier for the relationship with the external source system. 154 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

155 8 Sales Cloud Address Simplified Web Services Interface Call the Sales Cloud Address service (AddressService) to provide a representation of the Address entity in Oracle Sales Cloud. This service exposes the key attributes of an Address and provides operations to define and manage addresses. This service should be used to mange addresses in relation to a customer or prospect entity of type Account, Contact or Household. It is also used to manage multiple address purposes for a given address. While this service is independent and could be used to create an address for an existing customer or prospect, it is often used in conjunction with the Account, Contact or Household service to create the customer or prospect first before using this service Related Services: Trading Community Location Service is an alternate service used to manage addresses and needs to be used in conjunction with either the Trading Community Organization Service or Trading Community Person Service or Trading Community Group Service depending upon the context used to manage relationships. Life Cycle Active QName { ce Relationships Type Handles Handles Relationship To Sales Cloud Address Purpose SDO Sales Cloud Address SDO Operations Available Operations: getaddress createaddress updateaddress deleteaddress Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 155

156 Sales Cloud Address Simplified Web Services Interface Operations mergeaddress findaddress processaddress processcsaddress getaddress Retrieves the address based on the primary key identifier. Life Cycle Active Request Payload Element Name Type Description addressid Long Party site identifier Response Payload Name Type Description result Sales Cloud Address SDO Address that matches the inbound key attributes. createaddress Creates an Address. Life Cycle Active Request Payload Element Name address Type Sales Cloud Description Address to be created. 156 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

157 Sales Cloud Address Simplified Web Services Interface Operations Address SDO Response Payload Name Type Description result { lns.oracle. com/app s/crmco mmon/sal esparties/ addressse rvice/}ad dressresul t The address which is created. updateaddress Updates an address. The address is identified by either providing the primary or alternate keys of the Address, such AddressId, AddressNumber, SourceSystem or SourceSystemReferenceValue. Life Cycle Active Request Payload Element Name address Type Sales Cloud Address SDO Description Address to be updated. Response Payload Name Type Description Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 157

158 Sales Cloud Address Simplified Web Services Interface Operations result { lns.oracle. com/app s/crmco mmon/sal esparties/ addressse rvice/}ad dressresul t The address which is updated. mergeaddress Merges an address. It will perform an update if the object exists or an insert if the object doesn't already exist. Life Cycle Active Request Payload Element Name address Type Sales Cloud Address SDO Description Address to be merged. Response Payload Name Type Description result { lns.oracle. com/app s/crmco mmon/sal esparties/ addressse rvice/}ad dressresul Merged Address 158 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

159 Sales Cloud Address Simplified Web Services Interface Operations t deleteaddress Deletes an address. Life Cycle Active Request Payload Element Name address Type Sales Cloud Address SDO Description Address to be deleted. Response Payload Name Type Description result { lns.oracle. com/adf/ svc/types /}Method Result findaddress Finds a list of addresses matching the supplied criteria pertaining to the object. Life Cycle Active Request Payload Element Name Type Description Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 159

160 Sales Cloud Address Simplified Web Services Interface Operations findcriteria findcontrol { lns.oracle. com/adf/ svc/types /}FindCrit eria { lns.oracle. com/adf/ svc/types /}FindCon trol The criteria used to limit your query result, such as the filter (where clause), the fetch size, etc. Find Control. Not currently used. Response Payload Name Type Description result Sales Cloud Address SDO A list of Address that satisfy the inbound criteria. processaddress Bulk loads the Address. Performs a Create, Update, or Delete operation on a list of Address rows. Different operations may be applied to different objects, depending on what is specified in the ChangeSummary object. Life Cycle Active Request Payload Element Name Type Description changeoperati on address string Sales Cloud Address Indicates what action shall be performed, such as Create, Update, Merge, or Delete. Unbounded 160 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

161 Sales Cloud Address Simplified Web Services Interface Operations processcontrol SDO { mlns.ora cle.com /adf/sv c/types /}Proces scontrol A list of Address to be processed. Control your bulk upload behavior, such as whether the valid data will be committed if there are other invalid data in the same batch, and whether the outbound will contain the key attributes only or the full object. Response Payload Name Type Description result Sales Cloud Address SDO Unbounded A list of Address that are successfully processed. processcsaddress Applies the changes back to the data source for Address. Life Cycle Active Request Payload Element Name processdata processcontr ol Type { ns.oracle.c om/adf/sv c/types/}pr ocessdata { ns.oracle.c om/adf/sv c/types/}pr Description The object that is used to represent the changes that have been made. Control your bulk upload behavior, such as whether the valid data will be committed if there are other invalid data in the same batch, and whether the Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 161

162 Sales Cloud Address Simplified Web Services Interface Sales Cloud Address SDO ocesscont rol outbound will contain the key attributes only or the full object. Response Payload Name Type Description result { lns.oracle. com/adf/ svc/types /}Process Data Result of the operation including a list of related/updated data objects, and all warning and informational messages. Sales Cloud Address SDO An object that includes attributes used to store values while creating or updating an address. An address represents the location information of an account, contact or household. QName { Relationships Type Contains Handled by Relationship To Sales Cloud Address Purpose SDO Sales Cloud Address Attributes (Alternate 1 Keys/Label/ sections with description) Name Type Description PartyId long Creatable Unique Identifier of the account, contact or 162 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

163 Sales Cloud Address Simplified Web Services Interface Sales Cloud Address SDO PartyNumber string household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account, contact or household record with which the address is associated. Creatable Alternate unique identifier of the account, contact or household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The default value is the value specified in the profile option ZCA_PUID_PREFIX concatenated with a unique generated sequence number. The value is updateable depending on the profile option HZ_GENERATE_PARTY_NUMBER. A list of valid values is defined in the profile option HZ_GENERATE_PARTY_NUMBER. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. PartySourceSyste m string Creatable Name of external source system of the account, contact or household with which the address is associated. Part of Alternate Key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 163

164 Sales Cloud Address Simplified Web Services Interface Sales Cloud Address SDO PartySourceSyste mreferencevalu e string Creatable Identifier from external source system for the account, contact or household with which the address is associated. Part of Alternate Key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. AddressId long Keys Primary Key AddressNumber string The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. Creatable Comments string The alternate unique identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number. The user comments for the address DoNotMailFlag CorpCurrencyCo de boole an string Indicates that this address should not be used for mailing Creatable, Searchable, Updateable The corporate currency code associated with the 164 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

165 Sales Cloud Address Simplified Web Services Interface Sales Cloud Address SDO addresses. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. CreatedBy string The user who created the record. CreationDate CreatedByModul e CurcyConvRateTy pe dateti me string string Date and time when the record was created. Application module that created this organization record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. The currency conversion rate type associated with the address. This attribute is used by CRM Extensibility framework. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. CurrencyCode string The currency code related to the address. This attribute is used by CRM Extensibility framework. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. EndDateActive date Date after which this address is rendered inactive. FormattedAddres s string The formatted address information. FormattedMultilin eaddress string The formatted multiple line address information. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 165

166 Sales Cloud Address Simplified Web Services Interface Sales Cloud Address SDO LastUpdateDate dateti me The date and time when the record was last updated. LastUpdateLogin string The user who last updated the record. LastUpdatedBy string The user who last updated the record. LocationId long Read-only Mailstop string The unique identifier for the location record for this address. A user-defined code to indicate a mail drop point within their organization PrimaryFlag boole an Indicates if this is the primary address of the associated object. Accepts values Y for primary contact, N for all others. StartDateActive date Creatable Date from which this address is active. Defaulted to the current system date if not provided during create. Status string An internal application determined flag indicating status of the address. Status codes are defined by the lookup HZ_STATUS. AddrElementAttri bute1 string The additional address element to support flexible address format. AddrElementAttri string 166 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

167 Sales Cloud Address Simplified Web Services Interface Sales Cloud Address SDO bute2 AddrElementAttri bute3 AddrElementAttri bute4 AddrElementAttri bute5 string string string The additional address element to support flexible address format. The additional address element to support flexible address format. The additional address element to support flexible address format. The additional address element to support flexible address format. Address1 string The first line for address. Address2 string The second line for address. Address3 string The third line for address. Address4 string The fourth line for address. AddressLinesPhon etic string The phonetic or Kana representation of the Kanji address lines (used in Japan). Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 167

168 Sales Cloud Address Simplified Web Services Interface Sales Cloud Address SDO Building string City string ClliCode string Country string County string DateValidated date The specific building name or number at a given address. The city element of Address. The Common Language Location Identifier (CLLI) code. The country code of the address. The county element of the address. Read-only Description string FloorNumber string HouseType string Date on which the address was last validated. An extensive description of the location. The specific floor number at a given address or in a particular building when building number is provided. Indicates the building type. A list of `valid values 168 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

169 Sales Cloud Address Simplified Web Services Interface Sales Cloud Address SDO are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. Latitude LocationDirection s Longitude decim al string decim al Used to store latitude information for the location for spatial proximity and containment purposes. The directions to the location. Used to store longitude information for the location for spatial proximity and containment purposes. PostalCode string PostalPlus4Code string Province string State string The postal code as defined by the formal countrywide postal system. The four digit extension to the United States Postal ZIP code. The province element of Address. The state element of Address. ValidatedFlag boole an Indicates whether the location was validated. Y for validated, N for invalidated. If the value is True, then the location is validated. The value is internally set by system during address cleansing. Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 169

170 Sales Cloud Address Simplified Web Services Interface Sales Cloud Address SDO ValidationStartDa te date Date on which the validation starts. Internally set by system during address cleansing. ValidationStatusC ode string The standardized status code that describes the results of the validation. Internally set by system during address cleansing. SourceSystem string Creatable Composite alternate key: SourceSystem and SourceSystemReference Name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address. SourceSystemRef erencevalue AddressPurpose string Sales Cloud Addre ss Purpos e SDO Creatable Composite alternate key: SourceSystem and SourceSystemReference The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address. Reference to the address purpose child entity of this address 170 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

171 Sales Cloud Address Simplified Web Services Interface Sales Cloud Address Purpose SDO Sales Cloud Address Purpose SDO An object that includes attributes used to store values while creating or updating the address purpose. The address purpose describes the use of an address. For example, shipping address or billing address. QName { ose Relationships Type Contained by Handled by Relationship To Sales Cloud Address SDO Sales Cloud Address Attributes (Alternate 1 Keys/Label/ sections with description) Name Type Description AddressPurposeId long Keys Primary Key Purpose string Address purpose unique internal identifier used for identifying the address purpose record in case of update. The identifier is internally generated during create. Creatable Indicates the use or purpose of the address e.g. billing, shipping etc. A list of valid values is defined in the lookup PARTY_SITE_USE_CODE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. DeleteFlag boole an Indicates if the address purpose is to be deleted. Valid values are Y or N. Mention Y for delete, Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 171

172 Sales Cloud Address Simplified Web Services Interface Sales Cloud Primary Address SDO considered N by default Sales Cloud Primary Address SDO An object that includes attributes used to store values while creating or updating a primary address. A primary address is the default communication address of an entity irrespective of the address purpose QName { ess Relationships Type Contained by Contained by Contained by Handled by Handled by Handled by Relationship To Sales Cloud Account SDO Sales Cloud Contact SDO Sales Cloud Household SDO Sales Cloud Account Sales Cloud Contact Sales Cloud Household Attributes (Alternate 1 Keys/Label/ sections with description) Name Type Description AddressId long Keys Primary Key AddressNumber string Address internal unique identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. 172 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

173 Sales Cloud Address Simplified Web Services Interface Sales Cloud Primary Address SDO Creatable Alternate unique identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number. SourceSystem string Composite alternate key SourceSystem and SourceSystemReference Creatable Name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address. SourceSystemRef erencevalue string Composite alternate key SourceSystem and SourceSystemReference Creatable The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address. LocationId long Read-only PartyId Long Unique identifier for the location record for this address Creatable Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 173

174 Sales Cloud Address Simplified Web Services Interface Sales Cloud Primary Address SDO Unique Identifier of the account, contact or household to which the address is associated. One of PartyI d, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account, contact or household record with which the address is associated. AddrElementAttri bute1 AddrElementAttri bute2 AddrElementAttri bute3 AddrElementAttri bute4 AddrElementAttri bute5 string string string string string Additional address element to support flexible address format Additional address element to support flexible address format Additional address element to support flexible address format Additional address element to support flexible address format Additional address element to support flexible address format Address1 string First line for address Address2 string Second line for address 174 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

175 Sales Cloud Address Simplified Web Services Interface Sales Cloud Primary Address SDO Address3 string Address4 string Building string City string Country string County string FloorNumber string PostalCode string PostalPlus4Code string Third line for address Fourth line for address Specific building name or number at a given address City element of Address. Country code of the address. County element of Address. Specific floor number at a given address or in a particular building when building number is provided Postal code as defined by the formal countrywide postal system Four digit extension to the United States Postal ZIP Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 175

176 Sales Cloud Address Simplified Web Services Interface Sales Cloud Primary Address SDO code. Province string Province element of Address. State string State element of Address. Latitude Longitude decim al Decim al Used to store Latitude Information for the Location for spatial proximity and containment purposes. Used to store Longitude Information for the Location for spatial proximity and containment purposes Mailstop string A user-defined code to indicate a mail drop point within their organization AddressLinesPhon etic string Phonetic or Kana representation of the Kanji address lines (used in Japan) Comments string User comments for the address Description string An extensive description of the location DateValidated date 176 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

177 Sales Cloud Address Simplified Web Services Interface Sales Cloud Primary Address SDO Read-only HouseType string Date the address was last validated. Indicates the building type. A list of valid values is defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. LocationDirection s ValidatedFlag ValidationStartDa te FormattedAddres s FormattedMultilin eaddress string boole an date string string Directions to the location Indicates if the location was validated. Y for validated, N for invalidated. The value is internally set by system during address cleansing. Start date of the validation. Internally set by system during address cleansing. Formatted address information Formatted multiple line address information CreatedBy string Who column that indicates the user who created the record. CreationDate LastUpdateDate dateti me dateti me Who column that indicates the date and time of the creation of the record. Who column that indicates the date and time of the last update of the record. LastUpdateLogin string Who column that indicates the session login associated to the user who last updated the record. LastUpdatedBy string Who column that indicates the user who last updated the record. DeleteFlag boole Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 177

178 Sales Cloud Address Simplified Web Services Interface Sales Cloud Primary Address SDO CorpCurrencyCo de CurcyConvRateTy pe an string string Indicates if the primary address is to be deleted. Valid values are Y or N. Mention Y for delete, considered N by default Corporate currency code associated with the addresses. This attribute is used by CRM Extensibility framework The value of the profile option ZCA_COMMON_CORPORATE_CURRENCY is the default corporate currency value. Review and update the profile option using the Setup and Maintenance work area, Manage Profile Options task. Currency conversion rate type associated with the address. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. CurrencyCode string Currency Code related to the address. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. 178 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

179 9 Appendix A: Downloading and Setting Up the Fusion Service Tester You can use the Fusion Service Tester to easily test Oracle Sales Cloud Web services. It can be invoked by clicking a bat file or by running a jar file. You must download Java on your computer to run Fusion Service Tester: Installing JAVA on Windows machine 1. Get the latest JDK version from the link: html. 2. Install JAVA from the executable. 3. Note down the path of bin directory in the Java installation directory. The default path is: C:\Program Files\Java\jdkx.x.x\bin. 4. Set the System Environment variables. A. Right-click on 'My Computer' and select ''. B. Go to Advanced System Settings. C. Click Environment Variables. D. Set the PATH variable E. If PATH is already present, double click it and append the bin path like ";C:\Program Files\Java\jdkx.x.x\bin;". F. Else create a New Variable by clicking NEW. Provide variable name as "Path" G. and variable value as path of bin directory "C:\Program Files\Java\jdkx.x.x\bin;" H. Click Ok. 5. Type " java -version " in the command prompt to test if installation is successful. A successful installation will return version details. Downloading the Fusion Service Tester 1. Login to OER ( 2. Enter the following path in the browser window and press Enter: Running the Fusion Service Tester Client 1. Navigate to the Client code directory and Use the startfusionservicetester.sh or startfusionservicetester.bat to start the Client. 2. Alternatively you can run the client using the following command:- Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 179

180 Appendix A: Downloading and Setting Up the Fusion Service Tester Importing a New certificate in the keystore (for IE) java -Djavax.net.ssl.trustStore=default-keystore.jks -jar FusionServiceTester.jar Note: If you get a SSL handshake error related to invalid certificate path, then additional setup might be needed to manually add the certificate in the truststore. To do that follow the below instruction Importing a New certificate in the keystore (for IE) 1. Export the certificate from the browser to file using following steps A. Open the SSL URL for any of the web service. B. Click on the lock icon besides the URL. C. Go to the connections tab and certificate information link. D. Go to Details -> Copy to File -> Next E. Change the encoding to the Base-64 and click Next. F. Provide the filename and click finish. 2. Then in the command prompt type the below command: keytool -import -trustcacerts -file <filename> -alias <aliasname> - keystore default-keystore.jks -storepass welcome1 180 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

181 10 Appendix B: Sample Code: Static Web Service Proxy JAX-WS Style Note: The following code was developed using Oracle JDeveloper Studio This client is created as a Servlet to avoid certificate checking. package saaspaas_tester; import accountservice.proxy.accountservice; import accountservice.proxy.accountservice_service; import com.oracle.xmlns.adf.svc.types.dataobjectresult; import com.oracle.xmlns.adf.svc.types.findcriteria; import com.oracle.xmlns.adf.svc.types.processcontrol; import com.oracle.xmlns.adf.svc.types.returnmode; import com.oracle.xmlns.adf.svc.types.viewcriteria; import com.oracle.xmlns.adf.svc.types.viewcriteriaitem; import com.oracle.xmlns.adf.svc.types.viewcriteriarow; import com.oracle.xmlns.apps.crmcommon.salesparties.accountservice.account; import com.oracle.xmlns.apps.crmcommon.salesparties.accountservice.objectfactory; import com.oracle.xmlns.apps.crmcommon.salesparties.accountservice.types.findacco unt; import com.sun.xml.ws.developer.wsbindingprovider; import java.io.printwriter; import java.util.arraylist; import java.util.date; import java.util.list; import javax.xml.ws.webserviceref; import weblogic.wsee.jws.jaxws.owsm.securitypolicyfeature; public class PaaSSaaSCRUDSample private AccountService_Service accountservice_service; private String osc_hostname = "server.domain_name.com:port_number"; private String endpoint = " + this.osc_hostname + "/crmcommonsalesparties/accountservice"; private String osc_username = "User_name"; private String osc_password = "Password"; Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 181

182 Appendix B: Sample Code: Static Web Service Proxy JAX-WS Style Importing a New certificate in the keystore (for IE) public void testcrudoperations(printwriter out) { out.println("testing JCS/OSC CRUD operations with"); out.println("endpoint: : " + endpoint); out.println("username : " + osc_username); out.println("password: " + osc_password); Date time = new Date(); // Global Try Catch try { // Setup SOAP Connection // Workaround bug# , to ensure Java Cloud uses the correct XLS transformer System.setProperty("javax.xml.transform.TransformerFactory", "com.sun.org.apache.xalan.internal.xsltc.trax.transformerfactoryimpl"); // Set SSL SecurityPolicy, this examples assumes Https connection not SAML String SSLSecurityPolicy = "oracle/wss_username_token_over_ssl_client_policy"; SecurityPolicyFeature[] m_securityfeature = new SecurityPolicyFeature[] { new SecurityPolicyFeature(SSLSecurityPolicy) }; // Initiate account Service accountservice_service = new AccountService_Service(); //m_securityfeature = // new SecurityPolicyFeature[] { new SecurityPolicyFeature(SSLSecurityPolicy) }; // Connect to the JAXWS WebServiceEndpoint AccountService accountservice = accountservice_service.getaccountservicesoaphttpport(m_securityfeature); // Get the request context to set the outgoing addressing properties // Set the username,password and endpoint of the SOAP Service. These lines overrite what WSBindingProvider wsbp = (WSBindingProvider)accountService; wsbp.getrequestcontext().put(wsbindingprovider.username_property, osc_username); wsbp.getrequestcontext().put(wsbindingprovider.password_property, osc_password); 182 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

183 Appendix B: Sample Code: Static Web Service Proxy JAX-WS Style Importing a New certificate in the keystore (for IE) wsbp.getrequestcontext().put(wsbindingprovider.endpoint_address_property, endpoint); StringBuffer result = new StringBuffer(); // Always create an objectfactory and instantiate objects from this. // Only exception is when parameters are native java types e.g. String or Long // Make sure you use the right objectfactory for the WebService, in this example the correct objectfactory is // com.oracle.xmlns.apps.crmcommon.salesparties.accountservice.objectfactory ObjectFactory objectfactory = new ObjectFactory(); // // Create ACCOUNT Object // // Other Account payload attributes can be created in a similar manner Account acc = objectfactory.createaccount(); acc.setorganizationname("world Vision Inc - " + time.gettime()); acc.settype(objectfactory.createaccounttype("zca_customer")); acc.setceoname(objectfactory.createaccountceoname("john Smith")); // Call Service to create Object DataObjectResult createresponse = accountservice.createaccount(acc); // Response contains full result of created object // Verify the result from create account service call Long partyid = 0L; if (createresponse!= null && createresponse.getvalue()!= null && createresponse.getvalue().size() > 0) { Account createresult = (Account)createResponse.getValue().get(0); partyid = createresult.getpartyid(); out.println("created a party with PartyId: " + partyid); // we can get other attributes of the account from the createresult object // e.g. createresult.getpartynumber(), etc. } Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 183

184 Appendix B: Sample Code: Static Web Service Proxy JAX-WS Style Importing a New certificate in the keystore (for IE) // // Get Account // // Need the partyid of the account for this operation // partyid is either 0 or the partyid of the newly created party in the previous create method DataObjectResult getresult = accountservice.getaccount(partyid); if (getresult!= null && getresult.getvalue()!= null && getresult.getvalue().size() > 0) { Account getaccresult = (Account)getResult.getValue().get(0); String getorgname = getaccresult.getorganizationname(); String getceoname = getaccresult.getceoname().getvalue(); out.println("org name from get operation is +" + getorgname + " and ceo name is " + getceoname); } // // Update Account // We can update an account by creating an object with the right partyid (ala QueryByExample) and then the added/modified fields // out.println("updating Organization Name"); Account updateacc = objectfactory.createaccount(); updateacc.setpartyid(partyid); updateacc.setorganizationname("updated World Vision Inc " + time.gettime()); accountservice.updateaccount(updateacc); // we can verify the update result by doing a get operation account // // Merge account // merge either creates a new account or updates an exisitng out.println("merge : new Organization "); Account mergeacc = objectfactory.createaccount(); mergeacc.setpartynumber("dhqa_ _a1"); mergeacc.setorganizationname("merge Organization Test 123"); DataObjectResult mergeresult = accountservice.mergeaccount(mergeacc); 184 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

185 Appendix B: Sample Code: Static Web Service Proxy JAX-WS Style Importing a New certificate in the keystore (for IE) if (mergeresult!= null && mergeresult.getvalue()!= null && mergeresult.getvalue().size() > 0) { Account mergeaccresult = (Account)mergeResult.getValue().get(0); out.println(" PartyId is: " + mergeaccresult.getpartyid()); out.println(" PartyNumber is " + mergeaccresult.getpartynumber()); out.println(" Organization Name is " + mergeaccresult.getorganizationname()); } // // DELETE account // // using the partyid to delete the party // does it return anything? out.println("deleting Organization with party id " + partyid); Account account = objectfactory.createaccount(); account.setpartyid(partyid); accountservice.deleteaccount(account); // // PROCESS account // // Used for batch operations. The same operation is perfomed on each object out.println("performing Batch creation of Organizations"); // Create the Account objects Account account1 = objectfactory.createaccount(); account1.setpartynumber("dhqa_ _a1"); account1.setorganizationname("process Merge Account 1"); // Account account2 = objectfactory.createaccount(); account2.setpartynumber("dhqa_ _a1_123"); account2.setorganizationname("process Merge Account 2"); // add them to a list List<Account> accountlist = new ArrayList<Account>(); accountlist.add(account1); accountlist.add(account2); Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 185

186 Appendix B: Sample Code: Static Web Service Proxy JAX-WS Style Importing a New certificate in the keystore (for IE) //set the process control params ProcessControl pc = new ProcessControl(); pc.setpartialfailureallowed(true); pc.setexceptionreturnmode(returnmode.full); pc.setreturnmode(returnmode.full); // invoke the process operation. Here "merge" operation is being invoked DataObjectResult processresults = accountservice.processaccount("merge", accountlist, pc); List accountprocessresults = processresults.getvalue(); for (Object o : accountprocessresults) { Account processresult = (Account)o; out.println(processresult.getpartyid()); out.println(processresult.getpartynumber()); out.println(processresult.getorganizationname()); } // // FIND account // finding accounts whose party numbers are given // // The following code implements this SOAP message // // <typ:findcriteria> // <typ1:fetchstart>0</typ1:fetchstart> // <typ1:fetchsize>10</typ1:fetchsize> // <typ1:filter> // <typ1:group> // <typ1:uppercasecompare>true</typ1:uppercasecompare> // <typ1:item> // <typ1:uppercasecompare/> // <typ1:attribute>partynumber</typ1:attribute> // <typ1:operator>in</typ1:operator> // <typ1:value>dhqa_ _a1</typ1:value> // <typ1:value>dhqa_ _a1_123</typ1:value> // </typ1:item> // </typ1:group> // </typ1:filter> 186 Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact

187 Appendix B: Sample Code: Static Web Service Proxy JAX-WS Style Importing a New certificate in the keystore (for IE) // </typ:findcriteria> FindCriteria fc = new FindCriteria(); fc.setfetchsize(10); // Get max of 10 records fc.setfetchstart(0); // Start at index 0 ViewCriteriaItem vcitem = new ViewCriteriaItem(); vcitem.setattribute("partynumber"); vcitem.setoperator("in"); vcitem.setuppercasecompare(true); vcitem.getvalue().add("dhqa_ _a1"); vcitem.getvalue().add("dhqa_ _a1_123"); ViewCriteriaRow vcr = new ViewCriteriaRow(); vcr.getitem().add(vcitem); ViewCriteria vc = new ViewCriteria(); vc.getgroup().add(vcr); fc.setfilter(vc); // // Now findcriteria is created add it to the calling object and call the service // FindAccount facc = new FindAccount(); facc.setfindcriteria(fc); DataObjectResult findresponse = accountservice.findaccount(fc, null); if (findresponse!= null && findresponse.getvalue()!= null) { List findresults = findresponse.getvalue(); for (Object o : findresults) { Account findresult = (Account)o; out.println(findresult.getpartyid()); out.println(findresult.getpartynumber()); out.println(findresult.getorganizationname()); } } } catch (Exception e) { e.printstacktrace(); out.println(e.getlocalizedmessage()); } return; } } Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 187

188

189 11 Appendix C: Extracting Oracle Public Certificate from Fusion WSDL This is a sample certificate and the sections below illustrate how to extract the certificate from a WSDL and add to a keystore. The actual Oracle public certificate should be extracted from a Fusion WSDL. In the Fusion WSDL, the encrypted certificate is stored in the following format: <dsig:x509certificate>miicczccaxsgawibagietf8zwjanbgkqhkig9w0baqufadbkmrmw EQYKCZImiZPyLGQBGRYDY29tMSEwHwYKCZImiZPyLGQBGRYRb3JhY2xlb3V0c291cmNpbmcxED AOBgNVBAMTB3NlcnZpY2UwHhcNMTEwNjIwMDk1NjQyWhcNMTExMjE3MDk1NjQyWjBKMRMwEQYK CZImiZPyLGQBGRYDY29tMSEwHwYKCZImiZPyLGQBGRYRb3JhY2xlb3V0c291cmNpbmcxEDAOBg NVBAMTB3NlcnZpY2UwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAJJsUQQHiE9qlTlv3n1j P3JhepkAwsxXsy5+DMifv2ZbB2haoCcJ319Nx06tg67QyS5E79iAs3rLE5W/2rEKXmWjJ74whX 0gJho+a+33EMLDuejehtx1d726CoYIvTpGl+6C+QH1R3N1MIEFWk0JuLod5YFgEXgXhNQuEFXz 3UIbAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAGYQX4MKfFlwO1TuKpjtABEwveZKpyIvkfdCcqv ZVpdIb7rNyCeVWOuSlpldgEQ4lUYo29IrFf50z/Rbuz4tu3JT8uB2cpRpX9GDUKq5MTx6efVUV H9EGK0sZZ8NbX2aeAlOq02Wau2T0og5IxID7KPcCU1qiRV0WA3ebd15vODk=</dsig:X509Cer tificate> Copy the encrypted text to a text editor and remove the <dsig:x509certificate> and </dsig:x509certificate> tags. Add the following lines before and after the encrypted text BEGIN CERTIFICATE END CERTIFICATE BEGIN CERTIFICATE----- MIICCzCCAXSgAwIBAgIETf8ZWjANBgkqhkiG9w0BAQUFADBKMRMwEQYKCZImiZPyLGQBGRYDY2 9tMSEwHwYKCZImiZPyLGQBGRYRb3JhY2xlb3V0c291cmNpbmcxEDAOBgNVBAMTB3NlcnZpY2Uw HhcNMTEwNjIwMDk1NjQyWhcNMTExMjE3MDk1NjQyWjBKMRMwEQYKCZImiZPyLGQBGRYDY29tMS EwHwYKCZImiZPyLGQBGRYRb3JhY2xlb3V0c291cmNpbmcxEDAOBgNVBAMTB3NlcnZpY2UwgZ8w DQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAJJsUQQHiE9qlTlv3n1jP3JhepkAwsxXsy5+DMifv2 ZbB2haoCcJ319Nx06tg67QyS5E79iAs3rLE5W/2rEKXmWjJ74whX0gJho+a+33EMLDuejehtx1 d726coyivtpgl+6c+qh1r3n1miefwk0julod5yfgexgxhnquefxz3uibagmbaaewdqyjkozihv cnaqefbqadgyeagyqx4mkfflwo1tukpjtabewvezkpyivkfdccqvzvpdib7rnycevwouslpldg EQ4lUYo29IrFf50z/Rbuz4tu3JT8uB2cpRpX9GDUKq5MTx6efVUVH9EGK0sZZ8NbX2aeAlOq02 Wau2T0og5IxID7KPcCU1qiRV0WA3ebd15vODk= -----END CERTIFICATE---- Save the file as yourcert.crt. The certificate can now be imported to the keystore under the rcpt-key-alias. The Oracle certificate file can be imported to the keystore using the keytool commands listed below. Import Oracle certificate to a keystore file keytool -importcert -alias nameoforaclekey -file oraclecertificatefile.cer -keystore oracle-keystore.jks -storepass keystorepassword Oracle Sales Cloud Using Simplified SOAP Web Services for Account, Household, and Contact 189