You are on page 1of 408

Siebel CRM Web Services Reference

Version 8.1 November 2008

Copyright © 2005, 2008, Oracle. All rights reserved. The Programs (which include both the software and documentation) contain proprietary information; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited. The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. This document is not warranted to be errorfree. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose. PRODUCT MODULES AND OPTIONS. This guide contains descriptions of modules that are optional and for which you may not have purchased a license. Siebel’s Sample Database also includes data related to these optional modules. As a result, your software implementation may differ from descriptions in this guide. To find out more about the modules your organization has purchased, see your corporate purchasing agent or your Oracle sales representative. If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of the United States Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS. Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software--Restricted Rights (June 1987). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065. The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and we disclaim liability for any damages caused by such use of the Programs. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. The Programs may provide links to Web sites and access to content, products, and services from third parties. Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all risks associated with the use of such content. If you choose to purchase any products or services from a third party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warranty obligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third party.

Contents

Siebel CRM Web Services Reference 1

Chapter 1: What’s New in This Release Chapter 2: Siebel CRM Web Services Overview
How Siebel Applications Are Web Service Deployed About Web Services 11 12 14 17 17 21 22 19 13 14 Core Technologies for Web Services Web Services Deployment Cycle Support for Siebel Web Services Siebel Web Services Architecture About Siebel Web Service Modeling Siebel Web Service Documentation 11

Process of Exposing a Siebel Web Service Using the Web Services Deployment Wizard

About Siebel Web Service Authentication and Performance

Chapter 3: Siebel 8.1 Primary Web Services
8.1 Primary Web Services 8.1 ABOWebService 29 37 41 56 8.1 CatalogWebService 8.1 PromotionWebService 8.1 WebMarketing Account 67
69

25

8.1 Product Configurator Web Service 62

Message Schema (WSDL) for Account

AssetManagementComplex CMU Account Query CMU Account Update Contact 77 73 75

69

Siebel CRM Web Services Reference Version 8.1

3

Contents ■

ESB_AccountBalanceSiebelReqABCS_Service ESB_AdjustmentSiebelReqABCS_Service ESB_InvoiceSiebelReqABCS_Service ESB_PaymentSiebelReqABCS_Service FS Asset Warranty Service GetMktgWebSurvey ISS Price List Item WS LeadProcessingService LeadService List 120 123
123

80

83

88 94 98

ESB_UnbilledUsageSiebelReqABCS_Service 103 105 107 110

115

ListMgmtProspect

ListMgmtProspect Operations

LoyaltyAccrualService LoyaltyBatchEnrollment LoyaltyMemberService LoyaltyVoucherService

125 129 134 135 150 166 173 164

LoyaltyImportBusinessService LoyaltyRedemptionService MktgDeduplicationService MktgImportService PDSOrderHeader PriceListsWS Product Import 176 171 175 OrderDetailWebService

ProcessSalesOrderSiebelJMSProducer 180 186 189 191 ProductSearchService QuoteDetailWebService QuotingWebService Response 196 194

178

QuoteCheckOutWebService

4

Siebel CRM Web Services Reference Version 8.1

Contents ■

RetrieveAttachmentService searchSolution 201 204 SelfServiceAccount

199

SelfServiceAccountRootPath SelfServiceAllAccountsList SelfServiceContact 219 SelfServicePaymentHistory SelfServicePostLoginProcess SelfServiceRegistration SelfServiceResponsibility SelfServiceSmtpEmail SelfServiceTimeZone SelfServiceUser ServiceRequest SessionAccessWS 254 258 266 260 SelfServiceWebSite SelfServiceTemplateEmail 252 230

211 214 225 227

244 246 249

SWI Update Order Line Item Ulnbox Contact Item Universal Inbox 273 270

267
268

SWI Update Order Line Item Operations

UpdateCustomerSiebelJMSProducer WC_PickList_Payment_Profile_BS

275 278

Chapter 4: Web Services for Siebel CRM 8.0
Primary Web Services for Siebel CRM 8.0 Support and Testing Web Services 285 283

Chapter 5: Primary Web Services for Siebel CRM 8.0
ABOWebService AssetWebService 294 301 304 Asset Management

Siebel CRM Web Services Reference Version 8.1

5

Contents ■

CalculatePriceWS CatalogWebService CopyActivity EAILOVWS 321 322

304 307 316

ContextServiceWrapperService

EligibilityCompatibility EventManagement Event Registration ExternalAutoPolicy Forecast 332

322

326 332 332 332 332 340

ExternalPropertyPolicy

GetHealthCareProfessionalProfileInformation GetHeathCareProfessionalComplianceDetails GetUnallocatedExpenseItem INSClaims 350 354 356 358 359 359 373 379 376 383 385 387 387 392 392 390 IntegrationObjectInfo NetworkOrderEntry PartnerPrograms PartnerRegistration ProductConfigurator PromotionWebService QuoteAddItemsWS SerializationService ServiceRequest SessionAccessWS SFA_Activity_BS 347

ProductRecommendation

QuoteWebService and OrderWebService

385

SetAllocatedExpenseItem SiebelUserProfileService SiebelWebRegistration

6

Siebel CRM Web Services Reference Version 8.1

Contents ■

TroubleTicket Warranty 396

392 394 396 397 397 397

VerifyEntitlement WC_Account_BS WC_Contacts_BS

WC_Opportunity_BS WebMarketing 397

WC_Service_Request_BS

Index

Siebel CRM Web Services Reference Version 8.1

7

Contents ■

8

Siebel CRM Web Services Reference Version 8.1

1 of the software. Brief overview of Web services deployment wizards. Also. Added more information on business service methods and arguments. Added new Web service topic. Table 1. Added new Web service topic. New topic. Version 8. Topic New Product Features in Siebel CRM Web Services Reference. Added new Web service topic. Enhanced topic. Added new Web service topic. Added more information on business service methods and arguments. Added new Web service topic. Integration Objects on page 15 Determine Which Siebel Objects to Expose on page 17 Process of Exposing a Siebel Web Service on page 17 Assemble the Services on page 18 About Siebel Web Service Modeling on page 19 Using the Web Services Deployment Wizard on page 21 “CMU Account Query” on page 73 “CMU Account Update” on page 75 “ESB_AccountBalanceSiebelReqAB CS_Service” on page 80 “ESB_AdjustmentSiebelReqABCS_ Service” on page 83 “ESB_InvoiceSiebelReqABCS_Serv ice” on page 88 “ESB_PaymentSiebelReqABCS_Se rvice” on page 94 “ESB_UnbilledUsageSiebelReqABC S_Service” on page 98 “FS Asset Warranty Service” on page 103 Siebel CRM Web Services Reference Version 8.1 Description Added additional information on Internal Component field. more information about workflows and the way they are consumed as Web services. and registering public methods in Siebel Tools. Also. Provides new information on exposing Siebel Web services. Added new Web service topic.1 Table 1 lists changes described in this version of the documentation to support release 8. Clarified the task steps. Version 8.1 9 .1 What’s New in This Release What’s New in Siebel CRM Web Services Reference. Added new Web service topic. Reorganized Web service modeling discussion. Enhanced topic. Added a new discussion of classifying state requirements. Added new Web service topic. more information about workflows and the way they are consumed as Web services. New topic. New topic.

Added new Web service topic.What’s New in This Release ■ Table 1. Added new Web service topic. “ISS Price List Item WS” on page 107 “ProcessSalesOrderSiebelJMSProd ucer” on page 178 “Product Import” on page 180 “SWI Update Order Line Item” on page 267 “UpdateCustomerSiebelJMSProduc er” on page 275 This guide has been updated to reflect product name changes. Added new Web service topic. Topic New Product Features in Siebel CRM Web Services Reference.1 Description Added new Web service topic.1 . 10 Siebel CRM Web Services Reference Version 8. Version 8. Added new Web service topic.

Siebel CRM Web Services Reference Version 8. It contains the following topics: How Siebel Applications Are Web Service Deployed About Web Services Core Technologies for Web Services on page 12 Web Services Deployment Cycle on page 13 Siebel Web Service Documentation on page 14 Support for Siebel Web Services on page 14 Siebel Web Services Architecture on page 17 Process of Exposing a Siebel Web Service on page 17 About Siebel Web Service Modeling on page 19 Using the Web Services Deployment Wizard on page 21 About Siebel Web Service Authentication and Performance on page 22 How Siebel Applications Are Web Service Deployed Siebel applications are Web service deployed through the following means: ■ ■ ■ ■ Inbound and Outbound Web Services Integration Objects The Siebel application Business Services and Workflows About Web Services A Web service is a discrete piece of business logic. It contains data represented in XML and defined by XML Schema. which is accessible through Internet protocols.1 11 . It is distinguished by the following: ■ ■ ■ It is specified using Web services Description Language (WSDL). located somewhere on the Internet.2 ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ Siebel CRM Web Services Overview This chapter provides an overview of Web services and guidance for implementing Oracle’s Siebel Web service. It is transported by SOAP (an XML-based transport protocol).

■ ■ ■ Web Services Description Language (WSDL) XML and XML Schema Simple Object Access Protocol (SOAP) About Web Services Description Language (WSDL) WSDL is an XML-based format for describing the interface of a Web service. It may be optionally submitted to a registry or service broker to advertise a service. protocol binding. 12 Siebel CRM Web Services Reference Version 8. parameters. heterogeneous applications. Rooted in: ■ ■ ■ ■ Interoperability Standards XML Coarse-grained exposure of functionality Core Technologies for Web Services Oracle’s Siebel Web services use industry standard core technologies.1 . It is accessible through open standard protocols such as HTTP. WSDL describes the endpoints. WSDL describes the following: ■ The operations provided by a Web service. It exposes coarse-grained. and data types of all aspects of a Web service: ■ The WSDL which describes a Web service has the following characteristics: ■ ■ ■ It is published by the service provider. Its interface is defined by XML (XML Schema & WSDL). It is used by the client to format requests and interpret responses. ■ Additionally. loosely-coupled operations on document-structured data. SMTP.Siebel CRM Web Services Overview ■ Core Technologies for Web Services Web Service as a Server-Side Service A Web service is considered a server-side service if the following are true: ■ ■ ■ ■ ■ It is the basis for interoperable. FTP or JMS. Web services are all of the following: ■ ■ ■ A delivery mechanism for integrating loosely coupled software components. Delivered over standard Internet technologies. location. It is independent of underlying implementation. The bulleted list that follows includes each of the main core technologies utilized. operations. Each core technology is explained in detail in the topics that follow.

where: ■ ■ Document means that the payload for an operation. or response. Document/Literal is required as part of the WS-I interoperability standard that forms the basis of modern Web service usage. Web Services Deployment Cycle A service provider describes its service in the form of a WSDL file. When using Document/Literal formatting. the WDL file will contain an XML Schema definition that defines all messages and data types that will be used for a particular service. About Simple Object Access Protocol (SOAP) SOAP is a lightweight protocol intended for exchanging structured information in a decentralized. About XML and XML Schema A WSDL file is published in the form of an XML document instance. must be defined in a single XML element. At run time the following occurs: ■ ■ The service consumer formats a request in accordance with the WSDL definition. Literal means that the definition of that element must be described by an XML Schema embedded in the WSDL file. the service consumer uses the WSDL to generate a proxy in his own native development environment. Siebel CRM Web Services Reference Version 8. allowing him to program interactions with the service provider. The payload itself will consist entirely of XML data structures.1 13 . The mechanism to contact the Web service. SOAP messages consist of the following: ■ ■ ■ An envelope for wrapping messages. distributed environment. Conventions for a procedure call and. however complex. SOAP uses XML to define an extensible messaging framework. Typically. the WSDL is obtained directly by the developer of the service client consumer. including addressing and security information. At the time the design of a Web service. The service provider provides the expected response to the service consumer. A set of serialized rules for encoding data types in XML.Siebel CRM Web Services Overview ■ Web Services Deployment Cycle ■ ■ The input and output message structures for each Web service operation.

For example. Information is also available there on XML Schema development. which are designed for direct data-level access to the Siebel Object Manager. For example. NOTE: The Siebel Bookshelf is available on Oracle Technology Network (OTN) and Oracle E-Delivery. Figure 1. WSDL generation. Information can be found on Siebel Web service technology and on EAI technologies like the Siebel Adapter (ASI) and the UI Data Service (UDS). authentication and security. Inbound and Outbound Web services 14 Siebel CRM Web Services Reference Version 8. detailed documentation on the use of Siebel objects to create and maintain Web services can be found on the Siebel Bookshelf in Integration Platform Technologies: Siebel Enterprise Application Integration.1 . a custom UI that wants to view and modify Siebel Service Requests. Support for Siebel Web Services The following elements contribute to the deployment of Siebel Web services.Siebel CRM Web Services Overview ■ Siebel Web Service Documentation Siebel Web Service Documentation In addition to the documentation provided here. the Siebel Server would invoke an Outbound Web service operation against a third-party search engine. incorporating the results in its own reply to the client. file attachments. if the Siebel Server wanted to provide its clients the option of either searching internally or searching the Internet. ■ ■ ■ Inbound and Outbound Web Services Integration Objects on page 15 Business Services on page 15 Inbound and Outbound Web Services Siebel applications support both inbound and outbound Web services: ■ ■ Inbound Web services allow external clients to access Siebel functionality. It might also be installed locally on your intranet or on a network location. Figure 1 displays Inbound and Outbound Web services. Outbound Web services allow Siebel applications to make requests of external applications. Outbound Web service configuration.

Integration Component Fields represent Business Component Fields. Integration Objects provide the primary means of structuring messages. Siebel CRM Web Services Reference Version 8. of the type: UDS and ASI. deploying Business Services allows you to model your Web services within Siebel Tools. In the ‘Integration Component Fields’ applet. Typically defines the structure of data being exchanged between a Siebel application and an external application. Update. In Siebel Tools. An Integration Object may be used to support both inbound and outbound Web services. Integration Objects Business Services Business Services allow you to deploy a reusable object that contains a predefined set of methods. Additionally. An Integration Object represents a subset of a Siebel Business Object.Siebel CRM Web Services Overview ■ Support for Siebel Web Services Integration Objects In the area of Web services. the column ‘XML Tag’ governs the way the field name will appear in the WSDL. Siebel Web services employ two types of Business Service: ■ CRUD (Create. The ways in which the elements of the Integration Object correspond to the elements of the Business Component are explained as follows: ■ ■ ■ ■ Integration Components represent Business Components. Delete) data services. Figure 2.1 15 . Figure 2 displays the correspondence between Siebel Objects and Integration objects. their use with Inbound Web services is more tightly bound to the Siebel Object Manager. Read. Internal Component Field names and WSDL element/attribute names can be different.

Business Services 16 Siebel CRM Web Services Reference Version 8. Figure 3 displays Business Services and their corresponding Web service entities.Siebel CRM Web Services Overview ■ Support for Siebel Web Services ■ Functional Services (Custom Business Services and Workflow). Figure 3.1 .

you want to expose. Figure 4. Siebel Web services Architecture Process of Exposing a Siebel Web Service There are two major phases to the development of Siebel Web services. those objects must be assembled into Web services using a Siebel Application. Business Services and Integration Objects) must be configured at design time in Siebel Tools. you must first use Siebel Tools to determine which Siebel objects. Workflows or Integration Objects. such as Business Services. The Siebel Objects involved (Workflows. Then.1 17 . This topic lists the steps you must perform to expose a Siebel Web service.Siebel CRM Web Services Overview ■ Siebel Web Services Architecture Siebel Web Services Architecture Figure 4 displays the basic architecture for Siebel Web services. Determine Which Siebel Objects to Expose When exposing a Siebel Web service. Business Services and Workflows Consider the following when exposing Business Services and Workflows: Siebel CRM Web Services Reference Version 8.

navigate to the Administration–Web Services screen. Compile and deploy the objects (SRF) to be exposed. Act as boundary proxies for Business Objects & Business Components. most Workflows can be designated for participation in a Web service. These elements must also be compiled in the SRF before they can be referenced in the Web service Administration screens and views. Most Business Services with methods registered in Siebel Tools can be designated for participation in a Web service. 18 Siebel CRM Web Services Reference Version 8. Click New to create a new Web service. or select a Web service in the Inbound or Outbound Web Services list.Siebel CRM Web Services Overview ■ Process of Exposing a Siebel Web Service ■ Business Service methods and arguments correspond to Web service operations and messages. Workflows and Integration Objects Consider the following general guidelines when exposing Siebel Objects: ■ ■ In Siebel Tools make changes to Business Services.1 . ■ Integration Objects Consider the following when exposing Integration Objects: ■ ■ Special use of Integration Object allows mapping of complex BusSvc and WorkFlow data structures to XML Schema as required by Web services. and its Process Properties are the arguments to that operation. All Siebel objects must be design-time configured and deployed in the application SRF file before they can be used in Web service Administration screens and views. A Workflow is one-to-one equivalent to a single Web service operation. To assemble a Web service in the Web Service Administration view 1 2 3 In the Siebel Mobile Web client. For a limited subset of Web services. administrators may select the Business Services and associated methods that they wish to expose as Web services. In Web service Administration screens and views. Assemble the Services ■ ■ ■ ■ In the Siebel Application. a Siebel Tools design-time wizard is available to set up most required configuration elements for UDS (UI Data Service) Web service exposure. Workflows and Integration Objects to model desired Web service interface. Select either Inbound Web Services or Outbound Web Services. the Web service Administration screens and views allow the creation and configuration of all Web services at run time. Like most Business Services. General Guidelines for Business Services.

a Business Service cannot be enlisted at run time for participation in a Stateful exchange. Business Service Method Arguments are Web service methods. Stateless means that each Web service operation exists independently of any other. To combine the operations of several Business Services or Workflows into a single service. so far only operations involving the Order Management Configurator have required Stateful context management. model WSDL by configuring methods belonging to the Business Service(s) and/or Workflow(s) listed in the Service Port. (removed invalid clause pointing to Siebel Tools) When a Web Service operation is classified as Server Managed.Siebel CRM Web Services Overview ■ About Siebel Web Service Modeling 4 In the Service Ports list applet. ■ If a Web service operation is classified as Stateful the application data needs to be retained by the Siebel Server between method calls to determine whether the service could be made logically stateless. If a Business Service is either Stateless and/or Server Managed. add them to the Port for the Service. ■ ■ Stateful means that Siebel Object Manager context must be maintained and correlated from one Web service operation invocation to the next. select a Business Service or Workflow to act as Web Service invocation boundary object. You can expose Business Services through the following means: ■ ■ Classify State Requirements on page 19 Register Public Methods in Siebel Tools on page 20 Classify State Requirements ■ Most Siebel Web service operations are classified as Stateless.1 19 . About Siebel Web Service Modeling This section includes the following topics: ■ ■ Exposing a Business Service as a Web Service Exposing a Workflow as a Web Service on page 20 Exposing a Business Service as a Web Service The following statements can be applied to Business Services consumed as Web services: ■ ■ Business Service Methods are Web service Operations. the Business Service can participate in either a Stateless or a Stateful Web Service exchange. Click the Generate WSDL button in the Inbound or Outbound Web Services list applet. When Stateless is chosen. In all of the Siebel Web service implementations. 5 6 In the Operations list applet. then it should be classified as Server-managed. ■ Siebel CRM Web Services Reference Version 8.

or Output to direct the use of the argument in generating the WSDL. and the SRF has been compiled and deployed.’ Exposing a Workflow as a Web Service The following statements can be applied to Workflows consumed as Web services. Operations are mapped in Operations applet.Siebel CRM Web Services Overview ■ About Siebel Web Service Modeling ■ Note that. create service operation or operations in Operations and designate the BusService method as the Siebel method to execute. Create a new Service record or choose and existing Service in the Inbound Web Services applet. ■ In Administration–Web Services. choose the Business Service in the ‘Business Service/ Business Process’ name column. Input/Output. Siebel has resolved this uniqueness requirement by combining the Service Name with the ‘Method Display Name. Create a record in Service Ports. Create a service operation in Operations. see the Siebel Bookshelf document Siebel Web UI Dynamic Developer Kit. ■ If any of the argument is a Property Set hierarchy. the encoding of the SOAP header determines whether an operation is Stateful. set the WSDL operation name in the ‘Operation Name’ column. the description of the SessionType SOAP header element is applicable across the board with Siebel Web Services.1 . Stateless or Server Managed. Workflow Process Properties are Web service messages. configure the Business Service in Service Ports. Specify data type for this argument as Hierarchy and associate with Integration Objects defined in this topic. Register Public Methods in Siebel Tools ■ Specify the complete input and output arguments for each of these methods. ■ ■ A Workflow corresponds to a single Web service Operation. use the Business Service Method Args Type column. at run time. For details. A Workflow PropertySet has no direct external representation but can be mapped to an Integration Object. To specify whether an argument appears in the input operation and/or the output operation. set the Transport and URL. ■ Once the preceding configuration steps in Tools are complete. Choose Input. which is acknowledged to be burdensome. The WSDL XML namespace should be entered here. continue creating a Web service definition for this Business Service in the Siebel Business Application. Although the document is specific to the UI Data Service. do the following: ■ ■ ■ Define the property set structure as an Integration Object in Tools. Generally. 20 Siebel CRM Web Services Reference Version 8. and select SOAP_DOC_LITERAL in the ‘Binding’ column. and designate the Business Service method as the Siebel method to execute in the ‘Method Display Name’ column. ■ ■ ■ NOTE: The Siebel Inbound Web Service Dispatcher is set up with a name resolution mechanism that requires entries in the ‘Operation Name’ to be unique within a Siebel DB instance.

In the Administration–Web Services view. The WSDL XML namespace should be entered here. including arguments. Using the Web Services Deployment Wizard As a convenience. complete the following steps: a b 3 4 5 Define the property set structure as an Integration Object in tools. This is normal and expected. 6 Create a service operation in Operations. NOTE: This is important as you must expose a strongly-typed interface. set the WSDL operation name in the ‘Operation Name’ column. choose the Workflow in the Business Service/Business Process name column. 2 If any Process Property is a Property Set hierarchy. and designate ‘RunProcess’ as the Siebel method to execute in the ‘Method Display Name’ column. set the Transport and URL. Siebel Tools has a few wizard-style tools to assist in the configuration of Business Services.Siebel CRM Web Services Overview ■ Using the Web Services Deployment Wizard You can expose workflows as Web services in the following procedure. NOTE: The observation about operation naming uniqueness noted in this topic applies here as well. In/Out. Siebel has resolved this uniqueness requirement by combining the Service Name with an abbreviation of the Workflow Process Name. If you already have a Business Service configured and ready for use as a Web Service. Specify data type for this Process Property as ‘Hierarchy’ and associate with Integration Object. To expose Workflows as a Web service 1 Identify Process Properties that are to be exposed and correctly mark them as follows: ■ ■ ■ ‘In’ if used as an input argument. and Out arg types are included in the interface definition. ‘Out’ if used as an output argument. Siebel CRM Web Services Reference Version 8. and select SOAP_DOC_LITERAL in the Binding column. NOTE: To model a complete Web Service with more than one operation. ‘In/Out’ if used as both input and output. Workflows and Integration Objects into Web Services.1 21 . NOTE: The In. right-click on the Business Service and select ‘Deploy as Web Service…’ from the pop-up menu. do the following: Create a new Service record or choose and existing Service in the Inbound Web Services applet. several Service Ports might be specified under a single Service. The Generally. Create a record in Service Ports. You can perform this task for Workflows by right-clicking on the desired Workflow Process record. NOTE: Workflows that are either Persistent or Interactive must be re-factored to work as Web services.

the operation proceeds and a special SessionID token are placed in the SOAP header of the Web service reply. while fully supported as part of Siebel’s WSI Basic Profile compliance. thus bypassing the substantially more expensive process of re-executing the authentication. then you can have a wizard build a Business Services based on the underlying UDS class (CSSEAIUIDataService) and publish the resulting Business Service as a Web Service. formal authentication is performed prior to the application execution of the Web service operation. Delete (CRUD) and the use of the UDS (UI Data Service) service meets your needs. If the authentication succeeds. NOTE: This wizard does not create ASI-based Services. when presented with both the SessionID and a valid set of user credentials. the session that is being tracked by the SessionID is subject to expiration and other security checks. About Siebel Web Service Authentication and Performance In implementations where scalability is critical. authentication is managed using a combination of user credentials and a sessionID token: ■ When user credentials are presented in the SOAP header of a Web service request. ■ The facility is a distinct alternative to the basic authentication standard described by WS-Security. Using the UserName token as provided in WS-Security. As expected.Siebel CRM Web Services Overview ■ About Siebel Web Service Authentication and Performance If you have modeled an Integration Object and wish to use it for low-level data operations like Create. From the Siebel Tools File Menu. New Object.1 . EAI. Note that. With this facility. that SessionID will be used to restore cached session information. For detailed information on authentication and security see Integration Platform Technologies: Siebel Enterprise Application Integration. an attempt will be made to use the SessionID before resorting to the user credentials and re-authentication. Read. Update. will not yield the same benefit as using the higher-performance session optimization facility provided by the Siebel implementation. select File. Whenever the SessionID is included by the client in subsequent Web service requests. a lightweight context management facility for authentication is available and its use is recommended. and then Data Access Service. 22 Siebel CRM Web Services Reference Version 8.

1 Primary Web Services on page 25 8.1 PromotionWebService on page 56 8.1 Web services.1 CatalogWebService on page 37 8.1 ABOWebService on page 29 8.1 WebMarketing on page 62 Account on page 67 AssetManagementComplex on page 69 CMU Account Query on page 73 CMU Account Update on page 75 Contact on page 77 ESB_AccountBalanceSiebelReqABCS_Service on page 80 ESB_AdjustmentSiebelReqABCS_Service on page 83 ESB_InvoiceSiebelReqABCS_Service on page 88 ESB_PaymentSiebelReqABCS_Service on page 94 ESB_UnbilledUsageSiebelReqABCS_Service on page 98 FS Asset Warranty Service on page 103 GetMktgWebSurvey on page 105 ISS Price List Item WS on page 107 LeadProcessingService on page 110 LeadService on page 115 List on page 120 ListMgmtProspect on page 123 LoyaltyAccrualService on page 125 LoyaltyBatchEnrollment on page 129 LoyaltyImportBusinessService on page 134 LoyaltyMemberService on page 135 Siebel CRM Web Services Reference Version 8. Web services described include the following: 8.1 Primary Web Services This chapter includes detailed descriptions and information about Siebel 8.1 23 .1 Product Configurator Web Service on page 41 8.3 ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ Siebel 8.

1 Primary Web Services ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ LoyaltyRedemptionService on page 150 LoyaltyVoucherService on page 164 MktgDeduplicationService on page 166 MktgImportService on page 171 OrderDetailWebService on page 173 PDSOrderHeader on page 175 PriceListsWS on page 176 ProcessSalesOrderSiebelJMSProducer on page 178 Product Import on page 180 ProductSearchService on page 186 QuoteCheckOutWebService on page 189 QuoteDetailWebService on page 191 QuotingWebService on page 194 Response on page 196 RetrieveAttachmentService on page 199 searchSolution on page 201 SelfServiceAccount on page 204 SelfServiceAccountRootPath on page 211 SelfServiceAllAccountsList on page 214 SelfServiceContact on page 219 SelfServicePaymentHistory on page 225 SelfServicePostLoginProcess on page 227 SelfServiceRegistration on page 230 SelfServiceResponsibility on page 244 SelfServiceSmtpEmail on page 246 SelfServiceTemplateEmail on page 249 SelfServiceTimeZone on page 252 SelfServiceUser on page 254 SelfServiceWebSite on page 258 ServiceRequest on page 260 SessionAccessWS on page 266 SWI Update Order Line Item on page 267 Ulnbox Contact Item on page 270 24 Siebel CRM Web Services Reference Version 8.Siebel 8.1 .

com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI Type Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Siebel CRM Web Services Reference Version 8.com/CustomUI http://siebel.1 Primary Web Services ■ 8.Siebel 8.com/CustomUI http://siebel.1.1 25 .1 Primary Web Services Table 2 lists the primary Web services available with Siebel 8. The Services are divided by functional area. Table 2.com/CustomUI http://siebel.1 Primary Web Services ■ ■ ■ Universal Inbox on page 273 UpdateCustomerSiebelJMSProducer on page 275 WC_PickList_Payment_Profile_BS on page 278 8.com/CustomUI http://siebel. Area Custom UI Primary Web Services Web Service Name ProductSearchService RetrieveAttachmentService Search Solution MKTGDeduplicationService WC_Picklist_Payment_Profile_BS Universal Inbox SiebelWebPasswdMgmtService SiebelWebRegistrationService SiebelWebRespMgmt PDS Order Header Ulnbox Contact Item Namespace http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.

com/SelfService/ Common/User http://siebel.com/SelfService/ Common/Utility http://siebel.com/SelfService/ Common/Registration http://siebel.com/SelfService/ Common/Account http://siebel.com/SelfService/ Common/Account http://siebel.1 .com/SelfService/ Common/Utility http://siebel.com/SelfService/ eCommerce/Payment http://siebel.1 Primary Web Services ■ 8.1 Primary Web Services Table 2.com/SelfService/ Common/Contact http://siebel.com/SelfService/ Common/Account http://siebel. Area Self Service Primary Web Services Web Service Name SelfServiceAccount SelfServiceAccountRootPath SelfServiceAllAccountsList SelfServiceContact SelfServicePaymentHistory SelfServicePostLogin SelfServiceRegistration SelfServiceSmtpEmail SelfService User SelfServiceTemplateEmail SelfServiceTimeZone SelfServiceWebSite Namespace http://siebel.com/SelfService/ Common/Login http://siebel.Siebel 8.com/SelfService/ Common/Setup Type Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound 26 Siebel CRM Web Services Reference Version 8.com/SelfService/ Common/Utility http://siebel.

com/marketing/ webmarketing http://siebel.com/marketing/ webmarketing http://siebel.com/Loyalty/ LoyaltyRedemptionService http://siebel.com/marketing/list http://siebel.com/marketing/prospect http://siebel.com/marketing/leads http://siebel.com/marketing/contact http://siebel.com/Loyalty/ LoyaltyVoucherService http://siebel.1 27 .com/marketing/leads http://siebel.Siebel 8.com/Service/ServiceReqs Type Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Loyalty LoyaltyAccrual LoyaltyBatchEnrollment LoyaltyImportBusinessService LoyaltyMemberServices LoyaltyRedemptionService LoyaltyVoucherService Service Service Request Siebel CRM Web Services Reference Version 8.com/Loyalty/ LoyaltyEnrolmentServices http://siebel.com/marketing/ webmarketing http://siebel.com/Loyalty/ LoyaltyMemberServices http://siebel.com/marketing/account http://siebel.1 Primary Web Services ■ 8.com/Loyalty/ LoyaltyImportService http://siebel. Area Mktg Primary Web Services Web Service Name Account Contact Lead LeadProcessing List List Mgmt Prospect MKTGImportWebService GetMKTGWebSurvey Response WebMarketing Namespace http://siebel.com/marketing/response http://siebel.com/loy http://siebel.1 Primary Web Services Table 2.

com/OrderManagement/ PriceLists http://siebel.com/OrderManagement/ Order/Details http://siebel.Siebel 8.com/OrderManagement/ ABO http://siebel.com/OrderManagement/ Catalog http://siebel.siebel.1 Promotion Web Service SessionAccessWS Namespace http://siebel.com/OrderManagement/ Configurator http://siebel.com/asi/ Type Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound FS AssetManagementComplex FS Asset Warranty Comm CMU Account Query 28 Siebel CRM Web Services Reference Version 8.com/OrderManagement/ Quote/Quoting http://siebel.com/Service/ AssetWarranty http:siebel.1 .1 Primary Web Services ■ 8.com/OrderManagement/ Quote/Details http://siebel.1 Catalog Web Service CalculatePriceWS QuoteAddItems PriceListsWS QuoteCheckOutWebService QuoteDetailWebService QuotingWebService 8.com/Service/FS/ Assets http://siebel.com/OrderManagement/ Quote http://siebel.com/OrderManagement/ Promotion http://www.1 ABO Web Service ProductConfigurator 8.com/OrderManagement/ Quote/Quoting http://siebel.1 Primary Web Services Table 2.com/OrderManagement/ Quote/PSP http://siebel.siebel. Area OM Primary Web Services Web Service Name OrderDetailWebService 8.com/xml/ SessionAccess http://www.

oracle.com/ABCS/Siebel/ Industry/Telco/ UpdateCustomerSiebelJMSProducer/V1 Type Inbound Inbound Inbound Inbound Outboun d Outboun d Outboun d Outboun d Outboun d Outboun d Outboun d 8. Use this Web service to expose the following Asset-Based Ordering (ABO) functions: convert a quote into an order.com/ABCSImpl/ Siebel/Industry/Telco/ PaymentSiebelReqABCS/V1 http://xmlns. modify an asset.com/ABCS/Siebel/ Industry/Telco/ UnbilledUsageSiebelReqABCS/V1 http://xmlns.oracle. submit an order to the back-end office.oracle.1 29 .com/xml/ ProductImport http:siebel.1 ABOWebService NOTE: This Web service is available only for implementations of version 8.1 Primary Web Services ■ 8. A typical application that uses the Web service is Siebel Communication.oracle. or resume an asset.com/ABCS/Siebel/ Industry/Telco/ InvoiceSiebelReqABCS/V1 http://xmlns. disconnect an asset.com/ABCS/Siebel/ Industry/Telco/ AdjustmentSiebelReqABCS/V1 http://xmlns.siebel. Area Primary Web Services Web Service Name CMU Account Update SWI Update Order Line Item Product Import ISS Price List Item WS ESB_AccountBalanceSiebelReqABC S_Service ESB_UnbilledUsageSiebelReqABCS _Service ESB_InvoiceSiebelReqABCS_Servi ce ESB_PaymentSiebelReqABCS_Serv ice ESB_AdjustmentSiebelReqABCS_S ervice ProcessSalesOrderSiebelJMSProdu cer UpdateCustomerSiebelJMSProduce r Namespace http:siebel.com/asi/ http://www.com/asi/ http://xmlns.com/ABCS/ Industry/Telco/SalesOrder/ ProcessSalesOrderSiebelJMSProducer http://xmlns.oracle.com/ABCS/Siebel/ Industry/Telco/ AccountBalanceSiebelReqABCS/V1 http://xmlns.oracle. convert a completed order line item to an asset.Siebel 8.1 of Siebel Business Applications.1 ABOWebService Table 2. This Web service works only with an Asset-Based Ordering (ABO) enabled environment. Siebel CRM Web Services Reference Version 8. suspend.oracle.com/asi/ http:siebel.

Modifies an asset (Service Item).1 Primary Web Services ■ 8.1 ABOWebService Operations The asset operations Modify. and generates an order item to resume the selected asset. then it operates on the account profile. “ModifyAssetToOrder”. 30 Siebel CRM Web Services Reference Version 8. Disconnects an asset (Service Item) to generate a quote item to deactivate the selected asset. Suspends an active asset (Service Item) to generate a quote item to suspend the selected asset. it will add the quote item to the existing quote. Request Message Description: AutoOrder The following Web services “AutoOrder”. If AccountId is provided. If an active order is not provided. Suspends an asset (Service Item) and generates an order item to suspend the selected asset. If AccountId is not provided it operates on the contact profile. If an active quote is not provided. Table 3. Disconnects an asset (Service Item). Modifies an asset (Service Item).1 ABOWebService operations Description Converts a Quote to a Sales Order. it generates a new order and adds the order item into the new order. Suspend. see Table 3.1 ABOWebService 8. For a list of operations associated with this Web service. and generates an order item to deactivate the selected asset.Siebel 8. Creates assets from the completed order line items or updates a current asset. “SuspendAssetToOrder”. Name AutoOrder SubmitOrder AutoAsset ModifyAssetToQuote ModifyAssetToOrder DisconnectAssetToQuote DisconnectAssetToOrder SuspendAssetToQuote SuspendAssetToOrder ResumeAssetToQuote ResumeAssetToOrder 8. Submits an Order. “SumitOrder”. Resumes an asset (Service Item). and generates an order item to update the selected asset. Affix ToOrder in the Web service name means: if an active order is provided it adds the order item to the existing order. based on the account or contact profile. “ResumeAssetToOrder” and “DisconnectAssetToOrder” have a common output message format. or Resume create a new line item. Affix ToQuote in the Web service name means: if an active quote is provided. Disconnect. “PDS Order”. They have a similar input and output data schema. Resumes a suspended asset (Service Item) to generate a quote item to resume the selected asset. and generates a quote item to update the selected asset.1 . it generates a new quote and adds the quote item to the new quote.

Node OrderId Request Message: SubmitOrder Description Required. ResumeAssetToOrder. and a common response message format. ResumeAssetToQuote and DisconnectAssetToQuote have a common request message format. DisconnectAssetToOrder have a common request message format.1 Primary Web Services ■ 8. Request Message Description: SubmitOrder For a description of this request message. Table 6. Node PDS Order Header Line Item XA Response Message: AutoOrder Description Instance of Integration object PDS Order. RowId of the order to be submitted. which has the same format as the AutoOrder response message. ModifyAssetToQuote. Table 5. For a description of this response message. Node Object Id Request Message: AutoOrder Description Required. Table 4. see Table 4. PDS Quote. Response Message Description: AutoOrder The Integration Object Message Format is PDS Order. Order Line Item attributes. For a description of this request message.1 31 . seeTable 5. Response Message Description: SubmitOrder Integration Object Message Format: PDS Order. Order Header.1 ABOWebService ModifyAssetToOrder. see Table 6. Siebel CRM Web Services Reference Version 8. SuspendAssetToQuote. SuspendAssetToOrder. RowId of the Quote to be converted to the Sale Order.Siebel 8. Order Line Items.

Document in Order Management which refers to either a quote or an order. Provide either AssetIntegrationId or AssetNumber . AccountId ContactId 32 Siebel CRM Web Services Reference Version 8. Contact Id of the contact who owns the selected asset (Service Item) to be modified. Account Id of the account that owns the selected asset (Service Item). Node AssetIntegrationId AssetNumber ActiveDocumentId Request Message: ModifyAssetToQuote Description Asset Integration Id of the selected asset.1 ABOWebService Request Message Description: AutoAsset For a description of this request message. Asset Asset attributes Request Message Description: ModifyAssetToQuote For a description of this request message. This is an optional input. Table 7. For a description of this response message. Node Object Id LineItemId Request Message. it is the Quote Id of the active Quote to which the generated quote item has to be added. Node PDS Asset Header Line Item XA Response Message: AutoAsset Description Required. Asset Integration Id of the selected asset. In this Web service call. ActiveDocumentId refers to the current active Document that the current process is working on. Response Message Description: AutoAsset This Integration Object Message Format is PDS Asset. Each Document can have multiple children (Quote Items or Order Line Items). Provide either AssetIntegrationId or AssetNumber . Asset Header. Table 8.1 . seeTable 8. see Table 9 Table 9.Siebel 8. RowId of the corresponding Order that contains the Order Line Item to be converted or applied to an asset. RowId of an Order Line Item to be converted or applied to an asset. Integration Object.1 Primary Web Services ■ 8. AutoAsset Description Required. Required. see Table 7.

1 ABOWebService Table 9. Integration Object. ModifyAssetToQuote Description Required. Provide either AssetIntegrationId or AssetNumber. Document in Order Management which refers to either a quote or an order. Each Document can have multiple children (Quote Items or Order Line Items). see Table 11 Table 11. In this Web service call. Quote Header. Quote Line Item. AccountId ContactId DueDate Siebel CRM Web Services Reference Version 8. Provide either AssetIntegrationId or AssetNumber. This is an optional input. Request Message Description: ModifyAssetToOrder For a description of this request message. The due date of the generated line item. Specifies a Price List Id that is associated with the quote if a new quote is requested to generate. PriceListId CompoundProductNumber Response Message Description: ModifyAssetToQuote The Integration Object Message Format is PDS Quote. it is the Quote Id of the active Quote to which the generated quote item has to be added. Account Id of the account that owns the selected asset (Service Item). Quote Line Item attributes.Siebel 8. Asset Integration Id of the selected asset. Node PDS Quote Header Line Item XA Response Message. see Table 10.1 Primary Web Services ■ 8. For a description of this response message. It is not required if network ordering is not used.1 33 . Node AssetIntegrationId AssetNumber ActiveDocumentId Request Message: ModifyAssetToOrder Description Asset Integration Id of the selected asset. Compound Product Number for the Asset Based Ordering (ABO) network ordering. Contact Id of the contact who owns the selected asset (Service Item) to be modified. Node DueDate Request Message: ModifyAssetToQuote Description The due date of the generated line item. ActiveDocumentId refers to the current active Document that the current process is working on. Table 10.

It is required only if network ordering is used. Response Message Description: SuspendAssetToQuote Integration Object Message Format: PDS Quote. Node Request Message: ModifyAssetToOrder Description Specifies a Price List Id associated with the quote if a new quote is requested. Compound Product Number for ABO network ordering. Request Message Description: SuspendAssetToOrder This is the same request message as ModifyAssetToOrder.Siebel 8. Response Message Description: ResumeAssetToQuote Integration Object Message Format: PDS Quote.1 . Request Message Description: SuspendAssetToQuote This is the same request message as ModifyAssetToQuote. which has the same format as the AutoOrder response message.1 ABOWebService Table 11. Request Message Description: DisconnectAssetToQuote This is the same request message as ModifyAssetToQuote. 34 Siebel CRM Web Services Reference Version 8. Response Message Description: ResumeAssetToOrder Integration Object Message Format: PDS Order. Response Message Description: SuspendAssetToOrder Integration Object Message Format: PDS Order. PriceListId CompoundProduct Number Response Message Description: ModifyAssetToOrder Integration Object Message Format: PDS Order. Request Message Description: ResumeAssetToOrder This is the same request message as ModifyAssetToOrder.1 Primary Web Services ■ 8. Request Message Description: ResumeAssetToQuote This is the same request message as ModifyAssetToQuote.

Request Message Description: DisconnectAssetToOrder This is the same request message as ModifyAssetToOrder.1 Primary Web Services ■ 8.Siebel 8. Response Message Description: DisconnectAssetToOrder Integration Object Message Format: PDS Order.1 ABOWebService Application Interface This topic describes the application objects called by the this Web service.1 ABOWebService Application Interface Boundary Object Type Workflow Workflow Workflow Workflow Workflow Workflow Workflow Workflow Workflow Workflow Workflow Class (if Business Service) Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Siebel CRM Web Services Reference Version 8. Name SISOMAutoOrderWebService SISOMSubmitWebService SISOMAutoAssetWebService SISOMModifyWebService-Quote SISOMModifyWebService-Order SISOMSuspendWebService-Quote SISOMSuspendWebService-Order SISOMResumeWebService-Quote SISOMResumeWebService-Order SISOMDisconnectWebService-Quote SISOMDisconnectWebService-Order 8.1 ABOWebService Response Message Description: DisconnectAssetToQuote Integration Object Message Format: PDS Quote. refer to your application development documentation on Oracle Technology Network. For more information on application implementation.1 35 . Service Object (Business Service or Workflow) For a description of the service objects for this Web service. 8. see Table 12. Table 12.

.1 Primary Web Services ■ 8.\81_ABOWebService\AutoAsset_request.\81_ABOWebService\ModifyAssetToQuote_response..1 ABOWebService Data Object (Integration Object) For a description of data objects for this Web service.. navigate to the documentation library for Siebel applications on Oracle Technology Network.Siebel 8.\81_ABOWebService\AutoOrder_response..xml 36 Siebel CRM Web Services Reference Version 8..xml Response (ModifyAssetToQuote) See the following file to view the sample code: . see Table 13.1 .. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.. 8.xml Response (AutoAsset) See the following file to view the sample code: . Table 13. Request (AutoOrder) SSee the following file to view the sample code: . Extract the files in the zip file..\81_ABOWebService\AutoAsset_response.xml Request (ModifyAssetToQuote) See the following file to view the sample code: ....xml Request (AutoAsset) See the following file to view the sample code: .\81_ABOWebService\AutoOrder_request.xml Response (AutoOrder) See the following file to view the sample code: .\81_ABOWebService\ModifyAssetToQuote_request..1 ABOWebService Data Objects External Name PDS Quote PDS Order PDS Asset Siebel Repository Name PDS Quote PDS Order PDS Asset Example Package for ABOWebService To view an example of messages for this Web service.

1 CatalogWebService Message Schema (WSDL) for ABOWebservice To view the message schema for this Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Use this Web service to expose promotional offerings related to products.wsdl 8. see Table 15 Table 15. The default value is 1.1 CatalogWebService Operations For a list of operations associated with this Web service.\81_ABOWebService\81_ABOWebService.1 of Siebel Business Applications. 2 run but only return eligible products). as well as related products and categories. navigate to the documentation library for Siebel applications on Oracle Technology Network. 0. Optional. Publish a given catalog with category and products with support of pagination and visibility. Y or N (calculates price or not).1 37 .1 CatalogWebService NOTE: This Web service is available only for implementations of version 8. see Table 14. 1 run. Request Message Description: GetRelatedPromotions For a description of this request message.1 Primary Web Services ■ 8. Name PDS Related Promotions Interface PricingMode EligibilityMode Request Message: GetRelatedPromotions Description An instance of Integration Object PDS Related Promotions Interface. The default value is Y. Optional. 1 . 8. non-hierarchical list of categories. Table 14. Type Integration Object String String Siebel CRM Web Services Reference Version 8.. Retrieve a flat. Extract the files in the zip file.2 (eligibility display mode: 0 do not run. Name GetRelatedPromotions GetRelatedProducts GetCategory UDSPublishCatalog 8.Siebel 8. Retrieve a list of related products. See the following file to view the message schema: .1 CatalogWebService operations Description Retrieve a list of related promotion..

the List Price. It either contains SiebelContext or ExternalContext. Y or N (calculates price or not). provide ContextMode to run pricing and eligibility. However. After running Eligibility and Pricing. An instance of Integration Object PDS Catalog Context. If ContextMode is provided it is required. 0. It either contains SiebelContext or ExternalContext. An instance of Integration Object PDS Catalog Context. you must provide ContextMode to run pricing and eligibility. If ContextMode is provided it is required. Optional. Type Integration Object String String ContextMode String Context Integration Object 38 Siebel CRM Web Services Reference Version 8. Optional only if ContextMode is not provided.2 (eligibility display mode: 0 do not run. Table 17. Net Price. Type Integration Object Request Message Description: GetRelatedProducts For a description of this request message. 2 run but only return eligible products). Optional.1 . seeTable 16.1 Primary Web Services ■ 8. The default value is Y. Eligibility status and Eligibility Reason fields will be updated. Optional. 1 . 1 run. Type String ContextMode Context Integration Object Response Message Description: GetRelatedPromotions For a description of this response message. Name PDS Related Products Interface PricingMode EligibilityMode Request Message: GetRelatedProducts Description An instance of Integration Object PDS Related Products Interface. SiebelContext or ExternalContext. Optional. Optional only if ContextMode is not provided. However.Siebel 8. Name Request Message: GetRelatedPromotions Description SiebelContext or ExternalConext.1 CatalogWebService Table 15. Table 16. see Table 17. Name PDS Related Promotions Interface Response Message: GetRelatedPromotions Description PDS Related Promotions Interface. The default value is 1.

Siebel 8. 0.1 39 . the List Price. Y or N (calculates price or not). Table 18. This is a required input. Optional. Optional. Table 21. Type Integration Object Response Message Description: GetCategory For a description of this response message. After running Eligibility and Pricing. Table 20. 1 . Type Integration Object Request Message Description: GetCategory For a description of this request message. Name PDS Category Interface Integration Object Request Message: GetCategory Description An instance of Integration Object PDS Category Interface. Optional. 2 run but only return eligible products).1 Primary Web Services ■ 8. 1 run. However. Type Integration Object String String ContextMode String Siebel CRM Web Services Reference Version 8. seeTable 20. Name PDS Category Interface Integration Object Response Message: GetCategory Description An instance of Integration Object PDS Category Interface.1 CatalogWebService Response Message Description: GetRelatedProducts For a description of this response message. seeTable 18. see Table 21. Eligibility status and Eligibility Reason fields will be updated. The default value is Y.2 (eligibility display mode: 0 do not run. Name SiebelMessageIn PricingMode EligibilityMode Request Message: UDSPublishCatalog Description An instance of Integration Object PDS UDS Publish Catalog Interface. Name PDS Related Products Interface Response Message: GetRelatedProducts Description An instance of Integration Object PDS Related Products Interface. see Table 19. provide ContextMode to run pricing and eligibility. SiebelContext or ExternalConext. Table 19. The default value is 1. Net Price. Type Integration Object Request Message Description: UDSPublishCatalog For a description of this request message.

Visibility algorithm used in addition to a search specification to determine which records will be retrieved. LIC or LDC. CatalogWebService Data Objects External Name PDS Related Promotions Interface PDS Related Products Interface Siebel Repository Name PDS Related Promotions Interface PDS Related Products Interface 40 Siebel CRM Web Services Reference Version 8. Name SiebelMessageOut Response Message: UDSPublishCatalog Description An instance of Integration Object PDS UDS Publish Catalog Interface. Name of a predefined query. Table 22. Type Integration Object 8. refer to your application development documentation on Oracle Technology Network. Table 24. see Table 24. seeTable 22.1 Primary Web Services ■ 8. Optional only if ContextMode is not provided. Table 23.1 CatalogWebService Application Interface This topic describes the application objects called by the this Web service.1 CatalogWebService Table 21. Type Integration Object LOVLanguageMode ViewMode String String NamedSearchSpec String Response Message Description: UDSPublishCatalog For a description of this response message. It either contains SiebelContext or ExternalContext. For more information on application implementation. Name Context Request Message: UDSPublishCatalog Description An instance of Integration Object PDS Catalog Context. Service Object (Business Service or Workflow) For a description of the service objects for this Web service.Siebel 8. see Table 23. Catalog or Organization. If ContextMode is provided it is required.1 . Name PDS Product Data Service CatalogWebService Application Interface Boundary Object Type BusService Class CSSProdDataSvc Data Object (Integration Object) For a description of data objects for this Web service.

1 Product Configurator Web Service Table 24.\81_CatalogWebService\81_CatalogWebService_request.xml Message Schema (WSDL) for Siebel 8. Request See the following file to view the sample code: .. Extract the files in the zip file. The Web service enables queries on information contained within the product model.. Extract the files in the zip file.. Siebel CRM Web Services Reference Version 8. and perform multiple batch requests.xml Response See the following file to view the sample code: .wsdl 8.. linked items.1 CatalogWebService To view the message schema for this Web service.1 Primary Web Services ■ 8. resources.. CatalogWebService Data Objects External Name PDS Category Interface PDS UDS Publish Catalog Interface Siebel Repository Name PDS Category Interface PDS UDS Publish Catalog Interface Example Package for Siebel 8. navigate to the documentation library for Siebel applications on Oracle Technology Network.1 41 . and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 CatalogWebService To view an example of messages for this Web service.\81_CatalogWebService\81_CatalogWebService_response.1 Product Configurator Web Service NOTE: This Web service is available only for implementations of version 8. UI groups.1 of Siebel Business Applications.. navigate to the documentation library for Siebel applications on Oracle Technology Network. such as relationships. See the following file to view the message schema: . The service also allows you to configure a product. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.Siebel 8.\81_CatalogWebService\81_CatalogWebService. attributes.

Required. attributes. GetCfgObjectDefaultGroupItems request and response message is the same as “GetCfgObjectGroupItems”. Release server resources used during Begin/Update Configuration. Product or Class. Request Message Description: GetCfgObjectStructure GetCfgObjectStructure has the same request and response message.1 Product Configurator Web Service 8. Linked Items and Resources. Class Id of the parent. Display Name. Either Name or Id is required. Description. Required. Name of Object (product or class).1 . GetCfgObjectGroupItems has the same request and response message. For a description of this request message. Node WebChannelObjStructure Object Name Id ObjectType ParentClassId DisplayName Description Request Message: GetCfgObjectStructure Description Required. Required. see Table 25. The Object’s direct child properties are ignored as well those of UIOption. Name GetCfgObjectStructure GetCfgObjectGroupItems GetCfgObjectDefaultGroup Items BeginConfiguration UpdateConfiguration EndConfiguration 8.1 Product Configurator Web service operations Description Get Product Relationships.Siebel 8. see Table 26. linked items and resources). 42 Siebel CRM Web Services Reference Version 8. Responsibilities. Table 25. Id of Object (product or class). GroupItem behavior is similar to that of GetCfgObjectGroupItems. Get Default Product Group Items (group items will be based off all relationships. One or more must be specified. Only the GroupItem child is looked at and returned (others are copied to the Response message). Initializes the configurator session with a Quote Instance and product model. Enables Customization of products stored in Siebel DB. Either Name or Id is required. Executes operations on the Quote instance initialized in BeginConfiguration. Table 26. UI Group and Group Items. Attributes.1 Primary Web Services ■ 8. Get Product UI Definition. and Group. Required. This structure identified the objects that will be queries as well the data that will be returned about the objects.1 Product Configurator Web Service Operations For a list of operations associated with this Web service.

Siebel 8.1 Primary Web Services ■ 8.1 Product Configurator Web Service

Table 26. Node Attribute Name LocalType

Request Message: GetCfgObjectStructure Description Zero or more (only those child objects that are specified will be queried for). Name of Attribute. If empty, all attributes are returned. Local type. Internal type. Internal Id. Display name. Hidden flag. Required flag. Read Only flag. Validation Specification. Unit of Measure. Description. Zero or more. Local value. Internal value. Zero or more. Attribute Domain specific properties name value pairs. Name of Attribute. Value of attribute. Default value of the attribute. Only one of the value types will be populated depending on the type of the value. Display value. String value. Number value. Integer value. Date value. Boolean value. Rejected value of the attribute. Only one of the value types will be populated depending on the type of the value. Display value. String value.

InternalType OrigId DisplayName Hidden Required ReadOnly ValidationSpec UnitOfMeasure Description AttributeDomain LocalValue InternalValue AttributeDomainDecoration Name Value AttributeDefaultValue DisplayValue String Number Integer Date Boolean AttributeRejectedValue DisplayValue String

Siebel CRM Web Services Reference Version 8.1

43

Siebel 8.1 Primary Web Services ■ 8.1 Product Configurator Web Service

Table 26. Node Number Integer Date Boolean

Request Message: GetCfgObjectStructure Description Number value. Integer value. Date value. Boolean value. Zero or more. Attribute properties name. Value pairs. Zero or more (only those child objects that are specified will be queried for). Name of relationship. If Name and, or Id is specified, only that particular relationship will be returned. If both are empty, all relationships will be returned. Id of relationship. If Name and, or Id is specified, only that particular relationship will be returned. If both are empty, all relationships will be returned. Display name. Class name. Class Id. Default product Id. Default Cardinality. Minimum Cardinality. Maximum Cardinality. Zero or more. Name of product. If Name and, or Id is specified, only that particular relationship domain will be returned. If both are empty, all relationship domain products will be returned. Id of product. If Name and, or Id is specified, only that particular relationship domain will be returned. If both are empty, all relationship domain products will be returned. Display Name. Orig Id. Description. Zero or more. Relationship domain specific properties name.

AttributeDecoration Name Value Relationship Name

Id

DisplayName ClassName ClassId DefaultProductId DefaultCardinality MinimumCardinality MaximumCardinality RelationshipDomain Name

Id

DisplayName OrigId Description RelationshipDomainDecoration Name

44

Siebel CRM Web Services Reference Version 8.1

Siebel 8.1 Primary Web Services ■ 8.1 Product Configurator Web Service

Table 26. Node Value

Request Message: GetCfgObjectStructure Description Value pairs. Zero or more. Relationship properties name Value pairs. Zero or more (only those child objects that are specified will be queried for). Name of Linked item. Id of linked item. If Name and/or Id is specified, only that particular linked item will be returned. If both are empty, all linked items will be returned. Display name. Variable Name. Sort specification. Search specification. Needs execution flag for Business Component based query. Expression. Default Value. Business Object for Business Component based query. Business Component for Business Component based query. Field name in BC. Active flag. Linked Item properties. Name value. Pairs. Zero or more (only those child objects that are specified will be queried for). Name of resource. If Name and/or Id is specified, only that particular resource will be returned. If both are empty, all resources will be returned. Id of resource. If Name and/or Id is specified, only that particular resource will be returned. If both are empty, all resources will be returned. Display name.

RelationshipDecoration Name Value LinkedItem Name Id

DisplayName VariableName SortSpec SearchSpec NeedsExecution Expression DefaultValue BusinessObject BusinessComponent FieldName Active LinkedItemDecoration Name Value Resource Name

Id

DisplayName

Siebel CRM Web Services Reference Version 8.1

45

Siebel 8.1 Primary Web Services ■ 8.1 Product Configurator Web Service

Table 26. Node

Request Message: GetCfgObjectStructure Description Resource properties. Name value. Pairs. Object properties. Name value. Pairs.

ResourceDecoration Name Value ObjectDecoration Name Value

Request Message Description: GetCfgObjectGroupItems/ GetCfgObjectDefaultGroupItems For a description of this request message, see Table 27. Table 27. Node WebChannelObjGroupItems Object Name Id ObjectType ParentClassId DisplayName Description UIOption Name Request Message: GetCfgObjectGroupItems/GetCfgObjectDefaultGroupItems Description Required. This structure identified the objects that will be queries as well the data that will be returned about the objects. Required. One or more must be specified. Required. Name of Object (product or class). Either Name or Id is required. Required. Id of Object (product or class). Either Name or Id is required. Required. Product oR Class. Class Id of the parent. Display Name. Description. Zero or more. Name of UI Option. If Name and, or Id is specified, only that particular UI option will be returned. If both are empty, all UI options will be returned. Id of UI Option. If Name and, or Id is specified, only that particular UI option will be returned. If both are empty, all UI options will be returned. Type. Display Name. Sequence. Base Theme.

Id

Type DisplayName Sequence BaseTheme

46

Siebel CRM Web Services Reference Version 8.1

Siebel 8.1 Primary Web Services ■ 8.1 Product Configurator Web Service

Table 27. Node

Request Message: GetCfgObjectGroupItems/GetCfgObjectDefaultGroupItems Description Product theme. Zero or more. Name of responsibility. If Name and, or Id is specified, only that particular responsibility will be returned. If both are empty, all responsibilities will be returned. Id of responsibility. If Name and, or Id is specified, only that particular responsibility will be returned. If both are empty, all responsibilities will be returned. Zero or more. Name of Group. If Name and, or Id is specified, only that particular group will be returned. If both are empty, all groups will be returned. Id of Group. If Name and, or Id is specified, only that particular group will be returned. If both are empty, all groups will be returned. Display Name. Sequence. Group Theme. Description. Zero or more. Id of Group Item. If Id and, or Type is specified, only that particular group item will be returned. If both are empty, all group items will be returned. Type of Group Item (Relationship, Attribute, LinkedItem, or Resource). If Id and, or Type is specified, only that particular group item will be returned. If both are empty, all group items will be returned. Sequence. Group Item Theme. Refer to Attribute child object of GetCfgObjectStructure Request Message. Refer to Relationship child object of GetCfgObjectStructure Request Message. Refer to LinkedItem child object of GetCfgObjectStructure Request Message. Refer to Resource child object of GetCfgObjectStructure Request Message. Group properties.

ProductTheme Responsibility Name

Id

Group Name Id DisplayName Sequence GroupTheme Description GroupItem Id

Type

Sequence GroupItemTheme Attribute Relationship LinkedItem Resource GroupDecoration

Siebel CRM Web Services Reference Version 8.1

47

Siebel 8.1 Primary Web Services ■ 8.1 Product Configurator Web Service

Table 27. Node Name Value

Request Message: GetCfgObjectGroupItems/GetCfgObjectDefaultGroupItems Description Name value. Pairs. Object properties name value pairs.

Object Decoration

Request Message Description: BeginConfiguration For a description of this request message, see Table 28. Table 28. Node BeginConfiguration_Input InitInstanceOperation Request Message: BeginConfiguration Description Required. Required. The operation type for BeginConfiguration session. LOAD. This will load the hierarchy object from the db. HeaderId and RootId are required. IntegrationObjectName is needed to determine which table to query and what the structure of the hierarchy is. DEFAULT. This will load the hierarchy object from the db and create new line item for a product with its default instance. HeaderId and ProductId are required. IntegrationObjectName is needed to determine which table to query and what the structure of the hierarchy is. SET. This will load the hierarchy object from the ListOfQuote parameter (PDS Quote integration object). RootId is required to determine the root line item to use in this session. ADD. This will add a new line item to the hierarchy object from the ListOfQuote parameter (PDS Quote integration object). ProductId is required. HeaderId RootId ProductId ListOfQuote Required for InitInstanceOperation of LOAD / DEFAULT. Row Id of the Header. Required for InitInstanceOperation of LOAD / SET. Row Id for the root line item. Required for InitInstanceOperation of DEFAULT / ADD. Product Id for the root line item. Required for InitInstanceOperation of SET / ADD. Hierarchy object in PDS Quote integration object format. See General C/OM Web services for details on its structure. List of products, attributes, or relationships on which user requires domain information (with exclusions) in CfgInteractData integration object format.

ListOfData

ProductData

48

Siebel CRM Web Services Reference Version 8.1

Siebel 8.1 Primary Web Services ■ 8.1 Product Configurator Web Service

Table 28. Node Item

Request Message: BeginConfiguration Description

IntegrationId

Integration Id of the line item. If IntegrationId specified, only this line item and its sub line items are looked at. ProductId is optional. If ProductId is also specified, it should match IntegrationId. If IntegrationId & ProductId are not specified, the root line item is looked at. Product Id of the line item. If IntegrationId specified, only this line item and its sub line items are looked at. ProductId is optional. If ProductId is also specified, it should match IntegrationId. If IntegrationId & ProductId are not specified, the root line item is looked at. Name of the product. Quantity Relationship Name. For sub line items, RelationshipName can be specified to limit the search to a particular Relationship. Integration Id of the Root line item. Relationship Id Parent Product Id Parent Integration Id Can Drilldown Flag. Used to indicate whether the line item is a Customizable product. List Price Non-recurring Total Price - only set on the root line item Recurring Total Price - only set on the root line item Current Price of the Item after all the discounts have been factored in Exchange Date of the pricing field values Currency Code of the pricing field values Has Generics Flag. Used to indicate whether the line item is incomplete Eligibility Status Eligibility Reason Explanation, if required. Text of explanation. Zero or more. List of Relationships on which information is required.

ProductId

Name Quantity RelationshipName RootIntegrationId PortId ParentProductId ParentIntegrationId CanDrilldown ListPrice NRCCxTotal MRCCxTotal CurrentPrice ExchangeDate CurrencyCode HasGenericsFlag EligibilityStatus EligibilityReason Explanation ExplanationText Relationship

Siebel CRM Web Services Reference Version 8.1

49

Siebel 8.1 Primary Web Services ■ 8.1 Product Configurator Web Service

Table 28. Node Name Id

Request Message: BeginConfiguration Description Name of relationship to query for. If empty, all relationships are returned. Id. Always returned whether specified in Request or not. Has Generics Flag. Used to indicate whether the relationship is incomplete. Indicates the type of the Info that will be calculated for this relationship. Possible values include: ■ ■ ■ SelectionInfo - Only current line items for this relationship will be outputted. DomainInfo - Only the possible domain items for this relationship will be outputted. Any other values results in both of the above information being calculated and outputted.

HasGenericsFlag Request Type

DomainItem Name Id ListPrice ExchangeDate CurrencyCode PriceType CanDrilldown Excluded Attribute Name ValueType AttributeValue DisplayValue StringValue IntegerValue

Zero or more. Domain items of the relationship. Always returned whether specified in Request or not. Name of domain item Id of domain item List Price Exchange Date of the pricing field values Currency Code of the pricing field values Indicated the type of List Price: One-time or Recurring Can Drilldown flag. Used to indicate whether the line item is a customizable product. Excluded flag indicates the whether this domain item is excluded by a Constraint, Eligibility & Compatibility rule, or Promotion. Zero or more. List of attributes on which information is required. Name of attribute to query for. If empty, all attributes are returned. Type of attribute. Always returned whether specified in Request or not. Zero or more. List of Attribute values. Always returned whether specified in Request or not. Display value. Value displayed in a string. Value displayed as integer.

50

Siebel CRM Web Services Reference Version 8.1

see Table 28. Zero or one. Zero or more. Table 29. Date and time value. Promotion.Siebel 8.1 Product Configurator Web Service Table 28. Same recursive structure as that defined above. Node Request Message: BeginConfiguration Description Value displayed as number. One or more. Excluded flag indicates whether this value is excluded by a Constraint. See the response message description for Begin Configuration for details. Siebel CRM Web Services Reference Version 8. For more information. Linked Items.1 51 . Eligibility & Compatibility rule or Promotion. Node BeginConfiguration_Output Error_spcCode Error_spcMessage Response Message Description: Begin Configuration Description Required. Name of linked item. see Table 29. Linked Items. Zero or more. List of messages. Error Code if error occurred. Type of value. Error Message if error occurred. Value displayed in Boolean format. Proceed Actions and so on). Details on the error if any Proceed / Undo. Cardinality. GetCfgObjectGroupItems and GetCfgObjectDefaultGroupItems have the same request and response messages. This indicates whether a Procced or Undo was done on the conflicts and also whether there were any other violations that resulted in an Undo (like Promotion or Cardinality). For a description of this response message.1 Primary Web Services ■ 8. Source of the messages (Eligibility. Selected flag indicates whether this value is selected. NumberValue BooleanValue DateTimeValue Selected Excluded Item ListOfLinkedItems LinkedItems LinkedItemValue Name ValueType StatusText ConflictResolution Messages MessageType MessageSource Message Response Message Description: Begin Configuration GetCfgObjectStructure has the same request and response message. Message text.

Same as ListOfData in BeginConfiguration Request Message. If set Y. verify instance is called. If set Y. New item root Integration Id. See BeginConfiguration Request Message for details. all conflicts are auto resolved. Type of request (AddItem. see Table 30. This indicates whether the request was successful or not and contains messages to be displayed. then there were some conflicts (messages are present in ListOfMessage) that were automically resolved. then everything was ok. Node UpdateConfiguration_Input ConflictAutoResolve FinishInstanceInFlag SaveInstanceInFlag RepriceInstanceInFlag VerifyInstanceInFlag ListOfData ListOfRequest Requests Request Type Zero or more. Proceed or Undo.1 Product Configurator Web Service Table 29. If set to Undo. Request Message Description: UpdateConfiguration Description Required. RemoveItem. Instance is saved to db. Required Success / Warning / Error. If set to Proceed. If it is 'Error'. Node RootId Response Message Description: Begin Configuration Description New item root Id. SetItemQuantitty. SetAttribute. RootIntegrationId ListOfQuote ListOfData ListOfStatus Status StatusCode Request Message Description: UpdateConfiguration For a description of this request message. 52 Siebel CRM Web Services Reference Version 8. If StatusCode is 'Success'.Siebel 8. If it is 'Warning'. Quote instance if ReturnFullInstance input parameter was set to Y.1 Primary Web Services ■ 8. any conflict will result in an Undo of the entire batch. If set Y. If set Y. reprice is called.1 . The domain information about products / attributes / relationships as well current selections for the attributes / relationships that was requested in the Request Message. Table 30. ReplaceItem). then there were conflicts (messages are present in ListOfMessage) that could not be resolved and further requests to this session will not be honored. FinishIt is called. See the Request Message for more details. List of Requests that will be executed on the product instance.

Y or N. Relationship Id which contains the new product for AddItem. Node Item Request Message Description: UpdateConfiguration Description Zero or more requests. Error Code if error occurred. Y or N. New display value of attribute Value displayed in a string. AddProductId Quantity RelationshipId IntegrationId Attribute Name ValueType AttributeValue DisplayValue String Number Integer Date Boolean Zero or more. It might not be performed if there were some errors. see Table 31. Name or attribute. Siebel CRM Web Services Reference Version 8.1 53 . Node UpdateConfiguration_Output Error_spcCode Error_spcMessage FinishConfigurationOutFlag RepriceOutFlag SaveInstanceOutFlag VerifyOutFlag Response Message Description: UpdateConfiguration Description Required. ReplaceItem. Zero or more SetAttribute request details. Indicates whether Reprice was done. Table 31. Indicates whether Verify was done.1 Product Configurator Web Service Table 30.1 Primary Web Services ■ 8. Value displayed in Boolean format. Integration Id on which the operation will be performed. Y or N. Date. ReplaceItem. Value displayed as number. It might not be performed if there were some conflicts. Quantity. It might not be performed if there were some errors. Y or N. Add product Id for AddItem. Indicates whether Save Instance was done. Error Message if error occurred. Indicates whether Finish Configuration was performed. Response Message Description: UpdateConfiguration For a description of this response message. It might not be performed if there were some errors.Siebel 8. Value displayed as integer.

This indicates whether the request was successful or not and contains messages to be displayed. see Table 30 on page 52. refer to your application development documentation on Oracle Technology Network. Table 33. For more information.1 Product Configurator Web Service Table 31. see Table 28 on page 48. Error Code if error occurred. 8.1 Primary Web Services ■ 8. 54 Siebel CRM Web Services Reference Version 8. Node EndConfiguration_Input SaveInstanceFlag Request Message Description: EndConfiguration Description Required Save instance flag Response Message Description: EndConfiguration For a description of this response message. see Table 32 Table 32.1 . ListOfData ListOfStatus Request Message Description: EndConfiguration For a description of this request message. For more information. Quote instance.1 Product Configurator Web Service Application Interface This topic describes the application objects called by the this Web service. see Table 33.Siebel 8. For more details. Node EndConfiguration_Output Error_spcCode Error_spcMessage ListOfQuote Response Message Description: EndConfiguration Description Required. Node Response Message Description: UpdateConfiguration Description The domain information about products / attributes / relationships as well current selections for the attributes / relationships that was requested in the Request Message. Error Message if error occurred. see Table 29 on page 51. For more information on application implementation.

Extract the files in the zip file. 8.1 Primary Web Services ■ 8. Table 34.1 Product Configurator Service Objects Boundary Object Type Business Service Workflow Workflow Workflow Class (if BusService) CSSCfgObjBrokerService Not applicable Not applicable Not applicable Data Object (Integration Object) For a description of data objects for this Web service. Request (GetObjDefaultGroupItems) See the following file to view the sample code: Siebel CRM Web Services Reference Version 8. see Table 35.1 Product Configurator Web Service Service Object (Business Service or Workflow) For a description of the service objects for this Web service.1 Product Configurator Methods Method GetObjStructure GetObjGroupItems GetObjDefaultGroupItems Operation GetCfgObjectStructure GetCfgObjectGroupItems GetCfgObjectDefaultGroupItems Example Package for ProductConfigurator To view an example of messages for this Web service. 8. see Table 34. navigate to the documentation library for Siebel applications on Oracle Technology Network. Name Cfg Object Broker ConfiguratorWebChannelBeginConfig ConfiguratorWebChannelUpdateConfig ConfiguratorWebChannelEndConfig 8. Table 35. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 Product Configurator Data Objects External Name ListOfData ListOfRequest ListOfStatus ListOfLinkedItems ListOfQuote Siebel Repository Name CfgInteractData CfgInteractRequest CfgInteractStatus CfgLinkedItems PDS Quote Methods For a description of the methods for this Web service. Table 36. see Table 36.Siebel 8.1 55 .

Siebel 8.1 of Siebel Business Applications..\81_ProductConfigurator\GetObjGroupItems_response. navigate to the documentation library for Siebel applications on Oracle Technology Network.wsdl 8.1 Primary Web Services ■ 8. 56 Siebel CRM Web Services Reference Version 8.1 PromotionWebService NOTE: This Web service is available only for implementations of version 8.\81_ProductConfigurator\81_ProductConfigurator..xml Request (GetObjGroupItems) See the following file to view the sample code: .\81_ProductConfigurator\GetObjDefaultGroupItems_response. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.. get promotion commitment information and to upgrade a promotion.. Extract the files in the zip file...xml Response (GetObjStructure) See the following file to view the sample code: ... apply product promotion.1 PromotionWebService ....\81_ProductConfigurator\GetObjStructure_request..xml Message Schema (WSDL) for ProductConfigurator To view the message schema for this Web service.\81_ProductConfigurator\GetObjGroupItems_request.xml Request (GetObjStructure) See the following file to view the sample code: .xml Response (GetObjDefaultGroupItems) See the following file to view the sample code: .xml Response (GetObjGroupItems) See the following file to view the sample code: . See the following file to view the message schema: ..\81_ProductConfigurator\GetObjDefaultGroupItems_request..\81_ProductConfigurator\GetObjStructure_response. Use this Web service to get product promotion information.1 .

1 Primary Web Services ■ 8. Required value of Y or N. Optional. Siebel Context or External Context. Upgrade or migrate a promotion instance to another promotion and generate an order with the updated assets information. Name EligibilityMode PricingMode LoadAllDomainFlag LoadDefaultDomainFlag LoadPromDefFlag ContextMode Context ProdPromRuleType Request Message Description: GetProductPromotionDefinition Description Optional. 1. Table 38. default value as Y. Type Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Siebel CRM Web Services Reference Version 8. Get promotion commitment information for a given promotion asset.1 57 . Required.1 PromotionWebService 8. Upgrade or migrate a promotion instance to another promotion and generate a quote with the updated assets information.Siebel 8. Add a promotion and all default components to a quote or order. Required value of Y or N. Product or Pricing. Y or N. Required. Name getProductPromotionDefinition ApplyProductPromotion getPromotionCommitments UpgradePromotionToQuote UpgradePromotionToOrder 8. see Table 38.1 PromotionWebService Operations Description Returns promotion detail information. Table 37. Optional.1 PromotionWebService Operations For a list of operations associated with this Web service. Could be 0. 2. Required value of Y or N. Request Message Description: GetProductPromotionDefinition For a description of this request message. see Table 37. default value as 2. in SiebelMessage format of IO 'PDS Catalog Context.

see Table 39. Error Code if error occurred. Could be 0. Table 41. see Table 40. Optional. Table 39. 1. Table 40. depending on usage scenarios. Error Code if error occurred. Type Not applicable Not applicable Err_spcCode Err_spcMessage Not applicable Not applicable Request Message Description: ApplyProductPromotion For a description of this request message. see Table 41. Could be either default domain product details or all domain product details depending on input arguments. 2. Name EligibilityMode PricingMode ProdPromId ProdPromInstanceId LineItemId Quantity SiebelMessage Request Message Description: ApplyProductPromotion Description Optional. Name ProdPromDefinition PromDomainProduct Response Message Description: GetProductPromotionDefinition Description In SiebelMessage format of Integration Object ISS Promotion Definition for WS.1 PromotionWebService Response Message Description: GetProductPromotionDefinition For a description of this response message.Siebel 8. in SiebelMessage format of Integration Object PDS Quote. In SiebelMessage format of Integration Object PDS Product Interface'.1 . Name SiebelMessage Err_spcCode Err_spcMessage Response Message Description: ApplyProductPromotion Description Required. Error Message if error occurred. Y or N. Default value is 1.1 Primary Web Services ■ 8. default value as Y. Type Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Response Message Description: ApplyProductPromotion For a description of this response message. Optional. Required. depending on usage scenarios. Error Message if error occurred. Optional. In SiebelMessage format of the Integration Object PDS Quote. Type Not applicable Not applicable Not applicable 58 Siebel CRM Web Services Reference Version 8. Optional. default value as '2'. Required.

Type Integration Object Request Message Description: UpgradePromotionToQuote For a description of this request message. if any. Each Document can have multiple children (Quote Items or Order Line Items). Table 42. see Table 44. If there is a penalty for upgrading the promotion. Provide either AssetNumber or AssetIntegrationId. Table 44. it is the Quote Id of the active Quote to which the generated quote item has to be added. This is an optional input. Name PromotionCommitments Response Message Description: getPromotionCommitments Description An instance of the Integration Object ISS Promotion Commitments. also pass in the prorate plan used to prorate this penalty. see Table 43.1 59 . Name NewPromotionId AssetNumber AssetIntegrationId ActiveDocumentId Request Message Description: UpgradePromotionToQuote Description Required. Document in Order Management means a Quote or an Order. In this Web service call. Name Asset Integration Id Request Message Description: getPromotionCommitments Description Required.1 Primary Web Services ■ 8. if any. Asset Integration Id of the selected promotion asset. ActiveDocumentId means the current active Document that the current process is working on. Table 43. see Table 42. Account Id of the account that owns the selected promotion asset being upgraded. Type String String String String AccountId OverridePenaltyAmount OverrideProratePlanId String String String Siebel CRM Web Services Reference Version 8. Asset Number of the selected promotion asset. RowId of new promotion. Type String Response Message Description: getPromotionCommitments For a description of this response message.1 PromotionWebService Request Message Description: getPromotionCommitments For a description of this request message. Asset Integration Id of the Promotion Instance Asset. Penalty Amount for upgrading the promotion. Provide either AssetNumber or AssetIntegrationId.Siebel 8.

In this Web service call. Provide either AssetNumber or AssetIntegrationId. see Table 47. Asset Number of the selected promotion asset. Each Document can have multiple children (Quote Items or Order Line Items). Name QuoteIO Response Message Description: UpgradePromotionToQuote Description An instance of the integration object PDS Quote. Provide either AssetNumber or AssetIntegrationId.Siebel 8. RowId of new promotion. Account Id of the account that owns the selected promotion asset being upgraded. Name NewPromotionId AssetNumber AssetIntegrationId ActiveDocumentId Request Message Description: UpgradePromotionToOrder Description Required.1 PromotionWebService Response Message Description: UpgradePromotionToQuote For a description of this response message. also pass in the prorate plan used to prorate this penalty. it is the Order Id of the active Order to which the generated order item has to be added. If there is a penalty for upgrading the promotion. Table 47. Penalty amount for upgrading the promotion. Document in Order Management means a Quote or an Order.1 . Type String String String String AccountId OverridePenaltyAmount OverrideProratePlanId String String String Response Message Description: UpgradePromotionToOrder For a description of this response message. see Table 46.1 Primary Web Services ■ 8. Type Integration Object 60 Siebel CRM Web Services Reference Version 8. Asset Integration Id of the selected promotion asset. see Table 45. ActiveDocumentId means the current active Document that the current process is working on. Table 45. if any. Name OrderIO Response Message Description: UpgradePromotionToOrder Description An instance of the integration object PDS Order. Type Integration Object Request Message Description: UpgradePromotionToOrder For a description of this request message. This is an optional input. if any. Table 46.

For more information on application implementation.1 Primary Web Services ■ 8. refer to your application development documentation on Oracle Technology Network. Table 49. Service Object (Business Service or Workflow) For a description of the service objects for this Web service.. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.xml Response See the following file to view the sample code: . Name ISS Promotion WS .\81PromotionWebService\81PromotionWebService_request. 8.GetPromotionCommitments ISS Promotion WS-Upgrade Promotion-Quote ISS Promotion WS-Upgrade Promotion-Order 8. navigate to the documentation library for Siebel applications on Oracle Technology Network. see Table 49.1 PromotionWebService Data Objects External Name ISS Promotion Commitments PDS Quote PDS Order Siebel Repository Name ISS Promotion Commitments PDS Quote PDS Order Example Package for 8.1 PromotionWebService To view an example of messages for this Web service.\81PromotionWebService\81PromotionWebService_response.1 PromotionWebService Application Interface This topic describes the application objects called by the this Web service..1 61 .xml Siebel CRM Web Services Reference Version 8. Table 48..Siebel 8.1 PromotionWebService 8. see Table 48. Request See the following file to view the sample code: . Extract the files in the zip file.1 PromotionWebService Service Objects Boundary Object Type Workflow Workflow Workflow Data Object (Integration Object) For a description of data objects for this Web service..

Extract the files in the zip file.1 WebMarketing Operations For a list of operations associated with this Web service. See the following file to view the message schema: . List of forwardees.Forward to Friend to forward the emails.\81_PromotionWebService\81_PromotionWebService.1 WebMarketing NOTE: This Web service is available only for implementations of version 8. Campaign contact Id of the forwarder.. For a description of this request message.1 WebMarketing Operations Description To forward campaign details to a list of forwardees.1 PromotionWebService To view the message schema for this Web service. Type String String Integration Object String String 62 Siebel CRM Web Services Reference Version 8. Contact Id of the forwarder.wsdl 8. Request Message Description: EmailMarketingForwardToFriend Calls Email Marketing .1 Primary Web Services ■ 8. Following four new operations have been added to this Web service in Siebel Marketing 8. Table 50. see Table 51. The campaign Id of the campaign for which the info is being forwarded.Siebel 8. Name EmailMarketingForwardToFriend EmailMarketingUpdateJobStatus UpdateCampaignRecipient CheckModuleLicense 8.1 . and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. For more information on previous operations. Table 51..1 WebMarketing Message Schema (WSDL) for 8. Updates the info of a campaign recipient. see Table 50. navigate to the documentation library for Siebel applications on Oracle Technology Network. see “WebMarketing” on page 397. Use to update the job status of the task submitted for sending email. To check if a particular module is licensed. 8.1 of Siebel Business Applications.1. Node Account Id Campaign Id Forwardee Collection Forwarder Camp Con Id Forwarder Contact Id Request Message Description: EmailMarketingForwardToFriend Description Account Id of the forwarder of the email.

Node Dummy Response Message Description: EmailMarketingUpdateJobStatus Description Error code for the process (OK or NOTOK). The current offer.1 Primary Web Services ■ 8. Type String Siebel CRM Web Services Reference Version 8.Siebel 8. Node Dummy Response Message Description: EmailMarketingForwardToFriend Description Error code for the process (OK or NOTOK). The campaign wave Id. For a description of this request message. Table 54. Type String Request Message Description: EmailMarketingUpdateJobStatus This operation is called by Boldfish when a createMailing job is done. see Table 52. Node Request Message Description: EmailMarketingForwardToFriend Description Message that the forwarder sends across along with the mails. Type String String String String Forwarder Message Forwarder Prospect Id Offer Id Response Type Response Message Description: EmailMarketingForwardToFriend For a description of this response message. see Table 53.1 63 . Id of the offer for which the email is being sent. The prospect Id of the forwarder. Node BatchNumber ErrorCode OfferId OfferName TaskId WaveId Request Message Description: EmailMarketingUpdateJobStatus Description Batch number of the job. Task Id. It updates the status in the marketing system task table. Error code (if any) that needs to be passed for the job. The type of response.1 WebMarketing Table 51. The name of the offer. Table 52. Table 53. see Table 54. Type String String String String String String Response Message Description: EmailMarketingUpdateJobStatus For a description of this response message.

Table 56. The language mode.Siebel 8. Type Integration Object Request Message Description: CheckModuleLicense Calls Mktg List Export Service service to check module license and returns Y or N according as the output is ok or notok respectively. Node CampaignRecipientMsgOut Response Message Description: UpdateCampaignRecipient Description The updated campaign recipient info. Node IsModuleLicensed Response Message Description: CheckModuleLicense Description Y or N according as the module is licensed or not respectively.1 . Node CampaignRecipientMsgIn LOVLanguageMode Request Message Description: UpdateCampaignRecipient Description The campaign recipient info that needs to be updated. Table 58. Type String 8.1 WebMarketing Request Message Description: UpdateCampaignRecipient Calls EAI Siebel Adapter service to update campaign recipients. Type String Response Message Description: CheckModuleLicense For a description of this response message. Type Integration Object String Response Message Description: UpdateCampaignRecipient For a description of this response message. Node ModuleName Request Message Description: CheckModuleLicense Description The module name which needs to be checked. 64 Siebel CRM Web Services Reference Version 8.1 Primary Web Services ■ 8. For more information on application implementation. see Table 56. Table 57. For a description of this request message. see Table 57. see Table 55.1 WebMarketing Application Interface This topic describes the application objects called by the this Web service. see Table 58. refer to your application development documentation on Oracle Technology Network. For a description of this request message. Table 55.

see the following files in the WebServices ZIP download in the Siebel Bookshelf documentation library on Oracle Technology Network: .1 Primary Web Services ■ 8..1 WebMarketing To view an example of messages for this Web service.. Not applicable. see Table 59. see the following files in the WebServices ZIP download in the Siebel Bookshelf documentation library on Oracle Technology Network: .1 WebMarketing Service Object (Business Service or Workflow) For a description of the service objects for this Web service.Forward to Friend Email Marketing . Name Email Marketing . and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.. Table 59.xml Response (EmailMarketingForwardToFriend) To view the sample code. navigate to the documentation library for Siebel applications on Oracle Technology Network.Siebel 8.Update Status Mktg System Task Service Server Requests EAI Siebel Adapter Mktg List Export Service 8.\81_WebMarketing\EmailMktgFwdToFriend_response. Request (EmailMarketingForwardToFriend) To view the sample code. see Table 60.xml Siebel CRM Web Services Reference Version 8.1 65 ..1 WebMarketing Data Objects External Name Forwardee Collection CampaignRecipientMsgIn CampaignRecipientMsgOut Siebel Repository Name Marketing Email Forwardee Marketing Campaign Recipient Marketing Campaign Recipient Example Package for 8. 8. Table 60.1 WebMarketing Service Objects Boundary Object Type Workflow Workflow Business Service Business Service Business Service Business Service Class Not applicable. CSSSystemTaskService CSSSrmService CSSEAISiebelAdapterService CSSListExportService Data Object (Integration Object) For a description of data objects for this Web service.\81_WebMarketing\EmailMktgFwdToFriend_request.

and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.xml Request (UpdateCampaignRecipient) To view the sample code.wsdl 66 Siebel CRM Web Services Reference Version 8. navigate to the documentation library for Siebel applications on Oracle Technology Network. see the following files in the WebServices ZIP download in the Siebel Bookshelf documentation library on Oracle Technology Network: ...\81_WebMarketing\EmailMarketingUpdateJobStatus_request..xml Response (EmailMarketingUpdateJobStatus) To view the sample code. see the following files in the WebServices ZIP download in the Siebel Bookshelf documentation library on Oracle Technology Network: . Extract the files in the zip file... see the following files in the WebServices ZIP download in the Siebel Bookshelf documentation library on Oracle Technology Network: …\81_WebMarketing\CheckModuleLicense_response. see the following files in the WebServices ZIP download in the Siebel Bookshelf documentation library on Oracle Technology Network: .1 WebMarketing To view the message schema for this Web service.. See the following file to view the message schema: …\81_WebMarketing\81_WebMarketing. see the following files in the WebServices ZIP download in the Siebel Bookshelf documentation library on Oracle Technology Network: . see the following files in the WebServices ZIP download in the Siebel Bookshelf documentation library on Oracle Technology Network: …\81_WebMarketing\CheckModuleLicense_request.xml Request (CheckModuleLicense) To view the sample code..xml Response (CheckModuleLicense) To view the sample code.xml Message Schema (WSDL) for 8.\81_WebMarketing\UpdateCampaignRecipient_request.xml Response (UpdateCampaignRecipient) To view the sample code..Siebel 8.\81_WebMarketing\EmailMarketingUpdateJobStatus_request.1 Primary Web Services ■ 8.1 .1 WebMarketing Request (EmailMarketingUpdateJobStatus) To view the sample code.\81_WebMarketing\UpdateCampaignRecipient_response.

see Table 61 Table 61. Type String String String Siebel CRM Web Services Reference Version 8. Node Account Id Error Message Success Flag Response Message Description: AccountCreateAccount Description The new Account Id generated as a result of the new account creation.1 Primary Web Services ■ Account Account Use this Web service for the basic Siebel Marketing operations such as creating and updating accounts. An instance of the integration object Account Integration Object. Node Account IO Request Message Description: AccountCreateAccount Description Required. Type Integration Object Response Message Description: AccountCreateAccount For a description of this response message. Table 63. Account Operations There are two operations associated with this Web service which allow you to create and update accounts in Marketing. For a list of operations associated with this Web service. Request Message Description: AccountCreateAccount For a description of this request message. Flag to indicate success or failure of the operation. Error message if any. Table 62.Siebel 8. see Table 62. Updates an existing account.1 67 . see Table 63. Account is the Parent header and Account_BusinessAddress is the child. Name AccountCreateAccount AccountUpdateAccount Account Operations Description Creates an account.

Flag to indicate success or failure of the operation. refer to your application development documentation on Oracle Technology Network. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Node Error Message Success Flag Response Message Description: AccountUpdateAccount Description Error message if any. Extract the files in the zip file. Table 64. Request (AccountCreate) See the following file to view the sample code: …\Account\AccountCreate_request.Siebel 8. An instance of the integration object Account Integration Object. Account Data Object External Name Account IO Siebel Repository Name Account IO Example Package for Account To view an example of messages for this Web service. see Table 65. Node Account IO Request Message Description: AccountUpdateAccount Description Required. For more information on application implementation.xml 68 Siebel CRM Web Services Reference Version 8. navigate to the documentation library for Siebel applications on Oracle Technology Network.1 Primary Web Services ■ Account Request Message Description: AccountUpdateAccount For a description of this request message. see Table 64. Type String String Account Application Interface This topic describes the application objects called by the this Web service. Table 65.1 . Data Object (Integration Object) For a description of data objects for this Web service. see Table 66 Table 66. Type Integration Object Response Message Description: AccountUpdateAccount For a description of this response message. Account is the Parent header and Account_BusinessAddress is the child.

AssetManagementComplex Operations The following operations are used for the AssetManagementComplex Web service.xml Message Schema (WSDL) for Account To view the message schema for this Web service. the child items for a CP or bundle asset. Table 67. CP.wsdl AssetManagementComplex To display the detail of a promotion.1 69 . Request Message Description: AssetManagementComplexQueryPage Asset ManagementComplex web service is called to query for the details of a promotion. or bundle asset. child items for a CP or bundle asset. display the related products for a promotion. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. or bundle asset.xml Response (AccountUpdate) See the following file to view the sample code: …\Account\AccountUpdate_response. navigate to the documentation library for Siebel applications on Oracle Technology Network. For a list of operations associated with this Web service. See the following file to view the message schema: …\Account\Account. Name AssetManagementComplexQueryPageQuoteAddItems AssetManagementComplex Operations Description It fetches the details of promotion. see Table 67. CP. Siebel CRM Web Services Reference Version 8.Siebel 8. i. Displays the related products for promotion. Extract the files in the zip file.e. CP or bundle asset.1 Primary Web Services ■ AssetManagementComplex Response (AccountCreate) See the following file to view the sample code: …\Account\AccountCreate_response..xml Request (AccountUpdate) See the following file to view the sample code: …\Account\AccountUpdate_request.

1 . Node AssetManagementComplex IO AssetDescription AssetNumber BillingAccount BillingAccountId InstallDate IntegrationId OwnerContactId ProductDescription ProductId ProductName ProductPartNumber SerialNumber ServiceAccount ServiceAccountId Status NRCCxTotal MRCCxTotal Id AdjustedListPrice AssetCurrencyCode AssetDescription AssetId AssetNumber Comments InstallDate IntegrationId Name ParentAssetId PriceType ID Adjusted List Price Asset Currency Code Asset Description Asset ID Asset Number Comments Install Date Integration ID Asset Name Parent Asset ID Price Type Request Message Description: AssetManagementComplexQueryPage Description Required List Price Adjusted Value Billing Account Billing Account ID Install Date Integration ID Owner Contact ID Product Description Product ID Product Name Product Number Serial Number Service Account Service Account ID Status Type Integration Object String String String String String String String String String String String String String String String String String String String String String String String String String String String String String 70 Siebel CRM Web Services Reference Version 8.1 Primary Web Services ■ AssetManagementComplex For a description of this request message.Siebel 8. see Table 68. Table 68.

1 71 . Node AssetDescription AssetNumber BillingAccount BillingAccountId InstallDate IntegrationId OwnerContactId ProductDescription ProdPromId ProductDefTypeCode ProductId ProductName ProductPartNumber Response Message Description: AssetManagementComplexQueryPage Description Asset Description Asset Number Billing Account Billing Account ID Install Date Integration ID Owner contact ID Product Description Product Prom ID Product Code Product ID Product Name Product Part Number Type String String String String String String String String String String String String String Siebel CRM Web Services Reference Version 8. Table 69. see Table 69.Siebel 8. Node Request Message Description: AssetManagementComplexQueryPage Description Product Prom ID Product Def Type Code Product ID Product Name Product Part Number Product Type Quantity Root Asset ID Unit of Measure Asset Data Type Asset Description Asset Display Name Asset Value Type String String String String String String String String String String String String String ProdPromId ProductDefTypeCode ProductId ProductName ProductPartNumber ProductType Quantity2 RootAssetId UnitofMeasure DataType Description DisplayName Value Response Message Description: AssetManagementComplexQueryPage For a description of this response message.1 Primary Web Services ■ AssetManagementComplex Table 68.

see Table 70. Table 70. For more information on application implementation. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Name Asset Management Complex AssetManagementComplext Service Object Boundary Object Type Business Service Class CSSEAIUIDataService 72 Siebel CRM Web Services Reference Version 8.1 . refer to your application development documentation on Oracle Technology Network.1 Primary Web Services ■ AssetManagementComplex Table 69.Siebel 8. Node Response Message Description: AssetManagementComplexQueryPage Description Product Number Price Type Service Number Service Account Service Account ID Status ID Asjusted List Price Asset Currency Code Comments Asset Name Parent Asset ID Quantity Root Asset ID Unit of Measure Asset Data Type Asset Description Asset Display Name Asset Value Type String String String String String String String String String String String String String String String String String String String ProductType PriceType SerialNumber ServiceAccount ServiceAccountId Status Id AdjustedListPrice AssetCurrencyCode Comments Name ParentAssetId Quantity2 RootAssetId UnitofMeasure DataType Description DisplayName Value AssetManagementComplex Application Interface This topic describes the application objects called by the this Web service.

The account detail that this Web service finds includes details about the contacts. Request See the following file to view the sample code: …\AssetManagementComplex\AssetManagementComplex_request. addresses. A business service is exposed in the Siebel CRM application so that the middle layer can query for the account detail in the CRM application and synchronize this detail with the billing application. Table 71. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network. This detail includes only those fields that the billing application needs to synchronize data.xml Message Schema (WSDL) for AssetManagementComplex To view the message schema for this Web service. Siebel CRM Web Services Reference Version 8.wsdl CMU Account Query Use this Web service to find an account detail in the Siebel CRM application.1 Primary Web Services ■ CMU Account Query Data Object (Integration Object) For a description of data objects for this Web service. AssetManagementComplext Data Objects External Name SiebelMessage SiebelMessage SiebelMessageOut Siebel Repository Name SiebelMessage SiebelMessageIn SiebelMessageOut Example Package for AssetManagementComplex To view an example of messages for this Web service.1 73 .xml Response See the following file to view the sample code: …\AssetManagementComplex\AssetManagementComplex_response. See the following file to view the message schema: …\AssetManagementComplex\AssetManagementComplex. see Table 71.Siebel 8. and billing profiles that are associated with the account. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file. Extract the files in the zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network.

1 Primary Web Services ■ CMU Account Query The response message returns only an acknowledgement message and not data. see Table 72. Table 74.Account Siebel Repository Name CMU Query Account Io 74 Siebel CRM Web Services Reference Version 8. refer to your application development documentation on Oracle Technology Network. For more information on application implementation. Request Message Description: CMU Account Query Page For a description of this request message.1 . see Table 74. Node AccountId BillingProfileId Request Message Description: CMU Account Query Page Description The ID of the account for the billing profile. CMU Account Query Operations For a list of operations associated with this Web service. Name CMU Account Query Page CMU Account Query Operations Description Finds the account detail based on the account ID and the billing profile ID.Siebel 8. Table 72. see Table 75. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Name CMU Account Query Service CMU Account Query Service Object Boundary Object Type Business Service Class (If Business Service) CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service. see Table 73. The ID of the billing profile for the account. CMU Account Query Application Interface This topic describes the application objects called by the this Web service. Table 75. Table 73. CMU Account Query Data Object External Name CMU .

. Extract the files in the zip file. see Table 76. See the following file to view the message schema: . Request See the following file to view the sample code: . Table 76.\CMUAccountQuery\CMUAccountQuery.. navigate to the documentation library for Siebel applications on Oracle Technology Network.. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network.\CMUAccountQuery\CMUAccountQuery.. CMU Account Query Methods Method [BS: CMU Account Query Service].1 Primary Web Services ■ CMU Account Update Methods For a description of methods for this Web service. A business service is exposed in the Siebel CRM application to update the status field. The response message returns only an acknowledgement message and not data.\CMUAccountQuery\CMUAccountQuery.. Extract the files in the zip file. The billing application makes this inbound Web service call to the Siebel CRM application to update the status of the account.xml Message Schema (WSDL) for CMU Account Query To view the message schema for this Web service..xml Response See the following file to view the sample code: . Siebel CRM Web Services Reference Version 8.wsdl CMU Account Update Use this Web service to update the status of an account in the Siebel CRM application when the status of the account changes in the billing application.QueryPage Operation CMU Account QueryPage Example Package for CMU Account Query To view an example of messages for this Web service.Siebel 8.1 75 . and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.

Name CMU Account Update CMU Account Update Operations Description Updates the status of an account in the Siebel CRM application when the status of the account changes in the billing application. Table 78. CMU Account Update Application Interface This topic describes the application objects called by the this Web service. For more information on application implementation.1 . Name CMU Account Update CMU Account Update Service Object Boundary Object Type Business Service Class (If Business Service) CSSEAIDataSyncService Data Object (Integration Object) For a description of data objects for this Web service. Table 79.Siebel 8. Table 80. Request Message Description: CMU Account Update For a description of this request message. see Table 80. see Table 77. refer to your application development documentation on Oracle Technology Network. see Table 79. Table 77. Node AccountId AccountStatus Request Message Description: CMU Account Update Description The ID of the account for the billing profile.1 Primary Web Services ■ CMU Account Update CMU Account Update Operations For a list of operations associated with this Web service. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. CMU Account Update Data Object External Name Account Siebel Repository Name CMU Update Account Io 76 Siebel CRM Web Services Reference Version 8. The status of the account that was updated in the billing application. see Table 78.

. See the following file to view the message schema: .. navigate to the documentation library for Siebel applications on Oracle Technology Network. Siebel CRM Web Services Reference Version 8. Extract the files in the zip file.1 77 .xml Message Schema for Account Update To view the message schema for this Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file..Siebel 8. Table 81.Update Operation CMU Account Update Example Package for CMU Account Update To view an example of messages for this Web service.\CMUAccountUpdate\CMUAccountUpdate.\CMUAccountUpdate\CMUAccountUpdate. Extract the files in the zip file. Request See the following file to view the sample code: .. see Table 81.. navigate to the documentation library for Siebel applications on Oracle Technology Network..\CMUAccountUpdate\CMUAccountUpdate. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 Primary Web Services ■ Contact Methods For a description of methods for this Web service.wsdl Contact Use this Web service for the basic operations of Siebel Marketing such as to create and update contacts.xml Response See the following file to view the sample code: . CMU Account Update Methods Method [BS: CMU Account Update].

Node Contact IO Request Message Description: ContactCreateContact Description Required. Contact is the Parent header and Contact_BusinessAddress is the child. Type Integration Object 78 Siebel CRM Web Services Reference Version 8. Contact is the Parent header and Contact_BusinessAddress is the child. Flag to indicate success or failure of the operation. Table 83. Error Message if any. Table 82. An instance of the integration object Contact IO. Updates an existing contact. see Table 83. Type Integration Object Response Message Description: ContactCreateContact For a description of this response message. Name ContactCreateContact ContactUpdateContact contact Operations Description Creates a contact.1 . see Table 84.1 Primary Web Services ■ Contact Contact Operations For a list of operations associated with this Web service.Siebel 8. Type String String String Request Message Description: ContactUpdateContact For a description of this request message. see Table 82. Table 84. Table 85. see Table 85. Request Message Description: ContactCreateContact For a description of this request message. Node Contact IO Request Message Description: ContactUpdateContact Description Required. An instance of the integration object Contact IO. Node Contact Id Error Message Success Flag Response Message Description: ContactCreateContact Description The new Contact Id generated as a result of the new contact creation.

1 Primary Web Services ■ Contact Response Message Description: ContactUpdateContact For a description of this response message. Table 87. see Table 86. Type String String Contact Application Interface This topic describes the application objects called by the this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network. Extract the files in the zip file. Node Error Message Success Flag Response Message Description: ContactUpdateContact Description Error message if any. Flag to indicate success or failure of the operation. Data Object (Integration Object) For a description of data objects for this Web service. refer to your application development documentation on Oracle Technology Network.1 79 .xml Siebel CRM Web Services Reference Version 8. Table 86. Contact Data Object External Name Contact IO Siebel Repository Name Contact IO Example Package for Contact To view an example of messages for this Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. see Table 87. Request (ContactCreate) See the following file to view the sample code: …\Contact\ContactCreate_request.xml Request (ContactUpdate) See the following file to view the sample code: …\Contact\ContactUpdate_request.Siebel 8.xml Response (ContactCreate) See the following file to view the sample code: …\Contact\ContactCreate_response. For more information on application implementation.

Node AccountId AccountName MaximumNumberOfRecords CurrencyCode Request Message Description: QueryBalanceSummary Description The ID of the account for the billing profile.Siebel 8.1 Primary Web Services ■ ESB_AccountBalanceSiebelReqABCS_Service Response (ContactUpdate) See the following file to view the sample code: …\Contact\ContactUpdate_response. Table 88.xml Message Schema (WSDL) for Contact To view the message schema for this Web service. see Table 88. Extract the files in the zip file. The maximum number of records to retrieve from the external system.wsdl ESB_AccountBalanceSiebelReqABCS_Se rvice Use this Web service to retrieve information about the balance summary. and balance details for a billing profile. see Table 89. balance groups.1 . Request Message Description: QueryBalanceSummary For a description of this request message. ESB_AccountBalanceSiebelReqABCS_Service Operations For a list of operations associated with this Web service. The currency code of the account for the billing profile. Table 89. Retrieves the balance group and balance detail information for a billing profile. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. This Web service retrieves the information from the billing application. navigate to the documentation library for Siebel applications on Oracle Technology Network. 80 Siebel CRM Web Services Reference Version 8. See the following file to view the message schema: …\Contact\Contact. The name of the account for the billing profile. Name QueryBalanceSummary QueryBalanceDetails ESB_AccountBalanceSiebelReqABCS_Service Operations Description Retrieves the balance summary information for a billing profile.

see Table 91. Table 92. The name of the account for the billing profile. see Table 92. The attributes of the service charges for the balance group. The maximum number of records to retrieve from the external system. The attributes of the balances for the balance group. see Table 90. Table 90. Response Message Description: QueryBalanceDetails For a description of this response message.1 Primary Web Services ■ ESB_AccountBalanceSiebelReqABCS_Service Table 89. The attributes of the balance details for the balance. The ID of the billing profile for the account. Node CmuBalanceSummaryVbc Response Message Description: QueryBalanceSummary Description The attributes of the balance summary. Siebel CRM Web Services Reference Version 8. The currency code of the account for the billing profile. Node CmuBalanceGroupVbc CmuBalanceVbc CmuBalanceDetailsVbc CmuBalanceGroupServicesVbc Response Message Description: QueryBalanceDetails Description The attributes of the balance group. Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId Request Message Description: QueryBalanceDetails Description The ID of the account for the billing profile. BillingProfileName BillingProfileId Response Message Description: QueryBalanceSummary For a description of this response message. Table 91.Siebel 8. The ID of the billing profile for the account. Request Message Description: QueryBalanceDetails For a description of this request message.1 81 . Node Request Message Description: QueryBalanceSummary Description The name of the billing profile for the account. The name of the billing profile for the account.

see Table 93..1 .QueryBalanceDetails Operation QueryBalanceSummary QueryBalanceDetails Example Package for ESB_AccountBalanceSiebelReqABCS_Service To view an example of messages for this Web service. ESB_AccountBalanceSiebelReqABCS_Service Data Objects External Name Account Account Siebel Repository Name CMU Request Billing Profile IO CMU Response Balance Group IO Methods For a description of methods for this Web service. Extract the files in the zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. see Table 94. Name AccountBalanceSiebelReqABCS ESB_AccountBalanceSiebelReqABCS_Service Service Object Boundary Object Type Business Service Class (If Business Service) CSSWSOutboundDispatcher Data Object (Integration Object) For a description of data objects for this Web service.QueryBalanceSummary [BS:AccountBalanceSiebelReqABCS].Siebel 8. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file..1 Primary Web Services ■ ESB_AccountBalanceSiebelReqABCS_Service ESB_AccountBalanceSiebelReqABCS_Service Application Interface This topic describes the application objects called by the this Web service. Table 93.\AccountBalanceSiebelReqABCS\QueryBalanceDetailsReqMsg.xml 82 Siebel CRM Web Services Reference Version 8. refer to your application development documentation on Oracle Technology Network. Request See the following file to view the sample code: . see Table 95. Table 94. ESB_AccountBalanceSiebelReqABCS_Service Methods Method [BS:AccountBalanceSiebelReqABCS]. For more information on application implementation. Table 95.

item charge. and resource balance in a billing profile. and resource balances in a billing profile. ESB_AdjustmentSiebelReqABCS_Service Operations For a list of operations associated with this Web service. events.1 Primary Web Services ■ ESB_AdjustmentSiebelReqABCS_Service Response See the following file to view the sample code: .. use this Web service to retrieve adjustment information for a billing profile. Extract the files in the zip file. Table 96.Siebel 8.. See the following file to view the message schema: . Retrieves the adjustments for a bill in a billing profile. see Table 96..\AccountBalanceSiebelReqABCS\AccountBalanceSiebelReqABCSService. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 83 .xml Message Schema (WSDL) for ESB_AccountBalanceSiebelReqABCS_Service To view the message schema for this Web service. Siebel CRM Web Services Reference Version 8. event. navigate to the documentation library for Siebel applications on Oracle Technology Network. item charges. Name Create Adjustment QueryAdjustment ESB_AdjustmentSiebelReqABCS_Service Operations Description Creates an adjustment for a bill.\AccountBalanceSiebelReqABCS\QueryBalanceDetailsRespMsg.xml ESB_AdjustmentSiebelReqABCS_Service Use this Web service to adjust the bills.. Also.

Table 98. Table 97. By default. the ApprovedPercentage node is excluded. For a description of this request message. The approved percentage for the adjustment. Include Tax or Exclude Tax). the ApprovedAmt node is excluded.1 . If this node is included. The ID of the bill for the adjustment in the billing application. The ID of the billing profile for the account. The reason for the adjustment.1 Primary Web Services ■ ESB_AdjustmentSiebelReqABCS_Service Request Message Description: CreateAdjustment (Bill Adjustment) The following request and response message information applies to an adjustment for a bill. The date the adjustment is approved. FsInvoiceAdjustment 84 Siebel CRM Web Services Reference Version 8. Bill). If this node is included. The row ID of the adjustment record.Siebel 8. Comments that the user enters about the adjustment. Response Message Description: CreateAdjustment (Bill Adjustment) For a description of this response message. see Table 97. Node Response Message Description: CreateAdjustment Description The attributes of the adjustment in the header for the bill in the billing profile. see Table 98. Node Request Message Description: CreateAdjustment Description The following nodes apply to the FsInvoiceAdjustment node: AccountId BillingProfileId AdjustmentID AdjustmentLevelType ApprovedDate ReasonForRequest TaxType Status IntegrationId DecisionDescription ApprovedAmt ApprovedPercentage The ID of the account for the billing profile. The status of the adjustment. The type of tax for the adjustment (for example. the status is Open. The approved amount for the adjustment. The adjustment level (for example.

The approved value for the adjustment. Include Tax or Exclude Tax). the ApprovedAmt and ApprovedPercentage nodes are excluded. The ID of the billing profile for the account. and Resource Impact). Node Request Message Description: Create Adjustment Description The following nodes apply to the FsInvoiceAdjustment node: AccountId BillingProfileId AdjustmentID AdjustmentLevelType ApprovedDate The ID of the account for the billing profile. the status is Open. The type of resource for the adjustment (for example. The ID of the bill for the adjustment in the billing application. Siebel CRM Web Services Reference Version 8. Resource Balance) The following request and response message information applies to an adjustment for an item charge. The adjustment level (for example. This node applies only to a resource balance adjustment. The following nodes apply to the SiaInvoiceAdjustmentExternalItems node: ReasonForRequest TaxType Status IntegrationId ApprovedDescription ResourceType ApprovedCurrencyCode ApprovedAmt ApprovedPercentage ApprovedValue The reason for the adjustment. For a description of this request message. If this node is included. Event Details. USD). The approved amount for the adjustment. the ApprovedPercentage and ApprovedValue nodes are excluded. the ApprovedAmt and ApprovedValue nodes are excluded.1 85 . Currency or Non Currency).Siebel 8. Event. If this node is included. Table 99. If this node is included. Comments that the user enters about the adjustment. Item Charge. see Table 99. By default. The approved percentage for the adjustment. The currency code for the adjustment (for example.1 Primary Web Services ■ ESB_AdjustmentSiebelReqABCS_Service Request Message Description: Create Adjustment (Item Charge. event. The row ID of the adjustment record. The status of the adjustment. The date the adjustment is approved. The type of tax for the adjustment (for example. and resource balance.

Request Message Description: QueryAdjustment For a description of this request message. For more information on application implementation. and resource balance in the billing profile. Table 100. Event. Response Message Description: QueryAdjustment Node CmuBilledUsageArItemsVbc Description The attributes of the adjustments for the bill in the billing profile. The currency code of the account for the billing profile. see Table 102. event. 86 Siebel CRM Web Services Reference Version 8. see Table 101. Response Message Description: Create Adjustment Node FsInvoiceAdjustment SiaInvoiceAdjustmentExternalItems Description The attributes of the adjustment in the header for the bill in the billing profile. The attributes of the adjustment for the item charge. The name of the billing profile for the account. ESB_AdjustmentSiebelReqABCS_Service Application Interface This topic describes the application objects called by the this Web service. refer to your application development documentation on Oracle Technology Network. Response Message Description: QueryAdjustment For a description of this response message. The ID of the billing profile for the account. Resource Balance) For a description of this response message. Request Message Description: QueryAdjustment Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId BillPOID Description The ID of the account for the billing profile. see Table 100. Table 101.1 . The name of the account for the billing profile. The ID of the bill.1 Primary Web Services ■ ESB_AdjustmentSiebelReqABCS_Service Response Message Description: Create Adjustment (Item Charge. The maximum number of records to retrieve from the external system.Siebel 8. Table 102.

. Table 105..xml Response See the following file to view the sample code: .CreateAdjustment [BS:AdjustmentSiebelReqABCS]. Extract the files in the zip file. see Table 105.xml Siebel CRM Web Services Reference Version 8. navigate to the documentation library for Siebel applications on Oracle Technology Network. Table 103. ESB_AdjustmentSiebelReqABCS_Service Service Object Name AdjustmentSiebelReqABCS Boundary Object Type Business Service Class (If Business Service) CSSWSOutboundDispatcher Data Object (Integration Object) For a description of data objects for this Web service.Siebel 8. Table 104. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.QueryAdjustment Example Package for ESB_AdjustmentSiebelReqABCS_Service To view an example of messages for this Web service. Request See the following file to view the sample code: . see Table 104. ESB_AdjustmentSiebelReqABCS_Service Data Object Siebel Repository Name CMU Request Adjustment IO CMU Response Adjustment IO CMU Request Billed Usage IO CMU Response Billed Usage AR Items IO External Name Account Account Account Account Methods For a description of the methods for this Web service... see Table 103.1 87 . ESB_AdjustmentSiebelReqABCS_Service Methods Operation CreateAdjustment QueryAdjustment Method [BS:AdjustmentSiebelReqABCS].\AdjusmentSiebelReqABCS\QueryAdjustmentRequestMessage.1 Primary Web Services ■ ESB_AdjustmentSiebelReqABCS_Service Service Object (Business Service or Workflow) For a description of the service objects for this Web service.\AdjustmentSiebelReqABCS\QueryAdjustmentResponseMessage.

see Table 106. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. 88 Siebel CRM Web Services Reference Version 8. and resource balance information for bills in a billing profile.1 Primary Web Services ■ ESB_InvoiceSiebelReqABCS_Service Message Schema (WSDL) for ESB_AdjustmentSiebelReqABCS_Service To view the message schema for this Web service.\AdjustmentSiebelReqABCS\ESB_AdjustmentSiebelReqABCS_Service ESB_InvoiceSiebelReqABCS_Service Use this Web service to retrieve bill. Retrieves the billed event (for example. Operations for ESB_InvoiceSiebelReqABCS_Service For a list of operations associated with this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network. Start Date. To Amount. This Web service retrieves the information from the billing application. Finds the billed event detail based on data in the From Amount. Operations for ESB_InvoiceSiebelReqABCS_Service Operation Name QueryInvoiceList QueryInvoice QueryEventDetails SearchEventDetails QueryResourceBalance Description Retrieves the bills for a billing profile. and End Date fields.Siebel 8. Extract the files in the zip file. See the following file to view the message schema: . Table 106. Retrieves the detail for a bill. usage. Retrieves the non-currency resource balance detail for a billed event. phone call) detail for an item charge... event.1 .

1 89 . The currency code of the account for the billing profile. The ID of the billing profile for the account. The name of the account for the billing profile. The maximum number of records to retrieve from the external system. The ID of the billing profile for the account. see Table 107. The ID of the bill. The maximum number of records to retrieve from the external system. Response Message Description: QueryInvoiceList For a description of this response message. Table 107. The name of the billing profile for the account. The name of the billing profile for the account. The currency code of the account for the billing profile.Siebel 8. see Table 108 Table 108. Request Message Description: QueryInvoice For a description of this request message. see Table 109 Table 109. The name of the account for the billing profile.1 Primary Web Services ■ ESB_InvoiceSiebelReqABCS_Service Request Message Description: QueryInvoiceList For a description of this request message. Request Message Description: QueryInvoice Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId BillPOID Description The ID of the account for the billing profile. Response Message Description: QueryInvoiceList Node CmuInvoiceVbc Description The attributes of the header for the bills. Request Message Description: QueryInvoiceList Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId Description The ID of the account for the billing profile. Siebel CRM Web Services Reference Version 8.

90 Siebel CRM Web Services Reference Version 8. The attributes of the billed item charges. Response Message Description: QueryInvoice Node CmuBilledUsageServiceChargesVbc CmuBilledUsageItemChargesVbc Description The attributes of the billed service charges. The ID of the bill. The name of the billing profile for the account. The ID of the item charge. see Table 112.1 Primary Web Services ■ ESB_InvoiceSiebelReqABCS_Service Response Message Description: QueryInvoice For a description of this response message. Table 112. Request Message Description: QueryEventDetails For a description of this request message. Response Message Description: QueryEventDetails Node CmuCdrDetailsVbc Description The attributes of the billed events. The maximum number of records to retrieve from the external system. The currency code of the account for the billing profile. Table 110. see Table 110. Response Message Description: QueryEventDetails For a description of this response message. Request Message Description: QueryEventDetails Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId BillPOID ItemChargeId Description The ID of the account for the billing profile. The name of the account for the billing profile. Table 111. see Table 111.Siebel 8. The ID of the billing profile for the account.1 .

see Table 115. The ID of the item charge. Table 113. The currency code of the account for the billing profile. see Table 114. Response Message Description: SearchEventDetails Node CmuCdrDetailsVbc Description The attributes for the billed events. Request Message Description: QueryResourceBalance Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName Description The ID of the account for the billing profile. Table 115. The maximum number of records to retrieve from the external system.1 Primary Web Services ■ ESB_InvoiceSiebelReqABCS_Service Request Message Description: SearchEventDetails For a description of this request message. The ID of the billing profile for the account. The ID of the bill. The maximum amount of the event.Siebel 8. The minimum amount of the event. Table 114. The name of the account for the billing profile. The currency code of the account for the billing profile. The ending date of the event. see Table 113. Request Message Description: SearchEventDetails Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId BillPOID ItemChargeId StartDate EndDate FromAmount ToAmount Description The ID of the account for the billing profile. Response Message Description: SearchEventDetails For a description of this response message. Request Message Description: QueryResourceBalance For a description of this request message.1 91 . The maximum number of records to retrieve from the external system. Siebel CRM Web Services Reference Version 8. The name of the billing profile for the account. The name of the account for the billing profile. The name of the billing profile for the account. The starting date of the event.

1 . see Table 117. Request Message Description: QueryResourceBalance Node BillingProfileId BillPOID ItemChargeId EventId Description The ID of the billing profile for the account. ESB_InvoiceSiebelReqABCS_Service Data Object Siebel Repository Name CMU Request Billing Profile IO CMU Response Billing Invoice IO CMU Request Billed Usage IO CMU Response Billed Usage IO CMU Request CDR Details IO External Name Account Account Account Account Account 92 Siebel CRM Web Services Reference Version 8.Siebel 8. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. The ID of the bill. For more information on application implementation. Response Message Description: QueryResourceBalance Node CmuCdrBalanceDetailsVbc Description The attributes of the non-currency resource balances for the billed event. ESB_InvoiceSiebelReqABCS_Service Application Interface This topic describes the application objects called by the this Web service.1 Primary Web Services ■ ESB_InvoiceSiebelReqABCS_Service Table 115. refer to your application development documentation on Oracle Technology Network. Response Message Description: QueryResourceBalance For a description of this response message. The ID of the event. Table 118. Table 117. ESB_InvoiceSiebelReqABCS_Service Service Object Name InvoiceSiebelReqABCS Boundary Object Type Business Service Class (If Business Service) CSSWSOutboundDispatcher Data Object (Integration Object) For a description of data objects for this Web service. Table 116. see Table 116. see Table 118. The ID of the item charge.

Request See the following file to view the sample code: .. navigate to the documentation library for Siebel applications on Oracle Technology Network. ESB_InvoiceSiebelReqABCS_Service Methods Operation QueryInvoiceList QueryInvoice QueryEventDetails SearchEventDetails QueryResourceBalance Method [BS:InvoiceSiebelReqABCS].\InvoiceSiebelReqABCS\QueryInvoiceListRespMsg.SearchEventDetails [BS:InvoiceSiebelReqABCS].. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 93 .QueryResouceBalance Example Package for ESB_InvoiceSiebelReqABCS_Service To view an example of messages for this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network.QueryEventDetails [BS:InvoiceSiebelReqABCS]. ESB_InvoiceSiebelReqABCS_Service Data Object Siebel Repository Name CMU Response CDR Details IO CMU Request CDR Details Search IO CMU Request CDR Balance Details IO CMU Response CDR Balance Details IO External Name Account Account Account Account Methods For a description of the methods for this Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file. See the following file to view the message schema: Siebel CRM Web Services Reference Version 8.. Table 119.xml Response See the following file to view the sample code: . see Table 119.QueryInvoiceList [BS:InvoiceSiebelReqABCS]..\InvoiceSiebelReqABCS\QueryInvoiceListReqMsg.1 Primary Web Services ■ ESB_InvoiceSiebelReqABCS_Service Table 118.xml Message Schema (WSDL) for ESB_InvoiceSiebelReqABCS_Service To view the message schema for this Web service. Extract the files in the zip file.Siebel 8.QueryInvoice [BS:InvoiceSiebelReqABCS].

xml ESB_PaymentSiebelReqABCS_Service Use this Web service to pay the bills in a billing profile. Request Message Description: CreatePayment Node CmuCaptureNewPaymentVbc Description The attributes of the payment for the billing profile which include the payment method and the payment method details. see Table 121. Retrieves the payments for a bill in a billing profile. ESB_PaymentSiebelReqABCS_Service Operations Operation Name CreatePayment CreateInvoicePayment QueryPayment QueryInvoicePayment SearchPayment Description Creates a payment for a billing profile. Retrieves the payments for a billing profile. see Table 120. and the billing application processes these payments. Response Message Description: CreatePayment Node CmuCaptureNewPaymentVbc Description The attributes of the payment for the billing profile which include the confirmation number from the billing application after the application successfully processes the billing profile payment. ESB_PaymentSiebelReqABCS_Service Operations For a list of operations associated with this Web service.. and End Date fields. Maximum Amount. This Web service transfers payments that users create to the billing application. 94 Siebel CRM Web Services Reference Version 8. Start Date. use this Web service to retrieve payment information for the bills in a billing profile. see Table 122. Finds the payment detail for a billing profile based on data in the Minimum Amount.1 Primary Web Services ■ ESB_PaymentSiebelReqABCS_Service . Table 121.Siebel 8. Table 122. This Web service retrieves the payment information from the billing application. Table 120. Also. Request Message Description: CreatePayment For a description of this request message..\InvoiceSiebelReqABCS\InvoiceSiebelReqABCSService.1 . Response Message Description: CreatePayment For a description of this response message. Creates a payment for a bill in a billing profile.

Siebel 8. Table 126. The name of the billing profile for the account. Request Message Description: CreateInvoicePayment Node CmuCaptureNewPaymentInvoiceVbc Description The attributes of the payment for the bill which include the payment method and the payment method details. Table 123. Response Message Description: CreateInvoicePayment For a description of this response message. see Table 125. Request Message Description: QueryPayment Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId Description The ID of the account for the billing profile. The currency code of the account for the billing profile. Siebel CRM Web Services Reference Version 8. Table 124. Response Message Description: CreateInvoicePayment Node CmuCaptureNewPaymentInvoiceVbc Description The attributes of the payment for the bill which include the confirmation number from the billing application after the application successfully processes the bill payment. Request Message Description: QueryPayment For a description of this request message. see Table 126. Response Message Description: QueryPayment Node CmuBillingProfilePaymentsVbc Description The attributes of the payments for the billing profile. see Table 123. Response Message Description: QueryPayment For a description of this response message. Table 125. see Table 124. The ID of the billing profile for the account. The maximum number of records to retrieve from the external system.1 95 . The name of the account for the billing profile.1 Primary Web Services ■ ESB_PaymentSiebelReqABCS_Service Request Message Description: CreateInvoicePayment For a description of this request message.

see Table 128. Request Message Description: QueryInvoicePayment Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId BillPOID Description The ID of the account for the billing profile. see Table 129. The starting date of the payment. The name of the billing profile for the account. The maximum number of records to retrieve from the external system. Table 129. The name of the account for the billing profile. The ending date of the payment. The ID of the billing profile for the account. see Table 127. The maximum number of records to retrieve from the external system. Table 127.1 . 96 Siebel CRM Web Services Reference Version 8. Response Message Description: QueryInvoicePayment For a description of this response message. The currency code of the account for the billing profile. The ID of the billing profile for the account. The maximum amount of the payment. The currency code of the account for the billing profile. The name of the billing profile for the account. Table 128.Siebel 8. Request Message Description: SearchPayment For a description of this request message. The ID of the bill. The name of the account for the billing profile. Response Message Description: QueryInvoicePayment Node CmuBilledUsagePaymentsVbc Description The attributes of the payments for the bill. Request Message Description: SearchPayment Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId StartDate EndDate MinimumAmount MaximumAmount Description The ID of the account for the billing profile. The minimum amount of the payment.1 Primary Web Services ■ ESB_PaymentSiebelReqABCS_Service Request Message Description: QueryInvoicePayment For a description of this request message.

Table 130. Table 131. Response Message Description: SearchPayment Node CmuBillingProfilePaymentsVbc Description The attributes of the payments for the billing profile. refer to your application development documentation on Oracle Technology Network. see Table 132. see Table 130. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Table 132. see Table 131. For more information on application implementation.Siebel 8.1 97 .1 Primary Web Services ■ ESB_PaymentSiebelReqABCS_Service Response Message Description: SearchPayment For a description of this response message. ESB_PaymentSiebelReqABCS_Service Service Object Name PaymentReceiptSiebelABCS Boundary Object Type Business Service Class (If Business Service) CSSWSOutboundDispatcher Data Object (Integration Object) For a description of data objects for this Web service. ESB_PaymentSiebelReqABCS_Service Application Interface This topic describes the application objects called by the this Web service. ESB_PaymentSiebelReqABCS_Service Data Object Siebel Repository Name CMU Request New Payment Capture IO CMU Response New Payments IO CMU Request Billing Profile IO CMU Response Billing Profile Payments IO CMU Request New Payment Capture Invoice IO CMU Response New Payment Invoice IO CMU Request Billed Usage IO CMU Response Billed Usage Payments IO CMU Request Billing Profile Payments Search IO External Name Account Account Account Account Account Account Account Account Account Siebel CRM Web Services Reference Version 8.

navigate to the documentation library for Siebel applications on Oracle Technology Network.QueryInvoicePayment [BS: PaymentReceiptSiebelABCS]. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file..1 Primary Web Services ■ ESB_UnbilledUsageSiebelReqABCS_Service Methods For a description of the methods for this Web service.CreateInvoicePayment [BS: PaymentReceiptSiebelABCS]. Table 133..SearchPayment Example Package for ESB_PaymentSiebelReqABCS_Service To view an example of messages for this Web service. 98 Siebel CRM Web Services Reference Version 8..xml Response See the following file to view the sample code: .Siebel 8. see Table 133.QueryPayment [BS: PaymentReceiptSiebelABCS]. ESB_PaymentSiebelReqABCS_Service Methods Operation CreatePayment CreateInvoicePayment QueryPayment QueryInvoicePayment SearchPayment Method [BS: PaymentReceiptSiebelABCS].xml Message Schema (WSDL) for ESB_PaymentSiebelReqABCS_Service To view the message schema for this Web service.. event. navigate to the documentation library for Siebel applications on Oracle Technology Network. See the following file to view the message schema: .\PaymentReceiptSiebelABCS\PaymentReceiptSiebelABCSService..1 ..xml ESB_UnbilledUsageSiebelReqABCS_Serv ice Use this Web service to retrieve usage.CreatePayment [BS: PaymentReceiptSiebelABCS]. and resource balance information that is not yet billed for a billing profile.\PaymentReceiptSiebelABCS\QueryPaymentResponseMessage. This Web service retrieves the information from the billing application.\PaymentReceiptSiebelABCS\QueryPaymentRequestMessage. Request See the following file to view the sample code: . Extract the files in the zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

Request Message Description: QueryUnbilledUsage Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId Description The ID of the account for the billing profile. The name of the billing profile for the account. ESB_UnbilledUsageSiebelReqABCS_Service Operations Operation Name QueryUnbilledUsage QueryEventDetails SearchEventDetails QueryResourceDetails Description Retrieves unbilled usage detail for a billing profile. Request Message Description: QueryUnbilledUsage For a description of this request message. see Table 136. Response Message Description: QueryUnbilledUsage Node CmuUnbilledUsageVbc CmuUnbilledItemChargesVbc Description The attributes of the unbilled service charges.Siebel 8. The ID of the billing profile for the account. The attributes of the unbilled item charges Siebel CRM Web Services Reference Version 8. Table 136.1 99 . Response Message Description: QueryUnbilledUsage For a description of this response message. Retrieves the non-currency resource balance detail for an unbilled event.1 Primary Web Services ■ ESB_UnbilledUsageSiebelReqABCS_Service ESB_UnbilledUsageSiebelReqABCS_Service Operations For a list of operations associated with this Web service. The currency code of the account for the billing profile. phone call) detail for an item charge. The maximum number of records to retrieve from the external system. The name of the account for the billing profile. Table 135. see Table 135. see Table 134. and End Data fields. Table 134. Finds the unbilled event detail based on data in the From Amount. Start Date. Retrieves unbilled event (for example. To Amount.

Request Message Description: SearchEventDetails Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId UnbilledUsageServiceId UnbilledItemChargesId StartDate Description The ID of the account for the billing profile. Table 138. Table 139. Table 137. Response Message Description: QueryEventDetails Node CmuUnbilledItemChargesDetailsVbc Description The attributes of the unbilled events. The currency code of the account for the billing profile. The ID of the billing profile for the account. Request Message Description: SearchEventDetails For a description of this request message.1 . The name of the account for the billing profile. The maximum number of records to retrieve from the external system. see Table 137. The ID of the billing profile for the account. The currency code of the account for the billing profile. 100 Siebel CRM Web Services Reference Version 8. see Table 139. The ID of the unbilled item charge. The name of the account for the billing profile. The starting date of the event. The name of the billing profile for the account.Siebel 8. see Table 138. The ID of the unbilled service charge. The name of the billing profile for the account. The ID of the unbilled service charge. Request Message Description: QueryEventDetails Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId UnbilledUsageServiceId UnbilledItemChargesId Description The ID of the account for the billing profile.1 Primary Web Services ■ ESB_UnbilledUsageSiebelReqABCS_Service Request Message Description: QueryEventDetails For a description of this request message. The ID of the unbilled item charge. Response Message Description: QueryEventDetails For a description of this response message. The maximum number of records to retrieve from the external system.

see Table 140. Response Message Description: SearchEventDetails For a description of this response message. The name of the billing profile for the account. Response Message Description: QueryResouceBalance For a description of this response message. The ID of the unbilled service charge. Table 140. Request Message Description: SearchEventDetails Node EndDate FromAmount ToAmount Description The ending date of the event. Request Message Description: QueryResouceBalance For a description of this request message. Table 142. Table 141. The ID of the billing profile for the account. Siebel CRM Web Services Reference Version 8. Response Message Description: QueryResouceBalance Node CmuUnbilledBalanceDetailsVbc Description The attributes of the non-currency resource balances for an unbilled event. see Table 142. The name of the account for the billing profile.1 Primary Web Services ■ ESB_UnbilledUsageSiebelReqABCS_Service Table 139. The currency code of the account for the billing profile. The maximum amount of the event. see Table 141. The maximum number of records to retrieve from the external system. The minimum amount of the event. Response Message Description: SearchEventDetails Node CmuUnbilledItemChargesDetailsVbc Description The attributes of the unbilled events. Request Message Description: QueryResouceBalance Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId UnbilledUsageServiceId UnbilledItemChargesId UnbilledEventDetailsId Description The ID of the account for the billing profile.Siebel 8. The ID of the unbilled event. The ID of the unbilled item charge.1 10 1 .

see Table 145.1 . see Table 144. ESB_UnbilledUsageSiebelReqABCS_Service Methods Operation QueryUnbilledUsage QueryEventDetails SearchEventDetails QueryResourceBalance Method [BS:UnbilledUsageSiebelReqABCS]. Table 144.QueryUnbilledUsage [BS:UnbilledUsageSiebelReqABCS]. ESB_UnbilledUsageSiebelReqABCS_Service Data Objects Siebel Repository Name CMU Request Billing Profile IO CMU Response Unbilled Usage IO CMU Request Unbilled Details IO CMU Response Unbilled Details IO CMU Request Unbilled Details Search IO CMU Request Unbilled Balance Details IO CMU Response Unbilled Balance Details IO External Name Account Account Account Account Account Account Account Methods For a description of the methods for this Web service.1 Primary Web Services ■ ESB_UnbilledUsageSiebelReqABCS_Service ESB_UnbilledUsageSiebelReqABCS_Service Application Interface This topic describes the application objects called by the this Web service. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. For more information on application implementation. ESB_UnbilledUsageSiebelReqABCS_Service Service Object Name UnbilledUsageSiebelReqABCS Boundary Object Type Business Service Class (If Business Service) CSSWSOutboundDispatcher Data Object (Integration Object) For a description of data objects for this Web service.QueryBalanceSummary 102 Siebel CRM Web Services Reference Version 8. Table 145. refer to your application development documentation on Oracle Technology Network. see Table 143.SearchEventDetails [BS:UnbilledUsageSiebelReqABCS].Siebel 8.QueryEventDetails [BS:UnbilledUsageSiebelReqABCS]. Table 143.

Used to retrieve all the warranties for a specified asset's product and then add them to the asset if not already done so.\UnbilledUsageSiebelReqABCS\UnbilledUsageRequestMessage. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. FS Asset Warranty Service Operations For a list of operations associated with this Web service.\UnbilledUsageSiebelReqABCS\UnbilledUsageResponseMessage. navigate to the documentation library for Siebel applications on Oracle Technology Network.. Extract the files in the zip file. Extract the files in the zip file. Siebel CRM Web Services Reference Version 8.xml Response See the following file to view the sample code: . Request See the following file to view the sample code: . and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file..xml FS Asset Warranty Service Use this Web service to create asset warranties and to retrieve asset warranty information. See the following file to view the message schema: . Table 146.... see Table 146.Siebel 8.xml Message Schema (WSDL) for ESB_UnbilledUsageSiebelReqABCS_Service To view the message schema for this Web service.. FS Asset Warranty Service Operations Name CreateAssetWarranty GetAssetWarranty Description Adds the input warranty to the source asset.1 10 3 .\UnbilledUsageSiebelReqABCS\UnbilledUsageSiebelReqABCSService. navigate to the documentation library for Siebel applications on Oracle Technology Network.1 Primary Web Services ■ FS Asset Warranty Service Example Package for ESB_UnbilledUsageSiebelReqABCS_Service To view an example of messages for this Web service.

1 Primary Web Services ■ FS Asset Warranty Service Request Message Description: CreateAssetWarranty Adds a specific warranty to an asset. see Table 147. For a description of this request message. Row Id of the warranty. If there is no imcompatibility. Type String String Date Response Message Description: CreateAssetWarranty For a description of this response message. If that warranty has already been added to the asset record. Request Message Description: CreateAssetWarranty Node Asset Id Warranty Id Serviced Date Description Row Id of asset. Type String Response Message Description: GetAssetWarranty This Web service has no response message. 104 Siebel CRM Web Services Reference Version 8. The date depends on the start data type of each warranty. Date from which warranty will start (mm/dd/yyyy). For a description of this request message. but leaves the existing warranties untouched. CAUTION: This operation does not return an error message if the user provides the wrong value for Asset Id. the operation adds the other potenital warranties. there will be no message. Will give error message in the case of incompatibility of inputs. Table 149. Request Message Description: GetAssetWarranty Node Asset Id Description Row Id of asset.Siebel 8. Table 147. If some of the warranties are already attached to the asset. Table 148. see Table 148. then the service will update the service date.1 . Type String Request Message Description: GetAssetWarranty This operation will add all the warranty information associated with an asset. Response Message Description: CreateAssetWarranty Node StatusMsg Description (Optional). see Table 149.

doc Request/Response (GetAssetWarranties) See the following file to view the sample code: …\FSAssetWarranty\GetAssetWarranty Sample IO. refer to your application development documentation on Oracle Technology Network. navigate to the documentation library for Siebel applications on Oracle Technology Network. Service Object (Business Service or Workflow) For a description of the service objects for this Web service.1 10 5 . navigate to the documentation library for Siebel applications on Oracle Technology Network. Table 150.wsdl GetMktgWebSurvey Use this Web service to get Marketing Web Surveys. Extract the files in the zip file. Siebel CRM Web Services Reference Version 8. FS Asset Warranty Service Object Name BS: FS Asset Warranty Service Operation: CreateAssetWarranty BS: FS Asset Warranty Service Operation: GetAssetWarranties Busiiness Service CSSFSAssetWrntyService Boundary Object Type Business Service Class CSSFSAssetWrntyService Example Package for FS Asset Warranty Service To view an example of messages for this Web service. Request/Response (CreateAssetWarranty) See the following file to view the sample code: …\FSAssetWarranty\CreateAssetWarranty Sample IO. Extract the files in the zip file.doc Message Schema (WSDL) for FS Asset Warranty Service To view the message schema for this Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. See the following file to view the message schema: …\FSAssetWarranty\CreateAssetWarranty. For more information on application implementation. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.Siebel 8.1 Primary Web Services ■ GetMktgWebSurvey FS Asset Warranty Application Interface This topic describes the application objects called by the this Web service. see Table 150.

1 . Preserve. Name of the picklist (if any).Siebel 8. Type String String String String Integration Object String Response Message Description: GetMktgWebSurveyQueryPage For a description of this response message. and so on). 106 Siebel CRM Web Services Reference Version 8. refer to your application development documentation on Oracle Technology Network. Table 153. see Table 152. The View Mode set for the Object (Admin. Request Message Description: GetMktgWebSurveyQueryPage For a description of this request message. see Table 151. For more information on application implementation. Type Integration Object GetMktgWebSurvey Application Interface This topic describes the application objects called by the this Web service. Response Message Description: GetMktgWebSurveyQueryPage Node SiebelMessageOut Description An instance of the “GetMktgWebSurvey” Integration Object. see Table 153. Table 151. GetMktgWebSurvey Operations Name GetMktgWebSurveyQueryPage Description This operation is used to query up a Survey Page. An instance of the GetMktgWebSurvey Integration Object. Request Message Description: GetMktgWebSurveyQueryPage Node ExecutionMode LOVLanguageMode NamedSearchSpec PickListName SiebelMessageIn ViewMode Description The mode in which the query is to be performed. Table 152. Search Specification of the query.1 Primary Web Services ■ GetMktgWebSurvey GetMktgWebSurvey Operations For a list of operations associated with this Web service. The language mode from the seeded list.

The response message returns only an acknowledgement message and not data. GetMktgWebSurvey Data Object Siebel Repository Name Import Job Integration Object External Name Import Job Integration Object. update. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 10 7 . Extract the files in the zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network. and delete items in a price list in the Siebel CRM application. navigate to the documentation library for Siebel applications on Oracle Technology Network. Table 154. Example Package for GetMktgWebSurvey To view an example of messages for this Web service.Siebel 8.1 Primary Web Services ■ ISS Price List Item WS Data Object (Integration Object) For a description of data objects for this Web service.xml Message Schema (WSDL) for GetMktgWebSurvey To view the message schema for this Web service. see Table 154. …\GetMktgWebSurvey\GetMktgWebSurvey. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file. Siebel CRM Web Services Reference Version 8.wsdl ISS Price List Item WS Use this Web service to add.xml Response See the following file to view the sample code: …\GetMktgWebSurvey\GetMktgWebSurvey_response. Request See the following file to view the sample code: …\GetMktgWebSurvey\GetMktgWebSurvey_request.

This node is used only to insert. Updates an item in a price list. The ID of the product to add to the price list.1 . ISS Price List Item WS Operations Name Price List Item InsertorUpdate Price List Item Insert Price List Item Update Price List Item Delete Description Adds an item to a price list that does not already contain that item. Request Message Description: Price List Item Update Node Price List Item Id Description The ID of the price list item to update in the price list. This node is used only to update. Table 157. This node is used only to insert.Siebel 8. see Table 156. Request Message Description: Price List Item InsertOrUpdate For a description of this request message. Table 155. Table 156. Request Message Description: Price List Item Insert For a description of this request message. Request Message Description: Price List Item Update For a description of this request message. and updates an item in a price list that already contains that item. Table 158.1 Primary Web Services ■ ISS Price List Item WS ISS Price List Item WS Operations For a list of operations associated with this Web service. Adds an item to a price list. Request Message Description: Price List Item Insert Node Price List Id Product Id Description The ID of the price list. The ID of the price list item to update to the price list. Request Message Description: Price List Item InsertOrUpdate Node Price List Id Product Id Price List Item Id Description The ID of the price list. The ID of the product to add to the price list. see Table 155. see Table 157. 108 Siebel CRM Web Services Reference Version 8. see Table 158. Deletes an item from a price list.

ISS Price List Item WS Service Object Name ISS Price List Item WS Boundary Object Type Business Service Class (If Business Service) CSSEAIDataSyncService Data Object (Integration Object) For a description of data objects for this Web service. ISS Price List Item WS Application Interface This topic describes the application objects called by the this Web service. ISS Price List Item WS Methods Operation Price List Item InsertOrUpdate Price List Item Insert Price List Item Update Price List Item Delete Method [BS: ISS Price List Item WS]. Table 161. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Request Message Description: Price List Item Delete Node Price List Item Id Description The ID of the price list item to delete from the price list.Delete Siebel CRM Web Services Reference Version 8.Update [BS: ISS Price List Item WS]. see Table 159. ISS Price List Item WS Data Object Siebel Repository Name ISS Price List Item Integration Object External Name Admin Price List Methods For a description of methods for this Web service. see Table 161.InsertOrUpdate [BS: ISS Price List Item WS]. For more information on application implementation. see Table 160.1 10 9 . Table 162.1 Primary Web Services ■ ISS Price List Item WS Request Message Description: Price List Item Delete For a description of this request message. see Table 162. Table 160. Table 159.Siebel 8.Insert [BS: ISS Price List Item WS]. refer to your application development documentation on Oracle Technology Network.

Request See the following file to view the sample code: .1 .. See the following file to view the message schema: .\ISSPriceListItemWS\ISSPriceListItem.\ISSPriceListItemWS\ISSPriceListItem.. Lead Processing Service Operations For a list of operations associated with this Web service.. see Table 163..\ISSPriceListItemWS\ISSPriceListItemWS. 110 Siebel CRM Web Services Reference Version 8. Used for data cleansing of marketing data. navigate to the documentation library for Siebel applications on Oracle Technology Network. Scores leads based on defined characterstics. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Lead Processing Service Operations Name LeadProcessingServiceAssignLeads LeadProcessingServiceDataCleansing LeadProcessingServiceGetLeads LeadProcessingServiceScoreLeads Description Used to assign leads to sales representatives. Extract the files in the zip file.1 Primary Web Services ■ LeadProcessingService Example Package for ISS Price List Item WS To view an example of messages for this Web service. Extract the files in the zip file. including assigning.xml Message Schema (WSDL) for ISS Price List Item WS To view the message schema for this Web service. scoring and data cleansing.. Queries for leads. navigate to the documentation library for Siebel applications on Oracle Technology Network. querying. Table 163.xml Response See the following file to view the sample code: ..wsdl LeadProcessingService This service contains the basic operations for processing leads.Siebel 8..

The input search criteria to search on the Lead Business Component. Request Message Description: LeadProcessingServiceDataCleansing Node Business Component Business Object Search Specification Description Required. Type String String Response Message Description: LeadProcessingServiceAssignLeads For a description of this response message.Siebel 8. Table 165. Required. Search specification to querry the BC and get the values in activated Fields. Parameter to be passed to the Business Rules Workflow. see Table 164. This is the Business Rules Workflow process Id. Type String String String Siebel CRM Web Services Reference Version 8. Yes OR No based on success. Response Message Description: LeadProcessingServiceAssignLeads Node Error Message Process Instance Id Success Flag Description OK or NOTOK based on errors. Table 164. see Table 165. For a description of this request message. Required.1 Primary Web Services ■ LeadProcessingService Request Message Description: LeadProcessingServiceAssignLeads This method is used to assign leads. Type String String String Request Message Description: LeadProcessingServiceDataCleansing This method calls the Data Cleansing business service to cleanup a property set. Request Message Description: LeadProcessingServiceAssignLeads Node Execution Order Search Specification Description Required. It accepts the input parameters in a property set. Business Component to be passed to Data cleansing service. Required.1 11 1 . see Table 166 Table 166. Business Object from which the business component instance is obtained. For a description of this request message.

Table 167. Request Message Description: LeadProcessingServiceGetLeads Node Search Specification Description Required. see Table 169.1 Primary Web Services ■ LeadProcessingService Response Message Description: LeadProcessingServiceDataCleansing For a description of this request message. The input search criteria to search on Lead Business Component. For a description of this request message.Siebel 8. Has Lead Id and description of the leads. Table 168.1 . Yes OR No based on success. Type String String Request Message Description: LeadProcessingServiceGetLeads This method is used to get leads based on the input criteria. Type Integration Object Request Message Description: LeadProcessingServiceScoreLeads This method is used to score leads. see Table 170. Table 170. Request Message Description: LeadProcessingServiceScoreLeads Node Execution Order Description Required. see Table 168. Response Message Description: LeadProcessingServiceDataCleansing Node Error Message Success Flag Description OK or NOTOK based on errors. see Table 167. Table 169. Type String 112 Siebel CRM Web Services Reference Version 8. For a description of this request message. It accepts the input parameters in a property set. Type String Response Message Description: LeadProcessingServiceGetLeads For a description of this response message. Parameter to be passed to Business Rules Workflow. Response Message Description: LeadProcessingServiceGetLeads Node SiebelMessage Description Required.

LeadProcessingService Data Object Siebel Repository Name Lead Integration Object External Name Lead Example Package for Lead Processing Service To view an example of messages for this Web service. For more information on application implementation.xml Siebel CRM Web Services Reference Version 8. Request (LeadProcessingServiceAssignLeads) See the following file to view the sample code: …\LeadProcessingService\LeadProcessingService_AssignLeads_request. see Table 171. refer to your application development documentation on Oracle Technology Network. see Table 172. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 Primary Web Services ■ LeadProcessingService Response Message Description: LeadProcessingServiceScoreLeads For a description of this response message. Yes OR No based on success. Table 171. Response Message Description: LeadProcessingServiceScoreLeads Node Error Message Process Instance Id Success Flag Description OK or NOTOK based on errors.1 11 3 . Extract the files in the zip file. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Table 172. Type String String String LeadProcessingService Application Interface This topic describes the application objects called by the this Web service. Table 173. see Table 173.Siebel 8. navigate to the documentation library for Siebel applications on Oracle Technology Network. LeadProcessingService Service Object Name Business Rules Workflow Data Cleansing Boundary Object Type WorkFlow Busiiness Service Data Object (Integration Object) For a description of data objects for this Web service. This is the Business Rules Workflow process Id.

xml Response (LeadProcessingServiceGetLeads) See the following file to view the sample code: …\LeadProcessingService\LeadProcessingService_ScoreLeads_request.1 Primary Web Services ■ LeadProcessingService Response (LeadProcessingServiceAssignLeads) See the following file to view the sample code: …\LeadProcessingService\LeadProcessingService_AssignLeads_request.xml Request (LeadProcessingServiceScoreLeads) See the following file to view the sample code: …\LeadProcessingService\LeadProcessingService_ScoreLeads_request.wsdl 114 Siebel CRM Web Services Reference Version 8. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. See the following file to view the message schema: …\LeadProcessingService\LeadProcessing.xml Request (LeadProcessingServiceDataCleansing) See the following file to view the sample code: …\LeadProcessingService\LeadProcessingService_ScoreLeads_request.Siebel 8.1 .xml Response(LeadProcessingServiceDataCleansing) See the following file to view the sample code: …\LeadProcessingService\LeadProcessingService_ScoreLeads_request.xml Response (LeadProcessingServiceScoreLeads) See the following file to view the sample code: …\LeadProcessingService\LeadProcessingService_ScoreLeads_request.xml Message Schema (WSDL) for Lead Processing Service To view the message schema for this Web service. Extract the files in the zip file.xml Request (LeadProcessingServiceGetLeads) See the following file to view the sample code: …\LeadProcessingService\LeadProcessingService_ScoreLeads_request. navigate to the documentation library for Siebel applications on Oracle Technology Network.

retire and reject leads. For a description of this request message. Type String String String Response Message Description: LeadServiceRetireLead For a description of this response message. update. Updates a lead. see Table 176.1 Primary Web Services ■ LeadService LeadService Use this Web serviceto perform basic operations on the Lead entity. It accepts the input parameters in a property set. see Table 174. Response Message Description: LeadServiceRetireLead Node ReturnVal Description Error code (OK or NOTOK). Table 175. LeadService Operations Name LeadServiceRetireLead LeadServiceCreateLead LeadServiceRejectLead LeadServiceResponseToLead LeadServiceConvertLeadToOpty LeadServiceUpdateLead Description Retires a lead.Siebel 8.1 11 5 . convert. Required The reason code for retiring the lead. such create. Comments for retiring (if any). Converts response to leads. Table 176. see Table 175. Type String Siebel CRM Web Services Reference Version 8. Converts lead to an opportunity.The Id of the lead to be retired. Request Message Description: LeadServiceRetireLead This method is used to assign leads. Request Message Description: LeadServiceRetireLead Node LeadId ReasonCode Comments Description Required. Rejects a lead. LeadService Operations For a list of operations associated with this Web service. Table 174. Creates a lead.

1 Primary Web Services ■ LeadService Request Message Description: LeadServiceCreateLead For a description of this request message. Optionally an owner Id can be passed to whom the lead will be assigned. Reason code for rejecting the lead. Comments (if any). Request Message Description: LeadServiceCreateLead Node Lead IO Description Required. Y or N. Request Message Description: LeadServiceRejectLead Node LeadId OwnerId ReasonCode Comments Description Required. Table 180. Type String 116 Siebel CRM Web Services Reference Version 8. a reject reason code.1 .An instance of the Integration Object Lead IO. Response Message Description: LeadServiceRejectLead Node ReturnVal Description Error message(OK or NOTOK). Optional. Id of the lead generated as a result of the lead creation. Table 177. The lead Id is retained. see Table 178. Response Message Description: LeadServiceCreateLead Node Error Message Success Flag Lead Id Description Error message (if any). Type String String String Request Message Description: LeadServiceRejectLead This method is used to reject a lead. Type Integration Object Response Message Description: LeadServiceCreateLead For a description of this response message. along with a reject comments code. Table 178.Siebel 8. Type String String String String Response Message Description: LeadServiceRejectLead For a description of this response message. see Table 179. see Table 180. see Table 177. For a description of this request message. The Id of the lead to be rejected. Table 179.

Siebel 8.The Id of the response to be converted to lead. Type String Response Message Description: LeadServiceResponseToLead For a description of this response message. Y or N. The Id of the lead to be converted. Request Message Description: LeadServiceConvertLeadToOpty Node LeadId Contact Id Account Id Description Required . see Table 183. Y or N. Table 182. see Table 182. For a description of Siebel CRM Web Services Reference Version 8. The contact Id of the lead. The Id of the opportunity created. The account Id of the lead.1 Primary Web Services ■ LeadService Request Message Description: LeadServiceResponseToLead For a description of this request message. Type String String String Request Message Description: LeadServiceConvertLeadToOpty For a description of this request message. It accepts input parameters in a property set. see Table 184. Table 183. Response Message Description: LeadServiceResponseToLead Node Error Message Success Flag Lead Id Description Error message (if any). Type String String String Response Message Description: LeadServiceConvertLeadToOpty For a description of this response message. The Id of the lead created from the response.1 11 7 . Table 181. Table 184. Response Message Description: LeadServiceConvertLeadToOpty Node Error Message Success Flag Opty Id Description Error message (if any). Request Message Description: LeadServiceResponseToLead Node Response Id Description Required. Type String String String Request Message Description: LeadServiceUpdateLead This method is used to update leads. see Table 181.

Service Object (Business Service or Workflow) For a description of the service objects for this Web service. For more information on application implementation. Request Message Description: LeadServiceUpdateLead Node Lead IO Description Required. Table 186. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. see Table 185. navigate to the documentation library for Siebel applications on Oracle Technology Network. see Table 188. Y or N. Extract the files in the zip file. Table 185.Siebel 8. 118 Siebel CRM Web Services Reference Version 8. Table 188.1 Primary Web Services ■ LeadService this request message.1 . LeadService Data object Siebel Repository Name Lead IO External Name Lead Example Package for LeadService To view an example of messages for this Web service. refer to your application development documentation on Oracle Technology Network. An instance of the integration object Lead IO. Table 187. LeadService Service Object Name Response To Lead Conversion Lead To Opty Conversion Boundary Object Type Workflow Workflow Data Object (Integration Object) For a description of data objects for this Web service. see Table 187. see Table 186. Type String String LeadService Application Interface This topic describes the application objects called by the this Web service. Response Message Description: LeadServiceUpdateLead Node Error Message Success Flag Description Error message (if any). Type Integration Object Response Message Description: LeadServiceUpdateLead For a description of this response message.

xml Response (LeadServiceCreateLead) See the following file to view the sample code: …\LeadService\LeadService_CreateLead_response.Siebel 8.xml Request (LeadServiceCreateLead) See the following file to view the sample code: …\LeadService\LeadService_CreateLead_request.xml Siebel CRM Web Services Reference Version 8.xml Request (LeadServiceResponseToLead) See the following file to view the sample code: …\LeadService\LeadService_ResponseToLead_request.1 11 9 .xml Response(LeadServiceRejectLead) See the following file to view the sample code: …\LeadService\LeadService_RejectLead_response.xml Response (LeadServiceRetireLead) See the following file to view the sample code: …\LeadService\LeadService_RetireLead_response.xml Request (LeadServiceRejectLead) See the following file to view the sample code: …\LeadService\LeadService_RejectLead_request.xml Response (LeadServiceResponseToLead) See the following file to view the sample code: …\LeadService\LeadService_ResponseToLead_response.xml Request (LeadServiceConvertLeadToOpty) See the following file to view the sample code: …\LeadService\LeadService_ConvertToOpty_request.1 Primary Web Services ■ LeadService Request (LeadServiceRetireLead) See the following file to view the sample code: …\LeadService\LeadService_RetireLead_request.

and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. List Operations For a list of operations associated with this Web service. see Table 189. navigate to the documentation library for Siebel applications on Oracle Technology Network.xml Request (LeadServiceUpdateLead) See the following file to view the sample code: …\LeadService\LeadService_UpdateLead_request. Exports a list.xml Response (LeadServiceUpdateLead) See the following file to view the sample code: …\LeadService\LeadService_UpdateLead_response. Table 189.1 .1 Primary Web Services ■ List Response (LeadServiceConvertLeadToOpty) See the following file to view the sample code: …\LeadService\LeadService_ConvertToOpty_response. Extract the files in the zip file. See the following file to view the message schema: …\LeadService\Lead. List Operations Name ListCreateList ListExportList Description Creates a list. 120 Siebel CRM Web Services Reference Version 8.xml Message Schema (WSDL) for LeadService To view the message schema for this Web service.wsdl List Use this Web service for the basic operations for processing lists.Siebel 8.

see Table 191. The search specification for the records on the bc (if the records satisfying a condition are only to be picked). Table 192. Type String String String Request Message Description: ListExportList This method is used to export lists. Table 190. Error message if any.1 Primary Web Services ■ List Request Message Description: ListCreateList This method is used to create a list. The format (xml or CSV) based on which the filename(s) are to be created. An instance of the integration object List IO. It accepts the input parameters as a property set. see Table 192. Type String String String String List Application Interface This topic describes the application objects called by the this Web service. The Business Object containing the Business Component. see Table 190. Request Message Description: ListCreateList Node List IO Description Required. Siebel CRM Web Services Reference Version 8. For more information on application implementation.Siebel 8. refer to your application development documentation on Oracle Technology Network.1 12 1 . Type Integration Object Response Message Description: ListCreateList For a description of this response message. Response Message Description: ListCreateList Node List Id Error Message Success Flag Description List Id of the list created. For a description of this request message. For a description of this request message. Request Message Description: ListExportList Node Business Component Business Object Export Format Search Specification Description The Business Component whose records need to be exported. Table 191. It accepts the input parameters as a property set. Y or N.

xml Response (ListCreateList) See the following file to view the sample code: …\List\ListCreate_response.xml Request (ListExportList) See the following file to view the sample code: …\List\ListExport_request.wsdl 122 Siebel CRM Web Services Reference Version 8. navigate to the documentation library for Siebel applications on Oracle Technology Network. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Request (ListCreateList) See the following file to view the sample code: …\List\ListCreate_request. Extract the files in the zip file. List Data Object Siebel Repository Name List IO External Name List IO Example Package for List To view an example of messages for this Web service. Extract the files in the zip file.Siebel 8.xml Message Schema (WSDL) for List To view the message schema for this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network. see Table 194. List Service Object Name EAI XML Write to File Boundary Object Type Business Service Data Object (Integration Object) For a description of data objects for this Web service.1 . See the following file to view the message schema: …\List\List. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. see Table 193. Table 193.1 Primary Web Services ■ List Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Table 194.

see Table 196. Type Integration Object Response Message Description: ListMgmtProspectCreateProspect For a description of this response message. Updates a Prospect. For a description of this request message. For a description of this request message.1 12 3 . Table 197. Response Message Description: ListMgmtProspectCreateProspect Node Prospect Id Error Message Success Flag Description Unique Id of the prospect created. see Table 195. Table 195. Table 196. Request Message Description: ListMgmtProspectCreateProspect This method takes in an Integration Object called Prospect IO and returns the Prospect Id and Success Flag. Request Message Description: ListMgmtProspectUpdateProspect Node Prospect IO Description Required input parameter. Type String String String Request Message Description: ListMgmtProspectUpdateProspect This method updates a prospect. if any. Request Message Description: ListMgmtProspectCreateProspect Node Prospect IO Description Required input parameter. see Table 197. Error message. see Table 198. Table 198. ListMgmtProspect Operations Name ListMgmtProspectCreateProspect ListMgmtProspectUpdateProspect Description Creates a Prospect. Y or N. ListMgmtProspect Operations For a list of operations associated with this Web service. Type Integration Object Siebel CRM Web Services Reference Version 8.Siebel 8.1 Primary Web Services ■ ListMgmtProspect ListMgmtProspect Use this Web service for the basic operations of Marketing such as to create and update prospect.

navigate to the documentation library for Siebel applications on Oracle Technology Network.1 Primary Web Services ■ ListMgmtProspect Response Message Description: ListMgmtProspectUpdateProspect For a description of this response message.xml Request (ListMgmtProspectUpdate) See the following file to view the sample code: …ListMgmtProspect\ListMgmtProspectUpdate_request. Type String String Example Package for ListMgmtProspect To view an example of messages for this Web service. Extract the files in the zip file. see Table 199.wsdl 124 Siebel CRM Web Services Reference Version 8. Request (ListMgmtProspectCreate) See the following file to view the sample code: …ListMgmtProspect\ListMgmtProspectCreate_request. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.Siebel 8. Y or N. Table 199. Extract the files in the zip file. if any.xml Response (ListMgmtProspectUpdate) See the following file to view the sample code: …ListMgmtProspect\ListMgmtProspectUpdate_request. Response Message Description: ListMgmtProspectUpdateProspect Node Error Message Success Flag Description Error message.xml Response (ListMgmtProspectCreate) See the following file to view the sample code:: …ListMgmtProspect\ListMgmtProspectCreate_request. navigate to the documentation library for Siebel applications on Oracle Technology Network.1 .xml Message Schema (WSDL) for ListMgmtProspect To view the message schema for this Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. See the following file to view the message schema: …\ListMgmtProspect\ListMgmtProspect.

Type String. Table 203. LoyaltyAccrualService Operations For a list of operations associated with this Web service. Type Number Response Message Description: ProcessExternalOrder For a description of this response message. Imports the transactions from given input. see Table 200.Siebel 8. The Request Mode can be either Process or Simulate. Exports the Promotion of given Program. see Table 203. Type Number Request Message Description: ImportExternalOrderTxn For a description of this request message. and exporting promotions. Table 201.1 Primary Web Services ■ LoyaltyAccrualService LoyaltyAccrualService Use this Web service with the Siebel Loyalty Application to perform operations on orders. importing from an external file. Request Message Description: ImportExternalOrderTxn Node File Name Description File name that contains the transactions. including processing. Imports the transactions from external file. Request Message Description: ProcessExternalOrder Node Order Number – Number Description The number of transactions this order number will be processed. importing transactions. see Table 201. LoyaltyAccrualService Operations Name ProcessExternalOrder ImportExternalOrderTxn ProcessExternalOrderTxn Description Process all the transactions with the given order number. see Table 202. Response Message Description: ProcessExternalOrder Node Total Points Description Total Number of Points for a given order. ExportPromotions Request Message Description: ProcessExternalOrder For a description of this request message. Table 200. stamp the given order number to them and process all the transactions. stamp the given order number to them and process all the transactions. Siebel CRM Web Services Reference Version 8.1 12 5 . Table 202.

Request Message Description: ExportPromotions Node Activity Date Description Date should be between the start and end date of the promotion. Failure or Success. stamp the given order number to them and process all the transactions. Can be “Process” or “Simulate”. see Table 207. Type Number Number String Integration Object Response Message Description: ProcessExternalOrderTxn For a description of this response message.Siebel 8. see Table 206. The Request Mode can be either Process or Simulate. Siebel Message of Transactions. Type Number Hierarchy Request Message Description: ProcessExternalOrderTxn Imports the transactions from given input. For a description of this request message. Response Message Description: ProcessExternalOrderTxn Node Total Points – Number Return Value – String Siebel Message – Hierarchy Description Total Number of Points for the given order. Table 205. Transactions in Integration Object Format.1 . Total number of transactions in the Input. Table 204. see Table 205. For a description of this request message. Type Number String Hierarchy Request Message Description: ExportPromotions Exports the promotion of given program. Response Message Description: ImportExternalOrderTxn Node Total Points Siebel Message Description Total Number of Points for a given order. Type String 126 Siebel CRM Web Services Reference Version 8. Table 207. Siebel Message of Transactions. see Table 204. Table 206. Request Message Description: ProcessExternalOrderTxn Node Order Number Total Lines Request Mode LOY EAI Transactions Description Order Number to be stamped to the saved transactions.1 Primary Web Services ■ LoyaltyAccrualService Response Message Description: ImportExternalOrderTxn For a description of this response message.

see Table 208. navigate to the documentation library for Siebel applications on the Oracle Technology Network.xml Request (ImportExternalOrderTxn) See the following file to view the sample code: …\LoyaltyAccrualService\ProcessExternalOrderTxn_request. Request Message Description: ExportPromotions Node Export Flag Program Name Description Export Flag can be “Y” or “N”.xml Response (ImportExternalOrderTxn) See the following file to view the sample code: …\LoyaltyAccrualService\ProcessExternalOrderTxn_response. Table 208. Type String String Response Message Description: ExportPromtions For a description of this response message.1 12 7 .1 Primary Web Services ■ LoyaltyAccrualService Table 207. Request (ProcessExternalOrder) See the following file to view the sample code: …\LoyaltyAccrualService\ProcessExternalOrder_request. Then extract the files in the zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.xml Request (ImportExternalOrderTxn—if Request Mode is Simulate) See the following file to view the sample code: Siebel CRM Web Services Reference Version 8. Example of Package for LoyaltyAccrualService To view an example of messages for this Web service.xml Response (ProcessExternalOrder) See the following file to view the sample code: …\LoyaltyAccrualService\ProcessExternalOrder_response.Siebel 8. Program Name of which the user want to export the Promotions. Response Message Description: ExportPromtions Node Siebel Message Description All the Promotions in LOY EAI Promotion Integration Object Format. Type Integration Object.

xml Request (ProcessExternalOrderTxn) See the following file to view the sample code: …\LoyaltyAccrualService\ProcessExternalOrderTxn_request.wsdl WSDL (ImportExternalOrderTxn) …\LoyaltyAccrualService\ImportExternalOrderTxn.Siebel 8. WSDL (ProcessExternalOrder) …\LoyaltyAccrualService\ProcessExternalOrder.xml Response (ExportPromotions) See the following file to view the sample code: …\LoyaltyAccrualService\ExportPromotions_response.xml Message Schema (WSDL) for LoyaltyAccrualService To view the message schema for this Web service.xml Response(ImportExternalOrderTxn—if Request Mode is Simulate) See the following file to view the sample code: …\LoyaltyAccrualService\RequestMode_Simulate_response.xml Response (ProcessExternalOrderTxn) See the following file to view the sample code: …\LoyaltyAccrualService\ProcessExternalOrderTxn_response.1 Primary Web Services ■ LoyaltyAccrualService …\LoyaltyAccrualService\RequestMode_Simulate_request. navigate to the documentation library for Siebel applications on Oracle Technology Network.wsdl 128 Siebel CRM Web Services Reference Version 8.xml Request (ExportPromotions) See the following file to view the sample code: …\LoyaltyAccrualService\ExportPromotions_request.1 . Extract the files in the zip file.wsdl WSDL (ProcessExternalOrderTxn) …\LoyaltyAccrualService\ProcessExternalOrderTxn. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.

In case of any error.wsdl LoyaltyBatchEnrollment Use this Web service with the Siebel Loyalty Application to perform the following operations for a member: ■ ■ ■ ■ Enrolling a member into the selected Loyalty Program Updating member data Enrollment Payment processing for the selected member Generating specified number of pre-allotted memberships into the selected Loyalty Program.Siebel 8. MemberUpdate Used to update the member details.1 Primary Web Services ■ LoyaltyBatchEnrollment WSDL (ExportPromotions) …\LoyaltyAccrualService\ExportPromotions. LoyaltyBatchEnrollment Operations For a list of operations associated with this Web service. Table 209. LoyaltyBatchEnrollment Operations Name MemberEnrollment Description Enrolls a member into the specified loyalty program and returns the generated Member number. if any. If the membership status is ‘Pre-Allotted’ thn this Web service updates the member details and returns the list of simulated prices if there is payment involved for the membership scheme (Membership Plan is optional for pre-allotted members) along with the list of error messages occurred during the member update. see Table 209. then the member directly goes into the ‘Active’ status. Siebel CRM Web Services Reference Version 8.1 12 9 . along with the Simulated prices for enrollment. this Web service method enrolls the member into ‘Payment Pending’ status. If the Enrollment entails a payment. If there is no Payment required. it sends across the member data along with the error message or messages.

Siebel 8.1 Primary Web Services ■ LoyaltyBatchEnrollment

Table 209. LoyaltyBatchEnrollment Operations Name EnrollmentPaymentProcessing Description Used to process the enrollment payment for the selected member, who is in the ‘Payment Pending’ Status. If the payment processing is successful then the member status becomes ‘Active’, otherwise the status will remain in ‘Payment Pending’. This Web service returns the list of error messages occurred during the payment processing. GeneratePreallottedMemberships Used to generate the specified number of membership numbers for the given Loyalty Program. The status of all these memberships.

Request Message Description: MemberEnrollment For a description of this request message, see Table 210. Table 210. Request Message Description: MemberEnrollment Node Siebel Message Description Hierarchy of the Member details. Uses the Integration Object ‘LOY Member’ Required Input: ■ ■ ■ ■ ■ ■ Action Type must be Enrollment. Program Id. Membership Scheme Id. Member Type. Contact Details. Account/Household details based on the member type. Type Hierarchy (Integration Object : LOY Member).

130

Siebel CRM Web Services Reference Version 8.1

Siebel 8.1 Primary Web Services ■ LoyaltyBatchEnrollment

Response Message Description: MemberEnrollment For a description of this response message, see Table 211. Table 211. Response Message Description: MemberEnrollment Node Siebel Message Description Hierarchy of the Member details. If there is any error in the processing of the member details, then the property set returns the entire member details along with the error messages. If the member is created successfully and payment is involved for the membership scheme, then the property set contains the enrolment simulated price lists. Type Hierarchy (Integration Object : LOY Member).

Request Message Description: MemberUpdate For a description of this request message, see Table 212. Table 212. Request Message Description: MemberUpdate Node Siebel Message Description Hierarchy of the Member details. Uses the Integration Object LOY Member. Required Input: ■ ■ Action type must be ‘Update’. Member Number. Type Hierarchy (Integration Object : LOY Member)

Response Message Description: MemberUpdate For a description of this response message, see Table 213. Table 213. Response Message Description: MemberUpdate Node Siebe lMessage Description Hierarchy of the Member details. If there is any error in the processing of the member details, then the property set returns the entire member details along with the error messages. If the member is is in ‘pre-allotted’ status and the supplied membership scheme has payment, then the property set contains the enrolment simulated price lists. Type Hierarchy

Siebel CRM Web Services Reference Version 8.1

13 1

Siebel 8.1 Primary Web Services ■ LoyaltyBatchEnrollment

Request Message Description: EnrolmentPaymentProcessing For a description of this request message, see Table 214. Table 214. Request Message Description: EnrolmentPaymentProcessing Node Member Number Credit Card Number Card Holder Name Credit Card Type Expiration Month Expiration Year CVV Number Billing Address Billing Address2 Billing City Billing State Billing Country Billing Zip Code Amount Base Pay Currency Code Description Member number. Credit card number. Name of the credit card holder. Credit Card Type such as Visa, MasterCard, and so on. Expiration Month of the credit card. Expiration year of the credit card. CVV number of the credit card. Primary billing address of the member. Secondary billing address of the member. Billing address city. Billing address state. Billing address country. Billing address Zip code. Simulated Amount. Base price of the membership plan. Currency Code. Type String String String String String String String String String String String String String Number Number String

Response Message Description: EnrolmentPaymentProcessing For a description of this response message, see Table 215. Table 215. Response Message Description: EnrolmentPaymentProcessing Node MemberNumber Status Payment Errors Description Member Number. Status of the Member. The list of error messages occurred during the enrolment payment processing. Type String String Hierarchy (Integration Object: LOY ENR Payment Errors)

132

Siebel CRM Web Services Reference Version 8.1

Siebel 8.1 Primary Web Services ■ LoyaltyBatchEnrollment

Request Message Description: GeneratePreAllottedMemberships For a description of this request message, see Table 216. Table 216. Request Message Description: GeneratePreAllottedMemberships Node Program Id Number of Members Description Program Id. The total number of pre-allotted memberships to be generated. Type String Number

Response Message Description: GeneratePreAllottedMemberships For a description of this response message, see Table 217. Table 217. Response Message Description: GeneratePreAllottedMemberships Node MemberNumbers Description The hierarchy of the list of membership numbers generated in ‘Pre-allotted’ status. Type Hierarchy (Integration Object: LOY Preallotted Member)

Example Package for LoyaltyBatchEnrollment
To view an example of messages for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

Request See the following file to view the sample code: …\LoyaltyBatchEnrollment\LoyaltyBatchEnrollment_request.xml

Response See the following file to view the sample code: …\LoyaltyBatchEnrollment\LoyaltyBatchEnrollment_response.xml

Message Schema (WSDL) for LoyaltyBatchEnrollment
To view the message schema for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file. See the following file to view the message schema: …\LoyaltyBatchEnrollment\LoyaltyBatchEnrollment.wsdl

Siebel CRM Web Services Reference Version 8.1

13 3

Siebel 8.1 Primary Web Services ■ LoyaltyImportBusinessService

LoyaltyImportBusinessService
Use this Web Service with the Siebel Loyalty Application to perform all voucher related service operations, such as Voucher Validity Check and Status Change.

LoyaltyImportBusinessService Operations
For a list of operations associated with this Web service, see Table 218. Table 218. LoyaltyImportBusinessService Operations Name VoucherImport Description Takes in the File Name, Service Name, Method Name, File Format and Integration Object Name as input and processes the redemption availment transaction for those records sent in the File mentioned in the input. Generates the Log file with the same file name append with the current timestamp.

Request Message Description: VoucherImport This operation takes in the File Name, Service Name, Method Name, File Format and Integration Object Name as input and processes the redemption availment transaction for those records sent in the File mentioned in the input. It generates the Log file with the same file name appended with a current timestamp. For a description of this request message, see Table 219.

Table 219. Request Message Description: VoucherImport Node File Format File Name IO Name Method Name Service Name Description String String String String String Type Required Required Required Required Required

Response Message Description: VoucherImport For a description of this response message, see Table 220. Table 220. Response Message Description: VoucherImport Node ValidFlag Description Required Type String

134

Siebel CRM Web Services Reference Version 8.1

Siebel 8.1 Primary Web Services ■ LoyaltyMemberService

Example Package for LoyaltyImportBusinessService
To view an example of messages for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

Request See the following file to view the sample code: …\LoyaltyImportBusService\LoyaltyImportBusService_request.xml

Response See the following file to view the sample code: …\LoyaltyImportBusService\LoyaltyImportBusService_response.xml

Message Schema (WSDL) for LoyaltyImportBusinessService
To view the message schema for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file. See the following file to view the message schema: …\LoyaltyImportBusService\LoyaltyImportBusService.wsdl

LoyaltyMemberService
Use this Web service to do the following member service actions: ■ ■ ■ ■ Inquire membership details Process membership information for Renewal or Cancellation Retrieve member service price details Purchase or Transfer points

Siebel CRM Web Services Reference Version 8.1

13 5

Siebel 8.1 Primary Web Services ■ LoyaltyMemberService

LoyaltyMemberService Operations
For a list of operations associated with this Web service, see Table 221 Table 221. LoyaltyMemberService Operations Name PurchasePointsService Description Web service for Purchasing Points. Member should give membership number and point type he/she would want to purchase and number of points as input. Credit card details are also to be given as the service might involve monetary payment. Once the service is complete, out put is given as xml that shows transaction number and order number. Member point balances would be updated accordingly and reflected in the application. TransferPointsService Web service for Transferring points to another member. Member should give membership number, point type he/she would want to purchase and number of points as input. Transferee Member Number should also be mentioned in the input. Credit card details are also to be given as the service might involve monetary payment. Once the service is performed, out put is given as xml that shows transaction number and order number. Members’ (transferor and transferee) point balances would be updated accordingly and reflected in the application. LoungePurchaseService Web service to buy or renew Lounge. Member should give membership number, lounge period type and lounge period duration along with credit card details. He/she should also give payment mode (pay/points/points+pay) along with currency and point type details as the service might involve payment. After the service is performed, Member’s Lounge details would be updated and a transaction details are created. MembershipCancellationService Web service to cancel loyalty membership. Member should give membership number and credit card details (same as the card details used during membership enrollment or renewal). Fee would be refunded to the card given and membership would be cancelled after the service is performed. The credit card details should be same as what was used in the last payment (Enrolment / Renewal) transaction, done by the member.

136

Siebel CRM Web Services Reference Version 8.1

Siebel 8.1 Primary Web Services ■ LoyaltyMemberService

Table 221. LoyaltyMemberService Operations Name RenewMembershipService Description Web service to renew loyalty membership Member can use this web service to renew membership if he/she is not enrolled into lifetime membership scheme. Member should give Membership Number and Membership Scheme along with payment details (payment mode, Credit Card details and Point Type details) as the input. Membership dates would be updated along with the membership scheme after the service is performed successfully. GetMemberServicePrice the various Member Services Member should give membership number and member service name to obtain price lists in different payment modes. Out put would be an Integration Object that can be seen as XML file. MemberInquiry Web service used to query for Member(s) given the Member Names, Member Number, and so on. The output details would include Member Loyalty info, Contact Addresses, Phone numbers, and Email addresses, and so on.

Request Message Description: PurchasePointsService For a description of this request message, see Table 222. Table 222. Request Message Description: PurchasePointsService Node Member Number Description Membership Number. It is a mandatory input. Loyalty Membership Number of the person for whom the service is to be performed is to be given. Point Type Points Billing Address Billing Address2 The type of Point member wants to purchase is to be given. It is a mandatory input. The number of Points member wants to purchase is to be given. It is a mandatory input. Member billing address. It is required if the payment involves monetary currency and Credit Card details are mentioned. Secondary member billing address. It is required if the payment involves monetary currency and Credit Card details are mentioned. Member billing city. It is required if the payment involves monetary currency and Credit Card details are mentioned. String String String String Type String

Billing City

String

Siebel CRM Web Services Reference Version 8.1

13 7

If the member wants to override the price details. It is required if the payment involves monetary currency. It is required if the payment involves monetary currency and Credit Card details are mentioned. It is required if the payment involves monetary currency and Credit Card details are mentioned.Siebel 8. else it would be N. It is required if the payment involves monetary currency and Credit Card details are mentioned. such as Visa. It is a mandatory input. and so on. It is required if the payment involves monetary currency. It is required if the payment involves monetary currency and Credit Card details are mentioned. Credit card type. Member billing Zip code. Expiration year of member credit card. It is required if the payment involves monetary currency. Member should mention Override Pay when Override flag given is Y. It is required if the payment involves monetary currency. Credit card number. input would be Y. MasterCard.1 . It is the Monetary Amount overridden by the member. Loyalty Membership Number of the person for whom the service is to be performed is to be given. Expiration month of member credit cards. Type String String String String Card Holder Name Credit Card Number Credit Card Type Currency Expiration Month Expiration Year Member Number Override Flag Override Pay Override Reason Override Reason Code String String String String String String String String String String String 138 Siebel CRM Web Services Reference Version 8. It is a mandatory input. It is required if the payment involves monetary currency. Credit card holder name. CVV number from member credit card. Request Message Description: PurchasePointsService Node Billing Country Billing State Billing ZipCode CVV Number Description Member billing country. Member billing state. It is required as the payment involves monetary currency. Reason to override the pricelist is to be mentioned if the Override Flag is Y.1 Primary Web Services ■ LoyaltyMemberService Table 222. Currency type used by member. Membership Number.

Table 224. Order Id of the Point Purchase Service is given. Table 223. It is a mandatory input.Siebel 8. Member billing state. Secondary member billing address. Request Message Description: TransferPointService Node Member Number Point Type Points Transferee Member Number Billing Address Billing Address2 Billing City Billing Country Billing State Billing ZipCode Description Membership Number. Type String String String String String String Request Message Description: TransferPointService For a description of this request message. It is required if the payment involves monetary currency and Credit Card details are mentioned. Transferee Membership Number to whom the points are to be transferred. Response Code given by Siebel Order Management after authorizing credit card is sent in the output. see Table 223. Type String String String String String String String String String String Siebel CRM Web Services Reference Version 8. see Table 224. Member billing city. It is a mandatory input. It is required if the payment involves monetary currency and Credit Card details are mentioned. Member billing country. Response Message given by Siebel Order Management after authorizing credit card is sent in the output. The type of Point member wants to transfer is to be given. It is required if the payment involves monetary currency and Credit Card details are mentioned. The number of Points member wants to purchase is to be given. It is required if the payment involves monetary currency and Credit Card. It is a mandatory input. Transaction Number of the Point Purchase Service is given in the output. Response Message Description: PurchasePointsService Node Error Message Order Id Quote Id Siebel Response Code Siebel Response Message Transaction Number Description Error message if the transaction fails is given.1 Primary Web Services ■ LoyaltyMemberService Response Message Description: PurchasePointsService For a description of this response message. Member billing address. It is required if the payment involves monetary currency and Credit Card details are mentioned. Quote Id of the Point Purchase Service is given.1 13 9 . Loyalty Membership Number of the person for whom the service is to be performed is to be given.

Response Message Description: TransferPointService Node Error Message Order Id Quote Id Siebel Response Code Description Error message if the transaction fails is given. Reason to override the pricelist is to be mentioned if the Override Flag is Y. Type String String Credit Card Number Credit Card Type Currency Expiration Month Expiration Year Override Flag Override Pay Override Reason Override Reason Code String String String String String String String String String Response Message Description: TransferPointService For a description of this response message. Request Message Description: TransferPointService Node CVV Number Card Holder Name Description Member billing Zip code. If the member wants to override the price details.1 Primary Web Services ■ LoyaltyMemberService Table 224. Type String String String String 140 Siebel CRM Web Services Reference Version 8. It is required if the payment involves monetary currency. It is required if the payment involves monetary currency and Credit Card details are mentioned. It is required if the payment involves monetary currency. such as Visa. Expiration year of member credit card. see Table 225. Quote Id of the Point Transfer Service is given. else it would be N. It is required if the payment involves monetary currency and Credit Card details are mentioned. Credit card holder name. and so on.Siebel 8. Currency type used by member. Credit card number. Table 225. It is a mandatory input. Response Code given by Siebel Order Management after authorizing credit card is sent in the output. It is required if the payment involves monetary currency. input would be Y. Credit card type. It is required if the payment involves monetary currency. CVV number from member credit card. MasterCard. Member should mention Override Pay when Override flag given is Y. Order Id of the Point Transfer Service is given. It is required if the payment involves monetary currency.1 . Expiration month of member credit cards. It is required as the payment involves monetary currency. It is the Monetary Amount overridden by the member.

It is required if the payment involves monetary currency and credit card details are mentioned. It is required if the payment involves monetary currency and credit card details are mentioned. Type String String Request Message Description: LoungePurchaseService For a description of this request message. Table 226.Siebel 8. Type String String Lounge Period Duration Billing Address Billing Address2 String String String Billing City Billing Country Billing State String String String Billing ZipCode CVV Number String String Card Holder Name String Credit Card Number String Siebel CRM Web Services Reference Version 8. It is required if the payment involves monetary currency and credit card. Member billing state. It is required if the payment involves monetary currency and credit card details are mentioned. Secondary member billing address. Member billing country. It is required if the payment involves monetary currency and credit card details are mentioned. It is required if the payment involves monetary currency and credit card details are mentioned.1 14 1 . It is a mandatory input. Lounge period type as months or years. Member billing city. Lounge period duration for the number of months or years the member want to renew his lounge.1 Primary Web Services ■ LoyaltyMemberService Table 225. CVV number from member credit card. Loyalty Membership Number of the person for whom the service is to be performed is to be given. It is required if the payment involves monetary currency. Response Message Description: TransferPointService Node Siebel Response Message Transaction Number Description Response Message given by Siebel Order Management after authorizing credit card is sent in the output. Request Message Description: LoungePurchaseService Node Member Number Lounge Period Type Description Membership Number. It is required if the payment involves monetary currency and credit card details are mentioned. see Table 226. Member billing address. Credit card holder name. Transaction Number of the Point Transfer Service is given in the output. Member billing ZIP code.

Member should mention Override Pay when Override flag given is Y. Response Message Description: LoungePurchaseService Node Error Message Order Id Quote Id Siebel Response Code Description Error message if the transaction fails is given. else it would be N. Credit card type. Type String String String String String String String Override Reason String Override Reason Code. and so on. It is a mandatory input. It is required as the payment involves monetary currency. If the member wants to override the price details. Payment Mode Point Type String String String Response Message Description: LoungePurchaseService For a description of this response message. It is the Monetary Amount overridden by the member. Override Reason Code is to be mentioned if the Override Flag is Y. see Table 227. Response Code given by Siebel Order Management after authorizing credit card is sent in the output.1 . Table 227.Siebel 8. Expiration year of member credit card. input would be Y. It is required if the payment involves monetary currency. It is required if the payment involves monetary currency. It is a mandatory input. Reason to override the pricelist is to be mentioned if the Override Flag is Y. Member should mention Override Points when Override flag given is Y and the payment mode selected is Points or Points + Pay. Request Message Description: LoungePurchaseService Node Credit Card Type Currency Expiration Month Expiration Year Override Flag Override Pay Override Points Description Credit card number. Currency type used by member. Expiration month of member credit cards. Type String String String String 142 Siebel CRM Web Services Reference Version 8. such as Visa. MasterCard. Quote Id of the Lounge Purchase Service is given. Order Id of the Lounge Purchase Service is given.1 Primary Web Services ■ LoyaltyMemberService Table 226. It is required if the payment involves monetary currency. It is required if the payment involves monetary currency. Payment mode as Points or Points + Pay or Pay.

It is required if the payment involves monetary currency and Credit Card details are mentioned. Loyalty Membership Number of the person for whom the service is to be performed is to be given. Transaction Number of the Lounge Purchase Service is given in the output. It is a mandatory input. It is required if the payment involves monetary currency. It is required if the payment involves monetary currency and Credit Card details are mentioned. Request Message Description: RenewMembershipService Node Member Number Membership Scheme Billing Address Billing Address2 Billing City Billing Country Billing State Billing ZipCode CVV Number Card Holder Name Description Membership Number. Credit card type. Credit card holder name. and so on. see Table 228.1 14 3 . Type String String String String String String String String String String Credit Card Number Credit Card Type Currency String String String Siebel CRM Web Services Reference Version 8. It is required if the payment involves monetary currency. It is a mandatory input. Table 228.1 Primary Web Services ■ LoyaltyMemberService Table 227. It is required if the payment involves monetary currency and Credit Card details are mentioned. MasterCard.Siebel 8. It is required if the payment involves monetary currency. Member billing address. Secondary member billing address. Member billing state. It is required if the payment involves monetary currency and Credit Card details are mentioned. It is required if the payment involves monetary currency and Credit Card details are mentioned. Member billing city. Type String String Request Message Description: RenewMembershipService For a description of this request message. Membership Scheme to which the member wants to be renewed is to be given. CVV number from member credit card. Response Message Description: LoungePurchaseService Node Siebel Response Message Transaction Number Description Response Message given by Siebel Order Management after authorizing credit card is sent in the output. Member billing country. Credit card number. It is required if the payment involves monetary currency and Credit Card. Member billing Zip code. It is required if the payment involves monetary currency and Credit Card details are mentioned. such as Visa.

Response Code given by Siebel Order Management after authorizing credit card is sent in the output.1 Primary Web Services ■ LoyaltyMemberService Table 228. Reason to override the pricelist is to be mentioned if the Override Flag is Y. input would be Y. Member should mention Override Pay when Override flag given is Y. see Table 229. Expiration month of member credit cards. Order Id of the Renew Membership Service is given. Transaction Number of the Renew Membership Service is given in the output. Override Reason Code is to be mentioned if the Override Flag is Y. Response Message given by Siebel Order Management after authorizing credit card is sent in the output. It is a mandatory input.1 . Expiration year of member credit card. Type String String String String String String Override Reason Code Payment Mode Point Type String String String Response Message Description: RenewMembershipService For a description of this response message. It is required as the payment involves monetary currency. Quote Id of the Renew Membership Service is given. Request Message Description: RenewMembershipService Node Expiration Month Expiration Year Override Flag Override Pay Override Points Override Reason Description Currency type used by member. Member should mention Override Points when Override flag given is Y and the payment mode selected is Points or Points + Pay. Response Message Description: RenewMembershipService Node Error Message Order Id Quote Id Siebel Response Code Siebel Response Message Transaction Number Description Error message if the transaction fails is given. Payment mode as Points or Points + Pay or Pay. Table 229.Siebel 8. It is required if the payment involves monetary currency. It is a mandatory input. else it would be N. It is the Monetary Amount overridden by the member. It is required if the payment involves monetary currency. If the member wants to override the price details. Type String String String String String String 144 Siebel CRM Web Services Reference Version 8.

Member should mention Override Pay when Override flag given is Y.1 14 5 . This is required when the refund basis is Percentage or Prorata.1 Primary Web Services ■ LoyaltyMemberService Request Message Description: MembershipCancellationService For a description of this request message. Reason for the membership cancellation is to be mentioned here. input would be Y. This is required when the refund basis is Percentage or Prorata. Type String String String String String String Credit Card Type String Expiration Month String Expiration Year String Override Flag String Override Pay String Siebel CRM Web Services Reference Version 8. Fee will be refunded to the card number given. Membership Cancellation Reason Code is to be given. It is a mandatory input. Refund percentage is to be given if the selected fee refund basis is Percentage. Request Message Description: MembershipCancellationService Node Member Number Fee Refund Basis Refund Percentage Cancellation Reason Cancellation Reason Code Credit Card Number Description Membership number of the member whose membership has to be cancelled is given here. If the member wants to override the Refund Price details. Table 230. Credit card type (Visa or Master Card etc) is to be given as the same one mentioned in last enrolment or renewal transaction (whichever is the latest). Expiration Year is to be given as the same one mentioned in last enrolment or renewal transaction (whichever is the latest). This is required when the refund basis is Percentage or Prorata. if it matches with the previous renewal or enrolment transaction’s credit card details. Fee will be refunded to the card number given.Siebel 8. It is the Refund amount overridden by the member. It is a mandatory input. see Table 230. else it would be N. Prorata or Percentage or NoRefund can be given here. if it matches with the previous renewal or enrolment transaction’s credit card details. This is required when the refund basis is Percentage or Prorata. Expiration month is to be given as the same one mentioned in last enrolment or renewal transaction (whichever is the latest). Fee refund basis is the mandatory input. Credit card number is to be given as the same one mentioned in last enrolment or renewal transaction (whichever is the latest). It is a mandatory input.

Lounge Period Duration is to be given if the Transaction Sub Type is Lounge Purchase. Response Message Description: MembershipCancellationService Node Currency Error Message Order Id Quote Id Refund Amount Siebel Response Code Siebel Response Message Transaction Number Description Currency in which the fee is refunded is given as output. Type String String String String 146 Siebel CRM Web Services Reference Version 8. Transaction number of the Membership Cancellation is mentioned. Response code given by Siebel Order Management after authorizing credit card is sent in the output. Refund Order Id of the Membership Cancellation Service is given.1 Primary Web Services ■ LoyaltyMemberService Table 230. Currency in which the fee is refunded is given as output. Lounge Period Type (Months or Years etc) is to be given if the Transaction Sub Type is Lounge Purchase. see Table 231. see Table 232. Currency code is to be given if the member wants to get price lists in the given currency only. Response Message given by Siebel Order Management after authorizing credit card is sent in the output. Refund amount is given in the output. Error message if the transaction fails is given. Type String String Response Message Description: MembershipCancellationService For a description of this response message. Table 232. Table 231. Type String String String String String String String String Request Message Description: GetMemberServicePrice For a description of this request message.1 . Override Reason Code is to be given if the Override Flag is Y. Request Message Description: GetMemberServicePrice Node Member Number Currency Code Lounge Period Duration Lounge Period Type Description Membership number of the member who wants to get member service price details is to be given here. Request Message Description: MembershipCancellationService Node Override Reason Override Reason Code Description Reason for overriding price is mentioned here.Siebel 8.

Request Message Description: MemberInquiry Node Member Number Email Address First Name Last Name Middle Name Telephone Number Transaction Type ZIP Code Description Membership Number of the member whose details are to be inquired is given. It is a mandatory input. ZIP code of the member whose details are to be inquired is given.1 Primary Web Services ■ LoyaltyMemberService Table 232. Transaction type is given to query on the given type of transactions done by the member. Response Message Description: GetMemberServicePrice Node Integration Object of the Pricelists Description List of price lines. see Table 233. Telephone number of the member whose details are to be inquired is given.Siebel 8. Table 234. First name of the member whose details are to be inquired is given. Type String Points Qty Selected Membership Scheme Transaction Sub Type String String String Response Message Description: GetMemberServicePrice For a description of this response message.1 14 7 . Member Service Type (Points Purchase/Transfer Points/ Membership Renewal/Lounge Purchase) is to be mentioned. Type Integration Object Request Message Description: MemberInquiry For a description of this request message. after applying the promotions on the base prices. Membership Scheme is to be mentioned in the input if the Transaction Sub Type is Membership Renewal. Type String String String String String String String String Siebel CRM Web Services Reference Version 8. Last name of the member whose details are to be inquired is given. Middle name of the member whose details are to be inquired is given. Table 233. are given in the out put as XML file. Email address of the member whose details are to be inquired is given. Number of Points to be given if the Transaction Sub Type is Purchase Points or Transfer Points. Request Message Description: GetMemberServicePrice Node Point Type Description Point Type is to be given here if the member wants to see price lists of Points or Points + Pay mode in the given point type. see Table 234.

see Table 235.xml Response (PurchasePointsService) See the following file to view the sample code: …\LoyaltyMemberServices\PointPurchase_response. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network.1 . Extract the files in the zip file.xml Response (TransferPointsService) See the following file to view the sample code: …\LoyaltyMemberServices\TransferPoints_response. Table 235.xml Request (LoungePurchaseService) See the following file to view the sample code: …\LoyaltyMemberServices\LoungePurchase_request.1 Primary Web Services ■ LoyaltyMemberService Response Message Description: GetMemberServicePrice For a description of this response message.xml 148 Siebel CRM Web Services Reference Version 8.Siebel 8. Type Integration Object Example Package for LoyaltyMemberServices To view an example of messages for this Web service. Response Message Description: GetMemberServicePrice Node Siebel Message (Integration Object of the LOY Member Inquiry) Description Member details are given in the Integration Object and can be extracted as XML file.xml Request (TransferPointsService) See the following file to view the sample code: …\LoyaltyMemberServices\TransferPoints_request. Request (PurchasePointsService) See the following file to view the sample code: …\LoyaltyMemberServices\PointPurchase_request.xml Response (LoungePurchaseService) See the following file to view the sample code: …\LoyaltyMemberServices\LoungePurchase_response.

and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.xml Request (GetMemberServicePrice) See the following file to view the sample code: …\LoyaltyMemberServices\GetServicePrice_request.xml Request (RenewMembershipService) See the following file to view the sample code: …\LoyaltyMemberServices\RenewMembershipService_request.xml Response (MemberInquiry) See the following file to view the sample code: …\LoyaltyMemberServices\MemberInquiry_response.xml Response (GetMemberServicePrice) See the following file to view the sample code: …\LoyaltyMemberServices\GetServicePrice_response.xml Response (MembershipCancellationService) See the following file to view the sample code: …\LoyaltyMemberServices\MembershipCancellationService_response.xml Request (MemberInquiry) See the following file to view the sample code: …\LoyaltyMemberServices\MemberInquiry_request. Siebel CRM Web Services Reference Version 8.1 14 9 .xml Response (RenewMembershipService) See the following file to view the sample code: …\LoyaltyMemberServices\RenewMembershipService_response. Extract the files in the zip file.1 Primary Web Services ■ LoyaltyMemberService Request (MembershipCancellationService) See the following file to view the sample code: …\LoyaltyMemberServices\MembershipCancellationService_request.xml Message Schema (WSDL) for LoyaltyMemberServices To view the message schema for this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network.Siebel 8.

ProcessQuote Takes Quote Id as input and converts the quote to order and order to redemption transactions. If loan is not possible it does the point to pay conversion and returns the prorated pay and points for each transaction. Also performs the credit check and returns how much loan is required for each point type. Checks whether loan is required and returns how much loan is required to fulfill the redemption transaction. Returns available price options for a set of redemption activities. Returns available price options for a set of redemption activities. Table 236. Also creates a quote using the given redemption activities (transactions). CheckCredit GetQuote GetTransactionDetails GetRedemptionRefund 150 Siebel CRM Web Services Reference Version 8. LoyaltyRedemptionService Operations Name GetPriceOptions CheckPriceOptions Description Returns available price options for a set of redemption activities. Then processes those transactions. which need to be cancelled. Voucher Reissue and Order Management Integration. Performs the credit check for a given member and point type. see Table 236. Takes as input an Order Number and returns the Transaction details (including activities and Transaction Items if any) for the same.1 . including Redemption Processing. Also performs the credit check and returns how much loan is required for each point type.Siebel 8.wsdl LoyaltyRedemptionService User this Web service with the Siebel Loyalty Application to perform all redemption related operations. Returns the refund in Points or Points plus Pay for a given redemption transaction. LoyaltyRedemptionService Operations For a list of operations associated with this Web service. If loan is not possible it does the point to pay conversion and returns the prorated pay and points for each transaction. Also returns the point balance of the member in all point types. credit card details (optional) and shipping details (optional).1 Primary Web Services ■ LoyaltyRedemptionService See the following file to view the message schema: …\LoyaltyMemberService\LoyaltyMemberServices. Redemption Cancellation.

Takes as input Quote Id. Takes the chosen fee option details for a voucher.Siebel 8.1 Primary Web Services ■ LoyaltyRedemptionService Table 236. credit card details (optional). and creates a quote with the given data. Contains point balances of the member in all point types. see Table 237. Type Integration Object (Required) Response Message Description: GetPriceOptions For a description of this response message. Table 238. Returns the different fee options for reissuing the given voucher. GetReissueFeeOptions CheckReissueFeeOption GetReissueQuote ProcessReissueQuote UpdateQuoteShippingAddress AddCreditCardToQuote Request Message Description: GetPriceOptions For a description of this request message. does credit check if the payment mode involves points. billing address and updates the quote with the credit card details. see Table 238. Table 237. and whether the member has enough points to pay in this fee option if the payment mode involves Points. Checks whether a given fee option for a voucher is valid. Request Message Description: GetPriceOptions Node LOY Redemption Txn Description Contains the redemption activity details. creates Order for Quote. and creates a Loyalty Voucher Reissue transaction and processes it to reissue the voucher. Response Message Description: GetPriceOptions Node LOY Redemption Txn LOY Redemp Points Summary Description Contains the redemption activity details and the price options for each activity. checks whether the fee option is valid. Takes Quote Id and shipping details and updates the quote with the given shipping address. Type Integration Object (Required) Integration Object (Required) Siebel CRM Web Services Reference Version 8. Takes Quote Id. shipping details (optional). LoyaltyRedemptionService Operations Name CancelRedemptionTxn Description Takes the redemption transaction ID which need to be cancelled and the refund amount (either unmodified / overridden refund amount got from the GetRedemptionRefund method) and creates the cancellation transaction and processes it. credit card details.1 15 1 .

Currency if monetary payment is involved. Request Message Description: CheckCredit Node MemberNumber PointTypeId PointsReq LoanFlag Description Membership number. Point Summary for each point type including points to be paid. loan (if any) and Points to Pay Conversion flag. see Table 239.1 Primary Web Services ■ LoyaltyRedemptionService Request Message Description: CheckPriceOptions For a description of this request message. Table 240. see Table 240. Type String String Number String 152 Siebel CRM Web Services Reference Version 8. see Table 241. Request Message Description: CheckPriceOptions Node LOY Redemption Txn Description Contains the redemption activity details. Type Integration Object (Required) Response Message Description: CheckPriceOptions For a description of this response message. For a description of this request message. The required number of points. Table 239. point balance.Siebel 8. Type Integration Object Integration Object Number String Request Message Description: CheckCredit This operation performs a credit check for a given member and point type. Table 241. Total amount to be paid if monetary payment is involved. Id number for point type. Response Message Description: CheckPriceOptions Node LOY Redemption Txn LOY Redemp Points Summary Pay Pay Currency Code Description Contains the redemption activity details and one price option for each activity. Checks whether loan is required and returns how much loan is required to fulfill the redemption transaction.1 . Indicates whether loan limit should be considered.

Request Message Description: GetQuote Node LOY Redemption Txn Billing Address Billing Address2 Shipping Method Ship To Street Address Ship To Street Address 2 Ship To State Ship To Postal Code Ship To Country Billing City Billing Country Billing State Billing ZipCode CVV Number Description Contains the redemption activity details.1 Primary Web Services ■ LoyaltyRedemptionService Response Message Description: CheckCredit For a description of this response message. Response Message Description: CheckCredit Node CCResult Available Balance EligLoan Error Message LoanAllowed LoanFlag PointsShortage Required Description Required Required Type String String Number String String String String Request Message Description: GetQuote This operation creates a quote using the given redemption activities (transactions). Billing ZIP code. For a description of this request message.Siebel 8. see Table 242. Billing state. if necessary of customer being billed. if different from shipping address. Air or carrier name. credit card details (optional) and shipping details (optional). Second shipping street address if needed. Table 242. see Table 243. Address of customer being billed. Shipping state. Shipping Country. Billing city. if different from shipping address. Table 243.1 15 3 . Shipping method. Type Integration Object String String String String String String String String String String String String String Siebel CRM Web Services Reference Version 8. such as Ground. Second address. Shipping street address. if different from shipping address. if different from shipping address. Shipping postal code. Billing country.

Name of person who will receive shipped goods. Check to save shipping address for future use. point balance. Table 244. Expiration year of credit card.1 Primary Web Services ■ LoyaltyRedemptionService Table 243. Flag to indicate primary address for account. Type String String String String String String String String String String String Response Message Description:GetQuote For a description of this response message. and so on.Siebel 8. Total amount of transaction.1 . Credit card number. Response Message Description:GetQuote Node LOY Redemption Txn LOY Redmp Points Summary Currency Code Shipping Charge Quote Id Pay Tax Description Contains the redemption activity details and one price option for each activity. Shipping charge for transaction. Total taxed charged on transaction. Id of quote that is created. American Express. Point Summary for each point type including points to be paid. Code to indicate which currency being used for transation. Credit card line number. see Table 244. Request Message Description: GetQuote Node Card Holder Name Credit Card Expiration Month Credit Card Expiration Year Credit Card Line Number Credit Card Number Credit Card Type Recipient Name Save Shipping Address Flag Select Primary Shipping Address Flag Ship To Address Id Ship To City Description Name of credit card holder. Expiration date of credit card. such as Visa. loan (if any) and Points to Pay Conversion flag. Type Integration Object Integration Object String String String Number Number 154 Siebel CRM Web Services Reference Version 8. Credit cards type.

Siebel CRM Web Services Reference Version 8. Request Message Description: GetTransactionDetails Node Order Number Description Required Type String Response Message Description: GetTransactionDetails For a description of this response message. Response Message Description: Process Quote Node Status Order Id Required Description Type String String Request Message Description: GetTransactionDetails For a description of this request message. Table 246.Siebel 8. It then processes these transactions. see Table 246. see Table 248. Request Message Description: ProcessQuote Node Quote Id Description String Type Required Response Message Description: Process Quote For a description of this response message.1 Primary Web Services ■ LoyaltyRedemptionService Request Message Description: ProcessQuote This operation converts a quote to an order and an order to redemption transactions. Table 245. Response Message Description: GetTransactionDetails Node LOY Redemption Txn Description Contains details of the redemption transactions that have been created for this order along with transaction items for each transaction in case of package transaction. see Table 247. Type Integration Object.1 15 5 . Table 247. For a description of this request message. see Table 245. Table 248.

For a description of this request message. which is then cancelled.1 . see Table 249.Siebel 8. Request Message Description: CancelRedemptionTxn Node Override Expiry Date Override Expiry Date Flag Override Pay Override Points Override Price Flag Transaction Id Override Reason Code Payment Mode Simulate Pay Override Reason Required Required Description Type String String String String String String String String String String 156 Siebel CRM Web Services Reference Version 8. Table 251. Request Message Description: GetRedemptionRefund Node Transaction Id Description Required Type String Response Message Description: GetRedemptionRefund For a description of this response message.For a description of this request message. see Table 250. Table 250. Response Message Description: GetRedemptionRefund Node Pay Point Type Points Currency Payment Type Required Required Required Description Type String String String String String Request Message Description: CancelRedemptionTxn This operation takes the redemption transaction ID which requires cancellation as well as the refund amount (either the unmodified or overridden refund amount gotten from the GetRedemptionRefund operation) and creates the cancellation transaction and processes it.1 Primary Web Services ■ LoyaltyRedemptionService Request Message Description: GetRedemptionRefund This operation returns the refund amount for given redemption transaction. Table 249. see Table 251.

see Table 253. Table 252. Request Message Description: GetReissueFeeOptions Node Currency Code Voucher Id Point Type Id Payment Type Code Required Required Description Type String String String String Response Message Description:GetReissueFeeOptions For a description of this response message. Table 254. Response Message Description:CancelRedemptionTxn Node New Txn Id Description Id of the cancellation transaction. Response Message Description:GetReissueFeeOptions Node Product Point Id Fee Points Fee Amount Error Message Description Required Type String Number Number String Request Message Description: GetReissueQuote This operation takes the chosen fee option details for a voucher. see Table 255. and creates a quote with the given data. see Table 254. Table 253. Request Message Description: GetReissueQuote Node Voucher Id Currency Code Description Required Type String String Siebel CRM Web Services Reference Version 8. checks whether the fee option is valid. For a description of this request message. does credit check if the payment mode involves points. Type String Request Message Description: GetReissueFeeOptions This operation returns available fee options for reissue of a voucher with given Id. shipping details (optional).1 Primary Web Services ■ LoyaltyRedemptionService Response Message Description:CancelRedemptionTxn For a description of this response message.Siebel 8. credit card details (optional). For a description of this request message.1 15 7 . Table 255. see Table 252.

Siebel 8. Request Message Description: GetReissueQuote Node Payment Type Code Point Type Id Override Amount Override Flag Override Points Override Reason Override Reason Code Billing Address Billing Address2 Shipping Method Ship To Street Address 2 Ship To Street Address Ship To State Ship To Postal Code Ship To Country Billing City Billing Country Billing State Billing ZipCode CVV Number Card Holder Name Credit Card Expiration Month Credit Card Expiration Year Credit Card Number Credit Card Type Recipient Name Save Shipping Address Flag Select Primary Shipping Address Flag Description Required Type String String Number String Number String String String String String String String String String String String String String String String String String String String String String String String 158 Siebel CRM Web Services Reference Version 8.1 .1 Primary Web Services ■ LoyaltyRedemptionService Table 255.

Table 256. see Table 258. Table 258.Siebel 8. Table 257. Response Message Description: GetReissueQuote Node Currency Code Quote Id Error Message Fee Amount Fee Points Shipping Charge Tax Amount Currency Code Required Description Type String String String Number Number String String String Request Message Description: ProcessReissueQuote This operation takes as input Quote Id. see Table 256. see Table 257.1 15 9 . creates and Order for Quote. Response Message Description: ProcessReissueQuote Node Transaction Number Order Number New Voucher Expiry Date Description Required Required Required Type String String Date Siebel CRM Web Services Reference Version 8. Request Message Description: GetReissueQuote Node Ship To Address Id Ship To City Description Type String String Response Message Description: GetReissueQuote For a description of this response message. and creates a Loyalty Voucher Reissue transaction and processes it to reissue the voucher. Request Message Description: ProcessReissueQuote Node Quote Id Description Required Type String Response Message Description: ProcessReissueQuote For a description of this response message.1 Primary Web Services ■ LoyaltyRedemptionService Table 255. For a description of this request message.

Siebel 8.1 Primary Web Services ■ LoyaltyRedemptionService Table 258. see Table 259. see Table 260. Table 261. Request Message Description: AddCreditCardToQuote Node Billing Address Billing Address 2 Billing City Billing Country Billing ZipCode CVV Number Card Holder Name Credit Card Number Credit Card Type Expiration Month Expiration Year Required Description Required Type String String String String String Number String Number String String String 160 Siebel CRM Web Services Reference Version 8. Table 260. Request Message Description: UpdateQuoteShippingAddress Node Quote Id Description Required Type String Response Message Description: UpdateQuoteShippingAddress For a description of this response message. billing address and updates the quote with the credit card details. see Table 261. Response Message Description: UpdateQuoteShippingAddress Node Shipping Charge Description Required Type String Request Message Description: AddCreditCardToQuote This operation takes the Quote Id. credit card details. For a description of this request message. Response Message Description: ProcessReissueQuote Node New Voucher Number New Voucher Status Description Required Required Type String String Request Message Description: UpdateQuoteShippingAddress This operation takes the Quote Id and shipping details and updates the quote with the given shipping address. For a description of this request message.1 . Table 259.

xml Request (CheckCredit) See the following file to view the sample code: …\LoyaltyRedemptionService\CheckCredit_request.xml Request (CheckPriceOptions) See the following file to view the sample code: …\LoyaltyRedemptionService\CheckPriceOptions_request. Request (GetPriceOptions) See the following file to view the sample code: …\LoyaltyRedemptionService\GetPriceOptions_request. Example Packages for LoyaltyRedemptionService To view an example of messages for this Web service.xml Response (CheckPriceOptions) See the following file to view the sample code: …\LoyaltyRedemptionService\CheckPriceOptions_response.1 16 1 .xml Response (GetPriceOptions) See the following file to view the sample code: …\LoyaltyRedemptionService\GetPriceOptions_response.Siebel 8. navigate to the documentation library for Siebel applications on Oracle Technology Network.1 Primary Web Services ■ LoyaltyRedemptionService Response Message Description: GetReissueQuote There are no response messages for this operation. Extract the files in the zip file.xml Siebel CRM Web Services Reference Version 8.xml Request (GetQuote) See the following file to view the sample code: …\LoyaltyRedemptionService\GetQuote_request.xm Response (CheckCredit) See the following file to view the sample code: …\LoyaltyRedemptionService\CheckCredit_response. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.

xml Response(GetTransactionDetails) See the following file to view the sample code: …\LoyaltyRedemptionService\GetTransactionDetails_response.Siebel 8.xml Response (ProcessQuote) See the following file to view the sample code: …\LoyaltyRedemptionService\ProcessQuote_response.xml Response (GetRedemptionRefund) See the following file to view the sample code: …\LoyaltyRedemptionService\GetRedemptionRefund_response.xml 162 Siebel CRM Web Services Reference Version 8.xml Request (ProcessQuote) See the following file to view the sample code: …\LoyaltyRedemptionService\ProcessQuote_request.xml Request (GetRedemptionRefund) See the following file to view the sample code: …\LoyaltyRedemptionService\GetRedemptionRefund_request.xml Request (GetTransactionDetails) See the following file to view the sample code: …\LoyaltyRedemptionService\GetTransactionDetails_request.xml Request (CancelRedemptionTxn) See the following file to view the sample code: …\LoyaltyRedemptionService\CancelRedemptionTxn_request.xml Response (CancelRedemptionTxn) See the following file to view the sample code: …\LoyaltyRedemptionService\CancelRedemptionTxn_response.1 Primary Web Services ■ LoyaltyRedemptionService Response (GetQuote) See the following file to view the sample code: …\LoyaltyRedemptionService\GetQuote_response.1 .

xml Request (GetReissueQuote) See the following file to view the sample code: …\LoyaltyRedemptionService\GetReissueQuote_request.xml Request (ProcessReissueQuote) See the following file to view the sample code: …\LoyaltyRedemptionService\ProcessReissueQuote_request.xml Request (AddCreditCardToQuote) See the following file to view the sample code: …\LoyaltyRedemptionService\AddCreditCardToQuote_request.xml Response(GetReissueFeeOptions) See the following file to view the sample code: …\LoyaltyRedemptionService\GetReissueFeeOptions_response.1 Primary Web Services ■ LoyaltyRedemptionService Request (GetReissueFeeOptions) See the following file to view the sample code: …\LoyaltyRedemptionService\GetReissueFeeOptions_request.xml Response(ProcessReissueQuote) See the following file to view the sample code: …\LoyaltyRedemptionService\ProcessReissueQuote_response.Siebel 8.1 16 3 .xml Request (UpdateQuoteShippingAddress) See the following file to view the sample code: …\LoyaltyRedemptionService\UpdateQuoteShippingAddress_request.xml Response (UpdateQuoteShippingAddress) See the following file to view the sample code: …\LoyaltyRedemptionService\UpdateQuoteShippingAddress_response.xml Response (GetReissueQuote) See the following file to view the sample code: …\LoyaltyRedemptionService\GetReissueQuote_response.xml Siebel CRM Web Services Reference Version 8.

See the following file to view the message schema: …\LoyaltyRedemptionService\LoyaltyRedemptionService.Siebel 8. Partner Id voucher number and activity date.wsdl LoyaltyVoucherService Use this Web service with the Siebel Loyalty Application to perform all Voucher related Web service operations. Request Message Description: VoucherValidityCheck Node Voucher Number Activity Date Member Number Partner Id Description Required Required Required Required Type String String String String 164 Siebel CRM Web Services Reference Version 8. LoyaltyVoucherService Operations For a list of operations associated with this Web service. Request Message Description: VoucherValidityCheck This operation takes in the membership number. This involves creation of Availment transaction and processing it in real time. activity date and change the status of the voucher to 'Used' in Real time. Extract the files in the zip file. to validate the voucher and return Success/Failure. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 Primary Web Services ■ LoyaltyVoucherService Response (AddCreditCardToQuote) See the following file to view the sample code: …\LoyaltyRedemptionService\AddCreditCardToQuote_response. navigate to the documentation library for Siebel applications on Oracle Technology Network. Table 263. partner name. see Table 262. voucher number. For a description of this request message. including Voucher Validity Check and Status Change.1 . Table 262. see Table 263. LoyaltyVoucherService Operations Name VoucherStatusChange Description Takes in the membership number.xml Message Schema (WSDL) for LoyaltyRedemptionService To view the message schema for this Web service.

voucher number. For a description of this request message. Extract the files in the zip file. partner name. Table 265. Request Message Description: VoucherStatusChange Node Voucher Number Member Number Partner Name Activity Date Order Number Description Optional Required Required Required Optional Type String String String String Number Response Message Description: VoucherStatusChange For a description of this response message. see Table 265. Response Message Description: VoucherValidityCheck Node Valid Flag Description Required Type String Request Message Description: VoucherStatusChange This operation takes in the membership number. see Table 266. see Table 264. activity date and change the status of the voucher to Used in real time.Siebel 8. Table 266. Request See the following file to view the sample code: …\LoyaltyVoucherService\LoyaltyVoucherService_request.1 Primary Web Services ■ LoyaltyVoucherService Response Message Description: VoucherValidityCheck For a description of this response message. Response Message Description: VoucherStatusChange Node Voucher Number Order Number Voucher Type Return Value Description Optional Optional Required Required Type String Number String String Example Package for LoyaltyVoucherService To view an example of messages for this Web service. This involves creation of Availment transaction and processing it in real time. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network.xml Siebel CRM Web Services Reference Version 8. Table 264.1 16 5 .

Matches the contacts. Country name.xml Message Schema (WSDL) for LoyaltyVoucherService To view the message schema for this Web service. contact. Table 268. MktgDeduplicationServiceMatchOpportunity MktgDeduplicationServiceMatchProspect MktgDeduplicationServiceMatchContact Request Message Description: MktgDeduplicationServiceMatchAccount For a description of this request message. navigate to the documentation library for Siebel applications on Oracle Technology Network. see Table 267. Mktg Deduplication Service Operations For a list of operations associated with this Web service.1 Primary Web Services ■ MktgDeduplicationService Response See the following file to view the sample code: …\LoyaltyVoucherService\LoyaltyVoucherService_request. Description Type String String String String 166 Siebel CRM Web Services Reference Version 8.wsdl MktgDeduplicationService Use this Web service to check if a duplicate record exists for an account.Siebel 8. see Table 268. See the following file to view the message schema: …\LoyaltyVoucherService\LoyaltyVoucherService. Matches the prospects. Matches the opportunities. Request Message Description: MktgDeduplicationServiceMatchAccount Node DUNS Number Name Primary Account City Primary Account Country Account name. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. City name. Extract the files in the zip file. Mktg Deduplication Service Operations Node MktgDeduplicationServiceMatchAccount Description Matches account info provided with the accounts in the system and returns the row ids of the duplicates found with the score for each account.1 . opportunity or prospect. Table 267.

see Table 269. see Table 271. see Table 270. Type String Integration Object Siebel CRM Web Services Reference Version 8. Response Message Description: MktgDeduplicationServiceMatchOpportunity Node HasMatch Match Info Description Output String as “hasMatch” or “hasNoMatch”. Request Message Description: MktgDeduplicationServiceMatchAccount Node Primary Account Postal Code Primary Account State Primary Account Street Address Description City postal code. Table 269. State.1 Primary Web Services ■ MktgDeduplicationService Table 268.Siebel 8. Type String Integration Object Response Message Description: MktgDeduplicationServiceMatchOpportunity For a description of this response message. Type String String String Response Message Description: MktgDeduplicationServiceMatchOpportunity For a description of this response message. Response Message Description: MktgDeduplicationServiceMatchAccount Node HasMatch Match Info Description Output String as “hasMatch” or “hasNoMatch”. Response Message Description: MktgDeduplicationServiceMatchOpportunity Node Account Id Business Unit Id Name Description Opportunity’s account Id. Table 271. Score of the match and row id of the matchee. Opportunity’s business unit Id. Type String String String Response Message Description: MktgDeduplicationServiceMatchAccount For a description of this response message. Street address of primary account.1 16 7 . Score of the match and row id of the matchee. Opportunity’s name. Table 270.

see Table 273. Table 272. Request Message Description: MktgDeduplicationServiceMatchContact Node Account Birth Date Phone Description Account name of contact.1 .Siebel 8. Contact’s phone number. Phone number of prospect. Prospect’s first name. Prospect’s city. Request Message Description: MktgDeduplicationServiceMatchProspect Node Account Phone City Country Email Address First Name Home Phone # Last Name Middle Name Primary Postal Code Social Security Number State Street Address Work Phone # Description Account name of prospect. Prospect’s email address. Contact’s birth date. Prospect’s street address. see Table 272. Type String Integration Object Request Message Description: MktgDeduplicationServiceMatchContact For a description of this request message. Table 274.1 Primary Web Services ■ MktgDeduplicationService Request Message Description: MktgDeduplicationServiceMatchProspect For a description of this request message. Prospect’s middle name. Type String String String String String String String String String String String String String String Response Message Description: MktgDeduplicationServiceMatchProspect For a description of this response message. Prospect’s home phone number. Score of the match and row id of the matchee. Prospect’s last name. Prospect’s work phone number. Prospect’s country. see Table 274. Postal code. Table 273. Response Message Description: MktgDeduplicationServiceMatchProspect Node HasMatch Match Info Description Output String as “hasMatch” or “hasNoMatch”. Prospect’s state of residence. Type String String String 168 Siebel CRM Web Services Reference Version 8. Prospect’s social security number.

Contact’s country of residence. see Table 276. Type String Integration Object MktgImportDeduplicationService Application Interface This topic describes the application objects called by the this Web service. Table 276. MktgImportDeduplicationService Data Object Siebel Repository Name Mktg Deduplication External Name Mktg Deduplication Siebel CRM Web Services Reference Version 8. Contact’s email address.1 Primary Web Services ■ MktgDeduplicationService Table 274. Request Message Description: MktgDeduplicationServiceMatchContact Node City Country Email Address First Name Home Phone # Last Name Middle Name Primary Postal Code Social Security Number State Street Address Work Phone # Description Contact’s city of residence.Siebel 8. Contact’s middle name. Contact’s last name. Contact’s state of residence. Contact’s street address. Table 275. Contact’s home phone number. Score of the match and row id of the matchee. Contact’s first name. refer to your application development documentation on Oracle Technology Network. Response Message Description: MktgDeduplicationServiceMatchContact Node HasMatch Match Info Description Output String as “hasMatch” or “hasNoMatch”. Type String String String String String String String String String String String String Response Message Description: MktgDeduplicationServiceMatchContact For a description of this response message. Contact’s work phone number. Contact’s primary postal code. Contact’s social security number. For more information on application implementation. see Table 275.1 16 9 . Data Object (Integration Object) For a description of data objects for this Web service.

xml 170 Siebel CRM Web Services Reference Version 8. Request (MatchAccount) See the following file to view the sample code: …\MktgDeduplicationService\MatchAccount_request.xml Response (MatchAccount) See the following file to view the sample code: …\MktgDeduplicationService\MatchAccount_response.1 . Extract the files in the zip file.1 Primary Web Services ■ MktgDeduplicationService Example Package for MktgDeduplicationService To view an example of messages for this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network.xml Request (MatchProspect) See the following file to view the sample code: …\MktgDeduplicationService\MatchProspect_request.xml Response (MatchOpportunity) See the following file to view the sample code: …\MktgDeduplicationService\MatchOpportuntity_response.Siebel 8.xml Response (MatchProspect) See the following file to view the sample code: …\MktgDeduplicationService\MatchProspect_response.xml Response (MatchContact) See the following file to view the sample code: …\MktgDeduplicationService\MatchContact_response.xml Request (MatchOpportunity) See the following file to view the sample code: …\MktgDeduplicationService\MatchOpportuntity_request. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.xml Request (MatchContact) See the following file to view the sample code: …\MktgDeduplicationService\MatchContact_request.

wsdl MktgImportService This Web service is used for all the imports into the Siebel Marketing application such as Leads. Extract the files in the zip file. Table 277. Prospects and so on. Table 279. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. For a description of this request message. See the following file to view the message schema: …MktgDeduplicationService\MktgDedup. see Table 277. Contacts. Mktg Import Service Operations For a list of operations associated with this Web service. Response Message Description: MktgImportServiceInvokeImportJob Node ErrorCode Error Message Description OK or NOTOK Error message (if any) Type String String Siebel CRM Web Services Reference Version 8. see Table 279. navigate to the documentation library for Siebel applications on Oracle Technology Network. Request Message Description: MktgImportServiceInvokeImportJob Node ImportJobParams Description Required.1 Primary Web Services ■ MktgImportService Message Schema (WSDL) for Mktg Deduplication Service To view the message schema for this Web service.1 17 1 . Request Message Description: MktgImportServiceInvokeImportJob This method gets the details of the record(s) from the Business Component “Invoke Import Jobs” and schedules the import process. see Table 278. Mktg Import Service Operations Node MktgImportServiceInvokeImportJob Description Schedules various import processes for Marketing. Table 278.Siebel 8. Type Integration Object Response Message Description: MktgImportServiceInvokeImportJob For a description of this response message. An instance of the integration object “Import Job Integration Object”.

Mktg Import Service Data Object Siebel Repository Name Import Job Integration Object External Name Import Job Integration Object Example Package for MktgImportService To view an example of messages for this Web service. Request See the following file to view the sample code: …\MktgImportService\MktgImportServiceInvokeImportJob_request. Extract the files in the zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. see Table 281.wsdl 172 Siebel CRM Web Services Reference Version 8. For more information on application implementation.xml Message Schema (WSDL) for Mktg Import Service To view the message schema for this Web service.1 Primary Web Services ■ MktgImportService Mktg Import Service Application Interface This topic describes the application objects called by the this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network. see Table 280.xml Response See the following file to view the sample code: …\MktgImportService\MktgImportServiceInvokeImportJob_response. Table 281. refer to your application development documentation on Oracle Technology Network. Mktg Import Service Service Object Name Mktg System Task Service Boundary Object Type Business Service CSSSystemTaskService Data Object (Integration Object) For a description of data objects for this Web service. See the following file to view the message schema: …\MktgImportService\MktgImportService. Table 280. navigate to the documentation library for Siebel applications on Oracle Technology Network. Service Object (Business Service or Workflow) For a description of the service objects for this Web service.1 .Siebel 8. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

approvals. Table 284.Siebel 8. approvals. see Table 282.1 17 3 . see Table 284. approvals. shipping. Table 283.the order query can query the order header.1 Primary Web Services ■ OrderDetailWebService OrderDetailWebService Use this Web service to query orders based on search criteria. see Table 283. billing and shipment details is returned in the response. OrderDetailUpdate Request Message Description: OrderDetailQueryPage Based on the view criteria and searchspec set on the Integration Object . payment. OrderDetailWebService Operations For a list of operations associated with this Web service. OrderDetailWebService Operations Name OrderDetailQueryPage Description Performs query operations based on the viewcriteria and the searchspec set on the PDS Order Detail Integration Object as the input. shipping.to track the shipment details of an order. shipping and billing details. Additionally. Performs update operations on the PDS Order Detail Integration Object as the input. line details of the order. For a description of this request message. Language Mode (value is “LDC”) and viewMode (“All”). Details include payments. Type Integration Object Response Message Description: OrderDetailQueryPage Based on the view criteria and searchspec set on the Integation Object.approvals. This operation is used for editing the details of an order such as copy lines of the current order and/or cancel order. Request Message Description: OrderDetailQueryPage Node OrderDetailQueryPage_Input Description The method arguments are Orders IO with query parameters set. and retrieve details from a particular order. shipping and billing .For a description of this response message. Table 282.This operation is used for querying the order details including the payment. billing and shipment details. Response Message Description: OrderDetailQueryPage Node OrderDetailQueryPage_Output Description The retrieved data for the query set on the view criteria and searchspec. Type Integration Object Siebel CRM Web Services Reference Version 8. information about order header. line details of the order. payment. users can copy current order lines to a cart and/or cancel an order.

Type Integration Object OrderDetailWebService Application Interface This topic describes the application objects called by the this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network. see Table 287. 174 Siebel CRM Web Services Reference Version 8.1 Primary Web Services ■ OrderDetailWebService Request Message Description: OrderDetailUpdate For a description of this request message. Table 288. Table 285. Response Message Description: OrderDetailUpdate Node OrderDetailUpdate_Output Description The retrieved data for the update operation performed. Language Mode (value is “LDC”) and viewMode (“All”). which provides update and query operations on the Integration Object PDS Order Detail. see Table 286. Request Message Description: OrderDetailUpdate Node OrderDetailUpdate_Input Description The method arguments are Orders IO with parameters set. see Table 285. Table 286. Extract the files in the zip file. Table 287.1 . and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. This Web service exposes the EAI UI Business Service PDS Order Detail. see Table 288. refer to your application development documentation on Oracle Technology Network. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. OrderDetailWebService Data Object Siebel Repository Name PDS Order Detail External Name PDS Simplified Order Example Package for OrderDetailWebService To view an example of messages for this Web service. OrderDetailWebService Service Object Name PDS Order Detail Boundary Object Type Integration Object Class CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service. For more information on application implementation. Type Integration Object Response Message Description: OrderDetailUpdate For a description of this response message.Siebel 8.

Request Message Description: PDSOrderHeaderQueryPage For a description of this request message. See the following file to view the message schema: …\OrderDetailWebService\OrderDetailWebService. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. see Table 289.Siebel 8.1 17 5 .xml Message Schema (WSDL) for OrderDetailWebService To view the message schema for this Web service. Type ComplexType Siebel CRM Web Services Reference Version 8. Table 290.1 Primary Web Services ■ PDSOrderHeader Request See the following file to view the sample code: …\OrderDetailWebService\OrderDetailWebService_request.xml Response See the following file to view the sample code: …\OrderDetailWebService\OrderDetailWebService_response. PDSOrderHeader Operations Name PDSOrderHeaderQueryPage Description Get the header information of open orders for a specific asset. PDSOrderHeader Operations For a list of operations associated with this Web service. see Table 290. Extract the files in the zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network. Table 289.wsdl PDSOrderHeader Use this Web service to get header information for specific open orders. Request Message Description: PDSOrderHeaderQueryPage Node PDSOrderHeaderQueryPage_Input Description The request message includes the search criteria for order status and asset integration Id.

navigate to the documentation library for Siebel applications on Oracle Technology Network. navigate to the documentation library for Siebel applications on Oracle Technology Network.1 . 176 Siebel CRM Web Services Reference Version 8.xml Message Schema (WSDL) for PDSOrderHeader To view the message schema for this Web service. PriceListsWS Operations Node GetPriceLists Description Get all the price lists based on search spec. See the following file to view the message schema: …\PDSOrderHeader\PDSOrderHeader. Table 291. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.xml Response See the following file to view the sample code: …\PDSOrderHeader\PDSOrderHeader_response. Extract the files in the zip file. PriceListsWS Operations For a list of operations associated with this Web service. see Table 291. Table 292. Request See the following file to view the sample code: …\PDSOrderHeader\PDSOrderHeader_request. Response Message Description: PDSOrderHeaderQueryPage Node PDSOrderHeaderQueryPage_Output Description The response message includes list of order headers matching the search criteria.wsdl PriceListsWS Use this Web service to obtain price lists based on defined search specifications. Extract the files in the zip file. Type ComplexType Example Package for PDSOrderHeader To view an example of messages for this Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 Primary Web Services ■ PriceListsWS Response Message Description: PDSOrderHeaderQueryPage For a description of this response message.Siebel 8. see Table 292.

xml Message Schema (WSDL) for PriceListsWS To view the message schema for this Web service.1 17 7 . navigate to the documentation library for Siebel applications on Oracle Technology Network. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Type ComplexType Response Message Description: GetPriceLists For a description of this response message. Type ComplexType Example Package for PriceListsWS To view an example of messages for this Web service. Response Message Description: GetPriceLists Node GetPriceLists_Output Description Response message includes the price lists matching the search spec. Extract the files in the zip file.Siebel 8. Extract the files in the zip file.xml Response See the following file to view the sample code: …\PriceListsWS\PriceListsWS_response. see Table 293. Table 294. Request Message Description: GetPriceLists Node GetPriceLists_Input Description Request message includes the search spec. see Table 294. Table 293. Request See the following file to view the sample code: …\PriceListsWS\PriceListsWS_request. navigate to the documentation library for Siebel applications on Oracle Technology Network. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 Primary Web Services ■ PriceListsWS Request Message Description: GetPriceLists For a description of this request message. See the following file to view the message schema: …\PriceListsWS\PriceListsWS.wsdl Siebel CRM Web Services Reference Version 8.

ProcessSalesOrderSiebelJMSProducer Operations For a list of operations associated with this Web service. see Table 296. in the billing application.Siebel 8. The properties of the order item. The response message returns only an acknowledgement message and not data. ProcessSalesOrderSiebelJMSProducer Service Object Name ProcessSalesOrderSiebelJMSProducer Boundary Object Type Business Service Class (If Business Service) CSSWSOutboundDispatcher 178 Siebel CRM Web Services Reference Version 8.1 Primary Web Services ■ ProcessSalesOrderSiebelJMSProducer ProcessSalesOrderSiebelJMSProducer Use this Web service to submit a sales order from the Siebel CRM application to the billing application and to create a customer account. Table 296. For more information on application implementation. Request Message Description: Process For a description of this request message. Table 295. if needed. refer to your application development documentation on Oracle Technology Network. Request Message Description: Process Node Order OrderItem OrderItemXA Description The details of the header for the order. see Table 297. if needed. ProcessSalesOrderSiebelJMSProducer Operations Operation Name Process Description Submits a sales order to the billing application and creates a customer account. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. see Table 295. ProcessSalesOrderSiebelJMSProducer Application Interface This topic describes the application objects called by the this Web service. The details of the order item.1 . Table 297. in the billing application.

\ProcessSalesOrderSiebelJMSProducer\ProcessSalesOrderSiebelJMSProducerResponse Message.xml Siebel CRM Web Services Reference Version 8. navigate to the documentation library for Siebel applications on Oracle Technology Network.No Hierarchy External Name PDS Simplified Order Methods For a description of the methods for this Web service. Table 299. See the following file to view the message schema: . ProcessSalesOrderSiebelJMSProducer Data Object Siebel Repository Name PDS Order .xml Response See the following file to view the sample code: . Table 298. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.. Extract the files in the zip file.xml Message Schema (WSDL) for ProcessSalesOrderSiebelJMSProducer To view the message schema for this Web service.. navigate to the documentation library for Siebel applications on Oracle Technology Network. Request See the following file to view the sample code: .1 17 9 ..Siebel 8.1 Primary Web Services ■ ProcessSalesOrderSiebelJMSProducer Data Object (Integration Object) For a description of data objects for this Web service. see Table 298..\ProcessSalesOrderSiebelJMSProducer\ProcessSalesOrderSiebelJMSProducer.. Extract the files in the zip file. see Table 299.\ProcessSalesOrderSiebelJMSProducer\ProcessSalesOrderSiebelJMSProducerRequest Message.process Example Package for ProcessSalesOrderSiebelJMSProducer To view an example of messages for this Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. ProcessSalesOrderSiebelJMSProducer Methods Operation process Method [BS: ProcessSalesOrderSiebelJMSProducer]..

Siebel 8. Upserts the workspace project. Upserts the workspace project. 180 Siebel CRM Web Services Reference Version 8. Table 301.1 Primary Web Services ■ Product Import Product Import Use this Web service to add and update product definitions and product structures in the Siebel CRM application. Performs the update operation if the product definition or the child product structure exists. Request Message Description: Product Import Insert Node SiebelMessage Description The Siebel message for the integration object of CMU Product Integration. Upserts the related products in the product structure. Generates an error if the product definition exists. see Table 301. upsert denotes a combination of the insert and update operations. Generates an error if the product definition or the child product structure does not exist. In this Web service. The response message returns only an acknowledgement message and not data. Performs the insert operation if the child product structure does not exist. Upserts the workspace project.1 . Table 300. ■ Product Import Update This operation: ■ Updates the root product definition and the related products in the product structure. ■ Request Message Description: Product Import Insert For a description of this request message. Product Import Operations Operation Name Product Import Insert Description This operation: ■ ■ Inserts the root product definition. Product Import Operations For a list of operations associated with this Web service. ■ Product Import Upsert This operation: ■ Upserts the root product definition and the related products in the product structure. Performs the insert operation if the product definition or the child product structure does not exist. see Table 300. Performs the update operation if the child product structure exists.

Table 302. Request Message Description: Product Import Upsert Node SiebelMessage Description The Siebel message for the integration object of CMU Product Integration. Request Message Description: Product Import Upsert For a description of this request message. see Table 304. Table 304. see Table 302. see Table 303. refer to your application development documentation on Oracle Technology Network. Application Interface for Product Import This topic describes the application objects called by the this Web service. Request Message Description: Product Import Update Node SiebelMessage Description The Siebel message for the integration object of CMU Product Integration. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. For more information on application implementation.1 Primary Web Services ■ Product Import Request Message Description: Product Import Update For a description of this request message.1 18 1 . Product Import Service Object Name Product Import Boundary Object Type Business Service Class (If Business Service) CSSCMUProdWebSvc Siebel CRM Web Services Reference Version 8. Table 303.Siebel 8.

Integration Object name for data sync service. Integration Object name for data sync service. Currently not supported. Data Sync Service: Class CMU Product Class Data Sync Service: Product Data Sync Service: Workspace Definition Business Component Definition Business Object Detail Business Component Integration Field Map: Auto Explode Flag Integration Field Map: Billable Flag Integration Field Map: Billing Service Type Integration Field Map: Billing Type Integration Field Map: Business Unit Id Integration Field Map: Check Eligibility Flag Integration Field Map: Description CMU Product CMU Joint Workspace CMU Product Definition VBC CMU Admin ISS Product Definition CMU ISS Product Details BusComp Product|CMU Internal Product VOD| Auto Explode Flag Product|CMU Internal Product VOD| Billable Flag Product|CMU Internal Product VOD| Billing Service Type Product|CMU Internal Product VOD| Billing Type Product|CMU Internal Product VOD| Primary Organization Id Product|CMU Internal Product VOD| Pre Pick CD Product|CMU Internal Product VOD| Description 182 Siebel CRM Web Services Reference Version 8.1 . Integration Object name for data sync service. See the first note after this table. See the second note after this table. See the second note after this table. Integration Object name for data sync service. Product Import Business Service User Property Name Data Sync Service Data Sync Service: Attribute Value EAI Siebel Adapter CMU Attribute Comment EAI Adapter service that is invoked. See the second note after this table. See the first note after this table.1 Primary Web Services ■ Product Import Business Service User Property For a description of the user properties for this Business Service. see Table 305. See the second note after this table. See the second note after this table.Siebel 8. Currently not supported. See the second note after this table. Table 305. See the first note after this table. See the second note after this table.

See the second note after this table. See the second note after this table. Siebel CRM Web Services Reference Version 8. See the second note after this table. See the second note after this table. See the second note after this table. See the second note after this table. Product Import Business Service User Property Name Integration Field Map: Effective End Time Integration Field Map: Effective Start Time Integration Field Map: Inclusive Eligibility Flag Integration Field Map: Orderable Flag Integration Field Map: Price Type Integration Field Map: Product Id Integration Field Map: Product Name Integration Field Map: Product Type Integration Field Map: Sales Product Flag Integration Field Map: Service Instance Flag Integration Field Map: Service Product Flag Integration Field Map: Structure Type Integration Field Map: Track As Asset Flag Integration Field Map: Type Integration Field Map: Unit of Measure Integration Field Map: Vendor Id Integration Object: External Integration Object: Product Value Product|CMU Internal Product VOD| End Date Product|CMU Internal Product VOD| Start Date Product|CMU Internal Product VOD| Inclusive Eligibility Flag Product|CMU Internal Product VOD| Orderable Product|CMU Internal Product VOD| Price Type Product|CMU Internal Product VOD| Id Product|CMU Internal Product VOD| Name Product|CMU Internal Product VOD| Product Type Code Product|CMU Internal Product VOD| Sales Product Flag Product|CMU Internal Product VOD| Service Instance Product|CMU Internal Product VOD| Sales Service Flag Product|CMU Internal Product VOD| Product Def Type Code Product|CMU Internal Product VOD| Track As Asset Flag Product|CMU Internal Product VOD| Type Product|CMU Internal Product VOD| Unit of Measure Product|CMU Internal Product VOD| Vendor Id CMU Product Integration CMU Admin ISS Product Definition Comment See the second note after this table.1 Primary Web Services ■ Product Import Table 305.Siebel 8. See the first note after this table. See the first note after this table. See the second note after this table. See the second note after this table. See the second note after this table. See the second note after this table. See the second note after this table. See the second note after this table. See the second note after this table. See the second note after this table. See the second note after this table.1 18 3 .

See the first note after this table. See the first note after this table. See the first note after this table. See the first note after this table. See the first note after this table.1 Primary Web Services ■ Product Import Table 305. See the first note after this table. See the first note after this table. See the first note after this table. See the first note after this table.Siebel 8. See the first note after this table. Last Version:0 Last Version:0 Last Version:0 VOD Type:ISS_PROD_DEF Released Flag:N Organization Id: CMU Internal Product VOD CMU Attribute Versions BusComp CMU ISS Product VOD BusComp CMU ISS Product Versions BusComp CMU ISS Product Details BusComp CMU Internal Product Organization 184 Siebel CRM Web Services Reference Version 8. See the first note after this table. See the first note after this table. See the first note after this table. Product Import Business Service User Property Name Integration Object: Product Structure Integration Object: Workspace Preset Value: CMU Attribute VOD BusComp Preset Value: CMU Attribute Versions BusComp Preset Value: CMU ISS Product Attribute BusComp Preset Value: CMU ISS Product Details BusComp Preset Value: CMU ISS Product Structure Admin BusComp Preset Value: CMU ISS Product VOD BusComp Preset Value: CMU ISS Product Versions BusComp Preset Value: CMU Internal Product Organization Product Business Component Required Integration Component 1 Required Integration Component 2 Required Integration Component 3 Required Integration Component 4 Required Integration Component 5 Value CMU Admin ISS Product Structure CMU Admin ISS Joint Workspace Definition VOD Type:ISS_ATTR_DEF Version:1 Comment See the first note after this table.1 . See the first note after this table. See the first note after this table.

and attribute). See the first note after this table. See the first note after this table. See the first note after this table. The first part is the data type (for example. NOTE: You must change this value if you use an integration object. Product Import Business Service User Property Name Structure Business Component Structure Internal Business Component Version Business Component Workspace Business Component Workspace Business Object Workspace Object Business Component Workspace Project Business Component Workspace Project Business Object Workspace Project Item Business Component Workspace Project Lock Business Component Value CMU Product Structure VBC CMU ISS Product Structure Admin BusComp CMU ISS Product Versions BusComp CMU ISS Joint Workspace BusComp CMU Admin ISS Joint Workspace Definition CMU ISS Joint Workspace Object BusComp ISS Joint Workspace BusComp Admin ISS Joint Workspace Definition ISS Joint Workspace VOD Pick BusComp ISS Joint Workspace VOD Lock BusComp Comment See the first note after this table. The third part is the integration component field name. business object.1 18 5 . or business component with a different name. class. Table 306. see Table 306. See the first note after this table. See the first note after this table. Data Object (Integration Object) For a description of data objects for this Web service. Product Import Data Object Siebel Repository Name CMU Product Integration External Name CMU Product Integration Siebel CRM Web Services Reference Version 8.Siebel 8.1 Primary Web Services ■ Product Import Table 305. See the first note after this table. See the first note after this table. See the first note after this table. See the first note after this table. The second part is the integration component name. product. integration component. NOTE: This value is the field map.

..\ProductImport\ProductImport_request.xml Response See the following file to view the sample code: . navigate to the documentation library for Siebel applications on Oracle Technology Network. Extract the files in the zip file.. Update [BS: Product Import]. navigate to the documentation library for Siebel applications on Oracle Technology Network.1 .. Table 307.\ProductImport\Product Import.1 Primary Web Services ■ ProductSearchService Methods For a description of the methods for this Web service. 186 Siebel CRM Web Services Reference Version 8.. See the following file to view the message schema: .wsdl ProductSearchService Business Service (Search Product Service) for Searching Product Business Component and doing eligibility check. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.Siebel 8. Product Import Methods Operation Product Import Insert Product Import Update Product Import Upsert Method [BS: Product Import].Insert [BS: Product Import]. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Upsert Example Package for Product Import To view an example of messages for this Web service.xml Message Schema for Product Import To view the message schema for this Web service. see Table 307.\ProductImport\ProductImport_response. Extract the files in the zip file. Request See the following file to view the sample code: ..

Table 308.1 18 7 . Type Input: SearchProductInputSiebelMessage Output: SearchProductResponseSiebelMessage Request Message Description: QuoteCheckOut For a description of this request message. see Table 309. see Table 308. Request Message Description: QuoteCheckOut Node EligibilityMode ABOFlag AccountContractedProduc tsOnlyFlag AccountId AccountType ClassId CurrencyCode DiscountPercent DisplayName EligibilityDisplayMode ExchangeDate HeaderId Mode PriceListId City PostalCode State Country BusObjName BusCompName Price List Id City name Postal code State name Country name Currency code Discount in percent Display name Type of Account Description Type String String String String String String String String String String String String String String String String String String String String Siebel CRM Web Services Reference Version 8.Siebel 8. Table 309.1 Primary Web Services ■ ProductSearchService ProductSearchService Operations For a list of operations associated with this Web service. ProductSearchService Operations Node ExecuteSearch Description Retrieve Products based on passed criteria.

Type String String ProductSearchService Application Interface This topic describes the application objects called by the this Web service.1 Primary Web Services ■ ProductSearchService Table 309. For more information on application implementation. see Table 311. see Table 310. Request Message Description: QuoteCheckOut Node SignalMode ContextRowId ContextMode SearchText Hits Threshold Timeout FromPrice ToPrice Attribute Feature Timeout value Price Range Price Range Attribute name Search Criteria Records to be fetched Description Type String String String String String String String String String String String Response Message Description: ExecuteSearch For a description of this response message.Siebel 8. Product Id. Table 310. Table 311.1 . ProductSearchService Service Object Name SearchProductService Boundary Object Type Business Service Class CSSSrchProductSvc 188 Siebel CRM Web Services Reference Version 8. refer to your application development documentation on Oracle Technology Network. Response Message Description: ExecuteSearch Node TotalRecords ProductId Description Total number of records retrieved. Service Object (Business Service or Workflow) For a description of the service objects for this Web service.

See the following file to view the message schema: …\ProductSearchService\ProductSearchService.xml Response See the following file to view the sample code: …\ProductSearchService\ProductSearchService_response.1 18 9 .1 Primary Web Services ■ QuoteCheckOutWebService Data Object (Integration Object) For a description of data objects for this Web service. see Table 312.Siebel 8. navigate to the documentation library for Siebel applications on Oracle Technology Network. Extract the files in the zip file. Siebel CRM Web Services Reference Version 8.xml Message Schema (WSDL) for ProductSearchService To view the message schema for this Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network.wsdl QuoteCheckOutWebService Use this Web service to perform payment authorizations for quotes. Request See the following file to view the sample code: …\ProductSearchService\ProductSearchService_request. Table 312. Extract the files in the zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. ProductSearchService Data Object Siebel Repository Name Context SearchProductInputSiebelMessage SearchProductResponseSiebelMessage External Name PDS Catalog Context SearchProductInputIO SearchProductResponseIO Example Package for ProductSearchService To view an example of messages for this Web service.

the quote is submited to order. see Table 313. If the authorization fails. see Table 315. Request Message Description: QuoteCheckOut Node QuoteCheckOut_Input Description The request message includes the Id of the quote to be submitted. Otherwise.xml Response See the following file to view the sample code: …\QuoteCheckOutWebService\QuoteCheckOutWebService_response.Siebel 8.xml 190 Siebel CRM Web Services Reference Version 8. Extract the files in the zip file. Response Message Description: QuoteCheckOut Node QuoteCheckOut_Output Description The response message includes the Id of the order converted from quote. Request See the following file to view the sample code: …\QuoteCheckOutWebService\QuoteCheckOutWebService_request. Request Message Description: QuoteCheckOut For a description of this request message. a flag to indicate whether to do credit card authorization. the operation stops and returns.1 Primary Web Services ■ QuoteCheckOutWebService QuoteCheckOutWebService Operations For a list of operations associated with this Web service. Table 314. see Table 314. QuoteCheckOutWebService Operations Node QuoteCheckOut Description Performs the payment authorization. navigate to the documentation library for Siebel applications on Oracle Technology Network. Type ComplexType Response Message Description: QuoteCheckOut For a description of this response message. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 . and a flag to indicate whether to submit the quote to order. Table 315. Table 313. Type ComplexType Example Package for QuoteCheckOutWebService To view an example of messages for this Web service.

See the following file to view the message schema: …\QuoteCheckOutWebService\QuoteCheckOutWebService. It includes the search criteria. Request Message Description: QuoteDetailGet Node QuoteDetailGet_Input Description Quote object passed to the Web service. Table 317.1 Primary Web Services ■ QuoteDetailWebService Message Schema (WSDL) for QuoteCheckOutWebService To view the message schema for this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network. QuoteDetailWebService Operations Node QuoteDetailGet QuoteDetailUpdate QuoteDetailInsert QuoteDetailDelete QuoteDetailInit Description Requests and retrieves quote detail. Table 316. insert. see Table 316. Updates quote details. update.Siebel 8. see Table 317. Extract the files in the zip file. or delete details on a quote record. Deletes quote details.wsdl QuoteDetailWebService Use this Web service to retrieve. QuoteDetailWebService Operations For a list of operations associated with this Web service. Type ComplexType Response Message Description: QuoteDetailGet For a description of this response message.1 19 1 . Quote is initialized from database. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. see Table 318. Request Message Description: QuoteDetailGet For a description of this request message. Response Message Description: QuoteDetailGet Node QuoteDetailGet_Output Description Quote object returned. It includes the detail of the quote header and the payment information. Type ComplexType Siebel CRM Web Services Reference Version 8. Inserts new quote detail. Table 318.

seeTable 322. Response Message Description: QuoteDetailInsert Node QuoteDetailDelete_Output Description Quote returned from Web service. Type ComplexType Response Message Description: QuoteDetailInsert For a description of this response message. Request Message Description: QuoteDetailUpdate Node QuoteDetailUpdate_Input Description Quote to be updated into database. Table 321.Siebel 8. Response Message Description: QuoteDetailUpdate Node QuoteDetailUpdate_Output Description Quote returned with updated information. Request Message Description: QuoteDetailInsert Node QuoteDetailInsert_Input Description Quote to be inserted into database. see Table 320.1 Primary Web Services ■ QuoteDetailWebService Request Message Description: QuoteDetailUpdate For a description of this request message. Request Message Description: QuoteDetailDelete Node QuoteDetailDelete_Input Description Quote to be deleted from database. see Table 321. Type ComplexType Request Message Description: QuoteDetailDelete For a description of this request message. Table 319. Table 322. Type ComplexType Response Message Description: QuoteDetailUpdate For a description of this response message. see Table 319. Type ComplexType Request Message Description: QuoteDetailInsert For a description of this request message. see Table 323 Table 323. Table 320. Type ComplexType 192 Siebel CRM Web Services Reference Version 8.1 .

xml Response See the following file to view the sample code: …\QuoteDetailWebService\QuoteDetailWebService_response. Type ComplexType Example Package for QuoteDetailWebService To view an example of messages for this Web service. see Table 325. Request Message Description: QuoteDetailInit Node QuoteDetailInit_Input Description Quote to be initialized from database. navigate to the documentation library for Siebel applications on Oracle Technology Network. Response Message Description: QuoteDetailInit Node QuoteDetailInit_Output Description Quote returned from Web service. Type ComplexType Response Message Description: QuoteDetailInit For a description of this response message. Table 325.1 19 3 . Response Message Description: QuoteDetailDelete Node QuoteDetailDelete_Output Description Quote returned from Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file. see Table 326. Type ComplexType Request Message Description: QuoteDetailInit For a description of this request message.Siebel 8. Table 324. see Table 324. Table 326. Extract the files in the zip file.xml Message Schema (WSDL) for QuoteDetailWebService To view the message schema for this Web service. Request See the following file to view the sample code: …\QuoteDetailWebService\QuoteDetailWebService_request. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network.1 Primary Web Services ■ QuoteDetailWebService Response Message Description: QuoteDetailDelete For a description of this response message. Siebel CRM Web Services Reference Version 8.

Request Message Description: ExecuteQuoting For a description of this request message. see Table 328. Type ComplexType 194 Siebel CRM Web Services Reference Version 8. Flag to indicate whether to query the quote back from database or just return the quote in memory.1 . verifies the promotion. Table 327. shipping charge and tax based on the pass-in flag. Request Message Description: ExecuteQuoting Node ExecuteQuoting_Input Description The request message includes the quote to be saved.Siebel 8. Flag to indicate whether to verify the promotion. Flag to indicate whether to calculate the price for the quote. QuotingWebService Operations Name ExecuteQuoting Description Saves the quote into the database. Checks the eligibility. Table 328.1 Primary Web Services ■ QuotingWebService See the following file to view the message schema: …\QuoteDetailWebService\QuoteDetailWebService. It also includes the following flags: ■ ■ ■ ■ ■ ■ Flag to indicate whether to check the eligibility.wsdl QuotingWebService Use this Web service to process quotes and commit them to the database. QuotingWebService Operations For a list of operations associated with this Web service. or calculates the price. Flag to indicate whether to calculate the tax. Flag to indicate whether to calculate the shipping cost. see Table 327.

1 19 5 . Table 330. For more information on application implementation. Request See the following file to view the sample code: …\QuotingWebService\QuotingWebService_request. navigate to the documentation library for Siebel applications on Oracle Technology Network. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Type ComplexType QuotingWebService Application Interface This topic describes the application objects called by the this Web service. QuotingWebService Data Object Siebel Repository Name PDS Quote External Name PDS Simplified Quote Example Package for QuotingWebService To view an example of messages for this Web service. Response Message Description: ExecuteQuoting Node ExecuteQuoting_Output Description The response message includes the quote returned from Web service.xml Response See the following file to view the sample code: …\QuotingWebService\QuotingWebService_response. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Table 329.1 Primary Web Services ■ QuotingWebService Response Message Description: ExecuteQuoting For a description of this response message.Siebel 8.xml Siebel CRM Web Services Reference Version 8. see Table 330. Table 331. Extract the files in the zip file. refer to your application development documentation on Oracle Technology Network. see Table 329. see Table 331. QuotingWebService Service Object Name Web Channel Quoting Workflow Boundary Object Type Not applicable Data Object (Integration Object) For a description of data objects for this Web service.

navigate to the documentation library for Siebel applications on Oracle Technology Network. This operation is used to determine the campaign history record. see Table 333. if any. Table 333. For a description of this request message. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.wsdl Response Use this Web service for the basic Marketing operations such as creating and updating responses. Updates a Response. see Table 332.Siebel 8.1 . Table 332. See the following file to view the message schema: …\QuotingWebService\QuotingWebService. Request Message Description: ResponseCreateResponse Node Response IO Description Required input parameter. Response Operations Name ResponseCreateResponse ResponseSourceCodeLookup ResponseUpdateResponse Description Creates a Response. see Table 334 Table 334. Error message. Type Integration Object Response Message Description: ResponseCreateResponse For a description of this response message. Response Message Description: ResponseCreateResponse Node Response Id Error Message Success Flag Description Row Id of the new response.1 Primary Web Services ■ Response Message Schema (WSDL) for QuotingWebService To view the message schema for this Web service. Extract the files in the zip file. Response Operations For a list of operations associated with this Web service. Type String String String 196 Siebel CRM Web Services Reference Version 8. Y or N. Request Message Description: ResponseCreateResponse This method takes in an Integration Object called Response IO and returns the Response Id and Success Flag.

if any. Y or N. Table 336. Type String String String Request Message Description: ResponseUpdateResponse This method updates an existing response. Campaign Id of response source. if any.Siebel 8. For a description of this request message. see Table 335. Error message. Treatment Id for response. Type String String String String String String String Response Message Description: ResponseSourceCodeLookup For a description of this response message. Treatment code for response. Table 337. Table 335. Y or N. Source code for response. Type Integration Object Response Message Description: ResponseUpdateResponse For a description of this response message. For a description of this request message.1 19 7 . Request Message Description: ResponseUpdateResponse Node Response IO Description Required input parameter.1 Primary Web Services ■ Response Request Message Description: ResponseSourceCodeLookup This method takes in Ids and Codes of Offer. Table 338. Offer code for response. Type String String Siebel CRM Web Services Reference Version 8. Request Message Description: ResponseSourceCodeLookup Node Campaign Code Campaign Id Offer Code Offer Id Source Code Treatment Code Treatment Id Description Campaign code of response source. Response Message Description: ResponseSourceCodeLookup Node S_CAMP_CON_ID Error Message Success Flag Description Row Id of the response. Response Message Description: ResponseUpdateResponse Node Error Message Success Flag Description Error message. see Table 337. Offer Id for reponse. see Table 336. see Table 338. Campaign and Treatment and returns the S_CAMP_CON_ID.

Request (ResponseCreateResponse) See the following file to view the sample code: …\Response\ResponseCreateResponse_request.xml Request (ResponseSourceCodeLookup) See the following file to view the sample code: …\Response\ResponseSourceCodeLookup_request. navigate to the documentation library for Siebel applications on Oracle Technology Network.xml Response (ResponseSourceCodeLookup) See the following file to view the sample code: …\Response\ResponseSourceCodeLookup_response.1 Primary Web Services ■ Response Example Package for Response To view an example of messages for this Web service.xml Response (ResponseCreateResponse) See the following file to view the sample code: …\Response\ResponseCreateResponse_response. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. See the following file to view the message schema: …\Response\Response.xml Response (ResponseUpdateResponse) See the following file to view the sample code: …\Response\ResponseUpdateResponse_request.Siebel 8. navigate to the documentation library for Siebel applications on Oracle Technology Network. Extract the files in the zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.xml Message Schema (WSDL) for Response To view the message schema for this Web service. Extract the files in the zip file.xml Request (ResponseUpdateResponse) See the following file to view the sample code: …\Response\ResponseUpdateResponse_request.wsdl 198 Siebel CRM Web Services Reference Version 8.1 .

1 Primary Web Services ■ RetrieveAttachmentService RetrieveAttachmentService This Web service has one standard ‘QueryPage’ method to retrieve attachment documents. Request Message Description: RetrieveAttachmentService This fetches the Attachment content for a given attachment Id. see Table 340. For a list of operations associated with this Web service. see Table 339. RetrieveAttachmentService Operations Name QueryPage Parameters Input: Attachment Id Output: AttachmentDocIO (Attachment File Content) Description This retrieves the Attachment content for a given attachment Id.1 19 9 . Table 339. For a description of this request message. Request Message Description: RetrieveAttachmentService Node Id ModId ResFileAutoUpdFlg ResFileDate ResFileDeferFlg ResFileDockReqFlg ResFileDockStatFlg ResFileDockStatus ResFileExt ResFileName ResFileRev ResFileSize ResFileSrcPath ResFileSrcType ResFileBuffer LOVLanguageMode Description Document Id Modification Id Y or N File Date Y or N Y or N Y or N Y or N File Extension File Name File Id File Size File Source Path File Source Type File Buffer Language Independent code Type String String String String String String String String String String String String String String String String Siebel CRM Web Services Reference Version 8. Table 340. Business Service (Search Solution Service) for Searching Solution Business Component.Siebel 8. RetrieveAttachmentService Operations Provides search solution results.

For more information on application implementation.Siebel 8. see Table 341. refer to your application development documentation on Oracle Technology Network.1 . see Table 342.1 Primary Web Services ■ RetrieveAttachmentService Table 340. RetrieveAttachmentService Service Object Name RetrieveAttachmentService Boundary Object Type Business Service Class CSSEAIUIDataService 200 Siebel CRM Web Services Reference Version 8. Request Message Description: RetrieveAttachmentService Node ExecutionMode ViewMode Description Execution Mode Visibility Access Mode Type String String Response Message Description: RetrieveAttachmentService For a description of this response message. Table 342. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Response Message Description: RetrieveAttachmentService Node Id ModId ResFileAutoUpdFlg ResFileDate ResFileDeferFlg ResFileDockReqFlg ResFileDockStatus ResFileExt ResFileName ResFileRev ResFileSize ResFileSrcPath ResFileSrcType ResFileBuffer Description Document Id Modification Id Y or N File Date Y or N Y or N Y or N File Extension File Name File Id File Size File Source Path File Source Type File Buffer Type String String String String String String String String String String String String String String RetrieveAttachmentService Application Interface This topic describes the application objects called by the this Web service. Table 341.

and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network. Table 343.xml Message Schema (WSDL) for RetrieveAttachmentService To view the message schema for this Web service.xml Response See the following file to view the sample code: …\RetrieveAttachmentService\RetrieveAttachmentService_response. navigate to the documentation library for Siebel applications on Oracle Technology Network. See the following file to view the message schema: …\RetrieveAttachmentService\RetrieveAttachmentService. and retrieve a solution as a search result. Extract the files in the zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. see Table 343. Siebel CRM Web Services Reference Version 8.1 20 1 .wsdl searchSolution Use this Web service to search for solutions based on user inputs. RetrieveAttachmentService Data Object Siebel Repository Name SiebelMessageIn SiebelMessageOut External Name AttachmentDocIO AttachmentDocIO Example Package for RetrieveAttachmentService To view an example of messages for this Web service.1 Primary Web Services ■ searchSolution Data Object (Integration Object) For a description of data objects for this Web service. Extract the files in the zip file. Request See the following file to view the sample code: …\RetrieveAttachmentService\RetrieveAttachmentService_request.Siebel 8.

Index of Record. Solution Title. Request Message Description: searchSolution Performs a search on a solution based on specified input. searchSolution. Solution Title. see Table 345. Type String String String String Response Message Description: searchSolution For a description of this response message. Last Updated Date. Index of the first record returned.getSolution Input: SolutionId. searchSolution Operations Name searchSolution. Last Update Date). Type) ). Business Service (Search Solution Service) for Searching Solution Business Component. Index of Record. Last Update Date. For a list of operations associated with this Web service. From).Siebel 8. To. SolutionType. Solution Id.1 . Description Performs a search on a solution based on specified input. Request Message Description: searchSolution Node SearchText SolutionType From To Description Text to be searched. For a description of this request message.searchSolution Parameters Input: SearchInputsIO (SearchText. Table 346.1 Primary Web Services ■ searchSolution searchSolution Operations Provides search solution results. File Name. Retrieves solution from search results. Table 345. see Table 346. Table 344. Type of Solution. Resolution Text. FAQ. Solution Title. SolnAttachmentList (Attachment Id. Solution Type. Output: SearchResultsIO (Total Records. Output: SolutionResultIO (Solution Id. Type String String String String 202 Siebel CRM Web Services Reference Version 8. Response Message Description: searchSolution Node TotalRecords From SolutionId SolutionTitle Description Total number of records fetched. Solution Id. see Table 344.

Type String String Request Message Description: getSolution Retrieves solution from search results. Table 349. Response Message Description: getSolution Node FAQ LastUpdateDate AttachmentId AttachmentType Name ResolutionText Description Frequently Asked Question Last update date of the record Attachment ID Type of Attachment Name Resolution Text message Type String String String String String String searchSolution Application Interface This topic describes the application objects called by the this Web service.1 Primary Web Services ■ searchSolution Table 346. For more information on application implementation. see Table 347.Siebel 8. For a description of this request message. see Table 348. searchSolution Service Object Name Search Solution Service Boundary Object Type Business Service Class CSSSrchSolutionSvc Siebel CRM Web Services Reference Version 8. Table 348. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. refer to your application development documentation on Oracle Technology Network.1 20 3 . see Table 349. Index of the last record fetched. Table 347. Request Message Description: getSolution Node SolutionId Description Solution Id Type String Response Message Description: getSolution For a description of this response message. Response Message Description: searchSolution Node LastUpdateDate To Description Last update date of the record.

searchSolution Data Object Siebel Repository Name SolutionResultSiebelMessage SearchInputsSiebelMessage SearchResultsSiebelMessage External Name SolutionResultIO SearchInputsIO SearchResultsIO Example Package for searchSolution To view an example of messages for this Web service.1 Primary Web Services ■ SelfServiceAccount Data Object (Integration Object) For a description of data objects for this Web service. Extract the files in the zip file. See the following file to view the message schema: …\searchSolution\searchSolution. Extract the files in the zip file.1 . Table 350.xml Message Schema (WSDL) for searchSolution To view the message schema for this Web service.Siebel 8. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.xml Response See the following file to view the sample code: …\searchSolution\searchSolution_response. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. see Table 350. navigate to the documentation library for Siebel applications on Oracle Technology Network. 204 Siebel CRM Web Services Reference Version 8.wsdl SelfServiceAccount This WebService exposes the EAI UI Business Service SelfServiceAccount. navigate to the documentation library for Siebel applications on Oracle Technology Network. which provides CRUD and query operations on Integration Object SS_Account_IO. Request See the following file to view the sample code: …\searchSolution\searchSolution_request. This WebService exposes the Execute and Query Methods in the SelfServiceAccount Business Service as Web service operations.

if this address needs to be made the primary address on the Account. Performs Query operation based on the viewCriteria and searchSpec set on the instance of SS_Account_IO provided as input. if the purpose is to update the account or create/update business address for the given account. Table 352. see Table 351. set operation to Skipnode. Container element to hold the list of business addresses to be created or updated for the account. Set the Id of the account as a ViewCriteria. SelfServiceAccountQueryPage Request Message Description: SelfServiceAccountExecute For a description of this request message. see Table 352. inclusive of the Business Addresses associated to the account. set this field to the specific address of the account. editing and deleting BusinessAddress to an Account. This operation is used in Siebel Self Service 8. SelfServiceAccount Operations Name SelfServiceAccountExecute Description Performs CRUD operations on the instance of SS_Account_IO provided as input. Table 351.1 20 5 . Used to create or update the business address of the Account. Request Message Description: SelfServiceAccountExecute Node SelfServiceAccountExecute_Input ListOfSSAccount ListOfSSAccount/ Account Description Container element for the Execute Operation request. Corresponds to an instance of SS_Account_IO. operation = Update or if the business address needs to be added or updated. Set operation appropriately as Insert or Update and set IsPrimaryMVG=Y.1 for adding.Siebel 8. If the operation is update on AccountBusinessAddress.1 for querying the details of an Account. ListOfSSAccount/ Account /Id ListOfSSAccount/ Account / ListOfAccountBusinessAddress ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ Id Siebel CRM Web Services Reference Version 8.1 Primary Web Services ■ SelfServiceAccount SelfServiceAccount Operations For a list of operations associated with this Web service. Set operation accordingly. This operation is used in Siebel Self Service 8. If account details need to be updated.

Response Message Description: SelfServiceAccountExecute For a description of this response message. Refer to Siebel EAI. Description Container element for the Execute Operation response. Set TRUE to fetch if the address is the shippable address for the account. County. Description Set appropriate values for the details of this address. Request Message Description: SelfServiceAccountExecute Node ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ StreetAddress (Similarly StreetAddress2. Set the ModId while updating. if only the active addresses of the account need to be retrieved. Mod Id for the account record. Table 353. Country) ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ MainAddressFlag ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ BillAddressFlag ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ ShipAddressFlag ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ ActiveStatus ListOfAccountBusinessAddress/ AccountBusinessAddress/ ModId ExecutionMode LOVLanguageMode ViewMode Set to TRUE if the address is the main address for the account. AddressLine3. City. so as to make sure that the record is not updated in the interim.1 Primary Web Services ■ SelfServiceAccount Table 352.1 . see Table 353. Corresponds to an instance of SS_Account_IO. Refer to Siebel EAI. Refer to Siebel EAI. Response Message Description: SelfServiceAccountExecute Node SelfServiceAccountExecute_Output ListOfSSAccount ListOfSSAccount/ Account ListOfSSAccount/ Account /Id ListOfSSAccount/ Account / Mod Id Id of the account. State. Set TRUE if the address is the billable address for the account.Siebel 8. Set to TRUE. 206 Siebel CRM Web Services Reference Version 8.

as well as determining if each of the retrieved addresses are Billable or Shippable. primary Ship To Address Id.1 20 7 . see Table 354. used to fetch the Id of the Primary Bill To address of the account. This operation also retrieves the following information for a given account: primary address Id. used to fetch the Id of the Primary Ship To address of the account. Response Message Description: SelfServiceAccountExecute Node ListOfSSAccount/ Account / ListOfBusinessAddress ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ Id ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ ModId ModId of the address record created or updated. Description Container element for the QueryPage Operation request. Empty. Description Container element for the list of created or updated business address of the account. Request Message Description: SelfServiceAccountQueryPage This operation is used to query the details of the Account or to query the list of business addresses associated with an account.Siebel 8. Siebel CRM Web Services Reference Version 8. Table 354. primary Bill To Address Id. Corresponds to an instance of SS_Account_IO. Siebel SelfService 8. Empty. Id of the address created or updated. Request Message Description: SelfServiceAccountQueryPage Node SelfServiceAccountQueryPage_Input ListOfSSAccount ListOfSSAccount/ Account ListOfSSAccount/ Account /Id ListOfSSAccount/ Account / PrimaryAddressId ListOfSSAccount/ Account / PrimaryBillToAddressId ListOfSSAccount/ Account / PrimaryShipToAddressId ListOfSSAccount/ Account / ListOfBusinessAddress Set the Id of the aAccount as a ViewCriteria. For a description of this request message. For each created or updated business address of the account.1 uses LOVLanguageMode as ‘LDC’ and ViewMode as ‘All’ for this Web service.1 Primary Web Services ■ SelfServiceAccount Table 353. To fetch the business address of the account. Empty. used to fetch the Id of the primary address of the account.

1 . State. Country) ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ MainAddressFlag ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ BillAddressFlag ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ ShipAddressFlag ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ ActiveStatus ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ ModId ExecutionMode LOVLanguageMode ViewMode Empty. City. Empty. to fetch the ModId to be sent back while updating. AddressLine3. Empty. Set to TRUE. Refer to Siebel EAI. County. Refer to Siebel EAI. Empty. to fetch if the address is the Billable Address for the account. Description Empty. Empty (Set it to retrieve a specific address of this account). so as to make sure that the record is not updated in the interim. 208 Siebel CRM Web Services Reference Version 8.Siebel 8. to fetch if the address is the Shippable Address for the account. Request Message Description: SelfServiceAccountQueryPage Node ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ Id ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ StreetAddress (Similarly StreetAddress2. Set appropriate View Criteria for filtering addresses.1 Primary Web Services ■ SelfServiceAccount Table 354. if only the active addresses of the account need to be retrieved. Refer to Siebel EAI. to fetch if the address is the main address for the account. Empty. Empty.

Retrieved Id of the Primary Address of the account. Container element for the retrieved Business Address of the account. For each retrieved business address of the account.Siebel 8. see Table 355. Response Message Description: SelfServiceAccountQueryPage Node SelfServiceAccountQueryPage_Output ListOfSSAccount ListOfSSAccount/ Account ListOfSSAccount/ Account /Id ListOfSSAccount/ Account / PrimaryAddressId ListOfSSAccount/ Account / PrimaryBillToAddressId ListOfSSAccount/ Account / PrimaryShipToAddressId ListOfSSAccount/ Account / ListOfBusinessAddress ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ Id ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ StreetAddress (Similarly StreetAddress2. AddressLine3. Details of the business address. Id of the account. City. Description Container element for the QueryPage Operation response. State. Table 355. if the address is the Shippable Address for the account. Siebel CRM Web Services Reference Version 8. County. True. Corresponds to an instance of SS_Account_IO.1 Primary Web Services ■ SelfServiceAccount Response Message Description: SelfServiceAccountQueryPage For a description of this response message. if the address is the main Address for the account. if the address is the Billable Address for the account.1 20 9 . True. Country) ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ MainAddressFlag ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ BillAddressFlag ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ ShipAddressFlag True. Id of the address. Retrieved Id of the Primary Ship To address of the account. Retrieved Id of the Primary Bill To address of the account.

Siebel 8. navigate to the documentation library for Siebel applications on Oracle Technology Network. refer to your application development documentation on Oracle Technology Network. to fetch the ModId to be sent back while updating. Request (SelfServiceAccountExecute) See the following file to view the sample code: …\SelfServiceAccount\SelfServiceAccountExecute_request. so as to make sure that the record is not updated in the interim. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. see Table 357. Extract the files in the zip file. Description True.xml 210 Siebel CRM Web Services Reference Version 8. For more information on application implementation. SelfServiceAccount Service Object Name SelfServiceAccount Boundary Object Type Business Service Class CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service. SelfServiceAccount Application Interface This topic describes the application objects called by the this Web service.1 Primary Web Services ■ SelfServiceAccount Table 355. which provides CRUD and query operations on Integration Object SS_Account_IO. Table 357. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. if the address is active. Response Message Description: SelfServiceAccountQueryPage Node ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ ActiveStatus ListOfBusinessAddress/ BusinessAddress/ ModId Empty.1 . see Table 356 Table 356. SelfServiceAccount Data Object Siebel Repository Name SS_Account_IO External Name SS_Account_IO Example Package for SelfServiceAccount To view an example of messages for this Web service. This WebService exposes the EAI UI Business Service SelfServiceAccount.

1 21 1 . which provides query operations on Integration Object SS_AccountRootPath_IO. For a given account.xml Response (SelfServiceAccountQueryPage) See the following file to view the sample code: …\SelfServiceAccount\SelfServiceAccountQueryPage_response. In Siebel Self Service 8. navigate to the documentation library for Siebel applications on Oracle Technology Network. Siebel CRM Web Services Reference Version 8. this operation is used for retriving the path to the root account and also to fetch the priceLists of the accounts along this path. SelfServiceAccountRootPath Operations Name SelfServiceAccountRootPathQueryPage Description Performs Query operation based on the viewCriteria and searchSpec set on the instance of SS_AccountRootPath_IO provided as input.xml Request (SelfServiceAccountQueryPage) See the following file to view the sample code: …\SelfServiceAccount\SelfServiceAccountQueryPage_request. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.xml Message Schema (WSDL) for SelfServiceAccount To view the message schema for this Web service.wsdl SelfServiceAccountRootPath This Web service exposes the EAI UI Business Service ‘SelfServiceAccountRootPath’. See the following file to view the message schema: …\SelfServiceAccountQueryPage\SelfServiceAccount.Account Hierarchy. SelfServiceAccountRootPath Operations For a list of operations associated with this Web service. see Table 358.1 Primary Web Services ■ SelfServiceAccountRootPath Response (SelfServiceAccountExecute) See the following file to view the sample code: …\SelfServiceAccount\SelfServiceAccountExecute_response. This Web service exposes the ‘Query’ Method in the ‘SelfServiceAccount’ Business Service as Web service operation. this operation is used in the context of Global Accounts . Extract the files in the zip file.1. Table 358.Siebel 8. The response contains the list of accounts along the path to the root account and the priceList set for each of these accounts.

All. For a description of this response message. Empty. Response Message Description: SelfServiceAccountRootPathQueryPage Node SelfServiceAccountRootPathQueryPage_Output ListOfSSAccountRootPath Description Container element for the QueryPage Operation response. Empty. Corresponds to an instance of SS_AccountRootPath_IO. Empty. Table 359. LDC. from which the path to the root Account needs to be identified. Container element.1 . Request Message Description: SelfServiceAccountRootPathQueryPage Node SelfServiceAccountRootPathQueryPage_Input ListOfSSAccountRootPath ListOfSSAccountRootPath / SSAccountRootPath ListOfSSAccountRootPath / SSAccountRootPath /ParPartyId ListOfSSAccountRootPath / SSAccountRootPath /PartyId ListOfSSAccountRootPath / SSAccountRootPath /PartyName ListOfSSAccountRootPath / SSAccountRootPath /PriceListId ListOfSSAccountRootPath / SSAccountRootPath /RelationTypeCode ListOfSSAccountRootPath / SSAccountRootPath /Level1PartyId ExecutionMode LOVLanguageMode ViewMode Description Container element for the QueryPage Operation request.1 Primary Web Services ■ SelfServiceAccountRootPath Request Message Description: SelfServiceAccountRootPathQueryPage For a description of this request message. see Table 359. 212 Siebel CRM Web Services Reference Version 8. Empty. Empty. Response Message Description: SelfServiceAccountRootPathQueryPage The response contains the details based on the query set on the payment Integration Object . Id of the Account. Corresponds to an instance of SS_AccountRootPath_IO. see Table 360. which holds the columns to be queried. Forward only. Table 360. and the criteria to be used.Siebel 8.

Id of the retrieved account. PriceListId of the retrieved account.1 21 3 . Response Message Description: SelfServiceAccountRootPathQueryPage Node ListOfSSAccountRootPath /SSAccountRootPath Description Container element. For more information on application implementation. this account is one of the accounts in the path. Table 362. Else. the retrieved account is deemed as the root account. SELF or DIRECT or INDIRECT. which corresponds to an Account that is present along the path to the root Account. For more information on application implementation. Service Object (Business Service or Workflow) For a description of the service objects for this Web service.Siebel 8. refer to your application development documentation on Oracle Technology Network. DIRECT=> Account is the parent the Level1PartyId. ListOfSSAccountRootPath /SSAccountRootPath / ParPartyId ListOfSSAccountRootPath /SSAccountRootPath / PartyId ListOfSSAccountRootPath /SSAccountRootPath / PartyName ListOfSSAccountRootPath /SSAccountRootPath / PriceListId ListOfSSAccountRootPath /SSAccountRootPath / RelationTypeCode ListOfSSAccountRootPath /SSAccountRootPath / Level1PartyId SelfServiceAccountRootPath Application Interface This topic describes the application objects called by the SelfServiceAccountRootPath. SelfServiceAccountRootPath Service Object Name SelfServiceAccountRootPath Boundary Object Type Business Service Class CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service. Table 361. If ParPartyId is null. Name of the retrieved account. SelfServiceAccountRootPath Data Object Siebel Repository Name SS_AccountRootPath_IO External Name SS_AccountRootPath_IO Siebel CRM Web Services Reference Version 8. refer to application development documentation. see Table 361. see Table 362.1 Primary Web Services ■ SelfServiceAccountRootPath Table 360.

this operation is used in the context of Global Accounts .Account Hierarchy. For a given root account. Extract the files in the zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network.1 Primary Web Services ■ SelfServiceAllAccountsList Example Package for SelfServiceAccountRootPath To view an example of messages for this Web service.xml Message Schema (WSDL) for SelfServiceAccountRootPath To view the message schema for this Web service. In Siebel Self Service 8.Siebel 8.wsdl SelfServiceAllAccountsList This Web service exposes the EAI UI Business Service SelfServiceAllAccountsList. Extract the files in the zip file.1 . this operation is used for retriving all the children account that are directly or indirectly related to it. 214 Siebel CRM Web Services Reference Version 8. which provides query operations on Integration Object SS_AllAccount_List_IO. This Web service exposes the Query Method in the SelfServiceAllAccountsList Business Service as Web service operation. See the following file to view the message schema: …\SelfServiceAccountRootPath\SelfServiceAccountRootPath. …\SelfServiceAccountRootPath\SelfServiceAccountRootPath_response. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1.xml Response See the following file to view the sample code: NOTE: You need to filter out unnecessary “SELF” relationship records returned in this response. navigate to the documentation library for Siebel applications on Oracle Technology Network. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Request See the following file to view the sample code: …\SelfServiceAccountRootPath\SelfServiceAccountRootPath_request. including itself.

and the criteria to be used. Empty. Empty.1 21 5 .1 Primary Web Services ■ SelfServiceAllAccountsList SelfServiceAllAccountsList Operations For a list of operations associated with this Web service. Container element. Request Message Description: SelfServiceAllAccountsListQueryPage For a description of this request message. Request Message Description: SelfServiceAllAccountsListQueryPage Node SelfServiceAllAccountsListQueryPage_Input ListOfSSAllAccount ListOfSSAllAccount /SSAllAccountList Description Container element for the QueryPage Operation request. which holds the columns to be queried. see Table 364.Siebel 8. Table 363. The response contains the list of accounts that are related to the root account. Type String String String ListOfSSAllAccount /SSAllAccountList /ModId ListOfSSAllAccount /SSAllAccountList / ParentPartyId String String String Siebel CRM Web Services Reference Version 8. see Table 363. Corresponds to an instance of SS_AllAccount_List_IO. SelfServiceAllAccountsList Operations Name SelfServiceAllAccountsListQueryPage Description Performs Query operation based on the viewCriteria (contains the Root Account Id) on the instance of SS_AllAccount_List_IO provided as input. Table 364. Set the Root Account Id as the view criteria.

Corresponds to an instance of SS_AllAccount_List_IO.Siebel 8.1 Primary Web Services ■ SelfServiceAllAccountsList Table 364. Table 365.1 . Request Message Description: SelfServiceAllAccountsListQueryPage Node ListOfSSAllAccount /SSAllAccountList / RelationTypeCode ListOfSSAllAccount /SSAllAccountList / Level1AccountStatus /Level1ApprovalStatus Level1BusinessPhone Level1EmailAddress Level1FaxNumber Level1ParentPartyId Level1PartyLocation Level1PartyName Level1PriceListId Level1PrimaryAddressId Level1PrimaryBillToAddressId Level1PrimaryContactId Level1PrimaryShipToAddressId Level1Type Level2ParentAccountName ExecutionMode LOVLanguageMode ViewMode Empty (Columns to be retrieved in the response) Empty ForwardOnly LDC String String String String Description Empty Type String Response Message Description: SelfServiceAllAccountsListQueryPage For a description of this response message. Type String String 216 Siebel CRM Web Services Reference Version 8. see Table 365. Response Message Description: SelfServiceAllAccountsListQueryPage Node SelfServiceAllAccountsListQueryPage_Input ListOfSSAllAccount Description Container element for the QueryPage Operation response.

Level1PartyName. ListOfSSAllAccount /SSAllAccountList / Level1AccountStatus. AccountName of the Immediate Parent of this child account.Siebel 8. String String Description Container element. Level1PrimaryAddressId. Level1PrimaryShipToAddressId. Level1Type ListOfSSAllAccount /SSAllAccountList / Level1ParentPartyId Immediate Parent of this child account. and the criteria to be used. it matches the root account Id itelsef. Level1PartyLocation.1 21 7 . Level1FaxNumber. Response Message Description: SelfServiceAllAccountsListQueryPage Node ListOfSSAllAccount /SSAllAccountList /ModId ListOfSSAllAccount /SSAllAccountList / ParentPartyId ListOfSSAllAccount /SSAllAccountList /PartyId ListOfSSAllAccount /SSAllAccountList / RelationTypeCode Whether the child is directly or indirectly under this root account. AccountId of the child account.1 Primary Web Services ■ SelfServiceAllAccountsList Table 365. Level1BusinessPhone. Level1PrimaryContactId. Level1PrimaryBillToAddressId. Level1PriceListId. Level1EmailAddress. DIRECT or INDIRECT. Level1ApprovalStatus. For accounts with RelationTypeCode as DIRECT. Empty. Type String String String ListOfSSAllAccount /SSAllAccountList / Level2ParentAccountName String Siebel CRM Web Services Reference Version 8. String Retrieved details of the child account. which holds the columns to be queried. Can be SELF.

Extract the files in the zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network. navigate to the documentation library for Siebel applications on Oracle Technology Network. Extract the files in the zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Table 367. Request See the following file to view the sample code: …\SelfServiceAllAccountsList\SelfServiceAllAccountsList_request. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.Siebel 8.1 Primary Web Services ■ SelfServiceAllAccountsList SelfServiceAllAccountsList Application Interface This topic describes the application objects called by the this Web service.xml Message Schema (WSDL) for SelfServiceAllAccountsList To view the message schema for this Web service. For more information on application implementation. Table 366. SelfServiceAllAccountsList Service Object Siebel Repository Name SS_AllAccount_List_IO External Name SS_AllAccount_List_IO Example Package for SelfServiceAllAccountsList To view an example of messages for this Web service. refer to your application development documentation on Oracle Technology Network. Service Object (Business Service or Workflow) For a description of the service objects for this Web service.xml Response See the following file to view the sample code: …\SelfServiceAllAccountsList\SelfServiceAllAccountsList_response. see Table 367. See the following file to view the message schema: …\SelfServiceAllAccountsList\SelfServiceAllAccountsList.wsdl 218 Siebel CRM Web Services Reference Version 8.1 . see Table 366. SelfServiceAllAccountsList Service Object Name SelfServiceAllAccountsList Boundary Object Type Business Service Class CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service.

operation to Update or if child elements like. Hence in SelfService 8. inclusive of the Personal Addresses associated to the contact. Request Message Description: SelfServiceContactExecute Node ListOfSSContact Contact Corresponds to a record in SS_Contacts_IO. see Table 369.1 21 9 . Set operation accordingly.1. which also accepts an instance of Integration Object SS_Contacts_IO. This Web service exposes the Execute and Query Methods in the SelfServiceContact Business Service as Web service operations. Table 368. Personal Address. Set this if the mode on Contact node is Update or SkipNode. Id of the Contact. If Contact details needs to be updated. This operation is used in Siebel Self Service 8.1 for querying the details of the contact.Siebel 8. see Table 368. needs to be added/updated. which delegates the Integration Object to SelfServiceContact Business Service. for performing all the contact and account management activities. SelfServiceContact Operations For a list of operations associated with this Web service.1 uses SelfServiceRegistration Webservice. SelfServiceContact Web service is mostly used for QueryPage operation. String Description Type Contact /Id Siebel CRM Web Services Reference Version 8. SelfServiceContact Operations Name SelfServiceContactExecute SelfServiceContactQueryPage Performs Query operation based on the viewCriteria and searchSpec set on the instance of SS_Contacts_IO provided as input. Table 369. Siebel SelfService 8. SelfServiceRegistration Web service calls the SelfServiceRegistration workflow. Description Request Message Description: SelfServiceContactExecute For a description of this request message. set operation to SkipNode. which provides CRUD and query operations on Integration Object SS_Contacts_IO. NOTE: Though most of the Contact and Account Management activities can be perforned using SelfServiceContact Web service.1 Primary Web Services ■ SelfServiceContact SelfServiceContact This Web service exposes the EAI UI Business Service SelfServiceContact.

String Details of the assigned account.1 Primary Web Services ■ SelfServiceContact Table 369. Request Message Description: SelfServiceContactExecute Node Contact /ListOfAccount Description Container element for the assigned accounts of this contact. see Table 370. Mod Id Description Container element for the Execute Operation request. Id and ModId of Inserted/Updated Account Record. Response Message Description: SelfServiceContactExecute Node SelfServiceContactExecute_Output ListOfSSContact ListOfSSContact/Contact/Id. String Response Message Description: SelfServiceContactExecute For a description of this response message. If mode on ‘Contact’ is skipnode. then. accounts specified in this list are inserted and assigned to the newly created contact. Corresponds to an instance of SS_Contacts_IO. Id and ModId of Inserted/Updated CommunicationAddress Record. blank for adding new alternate email address. String String String Type 220 Siebel CRM Web Services Reference Version 8. Type Contact/ ListOfContactCommunicationAddress Contact / ListOfContactCommunicationAddress /ContactCommunicationAddress / AlternateEmailAddress Contact / ListOfContactCommunicationAddress /ContactCommunicationAddress / CommunicationAddressId Alternate email address value to be edited or created. Mod Id ListOfSSContact/Contact/ ListOfCommunicationAddress/ CommunicationAddress/Id. PrimaryContactId. Id and ModId of Inserted/Updated Contact Record. All other existing assigned accounts are unassigned by default. String Type Id of the alternate email address value to be edited.Siebel 8. Table 370. If mode on ‘Contact’ is insert.1 . accounts specified in this list are made as the only accounts assigned for this contact. Contact /ListOfAccount/ Account Contact /ListOfAccount/ Account/ Name. then. ModId ListOfSSContact/Contact/ListOfAccount/ Account/Id.

These columns are related to the username information. ChallengeQuestion.1 Primary Web Services ■ SelfServiceContact Request Message Description: SelfServiceContactQueryPage For a description of this request message. to make sure that Contact record is not updated in the interim. Empty (Columns to be retrieved). Status. CellularPhone. ChallengeAnswer Contact/ PrimaryAccountName. WorkPhone. SendPromotions Contact/ LoginName. PrimaryAddressId.Siebel 8. LastName. see Table 371. String String Container element for the AlternateEmailAddress to be retrieved. EmailAddress. Request Message Description: SelfServiceContactQueryPage Node SelfServiceContactQueryPage_Input ListOfSSContact ListOfSSContact/Contact Contact/ Id Contact/ ModId Set the Id of the Contact as a ViewCriteria. Type Complex Type (Refer WSDL) Complex Type (Refer WSDL) Complex Type (Refer WSDL) Contact/ FirstName. Description Container element for the QueryPage Operation request.1 22 1 . Table 371. FaxPhone. Account and AccountBusinessAddress. Retrieve and pass back while updating. ApprovalStatus. Corresponds to an instance of SS_Contacts_IO. PrimaryAddressName PrimaryPersonalAddressId Contact/ ListOfContactCommunicationAddress Empty (Columns to be retrieved). TimeZoneId. Empty (Columns to be retrieved). MiddleName. String Contact / ListOfContactCommunicationAddress /ContactCommunicationAddress String Siebel CRM Web Services Reference Version 8. HomePhone. Contact can have similar sub-nodes for querying PersonalAddress. EmailSRUpdatesFlag.

Description Container element for the QueryPage Operation response. Id of the Alternate Email Address of the contact.1 Registration screens. Corresponds to an instance of SS_Contacts_IO. SendPromotions Contact/ LoginName. ChallengeAnswer Id of the Contact being queried. HomePhone. Request Message Description: SelfServiceContactQueryPage Node Contact / ListOfContactCommunicationAddress /ContactCommunicationAddress / AlternateEmailAddress Contact / ListOfContactCommunicationAddress /ContactCommunicationAddress / CommunicationAddressId ExecutionMode LOVLanguageMode ViewMode Description Empty (Columns to be retrieved). FaxPhone.1 . Response Message Description: SelfServiceContactExecute Node SelfServiceContactQueryPage_Output ListOfSSContact ListOfSSContact/Contact Contact/ Id Contact/ ModId Contact/ FirstName. Complex Type (Refer WSDL) String Complex Type Response Message Description: SelfServiceContactExecute For a description of this response message. LDC. TimeZoneId.Siebel 8. Table 372. EmailSRUpdatesFlag. MiddleName. Primitive details of the contact.1 Primary Web Services ■ SelfServiceContact Table 371. All. CellularPhone. Type String Empty (Columns to be retrieved). EmailAddress. ChallengeQuestion. Alternate Email Address of the contact. Status. EmailSRUpdatesFlag and SendPromotions contain the preferences shown in SelfService 8. LastName. ForwardOnly. Type Complex Type (Refer WSDL) Complex Type (Refer WSDL) Complex Type (Refer WSDL) These nodes contain the values for the username information. String 222 Siebel CRM Web Services Reference Version 8. Container element for the QueryPage Operation response. WorkPhone. see Table 372. ApprovalStatus.

Primary BusinessAddressName and PrimaryPersonalAddressId respectively. see Table 373. PrimaryAddressName PrimaryPersonalAddressId Contact/ ListOfContactCommunicationAddress Contact / ListOfContactCommunicationAddress / ContactCommunicationAddress Contact / ListOfContactCommunicationAddress / ContactCommunicationAddress / AlternateEmailAddress Contact / ListOfContactCommunicationAddress / ContactCommunicationAddress / CommunicationAddressId ExecutionMode LOVLanguageMode ViewMode Alternate Email Address of the contact. (Refer WSDL) String Complex Type SelfServiceContact Application Interface This topic describes the application objects called by the this Web service. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. All. LDC. Complex Type ForwardOnly. String String Description These nodes contain the values for the PrimaryAccountName. refer to your application development documentation on Oracle Technology Network. Type String String Id of the Alternate Email Address of the contact. Container element for the AlternateEmailAddress retrieved.1 22 3 . Primary BusinAddressId. Response Message Description: SelfServiceContactExecute Node Contact/ PrimaryAccountName. PrimaryAddressId.Siebel 8. For more information on application implementation. SelfServiceContact Service Object Name SelfServiceContact Boundary Object Type BusinessService Class CSSEAIUIDataService Siebel CRM Web Services Reference Version 8. Table 373.1 Primary Web Services ■ SelfServiceContact Table 372.

Extract the files in the zip file. SelfServiceContact Data Object Siebel Repository Name SS_Contacts_IO External Name SS_Contacts_IO Example Package for SelfServiceContact To view an example of messages for this Web service.xml Request (SelfServiceContactExecute) See the following file to view the sample code: …\SelfServiceContact\SelfServiceContactExecute_request.xml Response (SelfServiceContactExecute) See the following file to view the sample code: …\SelfServiceContact\SelfServiceContactExecute_request.xml Message Schema (WSDL) for SelfServiceContact To view the message schema for this Web service. See the following file to view the message schema: …\SelfServiceContact\SelfServiceContact. navigate to the documentation library for Siebel applications on Oracle Technology Network.1 Primary Web Services ■ SelfServiceContact Data Object (Integration Object) For a description of data objects for this Web service. Table 374. Request (SelfServiceContactQueryPage) See the following file to view the sample code: …\SelfServiceContact\SelfServiceContactQueryPage_request. see Table 374.wsdl 224 Siebel CRM Web Services Reference Version 8. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 .xml Response (SelfServiceContactQueryPage) See the following file to view the sample code: …\SelfServiceContact\SelfServiceContactQueryPage_request.Siebel 8. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network. Extract the files in the zip file.

transaction amount. For a description of this response message.Siebel 8.type and date along with the order numbers can be queried.payment related details like the payment profile details. Payment details like Payment type.1 22 5 . Type Integration Object Response Message Description: SelfServicePaymentHistoryQueryPage The response contains the details based on the query set on the payment Integration Object. type and date for different orders against which the payment was made by a contact can be queried.this method is used for querying the payment details for different orders performed by a contact. Table 375. Response Message Description: SelfServicePaymentHistoryQueryPage Node SelfServicePaymentHistoryQueryPage_Output Description Integration Object Type The retrieved data for the query performed. Request Message Description: SelfServicePaymentHistoryQueryPage Based on the query criteria set on the Integration Object. refer to your application development documentation on Oracle Technology Network. SelfServicePaymentHistory Application Interface This Web service exposes the EAI UI Business Service SelfServicePaymentHistory. see Table 377. Table 377. SelfServicePaymentHistory Operations Name SelfServicePaymentHistoryQueryPage Description Performs query operations set on the SS_PaymentHistory_IO Integration Object as the input. For more information on application implementation. Payment profile. which provides update and query operations on Integration Object SS_PaymentHistory_IO. transaction amount. Request Message Description: SelfServicePaymentHistoryQueryPage Node SelfServicePaymentHistory QueryPage_Input Description The method arguments are Payment Integration Object. see Table 375. see Table 376. For a description of this request message. Language Mode (value is “LDC”) and viewMode (“All”).1 Primary Web Services ■ SelfServicePaymentHistory SelfServicePaymentHistory This webservice queries the Payment History details as specified by the search criteria for any contact logged into the application. Table 376. Siebel CRM Web Services Reference Version 8. SelfServicePaymentHistory Operations For a list of operations associated with this Web service.

navigate to the documentation library for Siebel applications on Oracle Technology Network.xml Message Schema (WSDL) for SelfServicePaymentHistory To view the message schema for this Web service. see Table 378. navigate to the documentation library for Siebel applications on Oracle Technology Network. SelfServicePaymentHistory Service Object Name SelfServicePaymentHistory Boundary Object Type Integration Object Class CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service. Request See the following file to view the sample code: …\SelfServicePaymentHistory\SelfServicePaymentHistory_request.1 Primary Web Services ■ SelfServicePaymentHistory Service Object (Business Service or Workflow) For a description of the service objects for this Web service.Siebel 8.1 . and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. see Table 379. Table 378.wsdl 226 Siebel CRM Web Services Reference Version 8. Extract the files in the zip file.xml Response See the following file to view the sample code: …\SelfServicePaymentHistory\SelfServicePaymentHistory_response. Extract the files in the zip file. SelfServicePaymentHistory Data Object Siebel Repository Name SS_PaymentHistory_IO External Name Payments Example Package for SelfServicePaymentHistory To view an example of messages for this Web service. Table 379. See the following file to view the message schema: …\SelfServicePaymentHistory\SelfServicePaymentHistory.

Table 380. P_Mode Request Parameter For a description of the P_Mode request parameter. Table 382. Returns both the contact details and responsibilities for the given user name.1 Primary Web Services ■ SelfServicePostLoginProcess SelfServicePostLoginProcess This Web service exposes the SelfServicePostLoginProcess workflow as LoadUserDetails operation. as displayed in Table 380. Table 381. Request Message Description: LoadUserDetails For a description of this request message.doc for the details on ListOfContact and its subnodes. see Table 380. where in ListOfSSContact/Contact/LoginName contains the username of the user for whom the details need to be retrived. The response of this Web service is determined by the P_Mode request parameter. Request Message Description: LoadUserDetails Node P_Mode ListOfSSContact Description See P_Mode Request Parameter table. SelfServicePostLoginProcess Operations For a list of operations associated with this Web service. SelfServicePostLoginProcess Operations Name LoadUserDetails Description This operation triggers the SelfServicePostLoginProcess workflow.1 22 7 . An SS_Contact_IO instance. P_Mode Request Parameter P_Mode OnlyLoadResponsibilities SkipLoadResponsibilities LoadEverything Response Returns only the responsibilities for the given user name.Siebel 8. Maps to an instance of “getUserResponsibilitiesResponse” IO String Complex Type (See WSDL) Type String P_LoginName getUserResponsibilitiesResponse getUserResponsibilitiesResponse / listOfUserResponsibilities/ Siebel CRM Web Services Reference Version 8. Returns only the contact details for the given user name. Container element for Responsibilities. Username of the user for whom the details need to be retrived. Refer to the SelfServiceContact. see Table 381. see Table 382.

Type Complex Type (See WSDL) getUserResponsibilitiesResponse Complex Type getUserResponsibilitiesResponse / listOfUserResponsibilities/ userResponsibilities/ responsibilityValue Error_spcCode Error_spcMessage (See WSDL) Name of the Responsibility. Refer to the SelfServiceContact. like Account and PersonalAddrrss. see Table 383. Table 384. Response Message Description: LoadUserDetails Node LoadUserDetails_Output ListOfSSContact Description Container element for the “LoadUserDetails” operation response. see Table 384.Siebel 8. which will have the retrived accounts(assigned) and PersonalAddress of the contact respectively. where in ListOfSSContact/Contact/Id contains the contactId of the user for whom the details are retrieved. An SS_Contact_IO instance.doc for the other nodes in ListOfContact and its complex subnodes. Table 383. refer to your application development documentation on Oracle Technology Network.1 .1 Primary Web Services ■ SelfServicePostLoginProcess Response Message Description: LoadUserDetails For a description of this response message. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Will be blank when mode is SkipLoadResponsibilities. SelfServicePostLoginProcess Service Object Name SelfServicePostLoginProcess Boundary Object Type Workflow 228 Siebel CRM Web Services Reference Version 8. For more information on application implementation. Complex Type (See WSDL) SelfServicePostLoginProcess Application Interface This topic describes the application objects called by the this Web service. Error Code returned by the Workflow.

and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. SelfServicePostLoginProcess Data Object Siebel Repository Name SelfServiceContact getUserResponsibilitiesResponse External Name SelfServiceContact getUserResponsibilitiesResponse Example Package for SelfServicePostLoginProcess To view an example of messages for this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network.xml Response (LoadUserDetails_SkipLoadResponsibilities) See the following file to view the sample code: …\SelfServicePostLoginProcess\LoadUserDetails_SkipLoadResponsibilities_response.1 Primary Web Services ■ SelfServicePostLoginProcess Data Object (Integration Object) For a description of data objects for this Web service. See the following file to view the message schema: …\SelfServicePostLoginProcess\SelfServicePostLoginProcess. Request (LoadUserDetails_OnlyLoadResponsibilities) See the following file to view the sample code: …\SelfServicePostLoginProcess\LoadUserDetails_OnlyLoadResponsibilities_request.xml Response(LoadUserDetails_OnlyLoadResponsibilities) See the following file to view the sample code: …\SelfServicePostLoginProcess\LoadUserDetails_OnlyLoadResponsibilities_response. Extract the files in the zip file. Table 385.xml Request (LoadUserDetails_SkipLoadResponsibilities) See the following file to view the sample code: …\SelfServicePostLoginProcess\LoadUserDetails_SkipLoadResponsibilities_request. see Table 385.Siebel 8. navigate to the documentation library for Siebel applications on Oracle Technology Network.xml Message Schema (WSDL) for SelfServicePostLoginProcess To view the message schema for this Web service.wsdl Siebel CRM Web Services Reference Version 8. Extract the files in the zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 22 9 .

Also used in Forgot Password Flow (for an anonymous session).Profile. inbox and approval types.Profile view. Table 386. Used in Siebel SelfService 8.1 in the Contacts . 230 Siebel CRM Web Services Reference Version 8. which internally uses the Business Services listed below to manage contacts. see Table 386. send welcome or password update notifications and createInboxItems to simulate pending registration approvals. and other usages in the Contacts . P_Mode Request Parameter For a description of the P_Mode request parameter.1 Primary Web Services ■ SelfServiceRegistration SelfServiceRegistration The ‘Enroll’ operation of this webservice invokes the “SelfServiceRegistration” workflow. if approval is needed. UpdateContact Used for updating a contact without a username.Administration screen. notification template. Used in Siebel SelfService 8. create username. and the Contacts . P_Mode Request Parameter P_Mode CreateContact Response Used for creating a contact without a username.Administration screen to update user information. assigned accounts. and the Contacts .Profile.1 . Also used for all self-service registrations. UpdateUser Used for updating a contact with a username and manage the assigned accounts and responsibilities. create a username in the associated LDAP. Need to pass the Usertype details (like approval required).Administration screen. ResetPasswordOnly Used for resetting the password of the currently logged in user of the siebel session or in the anonymous session. assign responsibilities. Activity of the workflow is determined by the P_mode input parameter passed to this webservice operation. Used in Siebel SelfService 8. CreateUser Used for creating a new contact. manage assigned responsibilities.Account views. and Contacts .1 for making a contact as a user in the Contacts . send welcome notification to the user and create an inbox item to the admin.Siebel 8. assigned personal/business addresses. when the mode is CreateUser. Also used for Personal Info updating from Contacts .Account views.1 in contact creation in the Contacts Administration screen.1 in the Contacts . Used in Siebel SelfService 8.

Siebel 8. Business Services Called by Enroll Operation The following Business Services aer called by the Enroll operation and are listed below: ■ ■ ■ ■ ■ ■ ■ ■ ■ EAITransactionService Business Service on page 231 SelfServiceContact Business Service on page 232 PRM ANI Utility Service Business Service on page 233 SiebelWebRegistrationService Business Service on page 234 Self Service User Business Service on page 235 EAITransactionService Business Service on page 236 ISS Approval Bus Service Business Service on page 237 Outbound Communications Manager Business Service on page 238 SessionAccessService Business Service on page 239 EAITransactionService Business Service For a description of this Business Service.1 Primary Web Services ■ SelfServiceRegistration SelfServiceRegistration Operations For a list of operations associated with this Web service.1 23 1 . Table 388. Siebel CRM Web Services Reference Version 8. EAITransactionService Business Service EAITransactionService Business Service Step Business Service Name Business Service Method Description Begin Transaction EAITransactionService Begin Transaction This step is used to initiate a transaction. Table 387. BeginTransaction will not take any parameters as input. see Table 387. SelfServiceRegistration Operations Name Enroll Description Internally calls the business services listed below. see Table 388.

Contact Address. Account. This step executes an EAIUI Service to execute the operations specified at each step in the Integration Object and returns a ContactIO with the ids specified for each step.1 Primary Web Services ■ SelfServiceRegistration SelfServiceContact Business Service For a description of this Business Service. and update contact and account records SelfServiceContact Execute Input Arguments Argument Name SiebelMessageIn ViewMode LanguageMode ExecutionMode Type Process Property Process Property Process Property Process Property Output Arguments Argument Name SiebelMessageOut Description Type Output Argument Property Name P_ContactIO(SS_Contacts_IO) Property Name P_ContactIO(SS_Contacts_IO) All LDC BiDirectional This step is used to create or update Contact. Contact Integration Object with appropriate action specified at the request elements is prepared in the java layer and passed as a Process Property to the workflow. Table 389. 232 Siebel CRM Web Services Reference Version 8. Sample SOAP request portions of SS_Contacts_IO are shown below.1 . see Table 389.Siebel 8. Contact_Account relationships and Alternate Communication Address. Self ServiceContact Business Service SelfServiceContact Business Service Step Business Service Name Business Service Method Create.

given the contact IO. seeTable 391. PRM ANI Utility Service Business Service PRM ANI Utility Service Business Service Step Business Service Name Business Service Method Retrieve Contact Id PRM ANI Utility Service GetProperty Input Arguments Argument Name Hierarchy Path: Property Name SiebelMessage Type Literal Literal Hierarchy Output Arguments Argument Name Property Value Description Type Output Argument Property Name P_ContactId Property Name Contact Id P_ContactIO(SS_Contacts_IO) This step is used to retrieve the contact Id.1 23 3 . In SelfService 8. the caller (java API that calls the proxy) shall ignore the errors reported by this step. which is then sent to Trigger Approval.1. Table 391. PRM ANI Utility Service Business Service PRM ANI Utility Service Business Service Step Business Service Name Business Service Method Retrieve Account Id (called only when accountId Process Property is null) PRM ANI Utility Service GetProperty Siebel CRM Web Services Reference Version 8.Siebel 8. PRM ANI Utility Service Business Service For a description of this Business Service. this step is only applicable during the Register your company flow to retrieve the Id of the newly created corporate account. and established as the root account. see Table 390. Hence. Table 390.1 Primary Web Services ■ SelfServiceRegistration PRM ANI Utility Service Business Service For a description of this Business Service.

seeTable 392. Table 392. and established as the root account.1. In SelfService 8. the caller (java API that calls the proxy) shall ignore the errors reported by this step. SiebelWebRegistrationService Business Service SiebelWebRegistrationService Business Service Step Business Service Name Business Service Method Create User SiebelWebRegistrationService Promote Input Arguments Argument Name Contactid Type Proxy User LoginName Password securityQuestion Type Process Property Process Property Process Property Process Property Process Property Process Property Property Name P_ContactId P_Usertype P_ProxyEmpLoginName P_LoginName P_NewPassword P_ChallengeQuestion 234 Siebel CRM Web Services Reference Version 8. which is then sent to Trigger Approval. given the contact IO. Hence.1 .Siebel 8.1 Primary Web Services ■ SelfServiceRegistration Table 391. PRM ANI Utility Service Business Service PRM ANI Utility Service Input Arguments Argument Name Hierarchy Path: Property Name SiebelMessage Type Literal Literal Hierarchy Output Arguments Argument Name Property Value Description Type Output Argument Property Name AccountId Property Name Contact Account Id P_ContactIO (SS_Contacts_IO) This step is used to retrieve the account Id. SiebelWebRegistrationService Business Service For a description of this Business Service. this step is only applicable during the Register your company flow to retrieve the Id of the newly created corporate account.

1 Primary Web Services ■ SelfServiceRegistration Table 392.Siebel 8. seeTable 393. S_USER record and also update the security question and answer.1 23 5 . Self Service User Business Service For a description of this Business Service. It uses a new EAIUI Service named SelfServiceUser that creates the S_PER_RESP records for the given user Id and the responsibility Id. The business service needs to create Web Channel User of “Web User” Type. LDAP user record. Self Service User Business Service Self Service User Business Service Step Business Service Name Business Service Method Assign Responsibilities SelfServiceUser Execute Input Arguments Argument Name SiebelMessageIn ViewMode LanguageMode Type Process Property Process Property Process Property Output Arguments Argument Name SiebelMessageOut Description Type Output Argument Property Name P_UserIO Property Name P_UserIO All LDC This step is used to create the responsibilities in Siebel. Table 393. Siebel CRM Web Services Reference Version 8. SiebelWebRegistrationService Business Service SiebelWebRegistrationService securityAnswer Process Property Output Arguments Argument Name SuccessCode ErrorMessage Description Type Output Argument Output Argument Property Name P_CreateUserStatus Error Message P_ChallengeAnswer This step executes the SiebelWebRegistrationService Business service to create a “Web_User” for the given contactid.

EAITransactionService Business Service EAITransactionService Business Service Step Business Service Name Business Service Method Commit Transaction EAITransactionService EndTransaction Input Arguments Argument Name Is Abort Description Type Literal Property Name False This step uses EAITransactionService. The parameter Is Abort need be set to False to commit the transaction.1 Primary Web Services ■ SelfServiceRegistration EAITransactionService Business Service For a description of this Business Service. see Table 394.1 .Siebel 8. EndTransaction to commit the transaction. Table 394. 236 Siebel CRM Web Services Reference Version 8.

based on the P_UsertypeApprovalRequd process property. ISS Approval Bus Service Business Service ISS Approval Bus Service Business Service Step Business Service Name Business Service Method Trigger Approval ISS Approval Bus Service CreateNewApprovalTasks Input Arguments Argument Name RequestingBusComp Approval Item ID Approval Level Name Inbox Type Approval Level Context Description Type Literal Process Property Process Property Process Property Process Property Property Name Value = Contact P_ContactId P_UsertypeApprovalType P_UsertypeInboxType P_AccountId This step uses ISS Approval Bus Service. for newly created corporate account (Register your company flow). see Siebel Self-Service Application Developer’s Guide. see Table 395. Siebel CRM Web Services Reference Version 8. Hence.1 Primary Web Services ■ SelfServiceRegistration ISS Approval Bus Service Business Service For a description of this Business Service.Siebel 8. Table 395. Note that P_AccountId contains the root account of the corporate account under which the contact/user is being created. CreateNewApprovalTasks business service method to create new Inbox Items based on the Inbox Type and Approval Types specified. For more information. P_AccountId is set to the Id of the newly created account. This step is executed only if approval is required by the user type.1 23 7 .

1 Primary Web Services ■ SelfServiceRegistration Outbound Communications Manager Business Service For a description of this Business Service. P_ContactId P_NotificationTemplateName P_Language P_Locale Property Name 238 Siebel CRM Web Services Reference Version 8. seeTable 396. using the Outbound Communications Manager.Siebel 8. Table 396. Outbound Communications Manager Business Service Outbound Communications Manager Business Service Step Business Service Name Business Service Method Trigger Notification Outbound Communications Manager CreateRequest Input Arguments Argument Name RecipientBusComp SourceIdList PackageNameList RequestLanguageCode RequestLocaleCode ProcessMode RequestName RecipientGroup Description Type Literal Process Property Process Property Process Property Process Property Literal Literal Process Property This step is used to trigger the notification based on the notification template specified. see Siebel Self-Service Application Developer’s Guide. CreateRequest. For more information.1 . This Business Service Method substitutes the necessary values from the ‘Contact’ Business Component loaded for the ‘Id‘ specified.

. Not of consequence in response. see Siebel Self-Service Application Developer’s Guide. Table 398. Type String String String String String Siebel CRM Web Services Reference Version 8.Siebel 8. SessionAccessService Business Service SessionAccessService Business Service Step Business Service Name Business Service Method Set new password in Siebel session SessionAccessService SetProfileAttr Input Arguments Argument Name Name Value PackageNameList RequestLanguageCode RequestLocaleCode ProcessMode RequestName RecipientGroup Description Type Literal Process Property Process Property Process Property Process Property Literal Literal Process Property This step is used to set the password in Siebel session. Not of consequence in response. Table 397. see Table 397. see Table 398. Response Message Description: CreateContact Node Process_spcInstance_spcId Object_spcId Siebel_spcOperation_spcObject_spcId Error_spcCode Error_spcMessage Description Not of consequence in response.1 Primary Web Services ■ SelfServiceRegistration SessionAccessService Business Service For a description of this Business Service.1 23 9 . For more information. Not of consequence in response. Not of consequence in response. P_NewPassword P_NotificationTemplateName P_Language P_Locale Property Name Response Message Description: CreateContact For a description of this Business Service.

Not of consequence in response. Inactive. Not of consequence in response. String String String String String String String String String String String String String Type Integration Object 240 Siebel CRM Web Services Reference Version 8. Not of consequence in response. P_DefaultOrgId P_Mode P_Usertype P_LoginName P_DefaultProxyEmployee P_LoginId P_CreateUserStatus P_Password P_NewPassword P_ChallengeQuestion P_ChallengeAnswer Not of consequence in response.1 Siebel BookShelf for more details. Maps to the P_ContactIO process property in the workflow. Not of consequence in response. for pending users. Response Message Description: CreateContact Node ListOfSSContact Description Contains an instance of the output integration object SS_Contacts_IO that holds the Id and ModId of the contact / account that is created/updated. Not of consequence in response. Username created Not of consequence in response. The status set on the newly created user.Siebel 8. Refer to SelfServiceContact WebService document for more information on the Structure and subnodes of ListOfSSContact. P_ContactId P_AccountId Not of consequence in response. Not of consequence in response. Derived Root Account Id Refer to SelfService 8.1 .1 Primary Web Services ■ SelfServiceRegistration Table 398. Value returned by SiebelWebRegistration BusinessService.

see Table 399. Not of consequence in response. Not of consequence in response. P_UsertypeApprovalRequd P_UsertypeApprovalType P_UsertypeInboxType P_UsertypeNotifTemplateName P_RecipientGroup P_Language P_Locale Not of consequence in response. Table 399. Not of consequence in response. String String String String String String String Type Integration Object Self Service Registration Application Interface This topic describes the application objects called by the this Web service. Not of consequence in response.1 24 1 . Refer to SelfServiceUser WebService document for more information on the Structure and subnodes of ListOfSSUser. Not of consequence in response. Response Message Description: CreateContact Node ListOfSSUser Description Contains an instance of the input Contains an instance of the output integration object “Users” that holds the Id and Mode Id of the user-responsibility mapping for the updated responsibility assignments. For more information on application implementation. Maps to the P_UserIO process property in the workflow.Siebel 8. Not of consequence in response. Self Service Registration Service Object Name SelfServiceRegistration Boundary Object Type Workflow Siebel CRM Web Services Reference Version 8. Service Object (Business Service or Workflow) For a description of the service objects for this Web service.1 Primary Web Services ■ SelfServiceRegistration Table 398. refer to your application development documentation on Oracle Technology Network.

Self Service Registration Data Object Siebel Repository Name SelfServiceContact Users External Name SelfServiceContact Users Example Package for SelfServiceRegistration To view an example of messages for this Web service. Account Assignments.xml Request Create a B2B contact as Inactive and create a username and trigger notification and create Inbox Items for approval. see Table 400.1 Primary Web Services ■ SelfServiceRegistration Data Object (Integration Object) For a description of data objects for this Web service.xml 242 Siebel CRM Web Services Reference Version 8. See the following file to view the sample code: …\SelfServiceRegistration\SelfServiceRegistration_1_request. Update Personal addresses of an existing Contact. Extract the files in the zip file. Request Create a B2C contact and username and trigger notification.Siebel 8. navigate to the documentation library for Siebel applications on Oracle Technology Network.1 . Responsibility Assignments. See the following file to view the sample code: …\SelfServiceRegistration\SelfServiceRegistration_2_request.xml Response Create a B2C contact and username and trigger notification. Create a B2B contact as Inactive and create a username and trigger notification and create Inbox Items for approval. Update Contact details. Table 400. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Request and Response Samples are provided for the following scenarios: 1 2 3 4 Create a B2C contact and a username and trigger notification. Password resetting for an existing contact. See the following file to view the sample code: …\SelfServiceRegistration\SelfServiceRegistration_1_request.

See the following file to view the sample code: …\SelfServiceRegistration\SelfServiceRegistration_2_response. Responsibility Assignment. See the following file to view the message schema: …\SelfServiceRegistration\SelfServiceRegistration.Siebel 8. See the following file to view the sample code: …\SelfServiceRegistration\SelfServiceRegistration_4_request. Account Assignment. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Password resetting for an existing contact.wsdl Siebel CRM Web Services Reference Version 8. Account Assignment.xml Response Update Personal Addresses of an existing contact. See the following file to view the sample code: …\SelfServiceRegistration\SelfServiceRegistration_3\_response.xml Request Update Contact Details.1 24 3 .1 Primary Web Services ■ SelfServiceRegistration Response Create a B2B contact as Inactive and create a username and trigger notification and create Inbox Items for approval. Extract the files in the zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network.xml Message Schema (WSDL) for SelfServiceRegistration To view the message schema for this Web service.xml Response Update Contact Details.xml Request Update Personal Addresses of an existing contact. See the following file to view the sample code: …\SelfServiceRegistration\SelfServiceRegistration_3_request. Password resetting for an existing contact See the following file to view the sample code: …\SelfServiceRegistration\SelfServiceRegistration_4_response. Responsibility Assignment.

Corresponds to an SS_Responsibility_IO IO. see Table 401.1 . Placeholder for the name of the responsibility to be retrived. Set to “Yes”. Container element for the list of SS_Responsibility_IO. 244 Siebel CRM Web Services Reference Version 8.Siebel 8. Table 402. Table 401.1 for retrieving the Id and Name of Web Enabled Responsibilities. for retrieving only Web Enabled Responsibilities. SelfServiceResponsibility Operations Name SelfServiceResponsibilityQueryPage Description Performs Query operation based on the viewCriteria and searchSpec set on the instance of SS_Responsibility_IO provided as input. see Table 402. Empty.1 Primary Web Services ■ SelfServiceResponsibility SelfServiceResponsibility This Web service exposes the EAI UI Business Service SelfServiceResponsibility. Placeholder for the Id of the responsibility to be retrived. Request Message Description: SelfServiceResponsibilityQueryPage For a description of this request message. this Web service exposes the Query Method in the SelfServiceResponsibility Business Service as Web service operation. which provides query operation on Integration Object SS_Responsibility_IO. Corresponds to the primary IC ‘Responsibility’. This operation is used in Siebel Self Service 8. Empty. Request Message Description: SelfServiceResponsibilityQueryPage Node SelfServiceResponsibilityQuery Page_Input ListOfSSResponsibility ListOfSSResponsibility/ Responsibility ListOfSSResponsibility/ Responsibility/AccessType ListOfSSResponsibility/ Responsibility/Id ListOfSSResponsibility/ Responsibility/Name Description Container element for SelfServiceResponsibility WebService input for QueryPage operation. SelfServiceResponsibility Operations For a list of operations associated with this Web service. Additionally.

see Table 404. see Table 403.1 24 5 . Table 405. Container element for the list of SS_Responsibility_IO. Retrived Id of the responsibility. Response Message Description: SelfServiceResponsibilityQueryPage Node SelfServiceResponsibilityQueryPage_Output Description Container element for SelfServiceResponsibility WebService output for QueryPage operation. Table 403. Table 404. “Yes” for Web Enabled Responsibility. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Corresponds to an SS_Responsibility_IO Integration Object. SelfServiceResponsibility Service Object Name SelfServiceResponsibility Boundary Object Type BusinessService Class CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service. For more information on application implementation. see Table 405.Siebel 8. refer to your application development documentation on Oracle Technology Network. Retrived name of the responsibility. Corresponds to the primary IC ‘Responsibility’.1 Primary Web Services ■ SelfServiceResponsibility Response Message Description: SelfServiceResponsibilityQueryPage For a description of this response message. ListOfSSResponsibility ListOfSSResponsibility/Responsibility ListOfSSResponsibility/Responsibility/ AccessType ListOfSSResponsibility/Responsibility/Id ListOfSSResponsibility/Responsibility/Name SelfServiceResponsibility Application Interface This topic describes the application objects called by the this Web service. SelfServiceResponsibility Data Object Siebel Repository Name SS_Responsibility_IO External Name SS_Responsibility_IO Siebel CRM Web Services Reference Version 8.

and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 . Request See the following file to view the sample code: …\SelfServiceResponsibility\SelfServiceResponsibility_request.wsdl SelfServiceSmtpEmail The SendSmtpEmail operation of this Web service invokes the SelfServiceSmtpEmail workflow. Extract the files in the zip file.1 Primary Web Services ■ SelfServiceSmtpEmail Example Package for SelfServiceResponsibility To view an example of messages for this Web service.xml Response See the following file to view the sample code: …\SelfServiceResponsibility\SelfServiceResponsibility_response.Siebel 8. Extract the files in the zip file. see Table 406. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network. SelfServiceSmtpEmail Operations For a list of operations associated with this Web service. SelfServiceSmtpEmail Operations Name SendSmtpEmail Description Invokes “SelfServiceSmtpEmai”l workflow. navigate to the documentation library for Siebel applications on Oracle Technology Network. 246 Siebel CRM Web Services Reference Version 8. See the following file to view the message schema: …\SelfServiceResponsibility\SelfServiceResponsibility.xml Message Schema (WSDL) for SelfServiceResponsibility To view the message schema for this Web service. Table 406. which internally uses the Outbound Communications Manager Business Service for sending non-template based SMTP Email.

Type String String String String String String String String String Siebel CRM Web Services Reference Version 8. for exceptions raised while submitting the request. if any. see Table 408. Id of Siebel operation. Not of consequence in response. see Table 407. This is automatically set from the workflow. for exceptions raised while submitting the request. Semicolon-separated list of email addresses for the TO line. Object Id. Response Message Description: SendSmtpEmail Node FromAddress MessageToList MessageCCList MessageBCCList MessageSubject MessageBody MessageHTMLBody Error Code Error Message Description Not of consequence in response. Message content in HTML. Not of consequence in response. Error message. Semicolon-separated list of email addresses for th CC line. Descriptive subject line for the message. This parameter when specified would override the parameter ‘MessageBody’. if any. Type String String String String String String String String String String String String Response Message Description: SendSmtpEmail For a description of this response message. This is automatically set from the workflow. Table 407. Request Message Description: SendSmtpEmail Node FromAddress MessageToList MessageCCList MessageBCCList MessageSubject MessageBody MessageHTMLBody Error Code Error Message Object Id Process Instance Id Siebel Operation Object Id Description Email address of the sender. Semicolon-separated list of email addresses for th BCC line. Id of process instance.Siebel 8. if any. Not of consequence in response. Not of consequence in response. if any. Table 408. Error details. Error code.1 Primary Web Services ■ SelfServiceSmtpEmail Request Message Description: SendSmtpEmail For a description of this request message. Not of consequence in response.1 24 7 . Message content in plain-text. Not of consequence in response. Error code.

Table 409. see Table 409.1 . and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.Siebel 8.1 Primary Web Services ■ SelfServiceSmtpEmail Table 408. navigate to the documentation library for Siebel applications on Oracle Technology Network.xml Response See the following file to view the sample code: …\SelfServiceSmtpEmail\SelfServiceSmtpEmail_response. Response Message Description: SendSmtpEmail Node Object Id Process Instance Id Siebel Operation Object Id Description Standard WF Output. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Request See the following file to view the sample code: …\SelfServiceSmtpEmail\SelfServiceSmtpEmail_request. Standard WF Output. See the following file to view the message schema: 248 Siebel CRM Web Services Reference Version 8. navigate to the documentation library for Siebel applications on Oracle Technology Network. For more information on application implementation. refer to your application development documentation on Oracle Technology Network.xml Message Schema (WSDL) for SelfServiceSmtpEmail To view the message schema for this Web service. SelfServiceSmtpEmail Service Object Name SelfServiceSmtpEmail Boundary Object Type Workflow Process Example Package for SelfServiceSmtpEmail To view an example of messages for this Web service. Extract the files in the zip file. Standard WF Output. Extract the files in the zip file. Type String String String SelfServiceSmtpEmail Application Interface This topic describes the application objects called by the this Web service.

see Table 410. Table 411.1 Primary Web Services ■ SelfServiceTemplateEmail …\SelfServiceSmtpEmail\SelfServiceSmtpEmail. An optional string that would help trace the outbound communication requests at the server side. The source recipient group name. A template must exist with the name and locale combination specified.wsdl SelfServiceTemplateEmail The ‘SendTemplateEmail’ operation of this webservice invokes the “SelfServiceTemplateEmail” workflow.Siebel 8. see Table 411. SelfServiceTemplateEmail Operations For a list of operations associated with this Web service. Request Message Description: SendTemplateEmail Node TemplateName SourceRecipientGroupName SourceObjectID Description The communication template name to be used in the request. Blank. Defaulting is not recommended. ROW_ID of the source object component of the recipient group. SelfServiceTemplateEmail Operations Name SendTemplateEmail Description Invokes “SelfServiceTemplateEmail” workflow. A template must exist with the name and language combination specified. Type String String String TemplateLanguageCode String TemplateLocaleCode String RequestName String RequestStatus Error Code Error Message String String String Siebel CRM Web Services Reference Version 8. Locale code the template. Language code the template. This would determine the data retrieved for processing the template and recipient address for the email. Status code for the outbound request placed. Request Message Description: SendTemplateEmail For a description of this request message.1 24 9 . which internally uses the “Outbound Communications Manager” Business Service for sending template based SMTP Email. Blank. Table 410. Either the name of Siebel-seeded recipient group or a custom one. Defaulting is not recommended.

Standard WF Output. if any. Standard WF Output. if any. This is automatically set from the workflow.1 . refer to your application development documentation on Oracle Technology Network. Not of consequence in response. for exceptions raised while submitting the request. see Table 412. 250 Siebel CRM Web Services Reference Version 8. Standard WF Output. This is automatically set from the workflow. Blank.1 Primary Web Services ■ SelfServiceTemplateEmail Table 411. Blank.Siebel 8. Error details. Error code. Not of consequence in response. Type String String String Response Message Description: SendTemplateEmail For a description of this response message. Not of consequence in response. Table 412. Response Message Description: SendTemplateEmail Node TemplateName SourceRecipientGroupName SourceObjectID TemplateLanguageCode TemplateLocaleCode RequestName RequestStatus Error Code Description Not of consequence in response. Not of consequence in response. Not of consequence in response. Not of consequence in response. Type String String String String String String String String Error Message String Object Id Process Instance Id Siebel Operation Object Id String String String SelfServiceTemplateEmail Application Interface This topic describes the application objects called by the this Web service. For more information on application implementation. for exceptions raised while submitting the request. Request Message Description: SendTemplateEmail Node Object Id Process Instance Id Siebel Operation Object Id Description Blank.

1 25 1 . see Table 413.xml Response See the following file to view the sample code: …\SelfServiceTemplateEmail\SelfServiceTemplateEmail_response. See the following file to view the message schema: …\SelfServiceTemplateEmail\SelfServiceTemplateEmail. navigate to the documentation library for Siebel applications on Oracle Technology Network. Request See the following file to view the sample code: …\SelfServiceTemplateEmail\SelfServiceTemplateEmail_request. see Table 414.Siebel 8.1 Primary Web Services ■ SelfServiceTemplateEmail Service Object (Business Service or Workflow) For a description of the service objects for this Web service.xml Message Schema (WSDL) for SelfServiceTemplateEmail To view the message schema for this Web service. Table 413. Extract the files in the zip file. SelfServiceTemplateEmail Data Object Siebel Repository Name Not applicable External Name Example Package for SelfServiceTemplateEmail To view an example of messages for this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network. Table 414.wsdl Siebel CRM Web Services Reference Version 8. Extract the files in the zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. SelfServiceTemplateEmail Service Object Namep SelfServiceTemplateEmail Boundary Object Type Workflow Process Data Object (Integration Object) For a description of data objects for this Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.

The language is set using the search spec. This operation is used to get the Siebel timezone values based on the language which is set in the searchspec. Table 417. see Table 417. Request Message Description:SelfServiceTimeZoneQueryPage Node SelfServiceTimeZoneQueryPage_Input Description The method arguments are TimeZone Integration Object with query parameters set. Table 415. SelfServiceTimeZone Operations Name SelfServiceTimeZoneQueryPage Description Performs query operations based on the searchspec set on the language as input. Language Mode as “LDC” and viewMode (“All”). Type Integration Object SelfServiceTimeZone Application Interface This topic describes the application objects called by the SelfServiceTimeZone. see Table 415. Request Message Description:SelfServiceTimeZoneQueryPage For a description of this request message. which provides query operation on Integration Object SS_TimeZone_IO. For more information on application implementation.1 . refer to your application development documentation on Oracle Technology Network. Type Integration Object Response Message Description: SelfServiceTimeZoneQueryPage For a description of this response message. This Web service exposes the Business Service SelfServiceTimeZone. These values are got in the session language if it is a Siebel supported locale else it is got in the base language.1 Primary Web Services ■ SelfServiceTimeZone SelfServiceTimeZone This webservice call is used to get all the Siebel Timezone values. 252 Siebel CRM Web Services Reference Version 8. SelfServiceTimeZone Operations For a list of operations associated with this Web service. Table 416.Siebel 8. Response Message Description: SelfServiceTimeZoneQueryPage Node SelfServiceTimeZoneQueryPage_Output Description The list of the timezone values which are returned in the language that is set in the search spec. see Table 416.

see Table 419. See the following file to view the message schema: …\SelfServiceTimeZone\SelfServiceTimeZone.Siebel 8. Table 418. Extract the files in the zip file.1 Primary Web Services ■ SelfServiceTimeZone Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Request See the following file to view the sample code: …\SelfServiceTimeZone\SelfServiceTimeZone_request. see Table 418. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Table 419.wsdl Siebel CRM Web Services Reference Version 8. navigate to the documentation library for Siebel applications on Oracle Technology Network. SelfServiceTimeZone Data Object Siebel Repository Name SS_TimeZone_IO External Name Time Zone Example Package for SelfServiceTimeZone To view an example of messages for this Web service. SelfServiceTimeZone Service Object Name SelfServiceTimeZone Boundary Object Type Integration Object Class CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service. Extract the files in the zip file.xml Message Schema (WSDL) for SelfServiceTimeZone To view the message schema for this Web service.xml Response See the following file to view the sample code: …\SelfServiceTimeZone\SelfServiceTimeZone\_response. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network.1 25 3 .

Request Message Description:SelfServiceUserExecute Node SelfServiceUserExecute_Input ListOfSSUser ListOfSSUser/User ListOfSSUser/User/LoginName ListOfSSUser/User/ ListOfSSUserResponsibility Description Container element for SelfServiceUser WebService input for Execute operation. see Table 420. Set the Username for which the associated responsibilities need to be reset.1 for retrieving the responsibilities of the users in delegated administration. Container element for the list of Users.Siebel 8. SelfServiceUser Operations Name SelfServiceUserExecute Description Performs CRUD operations on the instance of Users Integration Object provided as input. Request Message Description:SelfServiceUserExecute For a description of this request message. Container element for User_Responsibility IC.1 . Table 421. 254 Siebel CRM Web Services Reference Version 8. see Table 421. Corresponds to the primary IC ‘User’. leverages the same business service (SelfServiceUser) internally. Corresponds to a Users Integration Object. Set the mode as “skipnode” for adding/removing responsibilities of the user. This operation is used in Siebel Self Service 8. Though Siebel Self Service 8. Additionally.1 Primary Web Services ■ SelfServiceUser SelfServiceUser This Web service exposes the EAI UI Business Service SelfServiceUser. which provides CRUD and query operations on Integration Object Users. SelfServiceUser Operations For a list of operations associated with this Web service.1 does not use this Web service operation for managing responsibilities of a user. SelfServiceUserQueryPage Performs Query operation based on the viewCriteria and searchSpec set on the instance of Users Integration Object provided as input. Table 420. the SelfServiceRegistration Workflow used instead. this Web service exposes the Execute and Query methods in the SelfServiceUser Business Service as Web service operations.

Each entry represents a responsibility assigned to the user. see Table 422.1 Primary Web Services ■ SelfServiceUser Table 421. Id of the responsibility assigned to the user. Corresponds to the primary IC ‘User’. Container element for User_Responsibility IC.1 25 5 . Username for which the assigned responsibilities are updated. Request Message Description: SelfServiceUserQueryPage Node SelfServiceUserQueryPage_Input ListOfSSUser Description Container element for SelfServiceUser WebService input for QueryPage operation. Corresponds to a Users Integration Object. Container element for the list of Users. Corresponds to the User_Responsibility IC. Table 423. Response Message Description: SelfServiceUserExecute For a description of this response message.Siebel 8. Request Message Description:SelfServiceUserExecute Node ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Id Description Corresponds to the User_Responsibility IC. Earlier assigned responsibilities that are not listed here are deleted by default. Represents a responsibility association. Response Message Description: SelfServiceUserExecute Node SelfServiceUserExecute_Output ListOfSSUser ListOfSSUser/User ListOfSSUser/User/LoginName ListOfSSUser/User/ ListOfSSUserResponsibility ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Id Description Container element for SelfServiceUser WebService output for Execute operation. Set the Id of the responsibility to be assigned/retained to the user. Corresponds to a Users Integration Object. Siebel CRM Web Services Reference Version 8. Container element for the list of Users. see Table 423. for each responsibility to be added/ retained with the user. Request Message Description: SelfServiceUserQueryPage For a description of this request message. Table 422.

Table 424. Empty. see Table 424. Each entry represents a responsibility assigned to the user. Corresponds to the User_Responsibility IC. Request Message Description: SelfServiceUserQueryPage Node ListOfSSUser/User ListOfSSUser/User/LoginName ListOfSSUser/User/ ListOfSSUserResponsibility ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Id ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Responsibility Description Corresponds to the primary IC ‘User’.1 . Corresponds to a Users Integration Object.1 Primary Web Services ■ SelfServiceUser Table 423. 256 Siebel CRM Web Services Reference Version 8. Container element for User_Responsibility IC. Username for which the assigned responsibilities are retrived. Set the Username for which the associated responsibilities needs to be loaded. Id of the responsibility assigned to the user. Container element for User_Responsibility IC. Response Message Description: SelfServiceUserQueryPage For a description of this response message. Empty. Name of the responsibility assigned to the user.Siebel 8. Represents a responsibility associated to the user. Response Message Description: SelfServiceUserQueryPage Node SelfServiceUserQueryPage_Output ListOfSSUser ListOfSSUser/User ListOfSSUser/User/LoginName ListOfSSUser/User/ ListOfSSUserResponsibility ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Id ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Responsibility Description Container element for SelfServiceUser WebService output for QueryPage operation. Corresponds to the primary IC ‘User’. Corresponds to the User_Responsibility IC. to query the Id of the responsibility assigned to the user. Container element for the list of Users. to query the Name of the responsibility assigned to the user.

see Table 426. see Table 425. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.xml Message Schema (WSDL) for SelfServiceUser To view the message schema for this Web service. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. SelfServiceUser Data Object Siebel Repository Name Users External Name Users Example Package for SelfServiceUser To view an example of messages for this Web service.Siebel 8. refer to your application development documentation on Oracle Technology Network.1 25 7 . Request See the following file to view the sample code: …\SelfServiceUser\SelfServiceUser_request. navigate to the documentation library for Siebel applications on Oracle Technology Network. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 Primary Web Services ■ SelfServiceUser SelfServiceUser Application Interface This topic describes the application objects called by the this Web service.xml Response See the following file to view the sample code: …\SelfServiceUser\SelfServiceUser_response. navigate to the documentation library for Siebel applications on Oracle Technology Network. For more information on application implementation. Table 425. Table 426. Extract the files in the zip file.wsdl Siebel CRM Web Services Reference Version 8. SelfServiceUser Service Object Name SelfServiceUser Boundary Object Type BusinessService Class CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service. See the following file to view the message schema: …\SelfServiceUser\SelfServiceUser.

Type Integration Object 258 Siebel CRM Web Services Reference Version 8. see Table 429. For a description of this request message. Table 428.1 . This Webservice exposes two methods. Table 429. Request Message Description:SelfServiceWebSiteExecute Node SelfServiceWebSiteExecute_Input Description The method arguments are Site Integration Object.Siebel 8. Language Mode (value is “LDC”) and viewMode (“All”). Type Integration Object Response Message Description: SelfServiceWebSiteExecute The response contains the details based on the query set on the Site Integration Object. SelfServiceWebSite Operations For a list of operations associated with this Web service. This operation is used to query for the site details. Table 427. For a description of this response message. see Table 427. set on SelfServiceWebSite Integration Object as the input. SelfServiceWebSite Operations Name SelfServiceWebSiteExecute SelfServiceWebSiteQueryPage Description Perform various operations like creating/updating/deleting of sites with SelfServiceWebSite Integration Object as the input. ‘Query’ and the ‘Execute’ methods in its business service “SelfServiceWebSite “ as Webservice operations.1 Primary Web Services ■ SelfServiceWebSite SelfServiceWebSite This Webservice is used for creating /retrieving /updating /deleting sites. Response Message Description: SelfServiceWebSiteExecute Node SelfServiceWebSiteExecute_Output Description The data retrieved based on the query set. Performs query operations based on the querycriteria. see Table 428. Request Message Description:SelfServiceWebSiteExecute Creating/updating/deleting operations on a site can be performed based on the query criteria that is set.

SelfServiceWebSite Service Object Name SelfServiceWebSite Boundary Object Type Integration Object Class CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service. Table 431. Table 433. see Table 432. site related details are queried. refer to your application development documentation on Oracle Technology Network. see Table 433. This Web service exposes the Business Service SelfServiceWebSite. Language Mode as “LDC” and viewMode (“All”). Table 430. Request Message Description:SelfServiceWebSiteQueryPage Node SelfServiceWebSiteQueryPage_Input Description The method arguments are Site Integration Object with query parameters set. Type Integration Object SelfServiceWebSite Application Interface This topic describes the application objects called by the SelfServiceWebSite. For a description of this request message. which provides execute and query operations on Integration Object SS_WebSite_IO. Service Object (Business Service or Workflow) For a description of the service objects for this Web service.1 Primary Web Services ■ SelfServiceWebSite Request Message Description:SelfServiceWebSiteQueryPage Based on the querycriteria set on the Integration Object. Table 432. SelfServiceWebSite Data Object Siebel Repository Name SS_WebSite_IO External Name SS_WebSite_BO Siebel CRM Web Services Reference Version 8. see Table 431. see Table 430.Siebel 8. For more information on application implementation. Type Integration Object Response Message Description: SelfServiceWebSiteQueryPage The response contains the details based on the update query set on the Site Integration Object.1 25 9 . For a description of this response message. Response Message Description: SelfServiceWebSiteQueryPage Node SelfServiceTimeZoneQueryPage_Output Description The list of the timezone values which are returned in the language that is set in the search spec.

navigate to the documentation library for Siebel applications on Oracle Technology Network. update. navigate to the documentation library for Siebel applications on Oracle Technology Network.xml Response (SelfServiceWebSiteExecute) See the following file to view the sample code: …\SelfServiceWebSite\SelfServiceWebSiteExecute_response. read.wsdl ServiceRequest Use this Web service to create. Attachments. and delete the child objects like Activities.xml Response (SelfServiceWebSiteQuery) See the following file to view the sample code: …\SelfServiceWebSite\SelfServiceWebSiteQuery_response.xml Message Schema (WSDL) for SelfServiceWebSite To view the message schema for this Web service. Request (SelfServiceWebSiteExecute) See the following file to view the sample code: …\SelfServiceWebSite\SelfServiceWebSiteExecute_request.xml Request (SelfServiceWebSiteQuery) See the following file to view the sample code: …\SelfServiceWebSite\SelfServiceWebSiteQuery_request. Extract the files in the zip file.Siebel 8. Solutions and Service Request Agreements. update the Service Request and to create.1 . See the following file to view the message schema: …SelfServiceWebSiteQuery\SelfServiceWebSite. 260 Siebel CRM Web Services Reference Version 8. read.1 Primary Web Services ■ ServiceRequest Example Package for SelfServiceWebSite To view an example of messages for this Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

Service Request Agreement. Solution. Table 436. Used to Update the Service Request.Siebel 8. Siebel CRM Web Services Reference Version 8. Table 437. Returns the Mod_Id of the Service Request. see Table 436. Request Message Description: ServiceReqInsert_Input Node Abstract Description Abstract of the Service Request. Used to Create and Update the Service Request. ServiceReqQueryPage_Input ServiceReqInit_Input ServiceReqDelete_Input Request Message Description: ServiceReqInsert_Input For a description of this request message. Solution. Response Message Description: ServiceReqInsert_Input Node Id Mod_Id Description Returns the Row_Id of the Service Request. Service Request Agreement. see Table 437. Also this is used to Create / Update the child objects like Activities. Response Message Description: ServiceReqInsert_Input For a description of this response message. Solution. Request Message Description: ServiceReqUpdate_Input For a description of this request message. Used to get the default values for the Service Request. Attachment. ServiceRequest Operations Name ServiceReqInsert_Input ServiceReqUpdate_Input ServiceReqExecute_Input Description Used to Create the Service Request. Attachment. see Table 435. Used to Query the Service Request and the child objects like Activities.1 Primary Web Services ■ ServiceRequest ServiceRequest Operations For a list of operations associated with this Web service.1 26 1 . Attachment. see Table 434. Used to delete the child objects like Activities. Table 435. Request Message Description: ServiceReqUpdate_Input Node Id Description Row Id of the Service Request is required. Service Request Agreement. Table 434.

Description of the Activity. Table 439. in case of attachment type FILE. in case of attachment type FILE. Location of the File or URL for the Attachment.1 . File Name for the Attachment. Request Message Description: ServiceReqExecute_Input Request For a description of this request message. File Dock Status Flag for the Attachment. File Defer Flag for the Attachment. Row Id of the Activity. Contents to be attached. see Table 438. Returns the Mod_Id of the Service Request. Comments for the Attachment. Activity Id of the Attachment. Row Id of the Service Request. Type is required. in case of attachment type FILE. Description 262 Siebel CRM Web Services Reference Version 8. In this case its Service Request Id.Siebel 8. Abstract of the Service Request is required. File Revision for the Attachment. Table 438. Type of the Attachment (FILE/ URL). File Dock Required Flag for the Attachment. File Size for the Attachment. File extension for the Attachment.1 Primary Web Services ■ ServiceRequest Response Message Description: ServiceReqUpdate_Input For a description of this response message. see Table 439. File Auto Flag for the Attachment. in case of attachment type FILE. Response Message Description: ServiceReqUpdate_Input Node Id Mod_Id Description Returns the Row_Id of the Service Request. Request Message Description: ServiceReqExecute_Input Request Node Service Request Id Abstract Activities Id Type Description2 Attachment Id ActivityId ActivityComments ActivityFileAutoUpdFlg ActivityFileDeferFlg ActivityFileDockReqFlg ActivityFileDockStatFlg ActivityFileSrcType ActivityFileSrcPath ActivityFileName ActivityFileRev ActivityFileSize ActivityFileExt ActivityFileBuffer Row Id of the Attachment.

Also the child object’s Row Id. Response Message Description: ServiceReqQueryPage_Input Node Service Request Child Objects Description Returns all the information of the Service Request. Response Message Description: ServiceReqExecute_Input Request For a description of this response message. see Table 442. Siebel CRM Web Services Reference Version 8. Table 442. see Table 440 Table 440. Table 441. Request Message Description: ServiceReqQueryPage_Input For a description of this request message. Response Message Description: ServiceReqQueryPage_Input For a description of this response message. see Table 441. Request Message Description: ServiceReqExecute_Input Request Node ActivityFileBuffer Solution Id Name Agreement Id AgreementName Row Id of the agreement is required. Returns all the child information for that Service Request.1 26 3 . Returns the Mod_Id of the Service Request. Description Contents to be attached. Response Message Description: ServiceReqExecute_Input Request Node Id Mod_Id Description Returns the Row_Id of the Service Request. Request Message Description: ServiceReqQueryPage_Input Node Id Description Row Id of the Service Request. Row Id of the solution is required Name of the Solution. Also the child object’s Mod Id.1 Primary Web Services ■ ServiceRequest Table 439.Siebel 8.

Response Message Description: ServiceReqDelete_Input Node Id Mod_Id Description Returns the Row_Id of the Service Request. refer to your application development documentation on Oracle Technology Network. see Table 446. Row Id of the Service Request Agreement. Row Id of the Solution. Also the child object’s Mod Id.1 Primary Web Services ■ ServiceRequest Request Message Description: ServiceReqInit_Input For a description of this request message. ServiceRequest Application Interface This topic describes the application objects called by the this Web service.1 . see Table 445. Table 446. Request Message Description: ServiceReqInit_Input Node Service Request Description Pass the Service Request attributes.Siebel 8. Row Id of the Activity. see Table 443. Response Message Description: ServiceReqInit_Input For a description of this response message. Response Message Description: ServiceReqDelete_Input For a description of this response message. Table 445. For more information on application implementation. 264 Siebel CRM Web Services Reference Version 8. Request Message Description: ServiceReqDelete_Input For a description of this request message. Table 444. Row Id of the Attachment. Request Message Description: ServiceReqDelete_Input Node Id Id Id Id Id Description Row Id of the Service Request. Table 443. Returns the Mod_Id of the Service Request. Response Message Description: ServiceReqInit_Input Node Service Request Description Returns default information of the Service Request. see Table 444. Also the child object’s Row Id.

see Table 447.1 Primary Web Services ■ ServiceRequest Service Object (Business Service or Workflow) For a description of the service objects for this Web service.xml Message Schema (WSDL) for Service Request To view the message schema for this Web service.Siebel 8. ServiceRequest Data Object Siebel Repository Name ServiceReqIO External Name Service Request (SelfService) Example Package for Service Request To view an example of messages for this Web service.1 26 5 . ServiceRequest Service Object Name ServiceReq Boundary Object Type Business Service Class CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service.xml Response See the following file to view the sample code: …\ServiceReqWS\ServiceRequest_response. navigate to the documentation library for Siebel applications on Oracle Technology Network.wsdl Siebel CRM Web Services Reference Version 8. Extract the files in the zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Table 448. navigate to the documentation library for Siebel applications on Oracle Technology Network. Request See the following file to view the sample code: …\ServiceRequest\ServiceRequest_request. Extract the files in the zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. See the following file to view the message schema: …\ServiceRequest\ServiceRequest. see Table 448. Table 447.

This web service exposes the business service “SessionAccessService” which provides the business service method “Ping” which is used to set a message to terminate the Siebel session. Type Not applicable String SessionAccessWS Application Interface This topic describes the application objects called by the SessionAccessWS. Response Message Description: sessionAccessPing Node SessionAccessPing_Output SessionAccessPing_Input/msgOut Description Container Element. SessionAccessWS Operations For a list of operations associated with this Web service.1 Primary Web Services ■ SessionAccessWS SessionAccessWS This Web service call is used to terminate the Siebel session. Table 451. This web service exposes the business service “SessionAccessService” which provides the method “Ping” which is used to set a message to terminate the siebel session.1 . 266 Siebel CRM Web Services Reference Version 8. see Table 451. see Table 450. Type Not applicable String Response Message Description: sessionAccessPing For a description of this response message.Siebel 8. SessionAccessWS Operations Name sessionAccessPing Description This is used for setting a message as an input . Table 449. Sent as “1” which indicates successful termination of the session. see Table 449. Set as “Self Service Logout Request”. Request Message Description:sessionAccessPing Node SessionAccessPing_Input SessionAccessPing_Input/msgIn Description Container Element. For more information on application implementation. refer to your application development documentation on Oracle Technology Network. Table 450. Request Message Description:sessionAccessPing For a description of this request message.

A business service is exposed in the Siebel CRM application to update the status field. Siebel CRM Web Services Reference Version 8.1 26 7 .wsdl SWI Update Order Line Item Use this Web service to update the status of order line items for simple products.xml Message Schema (WSDL) for SessionAccessWS To view the message schema for this Web service. See the following file to view the message schema: …\SessionAccessWS\SessionAccessWS. SessionAccessWS Service Object Name SessionAccessService Boundary Object Type Class CSSUIFSessionAccessService Example Package for SessionAccessWS To view an example of messages for this Web service. then this Web service updates the statuses of the entire product hierarchy for the order. this Web service updates the statuses of the component products within that complex product or nested service bundle for the order line item ID that is passed to this Web service.Siebel 8. The response message returns only an acknowledgement message and not data. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 Primary Web Services ■ SWI Update Order Line Item Service Object (Business Service or Workflow) For a description of the service objects for this Web service.xml Response See the following file to view the sample code: …\SessionAccessWS\SessionAccess_response. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. If the order line item contains a complex product or nested service bundle. Table 452. and nested service bundles in the Siebel CRM application when the status of the order line item changes in the billing application. Request See the following file to view the sample code: …\SessionAccessWS\SessionAccess_request. The billing application makes this inbound Web service call to the Siebel CRM application to update the status of the order line item. If the order line item ID is the same as the root line item ID. see Table 452. navigate to the documentation library for Siebel applications on Oracle Technology Network. Extract the files in the zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network. complex products. Extract the files in the zip file.

SWI Update Order Line Item Application Interface This topic describes the application objects called by the this Web service. The row ID of the nested product in the order line item hierarchy. If this node has a value of TRUE. Request Message Descripiton: UpdateLineItems For a description of this request message. The row ID of the root order in the order line item hierarchy. The new value of the field in the order line item to update. Table 453.1 Primary Web Services ■ SWI Update Order Line Item SWI Update Order Line Item Operations For a list of operations associated with this Web service. SWI Update Order Line Item Service Objects Name CMU Order Line Item Update (For simple products) SIS OM UpdateOrderItem (For complex products) SIS OM NSB Update Order Line (For nested service bundles) Boundary Object Type Business Service Workflow Workflow Class (If Business Service) CSSEAIDataSyncService Not applicable Not applicable 268 Siebel CRM Web Services Reference Version 8. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. see Table 455.Siebel 8. see Table 453. For more information on application implementation. refer to your application development documentation on Oracle Technology Network. the order has a single line item. complex products. Request Message Descripiton: UpdateLineItems Node FieldName1 FieldValue1 RootLineItemId OrderLineItemId UpdateSingleLineItem Description The name of the field in the order line item to update.1 . Table 454. and nested service bundles. SWI Update Order Line Item Operations Name UpdateLineItems Description Updates the value of the field that is passed to it for order line items in simple products. The designation for an order with a single line item. Table 455. see Table 454.

Siebel 8.1 Primary Web Services ■ SWI Update Order Line Item

Data Object (Integration Object) For a description of data objects for this Web service, see Table 456. Table 456. SWI Update Order Line Item Data Object Siebel Repository Name Order Entry Line Item Update External Name Order Entry Line Item Update

Methods For a description of the methods for this Web service, see Table 457. Table 457. SWI Update Order Line Item Methods Operation UpdateLineItems Method [BS: CMU Order Line Item Update].Update

Example Package for SWI Update Order Line Item
To view an example of messages for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

Request See the following file to view the sample code: ...\SWIUpdateOrderLineItem\SWIUpdateOrderLineItem.xml Response See the following file to view the sample code: ...\SWIUpdateOrderLineItem\SWIUpdateOrderLineItem.xml

Message Schema (WSDL) for SWI Update Order Line Item
To view the message schema for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file. See the following file to view the message schema: ...\SWIUpdateOrderLineItem\SWIUpdateOrderLineItem.wsdl

Siebel CRM Web Services Reference Version 8.1

26 9

Siebel 8.1 Primary Web Services ■ Ulnbox Contact Item

Ulnbox Contact Item
UInbox Contact Item is a Web and Business Service generated to load Contact Inbox Items. These items can be filtered based any fields in the Business Component. For example, either approved or rejected Inbox items can be loaded by setting appropriate fields in the Integration Object while invoking the Web service. Page size should be specified to load the required number of items while invoking Web service. Based on the requirements Task Owner Id or Task Owner Login, Active Flag, Action and Context fields should be set while invoking the Web service.

Ulnbox Contact Item Operations
For a list of operations associated with this Web service, see Table 458. Table 458. Ulnbox Contact Item Operations Name UlnboxContactItemQueryPage Query Page Init Execute Description QueryPage method to query data in the Siebel database one page at a time. QueryPage method to query data in the Siebel database one page at a time. Action is initialized. Action is executed.

Request Message Description: UlnboxContactItemQueryPage For a description of this request message, see Table 459. Table 459. Request Message Description: UlnboxContactItemQueryPage Node ExecutionMode LOVLanguageMode NamedSearchSpec PickListName Description The mode in which the query is to be performed. LIC or LDC. Search Specification of the query. Name of the picklist (if any). Type String String String String

Response Message Description: UlnboxContactItemQueryPage For a description of this response message, see Table 460. Table 460. Response Message Description: UlnboxContactItemQueryPage Node SiebelMessageOut Description Output argument. Type Integration Object

270

Siebel CRM Web Services Reference Version 8.1

Siebel 8.1 Primary Web Services ■ Ulnbox Contact Item

To Specify Parameters While Invoking Ulnbox Contact Item
Use the following procedure to specify parameters while invoking the Ulnbox Contact Item Web service.

Specifying parameters while invoking Web service 1
Run the WSDL file thru proxy generator. This creates a C# class that should be modified to construct Input Integration Objects. For performance reasons, Page size can also be specified here. Following is the sample client side code showing how page size and other input parameters can be specified. AccountQueryPageMSO_Input input = new AccountQueryPageMSO_Input (); input.ViewMode = "All"; input.PageSize = "10"; input.StartRowNum = "0";

input.ListOfAccount = new Account[1];

input.ListOfAccount[0] = new Account (); input.ListOfAccount[0].Name = "MngoTestAccount"; input.ListOfAccount[0].Location = ""; proxy.AccountQueryPageMSO (input);

2

Records can be filtered based on logged in resource and context by specifying these values in Input Integration Objects.

Possible Performance and Scalability Issues The volume of Inbox data loaded by the Web service for a specific user and context can be extremely huge depending on implementations. There will be performance issues if is all retrieved together. This issue can be overcome by specifying the page size during each call.

Possible Deployment Issues Authentication URL may be changed during deployment to supply changed information such as user, password and so on. These changes should be done in the WSDL file.

Error Conditions All error conditions will be handled by Web services framework.

Siebel CRM Web Services Reference Version 8.1

27 1

Siebel 8.1 Primary Web Services ■ Ulnbox Contact Item

Ulnbox Contact Item Application Interface
This topic describes the application objects called by the this Web service. For more information on application implementation, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 461. Table 461. Ulnbox Contact Item Service Object Name UInbox Contact Item Boundary Object Type Not applicable Class CSSEAIUIDataService

Data Object (Integration Object) For a description of data objects for this Web service, see Table 462. Table 462. Ulnbox Contact Item Data Object Siebel Repository Name UInboxContactItem External Name UInbox Items

Example Package for Ulnbox Contact Item
To view an example of messages for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

Request See the following file to view the sample code: …\UlnboxContactItem\UlnboxContactItem_request.xml

Response See the following file to view the sample code: …\UlnboxContactItem\Response.xml

Message Schema (WSDL) for Ulnbox Contact Item
To view the message schema for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file. See the following file to view the message schema: …\UlnboxContactItem\UlnboxContactItem.wsdl

272

Siebel CRM Web Services Reference Version 8.1

Siebel 8.1 Primary Web Services ■ Universal Inbox

Universal Inbox
Universal Inbox is an existing Business Service providing functionality to create, update Inbox items or owner, invoke actions etc. This can be modified to include methods to invoke Approve and Reject Actions that will be deployed as a Web service.

Universal Inbox Operations
For a list of operations associated with this Web service, see Table 463. Table 463. Universal Inbox Operations Name UniversalInboxCallAction Description Executes the action registered for a specific Inbox Item type.

Request Message Description: UniversalInboxCallAction For a description of this request message, see Table 464. Table 464. Request Message Description: UniversalInboxCallAction Node InboxItemId ActionLIC InboxTypeName OwnerId ObjectId Description InboxItemId ActionLIC InboxTypeName OwnerId ObjectId Type String String String String String

Response Message Description: UniversalInboxCallAction For a description of this response message, see Table 465. Table 465. Response Message Description: UniversalInboxCallAction Node Status Error message Description Call status. Error message returned, if any. Type String String

This operation will return following messages:

1 2

Errors as in current inbox design like “post-approval action not configured”. User-friendly error message, when the SAME inbox item is concurrently updated by two Self Service users such as “This has already been approved by a different user”, if approved OR “This has already been rejected by a different user”, if rejected.

Siebel CRM Web Services Reference Version 8.1

27 3

Siebel 8.1 Primary Web Services ■ Universal Inbox

3 4

Returning the actual error message, if any, from the workflow that is being invoked. Since the Self Service workflow is invoked synchronously, all error messages will be propagated. CallAction Business Service Method will detect and return error messages raised by the Action Business Service. Web service Infrastructure will detect that the CallAction Business Service method has returned an error code and create a SOAP fault.

Invalid input conditions InboxItemId and ActionName are required input parameters to execute the action. Comments is an optional parameter.

Processing errors Errors occurring during workflow execution etc will be handled by Web services framework and the error extracted will be sent as SOAP fault.

Universal Inbox Application Interface
This topic describes the application objects called by the this Web service. For more information on application implementation, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 466. Table 466. Universal Inbox Service Object Node Universal Inbox Description Not applicable Type CSSUInboxSvc

Data Object (Integration Object) Since all Input and Output parameters are Strings, Integration Object is not required.

Example Package for Universal Inbox
To view an example of messages for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

Request See the following file to view the sample code: …\UniversalInbox\UniversalInbox_request.xml

274

Siebel CRM Web Services Reference Version 8.1

Siebel 8.1 Primary Web Services ■ UpdateCustomerSiebelJMSProducer

Response See the following file to view the sample code: …\UniversalInbox\Universal_Inbox_response.xml

Message Schema (WSDL) for Universal Inbox
To view the message schema for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file. See the following file to view the message schema: …\UniversalInbox\UniversalInbox.wsdl

UpdateCustomerSiebelJMSProducer
Use this Web service to synchronize the data between the Siebel CRM application and the billing application for details relating to accounts, addresses, contacts, and billing profiles. Because this Web service uses an asynchronous call, a response message does not apply.

UpdateCustomerSiebelJMSProducer Operations
For a list of operations associated with this Web service, see Table 467. Table 467. UpdateCustomerSiebelJMSProducer Operations Operation Name UpdateCustomerParty UpdateCustomerPartyAddress UpdateCustomerPartyContact UpdateCustomerPartyBillProfile Description Synchronizes account detail between the Siebel CRM application and the billing application. Synchronizes address detail for an account between the Siebel CRM application and the billing application. Synchronizes contact detail for an account between the Siebel CRM application and the billing application. Synchronizes billing profile detail for an account between Oracle’s Siebel CRM application and the billing application.

Request Message Description: UpdateCustomerParty For a description of this request message, see Table 468. Table 468. Request Message Description: UpdateCustomerParty Node Account Description The details of the account.

Siebel CRM Web Services Reference Version 8.1

27 5

Siebel 8.1 Primary Web Services ■ UpdateCustomerSiebelJMSProducer

Table 468. Request Message Description: UpdateCustomerParty Node CutAddress Contact Description The details of the address for an account. The details of the contact for an account.

Request Message Description: UpdateCustomerPartyAddress For a description of this response message, see Table 469. Table 469. Request Message Description: UpdateCustomerPartyAddress Node Account CutAddress ComInvoiceProfile Description The details of the account. The details of the address for an account. The details of the billing profile for an account.

Request Message Description: UpdateCustomerPartyContact For a description of this request message, see Table 470. Table 470. Request Message Description: UpdateCustomerPartyContact Node Account Contact ComInvoiceProfile Description The details of the account. The details of the contact for an account. The details of the billing profile for an account.

Request Message Description: UpdateCustomerPartyBillProfile For a description of this request message, see Table 471. Table 471. Request Message Description: UpdateCustomerPartyBillProfile Node BillingProfileCutAddress BillingProfileContact ComInvoiceProfile Description The details of the address for a billing profile. The details of the contact for a billing profile. The details of the billing profile for an account.

UpdateCustomerSiebelJMSProducer Application Interface
This topic describes the application objects called by the this Web service. For more information on application implementation, refer to your application development documentation on Oracle Technology Network.

276

Siebel CRM Web Services Reference Version 8.1

\UpdateCustomerSiebelJMSProducer\CmuAccSyncAccount. Extract the files in the zip file.1 27 7 . navigate to the documentation library for Siebel applications on Oracle Technology Network.Contact CMU . UpdateCustomerSiebelJMSProducer Methods Operation UpdateCustomerParty UpdateCustomerParty Address UpdateCustomerParty BillProfile UpdateCustomerParty Contact Method [BS: UpdateCustomerSiebelJMSProducer]. Table 472. UpdateCustomerSiebelJMSProducer Service Object Name UpdateCustomerSiebelJMSProducer Boundary Object Type Business Service Class (If Business Service) CSSWSOutboundDispatcher Data Object (Integration Object) For a description of data objects for this Web service.Account CMU . see Table 473.Com Invoice Profile Methods For a description of methods for this Web service.Address CMU .1 Primary Web Services ■ UpdateCustomerSiebelJMSProducer Service Object (Business Service or Workflow) For a description of the service objects for this Web service.. UpdateCustomerSiebelJMSProducer Data Object Siebel Repository Name CMU AccSync Account Io CMU AccSync Address Io CMU AccSync Contact Io CMU AccSync Billing Profile Io External Name CMU . and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.Siebel 8.UpdateCustomerPartyAddress [BS: UpdateCustomerSiebelJMSProducer]. see Table 472. Request See the following file to view the sample code: .UpdateCustomerPartyContact Example Package for UpdateCustomerSiebelJMSProducer To view an example of messages for this Web service.UpdateCustomerParty [BS: UpdateCustomerSiebelJMSProducer].xml Siebel CRM Web Services Reference Version 8. Table 473.UpdateCustomerPartyBillProfile [BS: UpdateCustomerSiebelJMSProducer]. see Table 474.. Table 474.

1 . Message Schema (WSDL) for UpdateCustomerSiebelJMSProducer To view the message schema for this Web service.\UpdateCustomerSiebelJMSProducer\UpdateCustomerSiebelJMSProducer. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.set on WC_PickList_Payment_Profile_IO integration object as the input. WC_PickList_Payment_Profile_BS Operations For a list of operations associated with this Web service. Table 475. Extract the files in the zip file.xml WC_PickList_Payment_Profile_BS This Web service is used for creating/updating/deleting/listing of payment wallet with payment methods. see Table 475. a response message does not apply. Perform various operations like creating/updating/ deleting of payment wallet with payment methods on the WC_PickList_Payment_Profile_IO Integration Object as the input. This Web service exposes the Query and Execute methods in the WC_PickList_Payment_Profile_BS Business Service as Web service operations.This operation is used to query the payment related details like the payment profile details and the account /contact information for which the payment wallet belongs to. WC_PickList_Payment_Profile_BS Operations Name WC_PickList_Payment_Profile_BSQueryPage Description Performs query operations based on the querycriteria..1 Primary Web Services ■ WC_PickList_Payment_Profile_BS Response Because this Web service uses an asynchronous call.. navigate to the documentation library for Siebel applications on Oracle Technology Network.Siebel 8. See the following file to view the message schema: . WC_PickList_Payment_Profile_BSExceute 278 Siebel CRM Web Services Reference Version 8.

Request Message Description: WC_PickList_Payment_Profile_BSQueryPage Node WC_PickList_Payment_Profile_ BSQueryPage_Input Description The container element for the QueryPage Operation request.payment related details like the payment profile details .1 27 9 . Table 476. For a description of this request message. creating/editing/deleting operations on a wallet can be perfomed. For a description of this request message. see Table 477. Type Integration Object Siebel CRM Web Services Reference Version 8.Siebel 8.account/contact information can be queried. see Table 476. Language Mode (value is “LDC”) and viewMode (“All”). Type Integration Object Request Message Description: WC_PickList_Payment_Profile_BSExecute Based on the query criteria set. Table 479. Response Message Description: WC_PickList_Payment_Profile_BSQueryPage Node WC_PickList_Payment_Profile_ BSQueryPage_Output Description The method arguments are Payment Integration Object.1 Primary Web Services ■ WC_PickList_Payment_Profile_BS Request Message Description: WC_PickList_Payment_Profile_BSQueryPage Based on the querycriteria set on the Integration Object. Request Message Description: WC_PickList_Payment_Profile_BSExecute Node WC_PickList_Payment_Profile_ BSExecute_Input Description The method arguments are Payment Integration Object. Table 478. see Table 478. Type Integration Object Response Message Description: WC_PickList_Payment_Profile_BSQueryPage For a description of this response message. Language Mode (value is “LDC”) and viewMode (“All”). Table 477. Response Message Description: WC_PickList_Payment_Profile_BSExecute Node WC_PickList_Payment_Profile_ BSExecute_Output Description The retrieved data for the update operation performed which could be creating/editing/deleting of a payment wallet. Language Mode (value is “LDC”) and viewMode (“All”). Type Integration Object Response Message Description: WC_PickList_Payment_Profile_BSExecute For a description of this response message.The method arguments are Payment Integration Object. see Table 479.

see Table 481. Extract the files in the zip file. see Table 480. which provides update and query operations on WC_PickList_Payment_Profile_IO Integration Object. navigate to the documentation library for Siebel applications on Oracle Technology Network. WC_PickList_Payment_Profile_BS Web service Name WC_PickList_Payment_Profile_BS Boundary Object Type Integration Object Class CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service. Extract the files in the zip file. Table 480.Siebel 8. WC_PickList_Payment_Profile_BS Web service Siebel Repository Name WC_PickList_Payment_Profile_IO External Name Payment Profile Example Package for WC_PickList_Payment_Profile_BS To view an example of messages for this Web service.1 Primary Web Services ■ WC_PickList_Payment_Profile_BS WC_PickList_Payment_Profile_BS Application Interface This Web service exposes the EAI UI Business Service WC_PickList_Payment_Profile_BS. navigate to the documentation library for Siebel applications on Oracle Technology Network. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. For more information on application implementation. Table 481.xml Response See the following file to view the sample code: …\WC_PickList_Payment_Profile_BS\WC_PickList_Payment_Profile_BS_response. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Request See the following file to view the sample code: …\WC_PickList_Payment_Profile_BS\WC_PickList_Payment_Profile_BS_request. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.xml Message Schema (WSDL) for WC_PickList_Payment_Profile_BS To view the message schema for this Web service. See the following file to view the message schema: 280 Siebel CRM Web Services Reference Version 8. refer to your application development documentation on Oracle Technology Network.1 .

wsdl Siebel CRM Web Services Reference Version 8.1 Primary Web Services ■ WC_PickList_Payment_Profile_BS …\WC_PickList_Payment_Profile_BS\WC_PickList_Payment_Profile_BS.1 28 1 .Siebel 8.

1 .Siebel 8.1 Primary Web Services ■ WC_PickList_Payment_Profile_BS 282 Siebel CRM Web Services Reference Version 8.

com/LS/ MarketingCompliance Type Inbound Inbound Inbound Outbound Outbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Siebel CRM Web Services Reference Version 8.com/Service/ AssetWarranty http://siebel. Table 482.com/Service/ FS/Entitlement http://siebel.com/claims/ http://siebel.0 Version of Oracle’s Siebel CRM Web services offering.0 Support and Testing Web Services on page 285 Primary Web Services for Siebel CRM 8.siebel.0 Table 482 lists the primary Web services available with Siebel 8.1 28 3 .0.4 ■ ■ Web Services for Siebel CRM 8.com/LS/ MarketingCompliance http://siebel.com/TroubleTicket http://siebel.com/Service/FS/ ServiceRequests http://www.com/ NetworkOrderEntry http://siebel.com/claims http://siebel.com/Service/ FS/Assets http://www. Primary Web Services Area CME Web Service Name NetworkOrderEntry TroubleTicket FINS INS Claims External Auto Policy External Property Policy FS Warranty CopyActivity ServiceRequest AssetManagement VerifyEntitlement LS GetHealthCareProfessionalCompl ianceDetails GetHealthCareProfessionalProfile Information Namespace http://siebel. The Web services are grouped in two tables under the following topics: Primary Web Services for Siebel CRM 8.com/Service/FS/ CopyActivity http://siebel.com/claims/ http://siebel.0 This chapter lists Web services that are part of 8.siebel. The Services are divided by functional area.

Primary Web Services Area Mktg Web Service Name GetUnallocatedExpenseItem SetAllocatedExpenseItem WebMarketing EventManagement Event Registration OM ABOWebService AssetWebService CatalogWebService ProductConfigurator ContactWebService CalculatePriceWS OrderWebService PromotionWebService QuoteAddItemsWS QuoteWebService CalculatePriceWS EligibilityCompatibility ProductRecommendation Namespace http://siebel.com/ OrderManagement/Quote/PSP http://siebel.com/ OrderManagement/Contact http://siebel.com/LS/ MarketingCompliance http://siebel.com/ Marketing/EventRegistration http://siebel.com/ OrderManagement/External/PSP http://siebel.com/ OrderManagement/Quote http://siebel.com/ OrderManagement/Asset http://siebel.siebel.com/ Marketing/EventData http://www.com/LS/ MarketingCompliance http://siebel.com/ OrderManagement/Configurator http://siebel.com/ OrderManagement/Quote/PSP http://siebel.com/ OrderManagement/Promotion http://siebel.com/ OrderManagement/Order http://siebel.com/ OrderManagement/Quote/PSP Type Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound 284 Siebel CRM Web Services Reference Version 8.Web Services for Siebel CRM 8.1 .com/ OrderManagement/Catalog http://siebel.com/marketing/ webmarketing http://www.0 Table 482.siebel.0 ■ Primary Web Services for Siebel CRM 8.com/ OrderManagement/Quote http://siebel.com/ OrderManagement/ABO http://siebel.

1 28 5 .com/CustomUI http://siebel. Support and Testing Web Services Area DDKPOC DDKPOC DDKPOC DDKPOC DDKPOC Web Service Name DedicatedBlockWS WC_Asset_DB_BS WC_MVG_Channel_Partner_BS WC_MVG_Household_BS WC_MVG_Industry_BS Namespace http://siebel.com/Sales/SFA http://siebel.siebel.com/Sales/SFA http://siebel.siebel.0 Web services used for support or testing.0 ■ Support and Testing Web Services Table 482.com/CustomUI http://siebel.com/ OrderManagement/ ContextService Type Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Support and Testing Web Services Table 483 lists the Siebel 8.com/CustomUI http://siebel.com/Sales/SFA http://www.com/publicsector http://siebel.com/xml/ LOVService http://www.Web Services for Siebel CRM 8.com/CustomUI http://siebel. Primary Web Services Area PRM Web Service Name PartnerPrograms PartnerRegistration PS SFA Serialization Service WC_Account_BS WC_Contacts_BS WC_Opportunity_BS WC_Service_Request_BS Forecast Integration_Object_Info_Service SFA_Activity_BS Utility EAILOVWS ContextServiceWrapperService Namespace http://siebel.com/PRM/ PartnerPrograms http://siebel.com/CustomUI Type Inbound Inbound Inbound Inbound Inbound Siebel CRM Web Services Reference Version 8.com/CustomUI http://siebel.com/CustomUI http://siebel.com/PRM/ PartnerRegistration http://siebel.com/CustomUI http://siebel. Table 483.com/CustomUI http://siebel.

com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.1 .com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel. Support and Testing Web Services Area DDKPOC DDKPOC DDKPOC DDKPOC DDKPOC DDKPOC DDKPOC DDKPOC DDKPOC DDKPOC DDKPOC DDKPOC DDKPOC DDKPOC DDKPOC DDKPOC DDKPOC DDKPOC Web Service Name WC_MVG_Internal_Division_BS WC_MVG_Organization_BS WC_MVG_Position_BS WC_MVG_Source_BS WC_MVG_Territory_BS WC_Orders_BS WC_PickList_Abs_Admin_Service_Region_BS WC_PickList_Action_BS WC_PickList_Agreement_Entitlement_BS WC_PickList_Auction_Services_BS WC_PickList_Business_Address_BS WC_PickList_Campaign_BS WC_PickList_Currency_BS WC_PickList_Employee_BS WC_PickList_FS_Shipping_BS WC_PickList_Internal_Product_BS WC_PickList_Order_Entry_BS WC_PickList_Payment_Profile_BS Namespace http://siebel.Web Services for Siebel CRM 8.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.0 ■ Support and Testing Web Services Table 483.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI Type Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound 286 Siebel CRM Web Services Reference Version 8.com/CustomUI http://siebel.com/CustomUI http://siebel.

com/ actuate7/wsdl http://schemas.0 ■ Support and Testing Web Services Table 483.com/CustomUI http://siebel.sigmadynamics.com/CustomUI http://siebel.actuate.com/CustomUI http://siebel. Support and Testing Web Services Area DDKPOC DDKPOC DDKPOC DDKPOC DDKPOC DDKPOC DDKPOC EAI Core EAI Core EAI Core EAI Core EAI Core EAI Core Misc Misc Misc Web Service Name WC_PickList_Payment_Terms_BS WC_PickList_Price_List_BS WC_PickList_Sales_Assessment_BS WC_PickList_Sales_Stage_BS WC_PickList_Service_Agreement_BS WC_PickList_Siebel_Instance_BS WC_PickList_VORD_Network_Asset_BS WC Cached State Managed Service WC Cached Stateful Service WC Cached Stateless Service WC NonCached State Managed Service WC NonCached Stateful Service WC NonCached Stateless Service ActuateAPI ActuateAPI DecisionService Namespace http://siebel.com/CustomUI http://siebel.com/ schema/services/ ExternalChoice Type Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Outbound Outbound Outbound Misc ExternalChoiceService Outbound Siebel CRM Web Services Reference Version 8.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://schemas.actuate.com/CustomUI http://siebel.com/ schema/services/ DecisionService http:// www.1 28 7 .com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.Web Services for Siebel CRM 8.com/ actuate8/wsdl http:// www.com/CustomUI http://siebel.sigmadynamics.

siebel.com/asi/ http://siebel.com/PSR/FS/ PSRUnitTest http://siebel.com/asi/ http://siebel.analytics.siebel.com/asi/ http://siebel.siebel.com/CustomUI http://www.siebel.1 .com/ collab/ http://siebel.com/ collab/ http://www.web/ soap/v1 com.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.analytics.web/ soap/v1 http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel. Support and Testing Web Services Area Misc Misc Misc Misc Misc Misc Misc Misc Test ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI Web Service Name JobManagementService SAWSessionService SendMailingService SiebelSharePointArchival SiebelSharePointIntegration WC_Quote_BS Web Collaboration Service WebCatalogService PSRUnitBenchmark AccountWS ActivityWS ContactWS CRM Contact Management CRM Lead Management CRM Marketing Management CRM Party Management CRM Service Management External Account External ANI Claims Notice of Loss External ANI Claims Payment Info External ATP Check External Contact External Credit Check External CRM Lead Management External CRM Marketing Management External CRM Service Management Namespace com.com/ SharepointIntegration com.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.0 ■ Support and Testing Web Services Table 483.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi Type Outbound Outbound Outbound Outbound Outbound Inbound Inbound Outbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Outbound Outbound Outbound Outbound Outbound Outbound Outbound Outbound Outbound 288 Siebel CRM Web Services Reference Version 8.siebel.siebel.analytics.Web Services for Siebel CRM 8.web/ soap/v1 urn:xml-send-mailing http://www.

Web Services for Siebel CRM 8.0 ■ Support and Testing Web Services Table 483.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ Type Outbound Outbound Outbound Outbound Outbound Outbound Outbound Outbound Outbound Outbound Outbound Outbound Outbound Outbound Outbound Outbound Outbound Outbound Outbound Outbound Outbound Outbound Inbound Inbound Inbound Inbound Inbound Inbound Siebel CRM Web Services Reference Version 8.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.1 28 9 .com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel. Support and Testing Web Services Area ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI Web Service Name External Employee External Household External Opportunity Create External Opportunity Query External Opportunity Update External Opportunity Update Response External Order External Position External Quote External Request Add/Cancel Group Policy Member External Request Add/Cancel Individual Policy Member External Request Authorization External Request Benefit Detail External Request Eligibility Check External Request Preliminary Rating External Request Providers External Request Referral External Request Update of Member Details External Send Update Provider Details External Shipment Tracking External Shopping Cart Create External Simple Product Healthcare Group Policy Member Management Healthcare Individual Policy Member Management Healthcare Member Details Management Healthcare Request Authorization Healthcare Request Benefit Detail Healthcare Request Eligibility Check Namespace http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.

com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.0 ■ Support and Testing Web Services Table 483.com/asi/ http://siebel.com/asi/ Type Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound 290 Siebel CRM Web Services Reference Version 8.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.1 .com/asi/ http://siebel.Web Services for Siebel CRM 8.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel. Support and Testing Web Services Area ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI ASI Web Service Name Healthcare Request Preliminary Rating Healthcare Request Providers Healthcare Request Referral Healthcare Send Update Provider Details Insurance Claims Notice of Loss Insurance Claims Payment Info Management Insurance Life Policy Management ModuleLicense OpportunityWS PIMDomainWS ProjectWS SearchExternalService SearchSecurityService ServiceRequestWS Siebel Account Siebel Case Information Siebel Contact Siebel Employee Siebel Household Siebel Invoice Siebel Opportunity Create Siebel Opportunity Query Siebel Opportunity Update Siebel Opportunity Update Response Siebel Order Siebel Position Siebel Quote Siebel Shopping Cart Create Siebel Simple Product Siebel TM Alignment Siebel TM Alignment Results Namespace http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.com/asi/ http://siebel.

com/asi/ http://www.Web Services for Siebel CRM 8.1 29 1 . Support and Testing Web Services Area ASI ASI Utility Utility Utility Web Service Name Siebel TM Hierarchy Siebel TM Territory SessionAccessWS SiebelUserProfileService SiebelWebRegistration Namespace http://siebel.com/xml/ SessionAccess http://siebel.siebel.0 ■ Support and Testing Web Services Table 483.com/CustomUI Type Inbound Inbound Inbound Inbound Inbound Siebel CRM Web Services Reference Version 8.com/CustomUI http://siebel.com/asi/ http://siebel.

0 ■ Support and Testing Web Services 292 Siebel CRM Web Services Reference Version 8.Web Services for Siebel CRM 8.1 .

0 This chapter includes detailed descriptions and information about version 8. It includes the following topics: ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ABOWebService on page 294 Asset Management on page 301 AssetWebService on page 304 CalculatePriceWS on page 304 CatalogWebService on page 307 ContextServiceWrapperService on page 316 CopyActivity on page 321 EAILOVWS on page 322 EligibilityCompatibility on page 322 EventManagement on page 326 Event Registration on page 332 ExternalAutoPolicy on page 332 ExternalPropertyPolicy on page 332 Forecast on page 332 GetHealthCareProfessionalProfileInformation on page 332 GetHeathCareProfessionalComplianceDetails on page 340 GetUnallocatedExpenseItem on page 347 INSClaims on page 350 IntegrationObjectInfo on page 354 NetworkOrderEntry on page 356 PartnerPrograms on page 358 PartnerRegistration on page 359 ProductConfigurator on page 359 ProductRecommendation on page 373 PromotionWebService on page 376 QuoteWebService and OrderWebService on page 379 Siebel CRM Web Services Reference Version 8.5 Primary Web Services for Siebel CRM 8.0 of Siebel CRM Web services.1 29 3 .

modify an asset. ABOWebService Operations The asset operations Modify. based on the account or contact profile.0 ■ ABOWebService ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ QuoteAddItemsWS on page 383 SerializationService on page 385 ServiceRequest on page 385 SessionAccessWS on page 387 SetAllocatedExpenseItem on page 387 SFA_Activity_BS on page 390 SiebelUserProfileService on page 392 SiebelWebRegistration on page 392 TroubleTicket on page 392 VerifyEntitlement on page 394 Warranty on page 396 WC_Account_BS on page 396 WC_Contacts_BS on page 397 WC_Opportunity_BS on page 397 WC_Service_Request_BS on page 397 WebMarketing on page 397 ABOWebService Use this Web service to expose the following Asset-Based Ordering (ABO) functions: convert a quote into an order. If an active quote is not provided. Affix “ToQuote” in the Web service name means: if an active quote is provided. Disconnect. suspend. They have a similar input and output data schema. or Resume create a new line item. or resume an asset. This Web service works only with an Asset-Based Ordering (ABO) enabled environment. submit an order to the back-end office. disconnect an asset. it generates a new quote and adds the quote item to the new quote.Primary Web Services for Siebel CRM 8. A typical application that uses the Web service is Siebel Communication.1 . If AccountId is provided. 294 Siebel CRM Web Services Reference Version 8. If AccountId is not provided it operates on the contact profile. convert a completed order line item to an asset. it will add the quote item to the existing quote. Suspend. then it operates on the account profile.

“SuspendAssetToOrder”. see Table 484 Table 484. Suspends an asset (Service Item) and generates an order item to suspend the selected asset. and a common response message format. ABOWebService Operations Name AutoOrder SubmitOrder AutoAsset ModifyAssetToQuote ModifyAssetToOrder DisconnectAssetToQuote DisconnectAssetToOrder SuspendAssetToQuote SuspendAssetToOrder ResumeAssetToQuote ResumeAssetToOrder Description Converts a Quote to a Sales Order. For a list of operations associated with this Web service. Submits an Order. and generates an order item to deactivate the selected asset. and generates a quote item to update the selected asset. “PDS Order”. SuspendAssetToOrder. ModifyAssetToQuote.Primary Web Services for Siebel CRM 8.1 29 5 . ModifyAssetToOrder. Request Message Description: AutoOrder The following Web services “AutoOrder”. Disconnects an asset (Service Item) to generate a quote item to deactivate the selected asset. Modifies an asset (Service Item). ResumeAssetToQuote and DisconnectAssetToQuote have a common request message format. Resumes an asset (Service Item). it generates a new order and adds the order item into the new order. and generates an order item to update the selected asset.0 ■ ABOWebService Affix “ToOrder” in the Web service name means: if an active order is provided it adds the order item to the existing order. Modifies an asset (Service Item). Suspends an active asset (Service Item) to generate a quote item to suspend the selected asset. Siebel CRM Web Services Reference Version 8. “ModifyAssetToOrder”. ResumeAssetToOrder. SuspendAssetToQuote. “ResumeAssetToOrder” and “DisconnectAssetToOrder” have a common output message format. Creates assets from the completed order line items or updates a current asset. and generates an order item to resume the selected asset. DisconnectAssetToOrder have a common request message format. PDS Quote. “SubmitOrder”. Resumes a suspended asset (Service Item) to generate a quote item to resume the selected asset. Disconnects an asset (Service Item). If an active order is not provided.

Response Message Description: AutoOrder Integration Object Message Format: PDS Order.Primary Web Services for Siebel CRM 8. Order Line Item attributes. Table 488. 296 Siebel CRM Web Services Reference Version 8. Response Message Description: AutoOrder Node PDS Order Header Line Item XA Description Instance of Integration object PDS Order. Required. Table 486. Order Header. For a description of this response message. Response Message Description: SubmitOrder Integration Object Message Format: PDS Order. Table 487. Request Message Description: AutoAsset For a description of this request message. which has the same format as the AutoOrder response message. RowId of the corresponding Order that contains the Order Line Item to be converted or applied to an asset. RowId of an Order Line Item to be converted or applied to an asset. Request Message Description: AutoAsset Node Object Id LineItemId Description Required. RowId of the Quote to be converted to the Sale Order. seeTable 486. RowId of the order to be submitted. Request Message Description: SubmitOrder Node OrderId Description Required. see Table 488.0 ■ ABOWebService For a description of this request message. see Table 485. Table 485. Request Message Description: AutoOrder Node Object Id Description Required. see Table 487. Order Line Items. Request Message Description: SubmitOrder For a description of this request message.1 .

Request Message Description: ModifyAssetToQuote Node AssetIntegrationId AssetNumber ActiveDocumentId Description Asset Integration Id of the selected asset. Asset Header. Integration Object. Account Id of the account that owns the selected asset (Service Item). see Table 489. Asset. Provide either AssetIntegrationId or AssetNumber. Compound Product Number for the Asset Based Ordering (ABO) network ordering. AccountId ContactId DueDate PriceListId CompoundProductNumber Siebel CRM Web Services Reference Version 8. Specifies a Price List Id that is associated with the quote if a new quote is requested to generate. The due date of the generated line item. This is an optional input. ActiveDocumentId means the current active Document that the current process is working on. Each Document can have multiple children (Quote Items or Order Line Items).1 29 7 .Primary Web Services for Siebel CRM 8. It is not required if network ordering is not used. Provide either AssetIntegrationId or AssetNumber. Contact Id of the contact who owns the selected asset (Service Item) to be modified. For a description of this response message. Request Message Description: ModifyAssetToQuote For a description of this request message. see Table 490. Response Message Description: AutoAsset Node PDS Asset Header Line Item XA Description Required. Table 489. Table 490. In this Web service call. Document in Order Management means a Quote or an Order. Asset Integration Id of the selected asset.0 ■ ABOWebService Response Message Description: AutoAsset Integration Object Message Format: PDS Asset. it is the Quote Id of the active Quote to which the generated quote item has to be added. Asset attributes.

which has the same format as the AutoOrder response message. Required only if network ordering if used. This is an optional input. In this Web service call. Request Message Description: ModifyAssetToOrder For a description of this request message. Quote Header. Specifies a Prices List Id associated with the quote if a new quote is requested.Primary Web Services for Siebel CRM 8. Contact Id of the contact who owns the selected asset (Service Item) to be modified.1 . Account Id of the account that owns the selected asset (Service Item). Provide either AssetIntegrationId or AssetNumber.0 ■ ABOWebService Response Message Description: ModifyAssetToQuote Integration Object Message Format: PDS Quote. it is the Order Id of the active Order to which the generated order line item has to be added. Request Message Description: ModifyAssetToOrder Node AssetIntegrationId AssetNumber ActiveDocumentId Description Asset Integration Id of the selected asset. ActiveDocumentId means the current active Document that the current process is working on. The due date of the generated line item. Integration Object. see Table 492. Table 491. 298 Siebel CRM Web Services Reference Version 8. Document in Order Management means a Quote or an Order. Table 492. Compound Product Number for ABO network ordering. Quote Line Item attributes. Provide either AssetIntegrationId or AssetNumber. Response Message Description: ModifyAssetToQuote Node PDS Quote Header Line Item XA Description Required. Each Document can have multiple children (Quote Items or Order Line Items). Quote Line Item. AccountId ContactId DueDate PriceListId CompoundProductNumber Response Message Description: ModifyAssetToOrder Integration Object Message Format: PDS Order. For a description of this response message. see Table 491. Asset Integration Id of the selected asset.

0 ■ ABOWebService Request Message Description: SuspendAssetToQuote This is the same request message as ModifyAssetToQuote.1 29 9 . Response Message Description: ResumeAssetToOrder Integration Object Message Format: PDS Order. Response Message Description: ResumeAssetToQuote Integration Object Message Format: PDS Quote. Response Message Description: SuspendAssetToQuote Integration Object Message Format: PDS Quote. Response Message Description: SuspendAssetToOrder Integration Object Message Format: PDS Order. Response Message Description: DisconnectAssetToQuote Integration Object Message Format: PDS Quote. Request Message Description: SuspendAssetToOrder This is the same request message as ModifyAssetToOrder. Request Message Description: DisconnectAssetToQuote This is the same request message as ModifyAssetToQuote. Siebel CRM Web Services Reference Version 8.Primary Web Services for Siebel CRM 8. Request Message Description: ResumeAssetToQuote This is the same request message as ModifyAssetToQuote. Request Message Description: ResumeAssetToOrder This is the same request message as ModifyAssetToOrder. Request Message Description: DisconnectAssetToOrder This is the same request message as ModifyAssetToOrder. Response Message Description: DisconnectAssetToOrder Integration Object Message Format: PDS Order.

and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. see Table 493. Table 493. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. 300 Siebel CRM Web Services Reference Version 8. For more information on application implementation.1 . Extract the files in the zip file. ABOWebService Service Object Name SISOMAutoOrderWebService SISOMSubmitWebService SISOMAutoAssetWebService SISOMModifyWebService-Quote SISOMModifyWebService-Order SISOMSuspendWebService-Quote SISOMSuspendWebService-Order SISOMResumeWebService-Quote SISOMResumeWebService-Order SISOMDisconnectWebService-Quote SISOMDisconnectWebService-Order Boundary Object Type Workflow Workflow Workflow Workflow Workflow Workflow Workflow Workflow Workflow Workflow Workflow Class (if Business Service) Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Data Object (Integration Object) For a description of data objects for this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network.0 ■ ABOWebService ABOWebService Application Interface This topic describes the application objects called by the this Web service. Table 494. ABOWebService Data Object Siebel Repository Name PDS Quote PDS Order PDS Asset External Name PDS Quote PDS Order PDS Asset Example Package for ABOWebService To view an example of messages for this Web service. refer to your application development documentation on Oracle Technology Network.Primary Web Services for Siebel CRM 8. see Table 494.

.. navigate to the documentation library for Siebel applications on Oracle Technology Network... .. read..0 ■ Asset Management Request (AutoOrder) See the following file to view the sample code: …\ABOWebService\AutoOrder_request.\ABOWebService\ModifyAssetToQuote_request.. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file...xml Response (AutoAsset) See the following file to view the sample code: .\ABOWebService\AutoAsset_request.xml Response (ModifyAssetToQuote) See the following file to view the sample code: ..\ABOWebService\ModifyAssetToQuote_response.wsdl Asset Management Use this Web service to create.xml Message Schema (WSDL) for ABOWebservice To view the message schema for this Web service.. and update Asset records.\ABOWebService\ABOWebService.xml Request (ModifyAssetToQuote) See the following file to view the sample code: .\ABOWebService\AutoOrder_response.xml Response (AutoOrder) See the following file to view the sample code: .Primary Web Services for Siebel CRM 8.. Siebel CRM Web Services Reference Version 8.xml Request (AutoAsset) See the following file to view the sample code: .1 30 1 .\ABOWebService\AutoAsset_response. Extract the files in the zip file.

see Table 495. refer to your application development documentation on Oracle Technology Network. Asset Management Application Interface This topic describes the application objects called by the this Web service. Because of this similarity. However. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. see Table 496. Table 495. For more information on application implementation. For a list of operations associated with this Web service. Asset Management Service Object Name Asset Management Boundary Object Type Business Service Class (If BusService) CSSEAIUIDataService 302 Siebel CRM Web Services Reference Version 8.Primary Web Services for Siebel CRM 8. the message formats for each operation have their own message names. Asset Mangement Operations Name Asset_spcManagement_AssetManagementInsert Request: Asset_spcManagement_AssetManagementInsert_Input Request: Asset_spcManagement_AssetManagementInsert_Output: Asset_spcManagement_AssetManagementQueryPage Request: Asset_spcManagement_AssetManagementQueryPage_Input Response: Asset_spcManagement_AssetManagementQueryPage_Output Asset_spcManagement_AssetManagementUpdate Request: Asset_spcManagement_AssetManagementUpdate_Input Response: Asset_spcManagement_AssetManagementUpdate_Output Updates an Asset record.0 ■ Asset Management Asset Mangement Operations Note that all operations for this service share a common data format. The request message consists of fields from the Asset Mgmt Business Component. Description Creates an Asset record. all the operations for this service are grouped together. Common Response Message Description Same as request message format.1 . Queries for an Asset record. because of the nature of the schema generation for the WSDL file. Table 496. Common Request Message Description All operations in this Web service work with a common request message format and a common response message format.

\AssetManagement\AssetManagement_request.xml Response See the following file to view the sample code: . Extract the files in the zip file.0 ■ Asset Management Data Object (Integration Object) For a description of data objects for this Web service.1 30 3 . navigate to the documentation library for Siebel applications on Oracle Technology Network.\AssetManagement\AssetManagement_response.. Table 497. Asset Management Data Object Siebel Repository Name Asset Management External Name Asset Management Methods For a description of methods for this Web service. . Table 498. see Table 498.. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file....[QueryPage] [BS:Asset Management]. Request See the following file to view the sample code: . Asset Management Methods Operation Asset_spcManagement_AssetManagementInsert Asset_spcManagement_AssetManagementQueryPage Asset_spcManagement_AssetManagementUpdate Method [BS:Asset Management]. navigate to the documentation library for Siebel applications on Oracle Technology Network.[Update] Example Package for AssetManagement To view an example of messages for this Web service.\AssetManagement\AssetManagement. see Table 497.Primary Web Services for Siebel CRM 8. Extract the files in the zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.[Insert] [BS:Asset Management].xml Message Schema (WSDL) for AssetManagement To view the message schema for this Web service..wsdl Siebel CRM Web Services Reference Version 8.

CalculatePriceWS Operations Name CalculatePrice Description Calculate price for the input Quote Document. Request Message Description: CheckQuoteEligibilityCompatibility For a description of this request message. The input and output are based on the “PSP Common” Integration Object. see Table 499. refer to your application development documentation on Oracle Technology Network. see the following files in the WebServices ZIP download in the Siebel Bookshelf documentation library on Oracle Technology Network: CalculatePriceWS Use this Web service to calculate the document’s Quote price. CalculatePriceWS Operations For a list of operations associated with this Web service.Primary Web Services for Siebel CRM 8. Table 500. see Table 501. Response Message Description: CheckQuoteEligibilityCompatibility Node QuoteIO Description An instance of the Integration Object PDS Quote. The Web service invokes the Web Channel Pricing Driver Workflow. For more information on application implementation. An instance of the Integration Object PDS Quote. Request Message Description: CheckQuoteEligibilityCompatibility Node QuoteIO Description Required.0 ■ AssetWebService AssetWebService To view the sample code. see Table 500. 304 Siebel CRM Web Services Reference Version 8. CalculatePriceWS Application Interface This topic describes the application objects called by the this Web service.1 . This Web service invokes the “Web Channel Pricing Driver Workflow” Workflow. Table 499. Response Message Description: CheckQuoteEligibilityCompatibility For a description of this response message. Table 501.

0 ■ CalculatePriceWS This is the Web service version of the PSP Driver Workflow Process. Table 502. Calls the Dynamic Pricing Procedure to perform pricing. PSP Driver Workflow Process Name Transfer Quote IO to PS Type Business Service Business Service EAI Integration Object to XML Hierarchy Converter Context Service Method IntObjHierToPSHier Sub process Not applicable Description Converts input to the PDS Quote integration object to a property set hierarchy. Get Context Business Service GetRowSetData Not applicable Get RowSet Set Pricing Date Business Service Business Service Context Service Row Set Transformation Toolkit GetRowSetData Not applicable Not applicable Conditional Action Transform Calculate Price Zero Out Totals Totaling Sub Procedure Business Service Business Service Row Set Transformation Toolkit Row Set Transformation Toolkit Conditional Action Transform Conditional Action Transform Dynamic Pricing Procedure Not applicable Not applicable Sync Row Set to PS Business Service Context Service SetRowSetData Not applicable Siebel CRM Web Services Reference Version 8. see Table 502.Primary Web Services for Siebel CRM 8. Clears the price totals on the Context Row Set. For a description of the workflows steps. Sets the Pricing Date to the current time stamp or the date provided by the Joint Workspace Scenario Builder. Writes the updated Row Set back to the Property Set Hierarchy.1 30 5 . Calculates the Totals for the Non Recurring Charge and Monthly Recurring Charge on the Context Row Set. Creates Row Set from Property Set hierarchy. Creates Context Row Set from the Property Set hierarchy.

CalculatePriceWS Data Objects Operation CalculatePrice Method RunProcess 306 Siebel CRM Web Services Reference Version 8. see Table 504. Table 504. Table 505. CalculatePriceWS Data Objects Siebel Repository Name PDS Quote Structure: Header |-----LineItem |----. Business Service EAI Integration Object to XML Hierarchy Converter PSHierToIntObjHier Not applicable Service Object (Business Service or Workflow) For a description of the service objects for this Web service. see Table 503. Converts the Property Hierarchy to the Integration Object Hierarchy. CalculatePriceWS Service Object Name Web Channel Pricing Driver Workflow Boundary Object Type Workflow Class (if BusService) Not applicable Data Object (Integration Object) For a description of data objects for this Web service.XA External Name PDS Quote Methods For a description of methods for this Web service. PSP Driver Workflow Process Name Sync Context to PS Transfer from PS to IO Type Business Service Business Service Context Service Method SetRowSetData Sub process Not applicable Description Writes the updated Context back to the Property Set Hierarchy.0 ■ CalculatePriceWS Table 502.1 . see Table 505.Primary Web Services for Siebel CRM 8. Table 503.

Extract the files in the zip file. get category product. Retrieves the full structure of a given Catalog including category and products.\CalculatePriceWS\CalculatePriceWS_response. execute search. CatalogWebService Operations Name Get Catalog Get Catalog Categories Get Category Products Publish Catalog Get Product Details Description Retrieves a list of catalogs. Siebel CRM Web Services Reference Version 8. and so on.. get product promotions.. see Table 506.xml Message Schema (WSDL) of CalculatePriceWS To view the message schema for this Web service. including get catalog. get search parameters. ...wsdl CatalogWebService Use this set of Web services to expose the catalog functions.com_OrderManagement_Quote_PSP_CalculatePriceWS. get catalog category.\CalculatePriceWS\http_siebel. navigate to the documentation library for Siebel applications on Oracle Technology Network.. Retrieves the basic product information along with the attributes. get search options. category and other contextual parameters. Extract the files in the zip file.Primary Web Services for Siebel CRM 8. Retrieves a list of products for a given catalog.0 ■ CatalogWebService Example Package for CalculatePriceWS To view an example of messages for this Web service. Table 506. Retrieves a list of categories for a given catalog.\CalculatePriceWS\CalculatePriceWS_request. Request See the following file to view the sample code: ..xml Response See the following file to view the sample code: . and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. CatalogWebService Operations For a list of operations associated with this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 30 7 .

For a description of this response message. Response Message Description: GetCatalogs Integration Object Message Format: PDS Catalog Interface. Returns the search results based on the search options and parameter values. Table 507. Request Message Description: GetCatalogCategory Node PDS Catalog Category Interface Description Required. An instance of Integration Object PDS Catalog Category Interface.0 ■ CatalogWebService Table 506. Response Message Description: GetCatalogs Node PDS Catalog Interface Description An instance of Integration Object PDS Catalog Interface. see Table 509. see Table 508. Retrieves all the possible values for a given product attribute. '200dpm' for the 'Printer Speed' option. enter 'Printer Speed'. 'Features'.1 . For example. Get Search Parameters Execute Search Request Message Description: GetCatalogs For a description of this request message. Request Message Description: GetCatalogs Node PDS Catalog Interface Description Required. Request Message Description: GetCatalogCategory For a description of this request message. Retrieves the search options for a specific product family or class. such as 'Product Literature'. enter '100dpm'. 'Color'. 308 Siebel CRM Web Services Reference Version 8. and so on for the 'Printer' Class.Primary Web Services for Siebel CRM 8. An instance of Integration Object PDS Catalog Interface. Retrieves a list of fields or attributes that are available for a search option. and so on. see Table 507. CatalogWebService Operations Name Get Product Children Get Product Attribute Domain Get Related Promotions Get Search Options Description Retrieves the details of the product specific child entities. Table 508. Retrieves all the related Promotions for a given product. Table 509. For example.

For a description of this response message. Optional. An instance of Integration Object PDS Catalog Context. Request Message Description: GetCategoryProducts Node PDS Category Product Interface PricingMode EligibilityMode Description Required. 1 run. The default value is 1.Primary Web Services for Siebel CRM 8. 2 run but only return eligible products). provide ContextMode to run pricing and eligibility. Optional. It either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. Request Message Description: GetCategoryProducts For a description of this request message. Net Price. Y or N (calculates price or not). ContextMode Context Response Message Description: GetCategoryProducts Integration Object Message Format: PDS Category Product Interface. see Table 511. Table 512. the List Price.2 (eligibility display mode: 0 do not run. SiebelContext or ExternalConext. If ContextMode is provided it is required. Siebel CRM Web Services Reference Version 8. For a description of this response message. An instance of Integration Object PDS Category Product Interface. see Table 512. Optional.0 ■ CatalogWebService Response Message Description: GetCatalogCategory Integration Object Message Format: PDS Catalog Category Interface. 1 . Response Message Description: GetCatalogCategory Node PDS Catalog Category Interface Description An instance of Integration Object PDS Catalog Category Interface. see Table 510. After running Eligibility and Pricing. However. The default value is Y. Eligibility status and Eligibility Reason fields will be updated. Table 511. Table 510. Response Message Description: GetCategoryProducts Node PDS Category Product Interface Description An instance of Integration Object PDS Catalog Category Interface.1 30 9 . 0.

However. After running Eligibility and Pricing. Optional. Request Message Description: GetProductDetails For a description of this request message. 0. The default value 1. Optional. Net Price. Table 515. 1 run. Request Message Description: GetProductDetails Node PDS Product Details Interface PricingMode EligibilityMode Description Required. The default value is 1. 1 run. see Table 515. 1 . 0. 2 run but only return eligible products ).1 . Optional only if ContextMode is not provided. SiebelContext or ExternalContext. Optional. 1 . you must provide ContextMode to run pricing and eligibility. Eligibility status and Eligibility Reason fields will be updated. Table 514.0 ■ CatalogWebService Request Message Description: PublishCatalog For a description of this request message. Optional. Y or N (calculates price or not).Primary Web Services for Siebel CRM 8. Response Message Description: PublishCatalog Node PDS Publish Catalog Interface Description An instance of Integration Object PDS Publish Catalog Interface. 2 run but only return eligible products ). Y or N (includes price waterfall or does not). An instance of Integration Object PDS Product Details Interface.2 (eligibility display mode: 0 do not run. Request Message Description: PublishCatalog Node PDS Publish Catalog Interface PricingMode EligibilityMode Description Required. An instance of Integration Object PDS Catalog Context. Y or N (calculates price or not). Table 513. the List Price. For a description of this response message.2 (eligibility display mode: 0 do not run. The default value is Y. see Table 513. If ContextMode is provided it is required. ContextMode Context IncludePriceWaterfall Response Message Description: PublishCatalog Integration Object Message Format: PDS Publish Catalog Interface. The default value is Y. An instance of Integration Object PDS Category Product Interface. It either contains SiebelContext or ExternalContext. see Table 514. Optional. 310 Siebel CRM Web Services Reference Version 8.

Eligibility status and Eligibility Reason fields will be updated. An instance of Integration Object PDS Product Children Interface. If ContextMode is provided it is required. Y or N (calculates price or not). For a description of this response message. 1 run. It either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. 2 (eligibility display mode: 0 do not run. 1.0 ■ CatalogWebService Table 515. 2 run but only return eligible products). If ContextMode is provided it is required. see Table 517. see Table 516. Optional. Request Message Description: GetProductDetails Node ContextMode Context Description SiebelContext or ExternalConext. Request Message Description: GetProductChildren For a description of this request message. Optional.1 31 1 . provide ContextMode to run pricing and eligibility.Primary Web Services for Siebel CRM 8. Net Price. SiebelContext or ExternalConext. The default value 1. Request Message Description: GetProductChildren Node PDS Product Children Interface PricingMode: EligibilityMode ContextMode Context Description Required. An instance of Integration Object PDS Catalog Context. However. The default value is Y. 0. It either contains SiebelContext or ExternalContext. Siebel CRM Web Services Reference Version 8. Table 516. However. Response Message Description: GetProductDetails Node PDS Product Details Interface Description An instance of Integration Object PDS Product Details Interface. Optional. provide ContextMode to run pricing and eligibility. After running Eligibility and Pricing. Optional. Table 517. the List Price. Optional only if ContextMode is not provided. Response Message Description: GetProductDetails Integration Object Message Format: PDS Product Details Interface. An instance of Integration Object PDS Catalog Context.

The default value is 15. (It will be made obsolete. The default value is N. An instance of Integration Object PDS Searchable Product Class Interface. Optional. Property name for the class Id field. Request Message Description: GetSearchParameters Retrieves a List of Fields or Attributes Available for a Search Option along with Attribute Domain Values If LOV Type. Optional. Do not use this parameter.1 . see Table 519. see Table 518. Table 519. Request Message Description: GetSearchParameters Node PDS Searchable Product Class Interface FieldNameClassId LookupFromCache MaximumAttributes Description Required. Table 518. Optional. Response Message Description: GetSearchOptions Node PDS Searchable Product Class Interface Description An instance of Integration Object PDS Searchable Product Class Interface. 312 Siebel CRM Web Services Reference Version 8. Y or N (lookup search parameters from cache). Response Message Description: GetProductChildren Node PDS Product Children Interface Description An instance of Integration Object PDS Product Children Interface.0 ■ CatalogWebService Response Message Description: GetProductChildren Integration Object Message Format: PDS Product Children Interface. Table 521. Request Message Description: GetSearchOptions For a description of this request message. For a description of this request message. see Table 521. Response Message Description: GetSearchOptions Integration Object Message Format: PDS Searchable Product Class Interface.Primary Web Services for Siebel CRM 8. For a description of this response message. Request Message Description: GetSearchOptions Node PDS Searchable Product Class Interface Description Required. For a description of this response message. Table 520. The default value is Class Id.) The maximum number of attributes returned for each product class. An instance of Integration Object PDS Searchable Product Class Interface. see Table 520. It is recommend that this field not be changed.

SearchByProduct or SearchByClass. see Table 525. Request Message Description: GetProductAttributeDomain Retrieves all the Possible Values for a Given Product Attribute.0 ■ CatalogWebService Response Message Description: GetSearchParameters Integration Object Message Format: PDS Product Class Attributes Interface. Optional. This is a required input for the SearchByProduct search option. see Table 522. Table 522. The default value is 1. Siebel CRM Web Services Reference Version 8. Request Message Description: ExecuteSearch Node SearchOption PDS Product Interface PricingMode EligibilityMode Description Required. Table 523. see Table 523. For a description of this request message. see Table 524. For a description of this response message. Product Configuration Model Id. Request Message Description: ExecuteSearch Performs an Attribute Search. Table 525.1 31 3 . Response Message Description: GetProductAttributeDomain Integration Object Message Format: PDS Product Attribute Domain Interface. Response Message Description: GetProductAttributeDomain Node PDS Product Attribute Domain Interface Description An instance of Integration Object PDS Product Attribute Domain Interface. Request Message Description: GetProductAttributeDomain Node Attribute Id Product Configuration Model Id Description Product attribute Id. Optional.1. Y or N (calculates price or not). This is a required input. An instance of Integration Object PDS Product Interface.Primary Web Services for Siebel CRM 8. For a description of this response message. For a description of this request message. Response Message Description: GetSearchParameters Node PDS Product Class Attributes Interface Description An instance of Integration Object PDS Product Class Attributes Interface.2 (eligibility display mode: 0 do not run. Returns the Search Results Based on the Search Options and Parameter Values. 2 run but only return eligible products ). Table 524. This is a required input. The default value is Y. 0. This field value can be looked up from the product integration object. 1 run.

Optional. Number of products returned. It either contains SiebelContext or ExternalContext. and Eligibility Reason fields will be updated. Optional only if ContextMode is not provided. see Table 526.1 . the List Price. Price field search expression. After running Eligibility and Pricing. For more information on application implementation. provide ContextMode to run pricing and eligibility. Optional. This is a required input for the SearchByClass search option. see Table 527. Optional. [Name] like "IBM*". Table 527. Net Price. Eligibility status. An instance of Integration Object PDS Catalog Context. If ContextMode is provided it is required. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Request Message Description: ExecuteSearch Node ContextMode Context Description SiebelContext or ExternalConext. PriceSearchExpression ProductSearchSpec ResultSize PDS Product Class Attributes Interface Response Message Description: ExecuteSearch Integration Object Message Format: PDS Product Interface. greater than > 100 and less than < 1000. For example. CatalogWebService Application Interface This topic describes the application objects called by the this Web service.Primary Web Services for Siebel CRM 8.0 ■ CatalogWebService Table 525. However. Search specification for the product business component. refer to your application development documentation on Oracle Technology Network. Optional. for example. CatalogWebService Service Object Name PDS Product Data Service Boundary Object Type BusService Class (if BusService) CSSProdDataSvc 314 Siebel CRM Web Services Reference Version 8. Table 526. Response Message Description: ExecuteSearch Node PDS Product Interface Description An instance of Integration Object PDS Product Interface. An instance of Integration Object PDS Product Class Attributes Interface. For a description of this response message. The default value is 100.

. navigate to the documentation library for Siebel applications on Oracle Technology Network.. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. . CatalogWebService Data Objects Siebel Repository Name PDS Catalog Interface PDS Catalog Category Interface PDS Category Product Interface PDS Publish Catalog Interface PDS Product Interface PDS Product Class Attributes Interface PDS Product Attribute Domain Interface PDS Searchable Product Class Interface PDS Product Details Interface PDS Product Children Interface External Name PDS Catalog Interface PDS Catalog Category Interface PDS Category Product Interface PDS Publish Catalog Interface PDS Product Interface PDS Product Class Attributes Interface PDS Product Attribute Domain Interface PDS Searchable Product Class Interface PDS Product Details Interface PDS Product Children Interface CatalogWebService Example Package To view an example of messages for this Web service.. Extract the files in the zip file.\CatalogWebService\CatalogWebService_request.xml Message Schema (WSDL) of CatalogWebService To view the message schema for this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network.wsdl Siebel CRM Web Services Reference Version 8..0 ■ CatalogWebService Data Object (Integration Object) For a description of data objects for this Web service.xml Response See the following file to view the sample code: .\CatalogWebService\CatalogWebService_response..\CatalogWebService\CatalogWebService. Request See the following file to view the sample code: . Table 528. see Table 528..1 31 5 . and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.Primary Web Services for Siebel CRM 8. Extract the files in the zip file.

UIActive. ContextServiceWrapperService-QuoteItem-Verify ContextServiceWrapperService-OrderHeader-Verify ContextServiceWrapperService-OrderItem-Verify Request Message Description: ContextServiceWrapperService-QuoteHeader-Verify This Web service request takes a “WS Quote” Integration Object as its input.Primary Web Services for Siebel CRM 8. including all of its items. see Table 530. The signal invoked is QuotesAndOrdersValidate. or validates the selected quote items under a quote. including all of its items. For a description of this request message. or selected line items in the whole document. including all of its items. ContextServiceWrapperService Operations For a list of operations associated with this Web service. or validates the selected order items under an order. Validates a Quote. Validates an Order. or validates the selected quote items under a quote. The signal invoked is QuotesAndOrdersValidate. ContextServiceWrapperService Operations Node ContextServiceWrapperService-QuoteHeader-Verify Description Validates a Quote. the request message is in a structure that is consistent with the “WS Quote” integration object definition.0 ■ ContextServiceWrapperService ContextServiceWrapperService These Web services invoke the QuotesAndOrdersValidate signal through the context service wrapper service. or validates the selected order items under an order. Validates an Order. Table 530. Request Message Description: ContextServiceWrapperService-QuoteHeader-Verify Node Header Line Item XA Description Quote (Quote Ids. The signal invoked is QuotesAndOrdersValidate. UISelected required) Quote Item Quote Item attributes 316 Siebel CRM Web Services Reference Version 8.1 . Therefore. They validate the quotes and orders. The signal invoked is QuotesAndOrdersValidate. Table 529. see Table 529. including all of its items.

see Table 533. Request Message Description: ContextServiceWrapperService-QuoteItem-Verify For a description of this request message. Siebel CRM Web Services Reference Version 8. see Table 531. UISelected required) Quote Item attributes Response Message Description: ContextServiceWrapperService-QuoteItem-Verify For a description of this response message. All: returns a validation message after validating all Customizable Products (CP) under the Quotes or Orders. Response Message Description: ContextServiceWrapperService-QuoteItem-Verify Node Return Message Return Message Return Message Return Message Description Data Validation: returns a validation message for validating a Quote or Order against the Data Validation Rule Set. Request Message Description: ContextServiceWrapperService-QuoteItem-Verify Node Header Line Item XA Description Quote (Quote Id required) Quote Item (Quote Items Ids.1 31 7 . Data Validation: returns a validation message for validating a Quote or Order against the Data Validation Rule Set. Response Message Description: ContextServiceWrapperService-QuoteHeader-Verify Node Return Message Return Message Return Message Return Message Description Data Validation: returns a validation message for validating a Quote or Order against the Data Validation Rule Set. Validate CP All: returns a validation message after validating all Customizable Products (CP) under the Quotes or Orders. Promotion: returns a validation message from the promotion verify workflow. Table 531. see Table 532.0 ■ ContextServiceWrapperService Response Message Description: ContextServiceWrapperService-QuoteHeader-Verify For a description of this response message. Promotion: returns a validation message from the promotion verify workflow. UIActive.Primary Web Services for Siebel CRM 8. Table 532. Table 533. Data Validation: returns a validation message for validating a Quote or Order against the Data Validation Rule Set.

1 . Response Message Description: ContextServiceWrapperService-OrderHeader-Verify Node Return Message Return Message Return Message Return Message Description Data Validation: returns a validation message for validating a Quote or Order against the Data Validation Rule Set. Promotion: returns a validation message from the promotion verify workflow. Request Message Description: ContextServiceWrapperService-OrderHeader-Verify Node Header Line Item XA Description Order Entry . see Table 536. Validate CP All: returns a validation message after validating all Customizable Products (CP) under the Quotes or Orders. UIActive.Orders (Order Id required) Order Entry .Orders (Order Id required) Order Entry . UISelected required) Order Item attributes 318 Siebel CRM Web Services Reference Version 8.0 ■ ContextServiceWrapperService Request Message Description: ContextServiceWrapperService-OrderHeader-Verify For a description of this request message. Table 534. Request Message Description: ContextServiceWrapperService-OrderItem-Verify Node Header Line Item XA Description Order Entry . Request Message Description: ContextServiceWrapperService-OrderItem-Verify For a description of this request message. see Table 534. UIActive.Primary Web Services for Siebel CRM 8. UISelected required) Order Item attributes Response Message Description: ContextServiceWrapperService-OrderHeader-Verify For a description of this response message. Data Validation: returns a validation message for validating a Quote or Order against the Data Validation Rule Set. Table 536. Table 535.Line Items (Order Items Ids.Line Items (Order Items Ids. see Table 535.

Table 537. Response Message Description: ContextServiceWrapperService-OrderItem-Verify Node Return Message Return Message Return Message Return Message Description Data Validation: returns a validation message for validating a Quote or Order against the Data Validation Rule Set. ContextServiceWrapperService Application Interface This topic describes the application objects called by the this Web service. ContextServiceWrapperService Data Objects Siebel Repository Name WS Quote WS Order External Name WS Quote WS Order Siebel CRM Web Services Reference Version 8. Validate CP All: returns a validation message after validating all Customizable Products (CP) under the Quotes or Orders. see Table 539. ContextServiceWrapperService Service Objects Name ContextServiceWrapperService-QuoteHeader-Verify ContextServiceWrapperService-QuoteItem-Verify ContextServiceWrapperService-OrderHeader-Verify ContextServiceWrapperService-OrderItem-Verify Boundary Object Type Workflow Workflow Workflow Workflow Data Object (Integration Object) For a description of data objects for this Web service. Data Validation: returns a validation message for validating a Quote or Order against the Data Validation Rule Set.Primary Web Services for Siebel CRM 8.1 31 9 . Table 538. see Table 537. see Table 538.0 ■ ContextServiceWrapperService Response Message Description: ContextServiceWrapperService-OrderItem-Verify For a description of this response message. Promotion: returns a validation message from the promotion verify workflow. refer to your application development documentation on Oracle Technology Network. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. For more information on application implementation. Table 539.

..\ContextServiceWrapperService\ValidateQuoteItems_response. navigate to the documentation library for Siebel applications on Oracle Technology Network.wsdl 320 Siebel CRM Web Services Reference Version 8.. .\ContextServiceWrapperService\ValidateQuoteItems_request.\ContextServiceWrapperService\ValidateQuote_request.xml Response (ValidateQuotes) See the following file to view the sample code: . see Table 540. navigate to the documentation library for Siebel applications on Oracle Technology Network..\ContextServiceWrapperService\ContextServiceWrapperService..\ContextServiceWrapperService\ValidateQuotes_response.xml Response (ValidateQuoteItems) See the following file to view the sample code: .. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.0 ■ ContextServiceWrapperService Methods For a description of methods for this Web service.xml Message Schema (WSDL) of ContextServiceWrapperService To view the message schema for this Web service. Request (ValidateQuotes) See the following file to view the sample code: . Extract the files in the zip file... ContextServiceWrapperService Methods Operation ValidateQuotes ValidateQuoteItems ValidateOrders ValidateOrderItems Method RunProcess RunProcess RunProcess RunProcess Example Packages for ContextServiceWrapperService To view an example of messages for this Web service.Primary Web Services for Siebel CRM 8. Table 540. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.xml Request (ValidateQuoteItems) See the following file to view the sample code: ... Extract the files in the zip file.1 .

Row Id of Activity Template. CopyActivity Application Interface This topic describes the application objects called by the this Web service. refer to your application development documentation on Oracle Technology Network. Response Message Description: WSCopyServiceActivityRunProcess There is response message for this operation.0 ■ CopyActivity CopyActivity Use this Web service to instantiate activities from an activity template for a Service Request. For more information on application implementation. see Table 541. Request Message Description: WSCopyServiceActivityRunProcess For a description of this request message. CopyActivity Operations Name WSCopyServiceActivityRunProcess Description Creates activity records. Table 543.1 32 1 . Table 541. CopyActivity Operations For a list of operations associated with this Web service. Row Id of Activity Plan. Request Message Description: WSCopyServiceActivityRunProcess Node SRId TemplateId ActPlanId Description Row Id of service request.Primary Web Services for Siebel CRM 8. see Table 542. CopyActivity Service Object Name WS Copy Service Activity Boundary Object Type Workflow Siebel CRM Web Services Reference Version 8. see Table 543. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Table 542.

.1 . Extract the files in the zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network. Table 544. Request (WSCopyServiceActivityRunProcess) See the following file to view the sample code: .0 ■ EAILOVWS Methods For a description of the methods for this Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.Primary Web Services for Siebel CRM 8. CopyActivity Methods Operation WSCopyServiceActivityRunProcess Method [WF: WS Copy Service Activity].. . and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network.xml Response (WSCopyServiceActivityRunProcess) See the following file to view the sample code: .xml Message Schema (WSDL) of CopyActivity To view the message schema for this Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file..wsdl EAILOVWS To view the message schema for this Web service... 322 Siebel CRM Web Services Reference Version 8. Extract the files in the zip file.\CopyActivity\CopyActivity. navigate to the documentation library for Siebel applications on Oracle Technology Network.\CopyActivity\CopyActivity_request. see Table 544. EligibilityCompatibility Use this Web service to validate the document’s (Quote) eligibility and compatibility status..[RunProcess] Example Package for CopyActivity To view an example of messages for this Web service.\CopyActivity\CopyActivity_response.

Post-Pick will have both the eligibility and compatibility checks executed. The default is External PDS Quote. Some of the fields used in the eligibility and compatibility process are shown in the following table: Eligibility and Compatibility User Fields. Table 547. Pre-Pick will trigger only the eligibility check. An instance of the Integration Object PDS Quote. PSPMode PickMode ProjectedAssetIO Eligibility and Compatibility Used Fields For a description of the Eligibility and Compatibility used fields.0 ■ EligibilityCompatibility EligibilityCompatibility Operations For a list of operations associated with this Web service. Table 545. see Table 547. EligibilityCompatibility Operations Name CheckQuoteEligibilityCompatibility Description Checks the eligibility and compatibility status for the input Quote Object. An instance of the Projected Asset Integration Object. It is used for a compatibility check with the current quote.1 32 3 . see Table 546.Primary Web Services for Siebel CRM 8. This parameter will be parsed as Mode used in the Variable Map. Table 546. Can be Pre-Pick or Post-Pick. Request Message Description: CheckQuoteEligibilityCompatibility For a description of this request message. Eligibility and Compatibility Used Fields PDS Quote (Quote) Mapping XML Name AccountContractedProductsOnlyFlag AccountId AccountType ShippingCity ShippingCountry Variable Name (Map to Internal Variable Map) Account Contracted Products Only Flag Account Id Account Type City Country How It Is Used in Eligibility and Compatibility Used in the workflow Account (used in the Eligibility Matrix) Account Type (used in the Eligibility Matrix) City (used in the Eligibility Matrix) Country (used in the Eligibility Matrix) Siebel CRM Web Services Reference Version 8. Request Message Description: CheckQuoteEligibilityCompatibility Node QuoteIO Description Required. see Table 545.

Checks if the product is effective.0 ■ EligibilityCompatibility Table 547. Table 548. Defines if the line item will trigger the eligibility and compatibility checking. Name of the line item. For more information about eligibility rules. it will compare with the Exclusive rules. PDS Quote Fields PDS Quote (Quote Line Item) XML Name AccountId ClassId EffectiveFrom EffectiveTo InclusiveEligibilityFlag Variable Name Account Id Class Id Effective From Effective To Inclusive Eligibility Flag How It Is Used Account (used in the Eligibility Matrix). Eligibility and Compatibility Used Fields PDS Quote (Quote) Mapping XML Name ShippingPostalCode PriceListId Variable Name (Map to Internal Variable Map) Postal Code Price List Id How It Is Used in Eligibility and Compatibility Postal Code (used in the Eligibility Matrix) Price List (checks in the workflow if the product is included in the price list) State (used in the Eligibility Matrix) ShippingState State PDS Quote Fields For a descripiton of PDS Quote Fields. It must be 'Y' to trigger the eligibility and compatibility check. Checks if the product is effective. Product Line (used in the Eligibility and Compatibility Matrix). Defines the type of rules it will use. Product (used in the Eligibility and Compatibility Matrix). Name PrePickCD Name Pre Pick PriceListId ProductId ProductLineId Price List Id Product Id Product Line Id 324 Siebel CRM Web Services Reference Version 8. Product Class (used in the Compatibility Matrix). If it is Y. see Table 548. Otherwise.1 . it will compare with the Inclusive rules. see Siebel Product Administration Guide and the chapter about defining product and promotion eligibility rules. Price List (checks if the product is included in the price list).Primary Web Services for Siebel CRM 8.

EligibilityCompatibility Data Objects Siebel Repository Name PDS Quote Projected Asset External Name PDS Simplified Quote Projected Asset Example Package for EligibilityCompatibility To view an example of messages for this Web service. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Table 550. navigate to the documentation library for Siebel applications on Oracle Technology Network. see Table 551. Table 551.xml Siebel CRM Web Services Reference Version 8. Table 549.0 ■ EligibilityCompatibility Response Message Description: CheckQuoteEligiblityCompatibility For a description of this response message. Response Message Description: CheckQuoteEligiblityCompatibility Node QuoteIO Description An instance of the Integration Object PDS Quote. Request Go to the following directory in the SampleCode. see Table 549. Extract the files in the zip file. After running the eligibility and compatibility process.\EligibilityCompatibility\EligibilityCompatibility_request.. see Table 550.Primary Web Services for Siebel CRM 8. For more information on application implementation. EligibilityCompatibility Service Object Name Web Channel Product Eligibility & Compatibility Driver Workflow Boundary Object Type Workflow Class (if BusService) Data Object (Integration Object) For a description of data objects for this Web service. EligibilityCompatibility Application Interface This topic describes the application objects called by the this Web service. refer to your application development documentation on Oracle Technology Network.1 32 5 .. the Eligibility Status and Eligibility Reason fields will be updated. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.zip file to view the sample code: .

see Table 552. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 . Table 552. .zip file to view the sample code: ..xml Message Schema (WSDL) of EligibilityCompatibility To view the message schema for this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network.. session and registration details based on the Event Id and Contact Id Inputs. Request Message Description: GetEvents Node Id Name Status Event Type Description Row Id of Event Name of Event Event Status Event Format 326 Siebel CRM Web Services Reference Version 8. Enroll a contact into a specified event which invokes the Event Registration Service.. see Table 553.\EligibilityCompatibility\EligibilityCompatibility. Extract the files in the zip file. EventManagement Operations For a list of operations associated with this Web service.0 ■ EventManagement Response Go to the following directory in the SampleCode. It also allows for event registration by a Contact with the same input parameters. Table 553.. EventManagement Operations Name GetEvents GetEventDetails GetSessions GetRegisteredEvents RegisterForEvent Description Retrieves a list of events based on Status or Date Search Specification. Retrieves a list of events registered by a specified contact.wsdl EventManagement This Web service allows enables you to retrieve event. Request Message Description: GetEvents For a description of this request message.\EligibilityCompatibility\EligibilityCompatibility_response. Retrieves event details for an event preferably based on an Id Search Specification. Retrieves a list of sessions.Primary Web Services for Siebel CRM 8.

1 32 7 . Request Message Description: GetEventDetails For a description of this request message. Table 554. see Table 553. Response Message Description: GetEvents This Response Message is the same as the Request Message. Description Maximum Number of Attendees than can enroll for the Event. Event Description. Session Name. For more information. Event Start Date. Session Description. Event Description. Event Participant Type.Primary Web Services for Siebel CRM 8. see Table 554. Session Region. Session End Date. Name of Event. Siebel CRM Web Services Reference Version 8. Event Plan.0 ■ EventManagement Table 553. Request Message Description: GetEvents Node Max Attendees Start Date End Date Description Parent Event Name Session Info Id Event Id Name Description Start Date End Date Region View Mode Session Id. Event End Date. Parent Event Id. Maximum Number of Attendees than can enroll for the Event. Event Status. Event Format. Request Message Description: GetEventDetails Node Id Name Status Event Type Max Attendees Start Date End Date Description Participant Type Description Row Id of Event. Event Start Date. All. Session Start Date. Event End Date.

1 . For more information. Parent Event Id. Event Period. Session Description. Name of the Venue where the Event happens. Event Invitation deadline. Session Region. Response Message Description: GetEventDetails This Response Message is the same as the Request Message. Contact Id. Event for which the attendee is registering to.0 ■ EventManagement Table 554. Request Message Description: GetEventDetails Node Region Parent Event Name Invitation Deadline Organization Lead Partner Primary venue Name URL Period Name Budget Period Session Info Id Event Id Name Description Start Date End Date Region View Mode Session Id. Event Budget Period. Request Message Description: GetRegisteredEvents For a description of this request message. see Table 555. 328 Siebel CRM Web Services Reference Version 8. Request Message Description: GetRegisteredEvents Node Id Event Id Attendee Id Name Status Description Row Id of Event Attendee. Web URL for Events.Primary Web Services for Siebel CRM 8. Event Plan. All. Event Organization. see Table 554. Event Partner. Session End Date. Event Registration Status. Session Start Date. Description Region where the Event takes Place. Session Name. Event Name. Table 555.

All. All. Name of Event. Session Region.0 ■ EventManagement Table 555. Response Message Description: GetRegisteredEvents This Response Message is the same as the Request Message.Primary Web Services for Siebel CRM 8. Request Message Description: GetSessions Node Id Name Status Event Type Max Attendees Start Date End Date Description Parent Event Name Session Info Id Event Id Name Description Start Date End Date Region View Mode Session Id. see Table 555. Event Description. Event Status. Request Message Description: GetRegisteredEvents Node Event Type Max Attendees Start End View Mode Description Event Format. Table 556. Session Start Date. Request Message Description: GetSessions For a description of this request message. Event Format.1 32 9 . End Date of Event. Event Plan. Description Row Id of Event. Session End Date. Siebel CRM Web Services Reference Version 8. Maximum Number of attendees allowed to enroll into the Event. Maximum Number of Attendees than can enroll for the Event. Session Description.. Event Start Date. For more information. see Table 556. Start Date of Event. Parent Event Id. Event End Date. Session Name.

Request Message Description: RegisterForEvent Node Status Registration date Contact Id Reg Id Event Id User Type Description Registration status. Attendee Id of event. EventManagement Service Object Name Event Data Service Event Detail Service Boundary Object Type Business Service Business Service Class (if Bus Service) CSSEAIUIDataService CSSEAIUIDataService 330 Siebel CRM Web Services Reference Version 8. Outcome Status. Registration Id. Registration Id.Primary Web Services for Siebel CRM 8. Response Message Description: RegisterForEvent Node Output Type Return Val Reg Id Description Message to Indicate detailed status. Response Message Description: RegisterForEvent For a description of this response message. see Table 556. EventManagement Application Interface This topic describes the application objects called by the this Web service. refer to your application development documentation on Oracle Technology Network. see Table 558. see Table 557. Event being enrolled to. Denotes type of Attendee. Date when the registration occurs. see Table 559.1 . Service Object (Business Service or Workflow) For a description of the service objects for this Web service. For more information.0 ■ EventManagement Response Message Description: GetSessions This Response Message is the same as the Request Message. Table 558. Request Message Description: RegisterForEvent For a description of this request message. For more information on application implementation. Table 557. Table 559.

Table 561.1 33 1 . Request See the following file to view the sample code: .\EventManagement\EventManagement_request. see Table 560... Extract the files in the zip file. EventManagement Methods Operation QueryPage QueryPage QueryPage QueryPage EnrollUser Display Name GetEvents GetEventDetails Session Data Service GetRegisteredEvents RegisterForEvent Method [BS: Event Data Service].[ EnrollUser] Example Package for EventManagement To view an example of messages for this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network. Table 560.0 ■ EventManagement Table 559. EventManagement Service Object Name Event Attendee Data Service Session Data Service Event Registration Service Boundary Object Type Business Service Business Service Business Service Class (if Bus Service) CSSEAIUIDataService CSSEAIUIDataService CSSEventRegistrationService Data Object (Integration Object) For a description of data objects for this Web service.[QueryPage] [BS: Event Attendee Data Service].[QueryPage] BS: Event Registration Service].xml Response See the following file to view the sample code: Siebel CRM Web Services Reference Version 8.[QueryPage] [BS: Event Detail Service].[QueryPage] [BS: Session Data Service]. EventManagement Data Objects Siebel Repository Name WC_Event_IO WC_EventSession_IO WC_ATT_IO External Name Event Event Session Event Attendee Methods For a description of the methods for this Web service. see Table 561.Primary Web Services for Siebel CRM 8. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.

332 Siebel CRM Web Services Reference Version 8.1 . navigate to the documentation library for Siebel applications on Oracle Technology Network. Extract the files in the zip file.xml Message Schema (WSDL) for EventManagement To view the message schema for this Web service. the message formats for each operation have their own message names. Extract the files in the zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. ExternalPropertyPolicy See “INSClaims” on page 350 for a description of this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network.. . lists of Alerts and lists of Service Requests.wsdl GetHealthCareProfessionalProfileInfor mation Use this Web service to read a complete profile for a Health Care Provider including Marketing Compliance information.. GetHealthCareProfessionalProfileInformation Operations Due to the nature of the schema generation for the WSDL file. navigate to the documentation library for Siebel applications on Oracle Technology Network. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.. …\Forecast\Forecast.0 ■ Event Registration .Primary Web Services for Siebel CRM 8.\EventManagement\EventManagement.. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.wsdl Event Registration To view the message schema for this Web service. ExternalAutoPolicy See “INSClaims” on page 350 for a description of this Web service. Forecast To view the message schema for this Web service.\EventManagement\EventManagement_response.

1 33 3 . Table 562. Request Message Description: LSMCProfileQueryById The operations in this Web service work with a common response message format but have different request message format. Siebel CRM Web Services Reference Version 8. Read the profile of an HCP specified by a combination of several attributes. For a description of this request message. Table 563.0 ■ GetHealthCareProfessionalProfileInformation For a list of operations associated with this Web service. see Table 562. see Table 563. GetHealthCareProfessionalProfileInformation Operations Name LSMCProfileQueryById LSMCProfileQueryByExample Description Read the profile of an HCP specified by his/her Siebel Contact Row Id.represents the Siebel Row Id of the Contact Object.Primary Web Services for Siebel CRM 8. Request Message Description: LSMCProfileQueryById Node <PrimaryRowId> Description Required .

0 ■ GetHealthCareProfessionalProfileInformation Request Message Description: LSMCProfileQueryByExample For a description of this request message. Table 564. see Table 564.Primary Web Services for Siebel CRM 8. 334 Siebel CRM Web Services Reference Version 8.1 . Request Message Description: LSMCProfileQueryByExample Node <Contact> <Created> <Updated> <AccountIntegrationId <CallClass> <ContactId> <CreatedByName> <EmployeeNumber> <FirstName> <LastName> <LeadContactType> <MarketPotential> <MiddleName> <PartyTypeCode> <PartyUId> <PersonUId> <PersonalContact> <PositionStatus> <PrimaryCity> <PrimaryEmployeeLoginOfPrimaryContactPosition> <PrimaryLastCallDate> <PrimaryLicenseExpirationDate> <PrimaryLicenseNumber> <PrimaryLicenseState> <PrimaryLicenseStatus> <PrimaryOrganization> <PrimaryPostalCode> <PrimarySpecialty> <PrimaryState> <PrimaryStateLicenseId> <PrimaryStreetAddress> <PrivacyCode> <Type> <UpdatedByName> <WorkPhone> Description Required is a combination of attributes to uniquely identify a Contact.

For a description of this response message.1 33 5 . Table 565.Primary Web Services for Siebel CRM 8. see Table 565.0 ■ GetHealthCareProfessionalProfileInformation Common Response Message Description The column Node represents a respective Siebel field if not specified otherwise. Common Response Message Description Node <ListOfLSMCProfile> <Contact soapenc> <Contact> <AccountIntegrationId> <CallClass> <ContactId> <CreatedByName> <EmployeeNumber> <FirstName> <LastName> <LeadContactType> <MarketPotential> <MiddleName> <PartyTypeCode> <PartyUId> <PersonUId> <PersonalContact> <PositionStatus> <PrimaryCity> <PrimaryCountry> <PrimaryEmployeeLoginOfPrimaryContact Position> <PrimaryLastCallDate> <PrimaryLicenseExpirationDate> <PrimaryLicenseNumber> <PrimaryLicenseState> <PrimaryLicenseStatus> <PrimaryOrganization> ListOfLSMCProfile Contact soapenc Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Parent Description <Tag> <Tag> <Tag> Siebel CRM Web Services Reference Version 8.

Common Response Message Description Node <PrimaryPostalCode> <PrimarySpecialty> <PrimaryState> <PrimaryStateLicenseId> <PrimaryStreetAddress> <PrivacyCode> <Type> <UpdatedByName> <WorkPhone> <ListOfLsMcBudgetContact> <LsMcBudgetContact soapenc> <LsMcBudgetContact> <BudgetAmount> <BudgetCurrency> <BudgetEndDate> <BudgetId> <BudgetName> <BudgetStartDate> <BudgetState> <ContactId> <ListOfLsMcBudgetContactSalesRep> <LsMcBudgetContactSalesRep soapenc> <LsMcBudgetContactSalesRep> <ContactBudgetId> <Currency2> <SalesRepBudget> <PositionId> <PositionName> <ListOfLsMcContactExpenseItem> <LsMcContactExpenseItem soapenc> Parent Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact ListOfLsMcBudgetContact LsMcBudgetContact soapenc LsMcBudgetContact LsMcBudgetContact LsMcBudgetContact LsMcBudgetContact LsMcBudgetContact LsMcBudgetContact LsMcBudgetContact LsMcBudgetContact LsMcBudgetContact ListOfLsMcBudgetContactSalesRep LsMcBudgetContactSalesRep soapenc LsMcBudgetContactSalesRep LsMcBudgetContactSalesRep LsMcBudgetContactSalesRep LsMcBudgetContactSalesRep LsMcBudgetContactSalesRep Contact ListOfLsMcContactExpenseItem <Tag> <Tag> <Tag> <Tag> <Tag> <Tag> <Tag> <Tag> Description 336 Siebel CRM Web Services Reference Version 8.0 ■ GetHealthCareProfessionalProfileInformation Table 565.Primary Web Services for Siebel CRM 8.1 .

Primary Web Services for Siebel CRM 8.1 33 7 . Common Response Message Description Node <LsMcContactExpenseItem> <ComplianceFlag> <Currency> <ExchangeRate> <ExpenseId> <ExpenseItemAmount> <ExpenseItemCurrency> <ExpenseItemId> <ExpenseItemTypeId> <ExpenseItemTypeName> <ProcessStatus> <TransactionState> <ListOfLsMcContactExpenseItemAllocation> <LsMcContactExpenseItemAllocation soapenc> <LsMcContactExpenseItemAllocation> <Currency2> <Description> <ExpenseId> <AllocatedAmount> <LoggedById> <ProcessStatus> <ReportingState> <TransactionState> <ListOfServiceRequest> <ServiceRequest soapenc> <ServiceRequest> <Abstract> <AdditionalInformation> <Area> Parent LsMcContactExpenseItem soapenc LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem ListOfLsMcContactExpenseItemAlloca tion LsMcContactExpenseItemAllocation soapenc LsMcContactExpenseItemAllocation LsMcContactExpenseItemAllocation LsMcContactExpenseItemAllocation LsMcContactExpenseItemAllocation LsMcContactExpenseItemAllocation LsMcContactExpenseItemAllocation LsMcContactExpenseItemAllocation LsMcContactExpenseItemAllocation Contact ListOfServiceRequest ServiceRequest soapenc ServiceRequest ServiceRequest ServiceRequest <Tag> <Tag> <Tag> <Tag> <Tag> <Tag> Description <Tag> Siebel CRM Web Services Reference Version 8.0 ■ GetHealthCareProfessionalProfileInformation Table 565.

Common Response Message Description Node <Comments> <ComplaintDescription> <ComplaintType> <ConfirmationNeeded> <ContactId2> <CreatedByName> <Currency> <CustomerComments> <Decision> <Description2> <EffectiveDate2> <HealthCareComplaintType> <HealthCareSubType> <Outcome> <Owner> <Priority> <ProviderId> <ProviderLastName> <SRNumber> <SROpenDate> <SRRootcause> <SRStatusDate> <SRSubType> <SRType> <SRUrgency> <Severity> <Status> <SubType> <Sub-Area> <ListOfFinAlertContact> Parent ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest ServiceRequest Contact <Tag> Description 338 Siebel CRM Web Services Reference Version 8.1 .0 ■ GetHealthCareProfessionalProfileInformation Table 565.Primary Web Services for Siebel CRM 8.

Common Response Message Description Node <FinAlertContact soapenc> <FinAlertContact> <Category> <ContactId> <Message> <Priority> <StartDate2> Parent ListOfFinAlertContact FinAlertContact soapenc FinAlertContact FinAlertContact FinAlertContact FinAlertContact FinAlertContact Description <Tag> <Tag> GetHealthCareProfessionalProfileInformation Application Interface This topic describes the application objects called by the this Web service. Table 568.1 33 9 . For more information on application implementation. see Table 566. GetHealthCareProfessionalProfileInformation Data Object Siebel Repository Name LSMCProfile External Name Contact Methods For a descripition of methods for this Web service. see Table 568. see Table 567. Table 567. GetHealthCareProfessionalProfileInformation Service Object Name LSMCProfile Boundary Object Type Business Service Class (if BusService) CSSEAIDataSyncService Data Object (Integration Object) For a description of data objects for this Web service. refer to your application development documentation on Oracle Technology Network.Primary Web Services for Siebel CRM 8. GetHealthCareProfessionalProfileInformation Methods Operation LSMCProfileQueryById LSMCProfileQueryByExample Method QueryById QueryByExample Siebel CRM Web Services Reference Version 8. Service Object (Business Service or Workflow) For a description of the service objects for this Web service.0 ■ GetHealthCareProfessionalProfileInformation Table 565. Table 566.

Reads the profile of the Health Care Provider specified by a combination of several attributes. Extract the files in the zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. GetHealthCareProfessionalComplianceDetails Operations Due to the nature of the schema generation for the WSDL file. navigate to the documentation library for Siebel applications on Oracle Technology Network. ... 340 Siebel CRM Web Services Reference Version 8. Extract the files in the zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network..1 .\GetHeathcareProfessionalProfileInformation\Request. GetHealthCareProfessionalComplianceDetails Operations Name LSMCDetailsQueryById LSMCDetailsQueryByExample Description Reads the profile of the Health Care Provider specified by his/her Siebel Contact Row Id.xml Response See the following file to view the sample code: .. see Table 569 Table 569. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.0 ■ GetHeathCareProfessionalComplianceDetails Example Package for GetHeathcareProfessionalProfileInformation To view an example of messages for this Web service. the message formats for each operation have their own message names. For a list of operations associated with this Web service.Primary Web Services for Siebel CRM 8.xml Message Schema (WSDL) for GetHeathcareProfessionalProfileInformation To view the message schema for this Web service.wsdl GetHeathCareProfessionalComplianceD etails Use this Web service to read the detail data of a Health Care Provider including Marketing Compliance information..\GetHeathcareProfessionalProfileInformation\Response.\GetHeathcareProfessionalProfileInformation\GetHeathcareProfessionalProfileInformat ion.. Request See the following file to view the sample code: .

Primary Web Services for Siebel CRM 8. Request Message Description: LSMCDetailsQueryById Node <PrimaryRowId> Description Required. see Table 570.1 34 1 . Represents the Siebel Row Id of the Contact Object. Siebel CRM Web Services Reference Version 8. For a description of this request message. Table 570.0 ■ GetHeathCareProfessionalComplianceDetails Request Message Description: LSMCDetailsQueryById The operations in this Web service work with a common response message format but have a different request message format.

Table 571. see Table 571.0 ■ GetHeathCareProfessionalComplianceDetails Request Message Description: LSMCDetailsQueryByExample For a description of this request message.Primary Web Services for Siebel CRM 8. Request Message Description: LSMCDetailsQueryByExample Node <Contact> <Created> <Updated> <AccountIntegrationId> <CallClass> <ContactId> <CreatedByName> <EmployeeNumber> <FirstName> <LastName> <LeadContactType> <MarketPotential> <MiddleName> <PartyTypeCode> <PartyUId> <PersonUId> <PersonalContact> <PositionStatus> <PrimaryCity> <PrimaryEmployeeLoginOfPrimaryContactPosition> <PrimaryLastCallDate> <PrimaryLicenseExpirationDate> <PrimaryLicenseNumber> <PrimaryLicenseState> <PrimaryLicenseStatus> <PrimaryOrganization> <PrimaryPostalCode> <PrimarySpecialty> <PrimaryState> <PrimaryStateLicenseId> <PrimaryStreetAddress> <PrivacyCode> <Type> <UpdatedByName> <WorkPhone> Description Required. 342 Siebel CRM Web Services Reference Version 8.1 . A combination of attributes to uniquely identify a Contact.

Primary Web Services for Siebel CRM 8. Table 572.0 ■ GetHeathCareProfessionalComplianceDetails Common Response Message Description The column Node represents a respective Siebel field if not specified otherwise.1 34 3 . see Table 572. Common Response Message Description Node <ListOfLSMCDetails><Tag> <Contact soapenc> <Contact> <AccountIntegrationId> <CallClass> <ContactId> <CreatedByName> <EmployeeNumber> <FirstName> <LastName> <LeadContactType> <MarketPotential> <MiddleName> <PartyTypeCode> <PartyUId> <PersonUId> <PersonalContact> <PositionStatus> <PrimaryCity> <PrimaryCountry> <PrimaryEmployeeLoginOfPrimaryContact Position> <PrimaryLastCallDate> <PrimaryLicenseExpirationDate> <PrimaryLicenseNumber> ListOfLSMCDetails Contact soapenc Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Parent Description <Tag> <Tag> <Tag> Siebel CRM Web Services Reference Version 8. For a description of this response message.

Common Response Message Description Node <PrimaryLicenseState> <PrimaryLicenseStatus> <PrimaryOrganization> <PrimaryPostalCode> <PrimarySpecialty> <PrimaryState> <PrimaryStateLicenseId> <PrimaryStreetAddress> <PrivacyCode> <Type> <UpdatedByName> <WorkPhone> <ListOfLsMcBudgetContact> <LsMcBudgetContact soapenc> <LsMcBudgetContact> <BudgetAmount> <BudgetCurrency> <BudgetEndDate> <BudgetId> <BudgetName> <BudgetStartDate> <BudgetState> <ContactId> <ListOfLsMcBudgetContactSalesRep> <LsMcBudgetContactSalesRep soapenc> <LsMcBudgetContactSalesRep> <ContactBudgetId> Parent Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact Contact ListOfLsMcBudgetContact LsMcBudgetContact soapenc LsMcBudgetContact LsMcBudgetContact LsMcBudgetContact LsMcBudgetContact LsMcBudgetContact LsMcBudgetContact LsMcBudgetContact LsMcBudgetContact LsMcBudgetContact ListOfLsMcBudgetContactSalesRep LsMcBudgetContactSalesRep soapenc LsMcBudgetContactSalesRep <Tag> <Tag> <Tag> <Tag> <Tag> <Tag> Description 344 Siebel CRM Web Services Reference Version 8.Primary Web Services for Siebel CRM 8.1 .0 ■ GetHeathCareProfessionalComplianceDetails Table 572.

0 ■ GetHeathCareProfessionalComplianceDetails Table 572. Common Response Message Description Node <Currency2> <SalesRepBudget> <PositionId> <PositionName> <ListOfLsMcContactExpenseItem> <LsMcContactExpenseItem soapenc> <LsMcContactExpenseItem> <ComplianceFlag> <Currency> <ExchangeRate> <ExpenseId> <ExpenseItemAmount> <ExpenseItemCurrency> <ExpenseItemId> <ExpenseItemTypeId> <ExpenseItemTypeName> <ProcessStatus> <TransactionState> <ListOfLsMcContactExpenseItemAllocation> <LsMcContactExpenseItemAllocation soapenc> <LsMcContactExpenseItemAllocation> <Currency2> <Description> <ExpenseId> <AllocatedAmount> Parent LsMcBudgetContactSalesRep LsMcBudgetContactSalesRep LsMcBudgetContactSalesRep LsMcBudgetContactSalesRep Contact ListOfLsMcContactExpenseItem LsMcContactExpenseItem soapenc LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem LsMcContactExpenseItem ListOfLsMcContactExpenseItemAllocation LsMcContactExpenseItemAllocation soapenc LsMcContactExpenseItemAllocation LsMcContactExpenseItemAllocation LsMcContactExpenseItemAllocation LsMcContactExpenseItemAllocation <Tag> <Tag> <Tag> <Tag> <Tag> <Tag> Description Siebel CRM Web Services Reference Version 8.Primary Web Services for Siebel CRM 8.1 34 5 .

see Table 574. see Table 573. Table 574.0 ■ GetHeathCareProfessionalComplianceDetails Table 572.Primary Web Services for Siebel CRM 8. GetHealthCareProfessionalComplianceDetails Methods Operation LSMCDetailsQueryById LSMCDetailsQueryByExample Method QueryById QueryByExample 346 Siebel CRM Web Services Reference Version 8. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. GetHealthCareProfessionalComplianceDetails Data Object Siebel Repository Name LSMCDetails External Name Contact Methods For a description of methods for this Web service. Table 575. see Table 575.1 . For more information on application implementation. refer to your application development documentation on Oracle Technology Network. Table 573. GetHealthCareProfessionalComplianceDetails Service Object Name LSMCDetails Boundary Object Type Business Service Class (if BusService) CSSEAIDataSyncService Data Object (Integration Object) For a description of data objects for this Web service. Common Response Message Description Node <LoggedById> <ProcessStatus> <ReportingState> <TransactionState> Parent LsMcContactExpenseItemAllocation LsMcContactExpenseItemAllocation LsMcContactExpenseItemAllocation LsMcContactExpenseItemAllocation Description GetHealthCareProfessionalComplianceDetails Application Interface This topic describes the application objects called by the this Web service.

Extract the files in the zip file. Request See the following file to view the sample code: . and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.\GetHeathcareProfComplianceDetails\GetHeathcareProfessionalComplianceDetails_respon se. navigate to the documentation library for Siebel applications on Oracle Technology Network.1 34 7 .0 ■ GetUnallocatedExpenseItem Example Package for GetHeathcareProfessionalComplianceDetails To view an example of messages for this Web service.\GetHeathcareProfComplianceDetails\GetHeathcareProfessionalComplianceDetails_reques t. . Table 576. the message formats for each operation have their own message names... For a list of operations associated with this Web service. Extract the files in the zip file.xml Response See the following file to view the sample code: . Siebel CRM Web Services Reference Version 8. see Table 576.wsdl GetUnallocatedExpenseItem Use this Web service to read the data of an expense item record for the purpose of allocating expenses for Marketing Compliance in ePharma.. navigate to the documentation library for Siebel applications on Oracle Technology Network. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.\GetHeathcareProfessionalComplianceDetails\GetHeathcareProfessionalComplianceDetail s. GetUnallocatedExpenseItem Operations Because of the nature of the schema generation for the WSDL file.Primary Web Services for Siebel CRM 8. GetUnallocatedExpenseItem Operations Name LSMCGetUnallocatedExpenseItemQueryById LSMCGetUnallocatedExpenseItemQueryByExample Description Read the data of an expense item specified by its Siebel Row Id.xml Message Schema (WSDL) for GetHeathcareProfessionalComplianceDetails To view the message schema for this Web service.... Read the data of an expense item specified by a combination of several attributes.

Common Response Message Description Node <ListOfLSMCGetUnallocatedExpenseItem xmlns><Tag> <ExpenseItem soapenc .. Table 579. A combination of attributes to uniquely identify an expense Item. For a description of this response message.1 . see Table 578. Table 577. see Table 577.. since it is difficult to uniquely identify the requested expense item. It is recommended to use the operation LSMCGetUnallocatedExpenseItemQueryById and specifying the Siebel Id of the expense item. NOTE: Retrieving the data of an expense item by a combination of attributes using the operation LSMCGetUnallocatedExpenseItemQueryByExample is not recommended.Primary Web Services for Siebel CRM 8. Request Message Description: LSMCGetUnallocatedExpenseItemQueryById Node <PrimaryRowId> Description Required. Request Message Description: LSMCGetUnallocatedExpenseItemQueryByExample For a description of this request message.0 ■ GetUnallocatedExpenseItem Request Message Description: LSMCGetUnallocatedExpenseItemQueryById The operations in this Web service work with a common response message format but have different request message format. see Table 579. Represents the Siebel Row Id of the Expense Item Object. Request Message Description: LSMCGetUnallocatedExpenseItemQueryByExample Node <Contact> <Id> <LSMCAllocationDate> <LSMCAllocationStatusCode> <LSMCComplianceFlag> <LSMCTransactionState> <ExpenseItemType> <Amount> <ExchangeRate> Description Required. Table 578. For a description of this request message.> <ExpenseItem> <Id> <LSMCAllocationDate> Parent N/A ListOfLSMCGetUnallocatedExpenseItem ExpenseItem soapenc ExpenseItem ExpenseItem Description <Tag> <Tag> <Tag> 348 Siebel CRM Web Services Reference Version 8. Common Response Message Description The column Node represents a respective Siebel field if not specified otherwise.

. For more information on application implementation.Primary Web Services for Siebel CRM 8.1 34 9 .> <LSMCBudgetContact> <Id> <BudgetState> <ListOfLSMCEmployeeExpenseItem> <LSMCEmployeeExpenseItem soapenc …> <LSMCEmployeeExpenseItem> <Id> Parent ExpenseItem ExpenseItem ExpenseItem ExpenseItem ExpenseItem ExpenseItem ExpenseItem ListOfLSMCContactExpenseItem LSMCContactExpenseItem soapenc LSMCContactExpenseItem LSMCContactExpenseItem ListOfLSMCBudgetContact LSMCBudgetContact soapenc LSMCBudgetContact LSMCBudgetContact ExpenseItem ListOfLSMCEmployeeExpenseItem LSMCEmployeeExpenseItem soapenc LSMCEmployeeExpenseItem <Tag> <Tag> <Tag> <Tag> <Tag> <Tag> <Tag> <Tag> <Tag> Description GetUnallocatedExpenseItem Application Interface This topic describes the application objects called by the this Web service. GetUnallocatedExpenseItem Service Object Name LSMCGetUnallocatedExpenseItem Boundary Object Type Business Service Class (if BusService) CSSEAIDataSyncService Siebel CRM Web Services Reference Version 8.. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. refer to your application development documentation on Oracle Technology Network. Common Response Message Description Node <LSMCAllocationStatusCode> <LSMCComplianceFlag> <LSMCTransactionState> <ExpenseItemType> <Amount> <ExchangeRate> <ListOfLSMCContactExpenseItem> <LSMCContactExpenseItem soapenc . Table 580.> <LSMCContactExpenseItem> <Id> <ListOfLSMCBudgetContact> <LSMCBudgetContact soapenc .0 ■ GetUnallocatedExpenseItem Table 579. see Table 580...

.Primary Web Services for Siebel CRM 8.0 ■ INSClaims Data Object (Integration Object) For a description of data objects for this Web service.xml Response See the following file to view the sample code: .. see Table 581. Extract the files in the zip file.\GetUnallocatedExpenseItem\GetUnallocatedExpenseItem_request. GetUnallocatedExpenseItem Methods Operation LSMCGetUnallocatedExpenseItemQueryById LSMCGetUnallocatedExpenseItemQueryByExample Method QueryById QueryByExample Example Package for GetUnallocatedExpenseItem To view an example of messages for this Web service.xml Message Schema (WSDL) for GetUnallocatedExpenseItem To view the message schema for this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network. and update claims and claim elements...1 ..wsdl INSClaims Use this Web service to query for. Request See the following file to view the sample code: . GetUnallocatedExpenseItem Data Object Siebel Repository Name LSMCGetUnallocatedExpenseItem External Name LSMCGetUnallocatedExpenseItem Methods For a description of methods for this Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.\GetUnallocatedExpenseItem\GetUnallocatedExpenseItem. Extract the files in the zip file. 350 Siebel CRM Web Services Reference Version 8. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. see Table 582. Table 582. Table 581.\GetUnallocatedExpenseItem\GetUnallocatedExpenseItem_response.. . navigate to the documentation library for Siebel applications on Oracle Technology Network.

Based on integration object FINS Claim Elements. Updates a claim element. Based on integration object INS Claims. Updates the claim record. Request Message Description: ClaimElementInsertOrUpdate For a description of this request message. see Table 584. Table 587. Request Message Description: INSClaimsQueryByExample For a description of this request message. Request Message Description: INSClaimsInsertOrUpdate For a description of this request message. INSClaimsOperations Name INSClaimsQueryByExample INSClaimsInsertOrUpdate ClaimElementQueryByExample ClaimElementInsertOrUpdate Description Retrieves the claim record. Request Message Description: INSClaimsQueryByExample Node SiebelMessage Description Required. Table 585. see Table 586. see Table 585. Request Message Description: INSClaimsInsertOrUpdate Node SiebelMessage Description Required. Table 586. Retrieves a claim element. Table 584. Request Message Description: ClaimElementInsertOrUpdate Node SiebelMessage Description Required. Table 583. see Table 587. Request Message Description: ClaimElementQueryByExample Node SiebelMessage Description Required.Primary Web Services for Siebel CRM 8. see Table 583. Siebel CRM Web Services Reference Version 8.1 35 1 . Based on integration object INS Claims.0 ■ INSClaims INSClaimsOperations For a list of operations associated with this Web service. Based on integration object FINS Claim Elements. Request Message Description: ClaimElementQueryByExample For a description of this request message.

For more information on application implementation. see Table 588.QueryByExample FINS Claim Elemetns. see Table 589. navigate to the documentation library for Siebel applications on Oracle Technology Network. refer to your application development documentation on Oracle Technology Network.QueryByExample INS Claims.InsertOrUpdate Example Package for INSClaims To view an example of messages for this Web service. INSClaims Data Object Siebel Repository Name INS Claims FINS Claim Elements External Name INS Claims FINS Claim Elements Methods For a description of methods for this Web service. Table 588.0 ■ INSClaims Common Response Message Description The response messages for these operations are the same as the request messages. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. INSClaims Application Interface This topic describes the application objects called by the this Web service. Extract the files in the zip file. Table 590. 352 Siebel CRM Web Services Reference Version 8. INSClaims Methods Operation INSClaimsQueryByExample INSClaimsInsertOrUpdate ClaimElementQueryByExample ClaimElementInsertOrUpdate Method INS Claims. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.InsertOrUpdate FINS Claim Elements. INSClaims Service Object Name INS Claims FINS Claim Elements Boundary Object Type Business Service Business Service Class (if BusService) CSSEAIDataSyncService CSSWSOutboundDispatcher Data Object (Integration Object) For a description of data objects for this Web service. Table 589.1 .Primary Web Services for Siebel CRM 8. see Table 590.

xml Request (ClaimElementQueryByExample) See the following file to view the sample code: .1 35 3 ....xml Request (ClaimElementsInsertOrUpdate) See the following file to view the sample code: ....xml Siebel CRM Web Services Reference Version 8.\ClaimElementsInsertOrUpdate\ClaimElementsInsertOrUpdate_request.xml Request (GetPropertyPolicy) See the following file to view the sample code: ..\INSClaims\INSClaim_response.\GetAutoPolicy\GetAutoPolicy_request...\GetPropertyPolicy\GetPropertyPolicy_request.xml Response (INSClaims) See the following file to view the sample code: .xml Response (ClaimElementQueryByExample) See the following file to view the sample code: ....0 ■ INSClaims Request (INSClaims) See the following file to view the sample code: ....\INSClaims\INSClaims_request.xml Request (GetAutoPolicy) See the following file to view the sample code: .Primary Web Services for Siebel CRM 8.\GetAutoPolicy\GetAutoPolicy_response...xml Response (GetAutoPolicy) See the following file to view the sample code: .\ClaimElementQueryByExample\ClaimElementQueryByExample_response.\GetPropertyPolicy\GetPropertyPolicy_response.xml Response (GetPropertyPolicy) See the following file to view the sample code: ..\ClaimElementQueryByExample\ClaimElementQueryByExample_request.

Extract the files in the zip file. IntegrationObjectInfo Operations For a list of operations associated with this Web service.wsdl IntegrationObjectInfo Use this Web service to get all the active fields for a given Integration Object and the Integration component name using the Siebel Object Manager Repository Integration Object. Integration Component name from which fields are retrieved.\INSClaimsInsertOrUpdate\INSClaimsInsertOrUpdate_request. IntegrationObjectInfo Operations Name GetIntegrationObjectInfo Description Retrieves fields from both an integration object and an integration component. Table 591. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Request Message Description: GetIntegrationObjectInfo The request message format includes Integration Object name and component name for which all the active fields have to be retrieved.1 . navigate to the documentation library for Siebel applications on Oracle Technology Network.. see Table 591. …INSClaims\INSClaims..xml Message Schema (WSDL) for INSClaims To view the message schema for this Web service. For a description of this request message.0 ■ IntegrationObjectInfo Request (INSClaimsInsertOrUpdate) See the following file to view the sample code: .Primary Web Services for Siebel CRM 8. Request Message Description: GetIntegrationObjectInfo Node IntegrationObjectName IntegrationCompName Description Integration Object name. see Table 592. Table 592. 354 Siebel CRM Web Services Reference Version 8.

Methods Business Service Operation GetIntegrationObjectInfo Method GetIntegrationObjectInfo Siebel CRM Web Services Reference Version 8. IntegrationObjectInfo Business Service Name Integration ObjectInfo Service Boundary Object Type Business Service Class CSSIntObjectInfoService Data Object (Integration Object) For a description of data objects for this Web service. refer to your application development documentation on Oracle Technology Network. see Table 593.0 ■ IntegrationObjectInfo Response Message Description: GetIntegrationObjectInfo Response Message includes all the repository integration component field names. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. For more information on application implementation. Response Message Description: GetIntegrationObjectInfo Node RepositoryIntegrationObject RepositoryIntegrationComponent ListOfRepositoryIntegrationComponentField Description Integration Object name. Table 594. Integration Component name. Table 595. For a description of this response message.Primary Web Services for Siebel CRM 8. Table 596. see Table 594. List of repository Integration Component field names. Integration Object Business Service Siebel Repository Name Siebel OM: Repository Integration Object External Name Repository Integration Object Methods For a description of methods for this Web service. see Table 596. Table 593. see Table 595.1 35 5 . IntegrationObjectInfo Application Interface This topic describes the application objects called by the this Web service.

return the error messages. as well as related attributes. Return the attribute of a network asset (regardless whether it is network. NetworkOrderEntry Operations Name GetNetworkAssets GetNetworkAssetAttributes GetNetworkAssetAttachments GetOpenNetworkOrders ValidateNetworkOrder QueryProjectedNetworkAsset Description Return the network asset based on the asset Id. Table 597. attached files. If the network is invalid. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.\IntegrationObjectInfo\IntegrationObjectInfo_request. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file..1 ..xml Message Schema (WSDL) for IntegrationObjectInfo To view the message schema for this Web service. use this service to validate a network based on product rules. and open orders. Return the open order line items for a network asset.\IntegrationObjectInfo\IntegrationObjectInfo.wsdl NetworkOrderEntry Use this Web service to access network assets. network node. Request See the following file to view the sample code: . Return the file attachment for a network asset. Extract the files in the zip file.. see Table 597.. Extract the files in the zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network.. 356 Siebel CRM Web Services Reference Version 8. navigate to the documentation library for Siebel applications on Oracle Technology Network. Return the projected asset for a network.0 ■ NetworkOrderEntry Example Package for IntegrationObjectInfo To view an example of messages for this Web service. Additionally.Primary Web Services for Siebel CRM 8. . or network connection). and. return projected assets for a network.\IntegrationObjectInfo\IntegrationObjectInfo_response. Validate a network based on the product rules. NetworkOrderEntry Operations For a list of operations associated with this Web service.xml Response See the following file to view the sample code: ..

Primary Web Services for Siebel CRM 8.0 ■ NetworkOrderEntry

Common Request Message Description The service has six operations. They do not share a common request message format.

Common Response Message Description The service has six operations. They do not share a common response message format.

NetworkOrderEntry Application Interface
This topic describes the application objects called by the this Web service. For more information on application implementation, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 598. Table 598. NetworkOrderEntry Service Object Name VORD NOE Complex Data Service VORD NOE Simple Data Service Boundary Object Type Business Service Business Service Class (if BusService) CSSVORDWebService CSSVORDWebService

Data Object (Integration Object) For a description of data objects for this Web service, see Table 599. Table 599. NetworkOrderEntry Data Object Siebel Repository Name VORD NOE Network Assets VORD NOE Asset Attributes VORD NOE Network Attachments VORD NOE Network Open Order Line Items VORD NOE Network Validation Rule VORD NOE Projected Asset External Name VORD NOE Asset Attributes VORD NOE Asset Attributes VORD Network Asset VORD Network Asset VORD Network Validation Rule VORD NOE Projected Asset Business Service VORD NOE Simple Data Service VORD NOE Simple Data Service VORD NOE Simple Data Service VORD NOE Simple Data Service VORD NOE Complex Data Service VORD NOE Complex Data Service

Siebel CRM Web Services Reference Version 8.1

35 7

Primary Web Services for Siebel CRM 8.0 ■ PartnerPrograms

Methods For a description of methods for this Web service, see Table 600. Table 600. NetworkOrderEntry Methods Operation GetNetworkAssets GetNetworkAssetAttributes GetNetworkAssetAttachments GetOpenNetworkOrders ValidateNetworkOrder QueryProjectedNetworkAsset Business Service VORD NOE Simple Data Service VORD NOE Simple Data Service VORD NOE Simple Data Service VORD NOE Simple Data Service VORD NOE Complex Data Service VORD NOE Complex Data Service Method GetNetworkAssets GetNetworkAssetAttributes GetNetworkAssetAttachments GetOpenNetworkOrders ValidateNetworkOrder QueryProjectedNetworkAsset

Example Package for NetworkOrderEntry
To view an example of messages for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

Request See the following file to view the sample code: ...\NetworkOrderEntry\NetworkOrderEntry_request.xml Response See the following file to view the sample code: ...\NetworkOrderEntry\NetworkOrderEntry_response.xml

Message Schema (WSDL) for NetworkOrderEntry
To view the message schema for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file. ...\NetworkOrderEntry\NetworkOrderEntry.wsdl

PartnerPrograms
To view the message schema for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

358

Siebel CRM Web Services Reference Version 8.1

Primary Web Services for Siebel CRM 8.0 ■ PartnerRegistration

PartnerRegistration
To view the message schema for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

ProductConfigurator
The Web service enables queries on information contained within the product model, such as relationships, attributes, linked items, resources, UI groups. The service also allows you to configure a product, and perform multiple batch requests.

ProductConfigurator Operations
For a list of operations associated with this Web service, see Table 601. Table 601. ProductConfigurator Operations Name GetCfgObjectStructure GetCfgObjectGroupItems GetCfgObjectDefaultGroupItems BeginConfiguration Description Get Product Relationships, Attributes, Linked Items and Resources. Get Product UI Definition, UI Group and Group Items. Get Default Product Group Items (group items will be based off all relationships, attributes, linked items and resources). Enables Customization of products stored in Siebel DB. Initializes the configurator session with a Quote Instance and product model. Executes operations on the Quote instance initialized in BeginConfiguration. Release server resources used during Begin/Update Configuration.

UpdateConfiguration EndConfiguration

Request Message Description: GetCfgObjectStructure GetCfgObjectStructure has the same request and response message. GetCfgObjectGroupItems has the same request and response message. GetCfgObjectDefaultGroupItems request and response message is the same as “GetCfgObjectGroupItems”. The Object’s direct child properties are ignored as well those of UIOption, Responsibilities, and Group. Only the GroupItem child is looked at and returned (others are copied to the Response message). GroupItem behavior is similar to that of GetCfgObjectGroupItems.

Siebel CRM Web Services Reference Version 8.1

35 9

Primary Web Services for Siebel CRM 8.0 ■ ProductConfigurator

For a description of this request message, see Table 602. Table 602. Request Message Description: GetCfgObjectStructure Node WebChannelObjStructure Object Name Id ObjectType ParentClassId DisplayName Description Attribute Name LocalType InternalType OrigId DisplayName Hidden Required ReadOnly ValidationSpec UnitOfMeasure Description AttributeDomain LocalValue InternalValue AttributeDomainDecoration Name Value Description Required. This structure identified the objects that will be queries as well the data that will be returned about the objects. Required. One or more must be specified. Required. Name of Object (product / class). Either Name or Id is required. Required. Id of Object (product / class). Either Name or Id is required. Required. Product OR Class. ClassId of the parent. Display Name. Description. Zero or more (only those child objects that are specified will be queried for). Name of Attribute. If empty, all attributes are returned. Local type. Internal type. Internal Id. Display name. Hidden flag. Required flag. Read only flag. Validation specification. Unit of measure. Description. Zero or more. Local value. Internal value. Zero or more. Attribute domain specific properties name value pairs. Name of object (product / class). Either Name or Id is required. Unique value.

360

Siebel CRM Web Services Reference Version 8.1

Primary Web Services for Siebel CRM 8.0 ■ ProductConfigurator

Table 602. Request Message Description: GetCfgObjectStructure Node AttributeDefaultValue DisplayValue String Number Integer Date Boolean AttributeRejectedValue DisplayValue String Number Integer Date Boolean AttributeDecoration Name Value Relationship Name Description Default value of the attribute. Only one of the valuetypes will be populated depending on the type of the value. Display value. String value. Number value. Integer value. Date value. Boolean value. Rejected value of the attribute. Only one of the valuetypes will be populated depending on the type of the value. Display value. String value. Number value. Integer value. Date value. Boolean value. Zero or more. Attribute properties name value pairs. Name of Object (product / class). Either Name or Id is required. Unique value. Zero or more (only those child objects that are specified will be queried for). Name of relationship. If Name and/or Id is specified, only that particular relationship will be returned. If both are empty, all relationships will be returned. Id of relationship. If Name and/or Id is specified, only that particular relationship will be returned. If both are empty, all relationships will be returned. Display name. Class name. Class Id. Default product Id. Default cardinality. Minimum cardinality.

Id

DisplayName ClassName ClassId DefaultProductId DefaultCardinality MinimumCardinality

Siebel CRM Web Services Reference Version 8.1

36 1

Primary Web Services for Siebel CRM 8.0 ■ ProductConfigurator

Table 602. Request Message Description: GetCfgObjectStructure Node MaximumCardinality RelationshipDomain Name Description Maximum cardinality. Zero or more. Name of product. If Name and/or Id is specified, only that particular relationship domain will be returned. If both are empty, all relationship domain products will be returned. Id of product. If Name and/or Id is specified, only that particular relationship domain will be returned. If both are empty, all relationship domain products will be returned. Display name. Orig Id. Description. Zero or more. Relationship domain specific properties name value pairs. Name of Object (product / class). Either Name or Id is required. Unique value. Zero or more. Relationship properties name value pairs. Name of Object (product / class). Either Name or Id is required. Unique value. Zero or more (only those child objects that are specified will be queried for). Name of Object (product / class). Either Name or Id is required. Id of linked item. If Name and/or Id is specified, only that particular linked item will be returned. If both are empty, all linked items will be returned. Display name. Variable Name. Sort specification. Search specification. Needs execution flag for BC based query. Expression. Default Value. Business Object for BC based query. Business Component for BC based query.

Id

DisplayName OrigId Description RelationshipDomainDecoration Name Value Relationship Decoration Name Value LinkedItem Name Id

DisplayName VariableName SortSpec SearchSpec NeedsExecution Expression DefaultValue BusinessObject BusinessComponent

362

Siebel CRM Web Services Reference Version 8.1

Primary Web Services for Siebel CRM 8.0 ■ ProductConfigurator

Table 602. Request Message Description: GetCfgObjectStructure Node FieldName Active LinkedItemDecoration Name Value Resource Name Description Field name in Business Component. Active flag. Linked Item properties name value pairs. Name of Object (product / class). Either Name or Id is required. Unique value. Zero or more (only those child objects that are specified will be queried for). Name of resource. If Name and/or Id is specified, only that particular resource will be returned. If both are empty, all resources will be returned. Id of resource. If Name and/or Id is specified, only that particular resource will be returned. If both are empty, all resources will be returned. Display name. Resource properties name value pairs. Name of Object (product / class). Either Name or Id is required. Unique value. Object properties name value pairs. Name of Object (product / class). Either Name or Id is required. Unique value.

Id

DisplayName ResourceDecoration Name Value ObjectDecoration Name Value

Request Message Description: GetCfgObjectGroupItems/ GetCfgObjectDefaultGroupItems For a description of this request message, see Table 603. Table 603. Request Message Description:GetCfgObjectGroupItems/GetCfgObjectDefaultGroupItems Node WebChannelObjGroupItems Object Name Id ObjectType ParentClassId Description Required. This structure identified the objects that will be queries as well the data that will be returned about the objects. Required. One or more must be specified. Required. Name of Object (product / class). Either Name or Id is required. Required. Id of Object (product / class). Either Name or Id is required. Required. Product OR Class. ClassId of the parent.

Siebel CRM Web Services Reference Version 8.1

36 3

Primary Web Services for Siebel CRM 8.0 ■ ProductConfigurator

Table 603. Request Message Description:GetCfgObjectGroupItems/GetCfgObjectDefaultGroupItems Node DisplayName Description UIOption Name Description Display Name. Description. Zero or more. Name of UI Option. If Name and/or Id is specified, only that particular UI option will be returned. If both are empty, all UI options will be returned. Id of UI Option. If Name and/or Id is specified, only that particular UI option will be returned. If both are empty, all UI options will be returned. Type. Display Name. Sequence. Base Theme. Product Theme. Zero or more. Name of responsibility. If Name and/or Id is specified, only that particular responsibility will be returned. If both are empty, all responsibilities will be returned. Id of responsibility. If Name and/or Id is specified, only that particular responsibility will be returned. If both are empty, all responsibilities will be returned. Zero or more. Name of Group. If Name and/or Id is specified, only that particular group will be returned. If both are empty, all groups will be returned. Id of Group. If Name and/or Id is specified, only that particular group will be returned. If both are empty, all groups will be returned. Display Name. Sequence. Group Theme. Description. Zero or more.

Id

Type DisplayName Sequence BaseTheme ProductTheme Responsibility Name

Id

Group Name

Id

DisplayName Sequence GroupTheme Description GroupItem

364

Siebel CRM Web Services Reference Version 8.1

Type of Group Item (Relationship / Attribute / LinkedItem / Resource). Request Message Description: BeginConfiguration Node BeginConfiguration_Input Description Required. all group items will be returned. only that particular UI option will be returned. Type Sequence GroupItemTheme Attribute Relationship LinkedItem Resource GroupDecoration Name Value Object Decoration Name Value Request Message Description: BeginConfiguration For a description of this request message. only that particular UI option will be returned. If Id and/or Type is specified. Name of UI Option. Refer to Attribute child object of GetCfgObjectStructure Request Message. all UI options will be returned. Unique value. Unique value. Table 604. Object properties name value pairs. all UI options will be returned. all group items will be returned. Name of UI Option. Request Message Description:GetCfgObjectGroupItems/GetCfgObjectDefaultGroupItems Node Id Description Id of Group Item. Refer to Resource child object of GetCfgObjectStructure Request Message. Refer to Relationship child object of GetCfgObjectStructure Request Message.Primary Web Services for Siebel CRM 8. If both are empty. If Name and/or Id is specified. Group item theme. Siebel CRM Web Services Reference Version 8. If both are empty. see Table 604.0 ■ ProductConfigurator Table 603. only that particular group item will be returned. If both are empty. If Id and/or Type is specified. Sequence. If Name and/or Id is specified. Group properties name value pairs. Refer to LinkedItem child object of GetCfgObjectStructure Request Message. If both are empty. only that particular group item will be returned.1 36 5 .

0 ■ ProductConfigurator Table 604. Product Id for the root line item. This will load the hierarchy object from the db and create new line item for a product with its default instance. HeaderId and ProductId are required. IntegrationObjectName is needed to determine which table to query and what the structure of the hierarchy is. See General C/OM Web services for details on its structure. ListOfData ProductData Item IntegrationId Integration Id of the line item. Required for InitInstanceOperation of DEFAULT / ADD. HeaderId and RootId are required. IntegrationObjectName is needed to determine which table to query and what the structure of the hierarchy is. If IntegrationId specified. the root line item is looked at. This will add a new line item to the hierarchy object from the ListOfQuote parameter (PDS Quote integration object). ProductId is optional. LOAD This will load the hierarchy object from the db. DEFAULT SET ADD HeaderId RootId ProductId ListOfQuote Required for InitInstanceOperation of LOAD / DEFAULT. RootId is required to determine the root line item to use in this session. If ProductId is also specified.Primary Web Services for Siebel CRM 8. Hierarchy object in PDS Quote integration object format. only this line item and its sub line items are looked at. This will load the hierarchy object from the ListOfQuote parameter (PDS Quote integration object). Request Message Description: BeginConfiguration Node InitInstanceOperation Description Required. Row Id for the root line item. Required for InitInstanceOperation of LOAD / SET. it should match IntegrationId. 366 Siebel CRM Web Services Reference Version 8. List of products / attributes / relationships on which user requires domain information (with exclusions) in CfgInteractData integration object format. Required for InitInstanceOperation of SET / ADD. ProductId is required. The operation type for BeginConfiguration session. If IntegrationId & ProductId are not specified.1 . Row Id of the Header.

Name Quantity RelationshipName RootIntegrationId PortId ParentProductId ParentIntegrationId CanDrilldown ListPrice HasGenericsFlag EligibilityStatus EligibilityReason Explanation ExplanationText Relationship Name Id DomainItem Name Id Excluded Attribute Name Zero or more. RelationshipName can be specified to limit the search to a particular Relationship. Name of relationship to query for. Integration Id of the Root line item. Used to indicate whether the line item is incomplete. If ProductId is also specified. Name of domain item. it should match IntegrationId. Eligibility Status. Parent Integration Id. Quantity. Excluded Flag indicates the whether this domain item is excluded by a Constraint. Domain Items of the relationship. Used to indicate whether the line item is a Customizable product. Relationship Id. List of Relationships on which information is required. Id of domain item. List Price. only this line item and its sub line items are looked at. Eligibility & Compatibility rule or Promotion. Always returned whether specified in Request or not. Name of attribute to query for. Relationship Name. If IntegrationId specified. ProductId is optional. Zero or more. If IntegrationId & ProductId are not specified. Always returned whether specified in Request or not. all relationships are returned. Zero or more. all attributes are returned. Parent Product Id.0 ■ ProductConfigurator Table 604. Request Message Description: BeginConfiguration Node ProductId Description Product Id of the line item. Siebel CRM Web Services Reference Version 8. If empty. If empty. the root line item is looked at. Eligibility Reason.1 36 7 .Primary Web Services for Siebel CRM 8. Id. Can Drilldown Flag. List of Attributes on which information is required. Has Generics Flag. Name of the product. For sub line items.

Value displayed as integer Value displayed as number Value displayed in Boolean format. Error code if error occurred. Eligibility & Compatibility rule or Promotion. Same recursive structure as that defined in this topic. GetCfgObjectGroupItems and GetCfgObjectDefaultGroupItems have the same request and response messages. see Table 605. List of Attribute values. 368 Siebel CRM Web Services Reference Version 8. Error message if error occurred.0 ■ ProductConfigurator Table 604. For a description of this response message. Selected Flag indicates whether this value is selected. Integration Id of new root item. See request message description for details. Root Id of new item. Linked items. List of linked items.1 . Always returned whether specified in Request or not. Response Message Description: Begin Configuration GetCfgObjectStructure has the same request and response message. See the preceding table for details. Name of linked item. Zero or more. Display Value. Response Message Description: Begin Configuration Node BeginConfiguration_Output Error_spcCode Error_spcMessage RootId RootIntegrationId Description Required. Excluded Flag indicates whether this value is excluded by a Constraint. Request Message Description: BeginConfiguration Node ValueType AttributeValue DisplayValue StringValue IntegerValue NumberValue BooleanValue DateTimeValue Selected Excluded Item ListOfLinkedItems LinkedItems LinkedItemValue Name ValueType Description Type of Attribute. Always returned whether specified in Request or not. Date and time value. Zero or more. Value displayed in a string. Table 605. Type of Value. One or more.Primary Web Services for Siebel CRM 8.

then there were conflicts (messages are present in ListOfMessage) that could not be resolved and further requests to this session will not be honored. Siebel CRM Web Services Reference Version 8. Promotion. If set to Undo.1 36 9 . Details on the error if any. all conflicts are auto resolved.Primary Web Services for Siebel CRM 8. This indicates whether the request was successful or not and contains messages to be displayed. then there were some conflicts (messages are present in ListOfMessage) that were automically resolved. and so on).0 ■ ProductConfigurator Table 605. Proceed Actions. Source of the messages (Eligibility. verify instance is called. Table 606. If set Y. See the Request Message for more details. List of messages. If set Y. any conflict will result in an Undo of the entire batch. Message text. Success / Warning / Error. If StatusCode is 'Success'. This indicates whether a Procced or Undo was done on the conflicts and also whether there were any other violations that resulted in an Undo (like Promotion or Cardinality). Zero or one. Required. ListOfStatus Status StatusCode StatusText ConflictResolution Messages MessageType MessageSource Message Request Message Description: UpdateConfiguration For a description of this request message. If it is 'Warning'. Instance is saved to db. see Table 606. The domain information about products / attributes / relationships as well current selections for the attributes / relationships that was requested in the Request Message. If set Y. Response Message Description: Begin Configuration Node ListOfQuote ListOfData Description Quote instance if ReturnFullInstance input parameter was set to Y. then everything was ok. If set Y. See BeginConfiguration Request Message for details. If it is 'Error'. Request Message Description: UpdateConfiguration Node UpdateConfiguration_Input ConflictAutoResolve FinishInstanceInFlag SaveInstanceInFlag RepriceInstanceInFlag VerifyInstanceInFlag Description Required. Cardinality. Zero or more. reprice is called. FinishIt is called. Proceed or Undo. Proceed / Undo. If set to Proceed.

Zero or more SetAttribute request details. Name or attribute. New display value of attribute. Response Message Description: UpdateConfiguration Node UpdateConfiguration_Output Error_spcCode Error_spcMessage FinishConfigurationOutFlag Description Required. ReplaceItem.0 ■ ProductConfigurator Table 606. Zero or more. Zero or more requests. Type of request (AddItem. Value displayed in a string. RemoveItem.1 . integer or number. see Table 607. ReplaceItem. Quantity. Value type: string. Value displayed as number. SetItemQuantitty. Value displayed in Boolean format.Primary Web Services for Siebel CRM 8. Relationship Id which contains the new product for AddItem. 370 Siebel CRM Web Services Reference Version 8. Indicates whether Finish Configuration was performed. Error Code if error occurred. List of Requests that will be executed on the product instance. Request Message Description: UpdateConfiguration Node ListOfData ListOfRequest Requests Request Type Item AddProductId Quantity RelationshipId IntegrationId Attribute Name ValueType AttributeValue DisplayValue String Number Integer Date Boolean Zero or more. Value displayed as integer. It might not be performed if there were some errors. Add product Id for AddItem. Description Same as ListOfData in BeginConfiguration Request Message. Table 607. Response Message Description: UpdateConfiguration For a description of this response message. SetAttribute. Y / N. Date and time value. ReplaceItem). Error Message if error occurred. Integration Id on which the operation will be performed.

Response Message Description: EndConfiguration Node EndConfiguration_Output Error_spcCode Error_spcMessage ListOfQuote Description Required. ProductConfigurator Application Interface This topic describes the application objects called by the this Web service. Siebel CRM Web Services Reference Version 8. See BeginConfiguration Request Message for details. Indicates whether Verify was done. Error Code if error occurred. It might not be performed if there were some conflicts. Indicates whether Reprice was done. Y / N. see Table 608. Table 609. Error Message if error occurred. Quote instance. For more information on application implementation. Request Message Description: EndConfiguration Node EndConfiguration_Input SaveInstanceFlag Description Required Save Instance flag Response Message Description: EndConfiguration For a description of this response message. Y / N. Response Message Description: UpdateConfiguration Node RepriceOutFlag SaveInstanceOutFlag VerifyOutFlag ListOfData Description Y / N. The domain information about products / attributes / relationships as well current selections for the attributes / relationships that was requested in the Request Message. Table 608. refer to your application development documentation on Oracle Technology Network. It might not be performed if there were some errors.Primary Web Services for Siebel CRM 8. ListOfStatus Request Message Description: EndConfiguration For a description of this request message. See BeginConfiguration Response Message. Indicates whether Save Instance was done.1 37 1 . See the Request Message for more details. see Table 609. It might not be performed if there were some errors.0 ■ ProductConfigurator Table 607. This indicates whether the request was successful or not and contains messages to be displayed.

Table 611. navigate to the documentation library for Siebel applications on Oracle Technology Network. Extract the files in the zip file. ProductConfigurator Methods Operation GetCfgObjectStructure GetCfgObjectGroupItems GetCfgObjectDefaultGroupItems Method GetObjStructure GetObjGroupItems GetObjDefaultGroupItems Example Package for ProductConfigurator To view an example of messages for this Web service. see Table 610. ProductConfigurator Service Object Name Cfg Object Broker ConfiguratorWebChannelBeginConfig ConfiguratorWebChannelUpdateConfig ConfiguratorWebChannelEndConfig Boundary Object Type Business Service Workflow Workflow Workflow Class (if BusService) CSSCfgObjBrokerService Not applicable Not applicable Not applicable Data Object (Integration Object) For a description of data objects for this Web service. see Table 612. ProductConfigurator Data Object Siebel Repository Name CfgInteractData CfgInteractRequest CfgInteractStatus CfgLinkedItems PDS Quote External Name ListOfData ListOfRequest ListOfStatus ListOfLinkedItems ListOfQuote Methods For a description of methods for this Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Table 612.Primary Web Services for Siebel CRM 8. see Table 611. Table 610.0 ■ ProductConfigurator Service Object (Business Service or Workflow) For a description of the service objects for this Web service.1 . Request (GetObjDefaultGroupItems) See the following file to view the sample code: 372 Siebel CRM Web Services Reference Version 8.

. Extract the files in the zip file.\ProductConfigurator\GetObjStructure_response.\ProductConfigurator\GetObjGroupItems_request.1 37 3 ....\ProductConfigurator\ProductConfigurator. .\ProductConfigurator\GetObjDefaultGroupItems_request.Primary Web Services for Siebel CRM 8. navigate to the documentation library for Siebel applications on Oracle Technology Network.\ProductConfigurator\GetObjDefaultGroupItems_response.xml Message Schema (WSDL) for ProductConfigurator To view the message schema for this Web service..\ProductConfigurator\GetObjGroupItems_response.xml Request (GetObjGroupItems) See the following file to view the sample code: ... Siebel CRM Web Services Reference Version 8.xml Response (GetObjGroupItems) See the following file to view the sample code: .xml Request (GetObjStructure) See the following file to view the sample code: ....\ProductConfigurator\GetObjStructure_request. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.xml Response (GetObjStructure) See the following file to view the sample code: .... based on the input Quote line items.xml Response (GetObjDefaultGroupItems) See the following file to view the sample code: .wsdl ProductRecommendation Use this Web service to generate the Recommended Products..0 ■ ProductRecommendation .

Table 613. Table 614. Recommended Products Used Fields For a description of recommended products used fields. Table 615. Request Message Description: GetRecommendedProductsForQuote Node QuoteIO PSP Mode Description Required. This parameter will be parsed as the Mode used in the Variable Map.1 . This is a required input. see Table 614. The default is External PDS Quote. Recommended Products Used Fields PDS Quote (Quote) Mapping XML Name AccountId AccountType ShippingCity ShippingCountry ShippingPostalCode PriceListId ShippingState Variable Name (Map to Internal Variable Map) Account Id Account Type City Country Postal Code Price List Id State How It Is Used Account (used in the Eligibility Check). Table 616. see Table 615. An instance of the Integration Object PDS Quote. Account Type (used in the Eligibility Check City (used in the Eligibility Check) Country (used in the Eligibility Check) Postal Code (used in the Eligibility Check) Price List (used in the Eligibility Check and pricing) State (used in the Eligibility Check) For a description of PDS Quote XML Name. see Table 616. see Table 613. PDS Quote XML Name PDS Quote (Quote Line Item) XML Name ProductId Variable Name Product Id How It Is Used Product (used as a key to find the recommended products) 374 Siebel CRM Web Services Reference Version 8.0 ■ ProductRecommendation ProductRecommendation Operations For a list of operations associated with this Web service. ProductRecommendation Operations Name GetRecommendedProductsForQuote Description Generate Recommended Products Request Message Description: GetRecommendedProductsForQuote For a description of this request message.Primary Web Services for Siebel CRM 8.

ProductRecommendation Application Interface This topic describes the application objects called by the this Web service. refer to your application development documentation on Oracle Technology Network. see Table 617.. Table 619. Response Message Description: GetRecommendedProductsForQuote Node RecommendedProductIO Description An instance of the integration object Recommended Products.Primary Web Services for Siebel CRM 8. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. and recommended reason and score. see Table 618. Extract the files in the zip file.\ProductRecommendation\ProductRecommendation_request.. ProductRecommendation Data Objects Siebel Repository Name Recommended Products PDS Quote External Name Recommended Products PDS Simplified Quote Example Package for ProductRecommendation To view an example of messages for this Web service. pricing. For more information on application implementation.0 ■ ProductRecommendation Response Message Description: GetRecommendedProductsForQuote For a description of this response message. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Table 617. navigate to the documentation library for Siebel applications on Oracle Technology Network.1 37 5 . It contains the product information. see Table 619. Request See the following file to view the sample code: . eligibility.xml Siebel CRM Web Services Reference Version 8. ProductRecommendation Service Object Name Web Channel Product Recommendation Driver Workflow Boundary Object Type Workflow Class (If BusService) Not applicable Data Object (Integration Object) For a description of data objects for this Web service. Table 618.

Required.xml Message Schema (WSDL) for ProductRecommendation To view the message schema for this Web service. Required.. PromotionWebService Operations Name ISS_spcPromotion_spcWS_spc-_spcGetProductPromotionDetails Request: spcGetProductPromotionDetails_GetProductPromotionDefinition_Input Response:spcGetProductPromotionDetails_GetProductPromotionDefinition_Output ISS_spcPromotion_spcWS_spc-_spcApplyProductPromotion Request: spcApplyProductPromotion_ApplyProductPromotion_Input Response: spcApplyProductPromotion_ApplyProductPromotion_Output Description Get Promotion Details information Apply Product Promotion Request Message Description: GetProductPromotionDefinition For a description of this request message.\ProductRecommendation\ProductRecommendation_response.1 . Required. Request Message Description: GetProductPromotionDefinition Node EligibilityMode PricingMode LoadAllDomainFlag LoadDefaultDomainFlag LoadPromDefFlag ContextMode Description Optional. default value as 'Y'. Table 620.wsdl PromotionWebService Use this Web service to get product promotion information. navigate to the documentation library for Siebel applications on Oracle Technology Network. see Table 620. .. Y/N.Primary Web Services for Siebel CRM 8. Required.0 ■ PromotionWebService Response See the following file to view the sample code: . Y/N.. Y/N.\ProductRecommendation\ProductRecommendation. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.. apply product promotion. see Table 621. 2. 376 Siebel CRM Web Services Reference Version 8. Could be 0. default value as '2'. Table 621. PromotionWebService Operations For a list of operations associated with this Web service. Optional. Y/N. 1. 'Siebel Context' or 'External Context'. Extract the files in the zip file.

Error Code if error occurred. in SiebelMessage format of IO 'PDS Quote'. Optional. 2. Could be 0. default value as 'Y'. Err_spcCode Err_spcMessage Request Message Description: ApplyProductPromotion For a description of this request message. In SiebelMessage format of IO 'PDS Product Interface'. 'Product' or 'Pricing'. Y/N. Optional.0 ■ PromotionWebService Table 621. Required. 1. Description Required. Required. Request Message Description: ApplyProductPromotion Node EligibilityMode PricingMode ProdPromId ProdPromInstanceId Description Optional. depending on usage scenarios. depending on usage scenarios. default value as '2'. Response Message Description: GetProductPromotionDefinition For a description of this response message. Request Message Description: GetProductPromotionDefinition Node Context ProdPromRuleType ProdPromId ProdPromRuleId ApplyProductPromotion EligibilityMode PricingMode ProdPromId ProdPromInstanceId LineItemId SiebelMessage Optional. depending on usage scenarios. Response Message Description: GetProductPromotionDefinition Node ProdPromDefinition PromDomainProduct Description In SiebelMessage format of IO 'ISS Promotion Definition for WS'. Optional. depending on usage scenarios. Optional. default value as 'Y'. in SiebelMessage format of IO 'PDS Catalog Context'. Optional. default value as '2'. Could be either default domain product details or all domain product details depending on input arguments. Error Message if error occurred. Optional. Siebel CRM Web Services Reference Version 8. Optional. 2. Optional. Required. see Table 622.Primary Web Services for Siebel CRM 8. Table 622. Could be 0. depending on usage scenarios.1 37 7 . see Table 623. Table 623. 1. Y/N.

depending on usage scenarios. Table 624. Table 626. Request Message Description: ApplyProductPromotion Node LineItemId SiebelMessage Description Optional.0 ■ PromotionWebService Table 623.GetProductPromotionDetails ISS Promotion WS . Response Message Description: ApplyProductPromotion For a description of this response message.ApplyProductPromotion ISS Promotion WS . see Table 625. Response Message Description: ApplyProductPromotion Node SiebelMessage Err_spcCode Err_spcMessage Description Required. see Table 626. Table 625. Error Code if error occurred. in SiebelMessage format of IO 'PDS Quote'.Primary Web Services for Siebel CRM 8. PromotionWebService Application Objects This topic describes the application objects called by this Web service. Required.1 . see Table 624. refer to application development documentation. For more information on application implementation. PromotionWebService Data Object Siebel Repository Name ISS Promotion Definition for WS PDS Catalog Context PDS Product Interface PDS Quote External Name ISS Promotion Definition for WS PDS Catalog Context PDS Product Interface PDS Quote 378 Siebel CRM Web Services Reference Version 8.Add Missed Items Sub Process Boundary Object Type Workflow Workflow Workflow Class Not applicable Not applicable Not applicable Data Object (Integration Object) For a description of data objects for this Web service. PromotionWebService Service Object Name ISS Promotion WS . Service Object (Business Service or Workflow) For a description of the service objects for this Web service. in SiebelMessage format of IO 'PDS Quote'. Error Message if error occurred.

.. navigate to the documentation library for Siebel applications on Oracle Technology Network. QuoteWebService and OrderWebService Operations Name Update Order Update Order Item Update Quote Update Quote Item Delete Order Delete Order Item Delete Quote Delete Quote Item Insert Order Insert Order Item Insert Quote Insert Quote Item Description Updates the order header information. Updates the line items for a specific quote. Deletes a given quote. see Table 627. Table 627. Inserts a quote. navigate to the documentation library for Siebel applications on Oracle Technology Network. QuoteWebService and OrderWebService Operations For a list of operations associated with this Web service. Adds the line items on a given quote.. Deletes a given order. Siebel CRM Web Services Reference Version 8.\PromotionWebService\PromotionWebService. Adds the line items on a given order.\PromotionWebService\PromotionWebService_request.0 ■ QuoteWebService and OrderWebService Example Package for PromotionWebService To view an example of messages for this Web service. Deletes the line items on a specific quote.. Deletes the line items on a specific order. Inserts an order.Primary Web Services for Siebel CRM 8. Updates the line items for a specific order. Extract the files in the zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.xml Message Schema (WSDL) for PromotionWebService To view the message schema for this Web service. Extract the files in the zip file.wsdl QuoteWebService and OrderWebService Use this set of Web services to manipulate the Quote or Order data. Request See the following file to view the sample code: . Updates the quote header information. .1 37 9 . and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.

Queries an order. Delete Quote Item QueryByExample/UpdateQuoteItem/InsertQuoteItem/DeleteQuoteItem Response Message Node QuoteItemIO Description Required. Request Message Description: Query. Table 630. Response Message Description: Query. An instance of the Integration Object PDS Quote Item. Table 631. Request Message Description: Query. Delete Quote Item For a description of this response message. Update.Primary Web Services for Siebel CRM 8. Delete Quote Item QueryByExample/UpdateQuoteItem/InsertQuoteItem/DeleteQuoteItem Request Message Node QuoteItemIO Description Required. Delete. see Table 631. Update. Delete Quote QueryByExample/QueryById/InsertQuote/DeleteQuote Request Message Node QuoteIO Description Required. Update. Response Message Description: Query. Quote For a description of this response message.1 .0 ■ QuoteWebService and OrderWebService Table 627. Table 629. Quote QueryByExample/QueryById/InsertQuote/DeleteQuote Response Message Node QuoteIO Description Required. Request Message Description: Query. An instance of the Integration Object PDS Quote. see Table 628. Response Message Description: Query. Delete Quote Item For a description of this request message. Request Message Description: Query. see Table 630. Table 628. see Table 629. Update. Delete. An instance of the Integration Object PDS Quote Item. 380 Siebel CRM Web Services Reference Version 8. Update. Response Message Description: Query. QuoteWebService and OrderWebService Operations Name Get Quote Get Order Description Queries the quote. Update. Update. Update. Delete Quote For a description of this request message. An instance of the Integration Object PDS Quote.

see Table 634. Response Message Description: Query. Table 633. Delete Order QueryByExample/QueryById/InsertOrder/DeleteOrder Response Message Node OrderIO Description Required. Table 635. see Table 632. Delete Order For a description of this response message. Table 634. Update. Response Message Description: Query. Delete Order Item For a description of this response message. QuoteWebService and OrderWebService Application Interface This topic describes the application objects called by the this Web service. refer to your application development documentation on Oracle Technology Network. Update. An instance of the Integration Object PDS Order.0 ■ QuoteWebService and OrderWebService Request Message Description: Query. Update. Request Message Description: Query. Request Message Description: Query. An instance of the Integration Object PDS Order Item. Update. Delete Order QueryByExample/QueryById/InsertOrder/DeleteOrder Request Message Node OrderIO Description Required. see Table 635. Table 632. Delete Order For a description of this request message. Update. An instance of the Integration Object PDS Order. Update. Siebel CRM Web Services Reference Version 8.1 38 1 . Update. Response Message Description: Query. Delete Order Item QueryByExample/UpdateOrderItem/InsertOrderItem/DeleteOrderItem Request Message Node OrderItemIO Description Required. see Table 633. Delete Order Item For a description of this request message. Delete Order Item QueryByExample/UpdateOrderItem/InsertOrderItem/DeleteOrderItem Response Message Node OrderItemIO Description Required.Primary Web Services for Siebel CRM 8. Response Message Description: Query. For more information on application implementation. An instance of the Integration Object PDS Order Item. Update. Request Message Description: Query.

Primary Web Services for Siebel CRM 8. Extract the files in the zip file. Table 637.. Table 636. navigate to the documentation library for Siebel applications on Oracle Technology Network. QuoteWebService and OrderWebService Data Objects Siebel Repository Name PDS Quote PDS Quote Item PDS Order PDS Order Item External Name PDS Simplified Quote PDS Simplified Quote PDS Simplified Order PDS Simplified Order Example Package for QuoteWebService To view an example of messages for this Web service.xml Response See the following file to view the sample code: . navigate to the documentation library for Siebel applications on Oracle Technology Network.. Extract the files in the zip file. QuoteWebService and OrderWebService Service Objects Name PDS Quote PDS Quote Item PDS Order PDS Order Item Boundary Object Type BusService BusService BusService BusService Class (if BusService) CSSEAIDataSyncService CSSEAIDataSyncService CSSEAIDataSyncService CSSEAIDataSyncService Data Object (Integration Object) For a description of data objects for this Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.1 . 382 Siebel CRM Web Services Reference Version 8.xml Message Schema (WSDL) for QuoteWebService To view the message schema for this Web service.. see Table 637.. Request See the following file to view the sample code: .0 ■ QuoteWebService and OrderWebService Service Object (Business Service or Workflow) For a description of the service objects for this Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.\Quote_and_Order\QuoteWebService_request. see Table 636.\Quote_and_Order\QuoteWebService_response.

This instance will include the product IDs that will be added. Turns on (Y) or off (N) Eligibility Check.\Quote_and_Order\QuoteWebService. Turns on (Y) or off (N) Pricing. An instance of Integration Object PDS Quote. Table 640.. An instance of Integration Object Added Products. Quantity of the product. Y or N. Required. Request Message Description: QuoteAdd Items For a description of this request message. Request Message Description: QuoteAdd Items Node Instance GetProductDataRequest Description Required. based on the Integration Object PDS Quote. Required field for each item. Quantity GetPricing CheckEligibility Response Message Description: QuoteAddItems For a description of this response message. ProductId Item.wsdl QuoteAddItemsWS Use this Web service to add the default instance (products) to the Quote Object. see Table 639.Primary Web Services for Siebel CRM 8. Not a required field. Y or N. The namespace is http://siebel. Item. Response Message Description: QuoteAddItems Node Instance Description Same as the input argument Instance (see the previous table). The updated instance will contain the new added products.. see Table 638. QuoteAddItemsWS Operations For a list of operations associated with this Web service. Siebel CRM Web Services Reference Version 8.com/OrderManagement/Quote/ ProductData. The product that will be added to the Instance. Table 638. The default value is 1. Table 639. QuoteAddItemsWS Operations Name QuoteAddItems Description Add quote line items. This is a required input. see Table 640.0 ■ QuoteAddItemsWS . This is a required input.1 38 3 .

refer to your application development documentation on Oracle Technology Network. Request See the following file to view the sample code: . navigate to the documentation library for Siebel applications on Oracle Technology Network. .Primary Web Services for Siebel CRM 8.\QuoteAddItemsWS\QuoteAddItemsWS_request. Extract the files in the zip file. navigate to the documentation library for Siebel applications on Oracle Technology Network. QuoteAddItems Data Objects Siebel Repository Name Added Products PDS Quote External Name None (XML) PDS Simplified Quote Example Package for QuoteAddItems To view an example of messages for this Web service.1 .. see Table 642.\QuoteAddItemsWS\http_siebel.com_OrderManagement_Quote_QuoteAddItemsWS. For more information on application implementation.xml Message Schema (WSDL) for QuoteAddItems To view the message schema for this Web service. Table 641.xml Response See the following file to view the sample code: .0 ■ QuoteAddItemsWS QuoteAddItems Application Interface This topic describes the application objects called by the this Web service.. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file..\QuoteAddItemsWS\QuoteAddItemsWS_response. Extract the files in the zip file.. QuoteAddItems Service Object Name Web Channel Quote Add Default Items Boundary Object Type Workflow Class (if BusService) Not applicable Data Object (Integration Object) For a description of data objects for this Web service. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Table 642.. see Table 641. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.wsdl 384 Siebel CRM Web Services Reference Version 8..

. see Table 643. all the operations for this service are grouped together.1 38 5 .wsdl ServiceRequest Use this Web service to create. Table 643.\SerializationService\SerializationService. The request message consists of fields from the Service Request business component. and delete service requests.. the message formats for each operation have their own message names. because of the nature of the schema generation for the WSDL file. For a list of operations associated with this Web service. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file..0 ■ SerializationService SerializationService To view the message schema for this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network.Primary Web Services for Siebel CRM 8. Siebel CRM Web Services Reference Version 8. ServiceRequest Operations Note that all operations for this service share a common data format. Extract the files in the zip file. Because of this similarity. ServiceRequest Operations Name Service_spcRequest_ServiceRequestInsert Request: Service_spcRequest_ServiceRequestInsert_Input Response: Service_spcRequest_ServiceRequestInsert_Output Service_spcRequest_ServiceRequestQueryPage Request: Service_spcRequest_ServiceRequestQueryPage_Input Response: Service_spcRequest_ServiceRequestQueryPage_Output Service_spcRequest_ServiceRequestUpdate Request: Service_spcRequest_ServiceRequestUpdate_Input Response: Service_spcRequest_ServiceRequestUpdate_Output Service_spcRequest_ServiceRequestDelete Request: Service_spcRequest_ServiceRequestDelete_Input Response: Service_spcRequest_ServiceRequestDelete_Output Delete service request Update service request Read service request Description Creates a service request Common Request Message Description All operations in this Web service work with a common request message format and a common response message format. However. update. read.

ServiceRequest Application Interface This topic describes the application objects called by the this Web service.1 .Primary Web Services for Siebel CRM 8. navigate to the documentation library for Siebel applications on Oracle Technology Network. ServiceRequest Service Object Name Service Request Boundary Object Type Business Service Class CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service. see Table 645. ServiceRequest Methods Operation Service_spcRequest_ServiceRequestInsert Service_spcRequest_ServiceRequestQueryPage Service_spcRequest_ServiceRequestUpdate Service_spcRequest_ServiceRequestDelete Method [BS:Service Request]. For more information on application implementation. Extract the files in the zip file.[Update] [BS:Service Request]. refer to your application development documentation on Oracle Technology Network. see Table 646. 386 Siebel CRM Web Services Reference Version 8.0 ■ ServiceRequest Common Response Message Description Same as Request Message format. Table 645. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Table 644.[QueryPage] [BS:Service Request]. Table 646.[Insert] [BS:Service Request].[Delete] Example Package for ServiceRequest To view an example of messages for this Web service. ServiceRequest Data Object Siebel Repository Name Service Request External Name Service Request Methods For a description of methods for this Web service. see Table 644. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.

\SessionAccessWS\SessionAccessWS.wsdl SetAllocatedExpenseItem Use this Web service to set the allocation data for a specific expense item record. Siebel CRM Web Services Reference Version 8.\ServiceRequest\ServiceRequest_response... SetAllocatedExpenseItem Operations Because of the nature of the schema generation for the WSDL file.xml Message Schema (WSDL) for ServiceRequest To view the message schema for this Web service. For a list of operations associated with this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network.Primary Web Services for Siebel CRM 8. Extract the files in the zip file. the message formats for each operation have their own message names. Extract the files in the zip file. Table 647.. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.xml Response See the following file to view the sample code: . This functionality is specific for allocating expenses for Marketing Compliance in ePharma.. SetAllocatedExpenseItem Operations Name LSMCSetAllocatedExpenseItemSynchronize Description Set the allocation data for an expense item.1 38 7 .. see Table 647. .\ServiceRequest\ServiceRequest.\ServiceRequest\ServiceRequest_request..wsdl SessionAccessWS To view the message schema for this Web service.. navigate to the documentation library for Siebel applications on Oracle Technology Network.0 ■ SessionAccessWS Request See the following file to view the sample code: . and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. ..

..Primary Web Services for Siebel CRM 8. Request Message Description: LSMCSetAllocatedExpenseItemSynchronize Node <ListOfLSMCSetAllocatedExpenseItem> <ExpenseItem . ExpenseItem ExpenseItem ExpenseItem ExpenseItem ExpenseItem ListOfLSMCContactExpenseItem LSMCContactExpenseItem … LSMCContactExpenseItem LSMCContactExpenseItem ListOfLSMCContactExpenseItemAlloca tion LSMCContactExpenseItemAllocation … LSMCContactExpenseItemAllocation LSMCContactExpenseItemAllocation LSMCContactExpenseItemAllocation LSMCContactExpenseItemAllocation Optional Optional Optional <Tag> <Tag> <Tag> Required <Tag> <Tag> <Tag> Required Required Optional Required Parent Node Description <Tag> <Tag> <Tag> Response Message Description See the example package file for SetAllocatedExpenseItem in the WebServices ZIP download in the Siebel Bookshelf documentation library on Oracle Technology Network. SetAllocatedExpenseItem Application Interface This topic describes the application objects called by the this Web service.0 ■ SetAllocatedExpenseItem Request Message Description: LSMCSetAllocatedExpenseItemSynchronize The Node column represents a respective Siebel field if not specified otherwise..1 .> <LSMCContactExpenseItem> <Id> <ListOfLSMCContactExpenseItemAllocation> <LSMCContactExpenseItemAllocation . refer to your application development documentation on Oracle Technology Network.. 388 Siebel CRM Web Services Reference Version 8.... For more information on application implementation.> <ExpenseItem> <Id> <LSMCAllocationDate> <LSMCAllocationStatusCode> <LSMCComplianceFlag> <ListOfLSMCContactExpenseItem> <LSMCContactExpenseItem . For a description of this request message. Table 648.. see Table 648.> <LSMCContactExpenseItemAllocation> <ExpenseItemContactId> <ReportingState> <Description> <AllocatedAmount> ListOfLSMCSetAllocatedExpenseItem ExpenseItem .

and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.0 ■ SetAllocatedExpenseItem Service Object (Business Service or Workflow) For a description of the service objects for this Web service...\SetAllocatedExpenseItem\SetAllocatedExpenseItem_request. SetAllocatedExpenseItem Data Object Siebel Repository Name LSMCSetAllocatedExpenseItem External Name LSMCSetAllocatedExpenseItem Methods For a description of methods for this Web service.\SetAllocatedExpenseItem\SetAllocatedExpenseItem_response. Request See the following file to view the sample code: . see Table 649.xml Response See the following file to view the sample code: ... and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Table 649. Table 650. Siebel CRM Web Services Reference Version 8.xml Message Schema (WSDL) for SetAllocatedExpenseItem To view the message schema for this Web service. SetAllocatedExpenseItem Service Object Name LSMCSetAllocatedExpenseItem Boundary Object Type Business Service Class (if BusService) CSSEAIDataSyncService Data Object (Integration Object) For a description of data objects for this Web service. Extract the files in the zip file. SetAllocatedExpenseItem Method Operation LSMCSetAllocatedExpenseItemSynchronize Method Synchronize Example Package for SetAllocatedExpenseItem To view an example of messages for this Web service. Extract the files in the zip file.1 38 9 . navigate to the documentation library for Siebel applications on Oracle Technology Network.Primary Web Services for Siebel CRM 8. see Table 651. Table 651. see Table 650. navigate to the documentation library for Siebel applications on Oracle Technology Network.

see Table 652..0 ■ SFA_Activity_BS . Table 654.\SetAllocatedExpenseItem\SetAllocatedExpenseItem. see Table 653. refer to your application development documentation on Oracle Technology Network. Table 653.1 . Response Message Description: SFAInsertActivity For a description of this request message. see Table 654. Response Message Description: SFAInsertActivity Node SFA_Activity_IO Description Required SFA_Activity_BS Application Interface This topic describes the application objects called by the this Web service. Table 652. 390 Siebel CRM Web Services Reference Version 8.wsdl SFA_Activity_BS Use this Web service to insert an activity which is associated to a selected list of contacts into the Siebel database.Primary Web Services for Siebel CRM 8. Response Message Description: SFAInsertActivity Node SFA_Activity_IO Description Required Response Message Description: SFAInsertActivity For a description of this response message.. For a list of operations associated with this Web service. SFA_Activity_BS Operations These operations are listed in the WSDL that is presented as a WSDL to the clients accessing it. SFA_Activity_BS Operations Name SFAInsertActivity Description Creates an activity record in the database and associates a contact record to it. For more information on application implementation.

1 39 1 . Table 657. Siebel CRM Web Services Reference Version 8. Table 656. SFA_Activity_BS Method Operation Insert Method Insert Example Package for SFA_Activity_BS To view an example of messages for this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network.. Extract the files in the zip file. SFA_Activity_BS Data Object Siebel Repository Name SFA_Activity_IO Boundary Object Type Siebel Business Object External Name Action Methods For a description of methods for for Web service. see Table 657. see Table 655.\SFA_Activity_BS\SFA_Activity_BS_response. Request See the following file to view the sample code: .0 ■ SFA_Activity_BS Service Object (Business Service or Workflow) For a description of the service objects for this Web service...Primary Web Services for Siebel CRM 8. Table 655. SFA_Activity_BS Service Object Name SFAActivity_BS Boundary Object Type Business Service Class (if BusService) CSSEAIUIDataService Data Object (Integration Object) For a description of data objects for this Web service..xml Response See the following file to view the sample code: . Extract the files in the zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.xml Message Schema (WSDL) for SFA_Activity_BS To view the message schema for this Web service. see Table 656. navigate to the documentation library for Siebel applications on Oracle Technology Network.\SFA_Activity_BS\SFA_Activity_BS_request.

retrieve and set status for trouble tickets.0 ■ SiebelUserProfileService . update.\SFA_Activity_BS\SFA_Activity_BS.\SiebelUserProfileService\SiebelUserProfileService. . navigate to the documentation library for Siebel applications on Oracle Technology Network.. 392 Siebel CRM Web Services Reference Version 8. . Update additional attributes on the trouble ticket.\SiebelWebRegistration\SiebelWebRegistration..Primary Web Services for Siebel CRM 8.. see Table 658. TroubleTicket Operations For a list of operations associated with this Web service..1 .wsdl TroubleTicket Use this Web service to create.wsdl SiebelUserProfileService To view the message schema for this Web service.. Return the existing trouble tickets that meet criteria specified in a search spec. typically to cancel or close a network alarm. Update the status of an existing network trouble ticket. Extract the files in the zip file. Common Request Message Description This Web service has four operations. Each operation does not share a common request message format.. Extract the files in the zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. TroubleTicket Operations Name CreateTroubleTicket UpdateTroubleTicket GetTroubleTicket SetTroubleTicketStatus Description Create a new network trouble ticket. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Table 658. navigate to the documentation library for Siebel applications on Oracle Technology Network. including the resource(s) and service(s) affected.wsdl SiebelWebRegistration To view the message schema for this Web service.

TroubleTicket Application Interface This topic describes the application objects called by the this Web service. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. refer to your application development documentation on Oracle Technology Network. see Table 661. Table 660.0 ■ TroubleTicket Common Response Message Description This Web service has four operations. see Table 659. For more information on application implementation. Each operation does not share a common response message format. Table 659. TroubleTicket Service Object Name Trouble Ticket Trouble Ticket Lightweight Boundary Object Type Business Service Business Service Class (if BusService) CSSEAIDataSyncService CSSEAIDataSyncService Data Object (Integration Object) For a description of data objects for this Web service. TroubleTicket Data Object Siebel Repository Name WS Trouble Ticket WS Trouble Ticket Lightweight External Name Service Request FINS eBanking Business Service Trouble Ticket Trouble Ticket Lightweight Methods For a description of methods for this Web service. TroubleTicket Methods Operation CreateTroubleTicket UpdateTroubleTicket GetTroubleTicket SetTroubleTicketStatus Business Service Trouble Ticket Trouble Ticket Trouble Ticket Trouble Ticket Lightweight Method Insert Update QueryByExample Update Siebel CRM Web Services Reference Version 8.1 39 3 .Primary Web Services for Siebel CRM 8. Table 661. see Table 660.

0 ■ VerifyEntitlement Example Package for TroubleTicket To view an example of messages for this Web service. Request See the following file to view the sample code: .1 .\TroubleTicket\TroubleTicket. Extract the files in the zip file..xml Response See the following file to view the sample code: .wsdl VerifyEntitlement Use this Web service to obtain the best response time for Service Requests based on customer entitlements. Table 662.. VerifyEntitlement Operations Name FSVerifyEntitlementRunProcess Description Verifies customer entitlements at time of service request creation to ensure fastest response time. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.. 394 Siebel CRM Web Services Reference Version 8..\TroubleTicket\TroubleTicket_response. navigate to the documentation library for Siebel applications on Oracle Technology Network.xml Message Schema (WSDL) for TroubleTicket To view the message schema for this Web service.. . VerifyEntitlement Operations For a list of operations associated with this Web service.Primary Web Services for Siebel CRM 8.. navigate to the documentation library for Siebel applications on Oracle Technology Network.\TroubleTicket\TroubleTicket_request. see Table 662.

1 39 5 . see Table 665. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Table 664. see Table 664.Primary Web Services for Siebel CRM 8. see Table 663. Response Message Description: FSVerifyEntitlement Node Commit_spcTime Entitlement_spcId Entitlement_spcName Description Commit Time for the SR Entitlement Id that was used Entitlement name that was used VerifyEntitlement Application Interface This topic describes the application objects called by the this Web service. refer to your application development documentation on Oracle Technology Network. Request Message Description: FSVerifyEntitlement Node Contact_spcTime_spcZone Account_spcId Product_spcId Contact_spcId Asset_spcId Owned_spcBy_spcId Priority Created_spcDate Contact_spcAccount_spcId Description Time zone Accounts which entitlements cover Products which entitlements cover Contacts which entitlements cover Assets which entitlements cover Owner of the SR Priority of the SR Created date of the SR Contact of the SR Response Message Description: FSVerifyEntitlement For a description of this response message.0 ■ VerifyEntitlement Request Message Description: FSVerifyEntitlement For a description of this request message. For more information on application implementation. Table 663. Table 665. VerifyEntitlement Service Object Name FS Verify Entitlement Boundary Object Type Workflow Class (if BusService) Not applicable Siebel CRM Web Services Reference Version 8.

navigate to the documentation library for Siebel applications on Oracle Technology Network.[RunProcess] Example Package for VerifyEntitlement To view an example of messages for this Web service.\VerifyEntitlement\VerifyEntitlement_request..\Warranty\CreateWarranty.1 . navigate to the documentation library for Siebel applications on Oracle Technology Network. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file... Extract the files in the zip file.. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.xml Message Schema (WSDL) for VerifyEntitlement To view the message schema for this Web service..0 ■ Warranty Methods For a description of the method used for this Web services. navigate to the documentation library for Siebel applications on Oracle Technology Network. Extract the files in the zip file..wsdl Warranty To view the message schema for this Web service. Extract the files in the zip file...\VerifyEntitlement\VerifyEntitlement_response. Request See the following file to view the sample code: . 396 Siebel CRM Web Services Reference Version 8.. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. VerifyEntitlement Methods Operation FSVerifyEntitlementRunProcess Method [WF: FS Verify Entitlement]. navigate to the documentation library for Siebel applications on Oracle Technology Network.Primary Web Services for Siebel CRM 8. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.wsdl . see Table 666.wsdl WC_Account_BS To view the message schema for this Web service. .\VerifyEntitlement\VerifyEntitlement.\Warranty\CheckWarranty.. Table 666. .xml Response See the following file to view the sample code: .

. you can get subscription list information.wsdl WebMarketing Use this Web service to retrieve personalized content from Web offers.. Extract the files in the zip file..wsdl WC_Opportunity_BS To view the message schema for this Web service.Primary Web Services for Siebel CRM 8.. Retrieve a list of all active subscription lists. see Table 667. and create responses for tracking click events.0 ■ WC_Contacts_BS . and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. WebMarketing Operations Name CreateWebMarketingResponse GetActiveLists Description Create response records to track click events. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Additionally. Extract the files in the zip file. .wsdl WC_Contacts_BS To view the message schema for this Web service.wsdl WC_Service_Request_BS To view the message schema for this Web service. Siebel CRM Web Services Reference Version 8. WebMarketing Operations For a list of operations associated with this Web service. navigate to the documentation library for Siebel applications on Oracle Technology Network.\WC_Contacts_BS\WC_Contacts_BS. and details based on the offer treatment Id and Contact Id.1 39 7 .\WC_Opportunity_BS\WC_Opportunity_BS.. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file.. Table 667. .. navigate to the documentation library for Siebel applications on Oracle Technology Network.\WC_Service_Request_BS\WC_Service_Request_BS.\WC_Account_BS\WC_Account_BS. Extract the files in the zip file.. navigate to the documentation library for Siebel applications on Oracle Technology Network..

0 ■ WebMarketing Table 667. Row Id of Prospect. Required. 398 Siebel CRM Web Services Reference Version 8. Required. Row Id of Contact. Description of the response. Response Method. products.1 . Either PRSP_CON_ID or PR_CON_ID must be filled in. Row Id of Campaign. URLs and template. Subscribe to Email Action Code. Row Id of Campaign Contact. Status Code. Subscribe to Phone Action Code. Response Type. Row Id of Event. personalization Web content will also be returned. events.Primary Web Services for Siebel CRM 8. Request Message Description: CreateWebMarketingResponse For a description of this request message. Delivery Method. Response Row Id. Response URL. Row Id of Account. Subscribe to Direct Mail Action Code. Request Message Description: CreateWebMarketingResponse Node Response ACCNT_ID Delivery Method Description Destination Name Destination URL Event Id Event Reg Id Id PRSP_CON_ID PR_CON_ID Response Method Response Type SRC_ID S_CAMP_CON_ID Status Sub_DMail_Cd Sub_Email_Cd Sub_Fax_Cd Sub_Phone_Cd Subscription List Id Description Required. Required. Subscribe to Fax Action Code. Hyperlink name of response URL. see Table 668. Table 668. Row Id of Subscription List. Retrieves Web offer treatment and related Web surveys. Event Registration Id. WebMarketing Operations Name GetListMembers GetWebTreatment Description Retrieve a list of subscription lists that the contact/prospect is subscribed to. If context information is provided. Either PRSP_CON_ID or PR_CON_ID must be filled in.

Row Id of subscription list. Required. Row Id of Offer Treatment. Response Message Description: CreateWebMarketingResponse Node Same as request message Description Not applicable Request Message Description: GetActiveLists For a description of this request message. Table 672.Primary Web Services for Siebel CRM 8. Visibility algorithm used to determine which records will be retrieved.0 ■ WebMarketing Table 668. Response Message Description: GetActiveLists Node Same as request message Description Not applicable Request Message Description: GetListMembers For a description of this request message. Request Message Description: GetListMembers Node List Members Contact Id Description Required Row Id of Contact Siebel CRM Web Services Reference Version 8. see Table 670. see Table 669. Name of subscription list. Table 669.1 39 9 . Table 671. Request Message Description: GetActiveLists Node List Description Id Name ViewMode Description Required. Response Message Description: CreateWebMarketingResponse For a description of this response message. Response Message Description: GetActiveLists For a description of this response message. see Table 671. Table 670. Request Message Description: CreateWebMarketingResponse Node Summary Treatment Id Description Summary. Description of the response. see Table 672.

Table 674. Table 673. Request Message Description: GetListMembers Node List Id List Name Prospect Id Description Row Id of Subscription List Name of Subscription List Row Id of Prospect Response Message Description: GetListMembers For a description of this response message. Response Message Description: GetWebTreatment For a description of this response message.Primary Web Services for Siebel CRM 8. Row Id of Campaign. Table 675. Row Id of Web Treatment. see Table 674. Flag to indicate if the Web treatment is inbound. 400 Siebel CRM Web Services Reference Version 8. see Table 675. Web Server URL to be substituted in response forms. Row Id of Prospect.1 . Description of the response. Response Message Description: GetListMembers Node Same as request message Description Not applicable Request Message Description: GetWebTreatment For a description of this request message. Row Id of Web Treatment. Required. see Table 673. Response Message Description: GetWebTreatment Node WebTreatment Active For Inbound Flag Description Id Description Required. Row Id of Campaign Contact. Request Message Description: GetWebTreatment Node WebTreatment Id Context ContactId ProspectId CampConId CampaignId WebServer Row Id of Contact. Description Required.0 ■ WebMarketing Table 672.

Primary Web Services for Siebel CRM 8. Name of Event. Service Object (Business Service or Workflow) For a description of the service objects for this Web service. Row Id of Web Survey. Response Message Description: GetWebTreatment Node Language Code Locale Code Name PriceList Id Valid End Date Valid Start Date Template Lit Id Personalized Content Related Web Surveys Id Name Related Products Product Id Product Related Events Id Name Description Language Code. Row Id of Event. see Table 676. Name of Web Survey. WebMarketing Service Object Name WebMarketingService Boundary Object Type Business Service Class (if BusService) CSSWebMarketingService Siebel CRM Web Services Reference Version 8. Valid Start Date. refer to your application development documentation on Oracle Technology Network. Web survey to associate. Row Id of Treatment Template. Table 676. Valid End Date. Row Id of Product. Locale Code. WebMarketing Application Interface This topic describes the application objects called by the this Web service.0 ■ WebMarketing Table 675. Related product to retrieve. Template type. Related events to retreive. Name of Web Treatment.1 40 1 . Row Id of PriceList Id. Personalized Content of Web treatment. For more information on application implementation. Name of Product.

[CreateResponse] [BS: WebMarketingService]. navigate to the documentation library for Siebel applications on Oracle Technology Network. and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file..1 .\WebMarketing\WebMarketing_request. WebMarketing Methods Operation CreateWebMarketingResponse GetActiveLists GetListMembers GetWebTreatment Method [BS: WebMarketingService].xml 402 Siebel CRM Web Services Reference Version 8. see Table 678.[GetListMembers] [BS: WebMarketingService]. Extract the files in the zip file.[GetWebTreatment] Example Package for WebMarketing To view an example of messages for this Web service. Table 677.0 ■ WebMarketing Data Object (Integration Object) For a description of data objects for this Web service.. Request See the following file to view the sample code: .Primary Web Services for Siebel CRM 8. Table 678.. WebMarketing Data Object Siebel Repository Name Response SubscriptionList SubscriptionListMember GetWebTreatment GetWebTreatmentResponse Offer External Name Response Subscription Subscription Methods For a description of the methods for this Web services..[GetActiveLists] [BS: WebMarketingService]. see Table 677.\WebMarketing\WebMarketing_response.xml Response See the following file to view the sample code: .

wsdl Siebel CRM Web Services Reference Version 8.Primary Web Services for Siebel CRM 8. navigate to the documentation library for Siebel applications on Oracle Technology Network.1 40 3 . and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file...0 ■ WebMarketing Message Schema (WSDL) for WebMarketing To view the message schema for this Web service. Extract the files in the zip file.\WebMarketing\WebMarketing. .

Primary Web Services for Siebel CRM 8.1 .0 ■ WebMarketing 404 Siebel CRM Web Services Reference Version 8.

schema 61 operations 57 8.1 ABOWebService. Web service 29 application interface 35 example package. schema 73 operations 69 AssetWebService. schema 325 operations 323 ESB_AccountBalanceSiebelReqABCS_Servic e example package for 82 message schema for 83 ESB_AdjustmentSiebelReqABCS_Service message schema for 88 ESB_InvoiceSiebelReqABCS_Service example package for 93 message schema for 93 EventManagement. Web service 307 application interface 314 example package.1 40 5 . Web service 304 application interface 304 example package. Web service 304 Siebel CRM Web Services Reference Version 8. Web service 37 application interface 40 example package. list of 283 8. Web service 332 ExternalAutoPolicy. schema 55 operations 42 8.Index Numerics 8. Web service application interface 330 example package. schema 79 operations 78 ContextServiceWrapperService. Web service 73 CMU Account Update message schema for 77 operation for 76 Contact. schema 315 operations 307 CMU Account Query. Web service 316 application interface 319 example package. schema 65 operations 62 A ABOWebService. Web service 67 application interface 68 example package. Web Service 321 application interface 321 example package. schema 75 CMU Account Query.1 primary web services 25 8. Web service 77 application interface 79 example package. message schema 41 operations 37 8. Web Service example package. schema 68 operations 67 Asset Management. Web service 301 application interface 302 example package. Web service 322 EligibilityCompatibility. schema 331 EventRegistration. schema 36 operations 30 8. Web service 56 application interface 61 example package. Web service 332 C CalculatePriceWS.1 Product Configurator Web Service 41 application interface 54 example package. schema 307 operations 304 CatalogWebService. schema 303 operations 302 AssetManagementComplex. schema 320 operations 316 CopyActivity. schema 300 operations 294 Account. schema 322 operations 321 E EAILOVWS.0 Primary Web services.1 CatalogWebService. Web service 62 application interface 64 example package. Web service 322 application interface 325 example package.1 PromotionWebService.1 WebMarketing. Web service 294 application interface 300 example package. Web service 69 application interface 72 example package.

Web service 125 example package. Web service 358 PartnerRegistration. schema 122 operations 120 ListMgmtProspect. schema 176 operations 175 PriceListsWS. schema 135 operations 134 LoyaltyMemberService. Web service 332 application interface 339 example package. Web service 135 example package. schema 118 operations 115 List. schema 350 operations 347 example package. Web service 340 application interface 346 example package. Web service application interface 169 example package. schema 124 operations 123 LoyaltyAccrualService. schema 127 operations 125 LoyaltyBatchEnrollment. Web service 332 G GetHealthCareProfessionalProfileInformatio n. Web service 332 F Forecast. schema 170 operations 166 MktgImportService. schema 148 operations 136 LoyaltyRedemptionService. Web service 123 example package. Web service 150 example package. Web service 164 example package. schema 172 operations 171 166 I INSClaims. schema 113 operations 110 LeadService. schema 133 operations 129 LoyaltyImportBusinessService. Web service 171 application objects 172 example package. schema 347 operations 340 GetMktgWebSurvey. schema 358 operations 356 356 L LeadProcessingService. Web service 134 example package. schema 165 operations 164 M MktgDeduplicationService. Web service 105 application interface 106 example package. Web service 347 application interface 349 example package. schema 174 operations 173 OrderWebService. schema 340 operations 332 GetHeathCareProfessionalComplianceDetail s. Web service 115 application interface 118 example package.1 . Web service 120 application interface 121 example package. Web service 359 PDSOrderHeader. Web service 110 application interface 113 example package. Web service 173 application interface 174 example package. Web service 176 example package. schema 352 operations 351 N NetworkOrderEntry. Web service 175 example package. Web service application interface 357 example package. Web service 350 application interface 352 example package. schema 161 operations 150 LoyaltyVoucherService. Web service 379 application interface 381 operations 379 P PartnerPrograms. Web service 129 O OrderDetailWebService.Index ■ F ExternalPropertyPolicy. schema 177 operations 176 Product Import 406 Siebel CRM Web Services Reference Version 8. schema 107 operations 106 GetUnallocatedExpenseItem.

schema 382 QuotingWebService. Web service 230 application interface 241 enroll operation. Web service 246 application interface 248 example package. Web service 214 application interface 218 example package. schema 195 operations 194 R Response. schema 251 operations 249 SelfServiceTimeZone. Web service 204 application objects 210 example package. Web service 191 example package. business services called by 231 example package. Web service 186 application interface 188 example package. Web service 244 application interface 245 example package. schema 375 operations 374 ProductSearchService. Web service 189 example package. schema 201 operations 199 S searchSolution. schema 214 operations 211 SelfServiceAllAccountsList. Web service 219 application interface 223 example package. schema 379 operations 376 Q QuoteAddItemsWS. Web service 373 application interface 375 example package. schema 190 operations 190 QuoteDetailWebService. schema 218 operations 215 SelfServiceContact. Web service 211 application interface 213 example package. Web service 201 application interface 203 example package. Web service 225 operations 225 SelfServicePostLoginProcess. schema 204 operations 202 SelfServiceAccount. Web service 252 application interface 252 example package. Web service 376 application objects 378 example package.Index ■ Q message schema for 186 ProductConfigurator. schema 248 operations 246 SelfServiceTemplateEmail. schema 384 operations 383 QuoteCheckOutWebService. schema 210 operations 205 SelfServiceAccountRootPath. schema 372 operations 359 ProductRecommendation. Web service 254 application interface 257 example package. schema 257 operations 254 SelfServiceWebSite. schema 253 operations 252 SelfServiceUser. Web service 379 application interface 381 example package. schema 198 operations 196 RetrieveAttachmentService. Web service 196 example package. Web service 194 application interface 195 example package. schema 224 operations 219 SelfServicePaymentHistory. Web service 227 example package. schema 189 operations 187 PromotionWebService. Web service 249 application interface 250 example package.1 40 7 . schema 193 operations 191 QuoteWebService. Web service 383 application interface 384 example package. Web service 199 application interface 200 example package. schema 246 operations 244 SelfServiceSmtpEmail. schema 242 operations 231 P_mode request parameter 230 SelfServiceResponsibility. schema 229 operations 227 P_mode request parameter 227 SelfServiceRegistration. Web service 359 application interface 371 example package. Web service 258 Siebel CRM Web Services Reference Version 8.

schema 394 operations 392 U Ulnbox Contact Item. schema 389 operations 387 SFA_Activity_BS. Web service 266. Web service 392 Simple Access Protocol (SOAP). schema 391 operations 390 Siebel Web Service. schema 280 operations 278 Web services about 11 as server-side service 12 business services 15 core technologies 12 development cycle 13 documentation 14 enabling Siebel applications with 11 inbound. Web service 397 T TroubleTicket. Web service 273 application interface 274 example package. specifying 271 Universal Inbox. using 21 Web Services Description Language (WSDL). schema 402 operations 397 WS_Account_BS. process of exposing assembling the services 18 determining which objects to expose 17 Siebel Web service. modeling 19 exposing business service as web service 19 exposing workflow as web service 20 Siebel Web Service. Web service 396 WS_Contact_BS. Web service 387 application interface 388 example package. schema 265. schema 274 operations 273 X XML. schema 260 operations 258 SerializationService. Web service 392 application interface 393 example package. Web service 394 application interface 395 example package. about 13 UpdateCustomerSiebelJMSProducer described 275 example package for 277 message schema for 278 V VerifyEntitlement. 385 application interface 264 application objects 386 example package. Web service 385 ServiceRequest. Web service 260. 385 SessionAccessWS. about 13 408 Siebel CRM Web Services Reference Version 8. 386 operations 261. outbound 14 integration objects 15 Siebel architecture 17 Siebel support 14 support and testing. Web service 397 application interface 401 example package. schema 267 operations 266 SetAllocatedExpenseItem. list 285 Web Services Deployment Wizard. Web service 397 WS_Service_Request_BS.Index ■ T application interface 259 example package. schema 272 operations 270 parameters. schema 396 operations 394 W Warranty. Web service 397 WS_Opportunity_BS. Web service 278 application interface 280 example package. XML schema 13 WebMarketing. Web service 390 application interface 390 example package. Web service 392 SiebelWebRegistration. XML Schema. 387 application interface 266 example package. process of exposing 17 Siebel Web Services authentication and performance 22 SiebelUserProfileService. about 12 Web services. Web service 396 WC_Picklist_Payment_Profile_BS. Web service 270 application interface 272 example package.1 . core technologies SOAP 13 WSDL 12 XML.