CRMWeb

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. Siebels 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: Whats 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
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
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
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
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
Contents
Whats New in This Release
Whats New in Siebel CRM Web Services Reference, Version 8.1

Table 1 lists changes described in this version of the documentation to support release 8.1 of the software.
Table 1. Topic
New Product Features in Siebel CRM Web Services Reference, Version 8.1 Description Added additional information on Internal Component field. Enhanced topic. Added more information on business service methods and arguments. Also, more information about workflows and the way they are consumed as Web services. New topic. Provides new information on exposing Siebel Web services. Added more information on business service methods and arguments. Also, more information about workflows and the way they are consumed as Web services. Enhanced topic. Clarified the task steps. New topic. Reorganized Web service modeling discussion. Added a new discussion of classifying state requirements, and registering public methods in Siebel Tools. New topic. Brief overview of Web services deployment wizards. Added new Web service topic. Added new Web service topic. Added new Web service topic. Added new Web service topic. Added new Web service topic. Added new Web service topic. Added new Web service topic. 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
Whats New in This Release
Table 1. Topic
New Product Features in Siebel CRM Web Services Reference, Version 8.1 Description Added new Web service topic. Added new Web service topic. Added new Web service topic. Added new Web service topic. 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.
10
Siebel CRM Web Services Overview
This chapter provides an overview of Web services and guidance for implementing Oracles Siebel Web service. 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, located somewhere on the Internet, which is accessible through Internet protocols. It is distinguished by the following: It is specified using Web services Description Language (WSDL). It is transported by SOAP (an XML-based transport protocol). It contains data represented in XML and defined by XML Schema.
11
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, heterogeneous applications. Its interface is defined by XML (XML Schema & WSDL). It exposes coarse-grained, loosely-coupled operations on document-structured data. It is independent of underlying implementation. It is accessible through open standard protocols such as HTTP, SMTP, FTP or JMS.
Web services are all of the following: A delivery mechanism for integrating loosely coupled software components. Delivered over standard Internet technologies. Rooted in:

Interoperability Standards XML Coarse-grained exposure of functionality
Core Technologies for Web Services

Oracles Siebel Web services use industry standard core technologies. The bulleted list that follows includes each of the main core technologies utilized. Each core technology is explained in detail in the topics that follow. 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. WSDL describes the endpoints, location, protocol binding, operations, parameters, 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. It is used by the client to format requests and interpret responses. It may be optionally submitted to a registry or service broker to advertise a service.
Additionally, WSDL describes the following:
The operations provided by a Web service.
12
Siebel CRM Web Services Overview Web Services Deployment Cycle
The input and output message structures for each Web service operation. The mechanism to contact the Web service.
About XML and XML Schema

A WSDL file is published in the form of an XML document instance. Document/Literal is required as part of the WS-I interoperability standard that forms the basis of modern Web service usage, where: Document means that the payload for an operation, however complex, must be defined in a single XML element. Literal means that the definition of that element must be described by an XML Schema embedded in the 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. The payload itself will consist entirely of XML data structures.
About Simple Object Access Protocol (SOAP)

SOAP is a lightweight protocol intended for exchanging structured information in a decentralized, distributed environment. SOAP uses XML to define an extensible messaging framework. SOAP messages consist of the following: An envelope for wrapping messages, including addressing and security information. A set of serialized rules for encoding data types in XML. Conventions for a procedure call and, or response.
Web Services Deployment Cycle

A service provider describes its service in the form of a WSDL file. Typically, the WSDL is obtained directly by the developer of the service client consumer. At the time the design of a Web service, the service consumer uses the WSDL to generate a proxy in his own native development environment, allowing him to program interactions with the service provider. At run time the following occurs: The service consumer formats a request in accordance with the WSDL definition. The service provider provides the expected response to the service consumer.
13
Siebel CRM Web Services Overview Siebel Web Service Documentation
Siebel Web Service Documentation

In addition to the documentation provided here, 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. NOTE: The Siebel Bookshelf is available on Oracle Technology Network (OTN) and Oracle E-Delivery. It might also be installed locally on your intranet or on a network location. Information can be found on Siebel Web service technology and on EAI technologies like the Siebel Adapter (ASI) and the UI Data Service (UDS), which are designed for direct data-level access to the Siebel Object Manager. Information is also available there on XML Schema development, WSDL generation, Outbound Web service configuration, file attachments, authentication and security.
Support for Siebel Web Services

The following elements contribute to the deployment of Siebel Web services. 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. For example, a custom UI that wants to view and modify Siebel Service Requests. Outbound Web services allow Siebel applications to make requests of external applications. For example, if the Siebel Server wanted to provide its clients the option of either searching internally or searching the Internet, 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. Figure 1 displays Inbound and Outbound Web services.
Figure 1.
Inbound and Outbound Web services
14
Siebel CRM Web Services Overview Support for Siebel Web Services
Integration Objects
In the area of Web services, Integration Objects provide the primary means of structuring messages. An Integration Object may be used to support both inbound and outbound Web services, their use with Inbound Web services is more tightly bound to the Siebel Object Manager. An Integration Object represents a subset of a Siebel Business Object. 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. Integration Component Fields represent Business Component Fields. Typically defines the structure of data being exchanged between a Siebel application and an external application. Internal Component Field names and WSDL element/attribute names can be different. In Siebel Tools, In the Integration Component Fields applet, the column XML Tag governs the way the field name will appear in the WSDL. Figure 2 displays the correspondence between Siebel Objects and Integration objects.
Figure 2.
Integration Objects
Business Services
Business Services allow you to deploy a reusable object that contains a predefined set of methods. Additionally, deploying Business Services allows you to model your Web services within Siebel Tools. Siebel Web services employ two types of Business Service: CRUD (Create, Read, Update, Delete) data services, of the type: UDS and ASI.
15
Siebel CRM Web Services Overview Support for Siebel Web Services
Functional Services (Custom Business Services and Workflow). Figure 3 displays Business Services and their corresponding Web service entities.
Figure 3.
Business Services
16
Siebel CRM Web Services Overview Siebel Web Services Architecture
Siebel Web Services Architecture

Figure 4 displays the basic architecture for Siebel Web services.
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. The Siebel Objects involved (Workflows, Business Services and Integration Objects) must be configured at design time in Siebel Tools. Then, those objects must be assembled into Web services using a Siebel Application. This topic lists the steps you must perform to expose a Siebel Web service.
Determine Which Siebel Objects to Expose

When exposing a Siebel Web service, you must first use Siebel Tools to determine which Siebel objects, such as Business Services, Workflows or Integration Objects, you want to expose.
Business Services and Workflows Consider the following when exposing Business Services and Workflows:
17
Siebel CRM Web Services Overview Process of Exposing a Siebel Web Service
Business Service methods and arguments correspond to Web service operations and messages. Most Business Services with methods registered in Siebel Tools can be designated for participation in a Web service. A Workflow is one-to-one equivalent to a single Web service operation, and its Process Properties are the arguments to that operation. Like most Business Services, most Workflows can be designated for participation in a Web service.
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. Act as boundary proxies for Business Objects & Business Components.
General Guidelines for Business Services, Workflows and Integration Objects Consider the following general guidelines when exposing Siebel Objects: In Siebel Tools make changes to Business Services, Workflows and Integration Objects to model desired Web service interface. Compile and deploy the objects (SRF) to be exposed.
Assemble the Services

In the Siebel Application, the Web service Administration screens and views allow the creation and configuration of all Web services at run time. In Web service Administration screens and views, administrators may select the Business Services and associated methods that they wish to expose as Web services. 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. For a limited subset of Web services, a Siebel Tools design-time wizard is available to set up most required configuration elements for UDS (UI Data Service) Web service exposure. These elements must also be compiled in the SRF before they can be referenced in the Web service Administration screens and views.
To assemble a Web service in the Web Service Administration view 1 2 3

In the Siebel Mobile Web client, navigate to the AdministrationWeb Services screen. Select either Inbound Web Services or Outbound Web Services. Click New to create a new Web service, or select a Web service in the Inbound or Outbound Web Services list.
18
Siebel CRM Web Services Overview About Siebel Web Service Modeling
In the Service Ports list applet, select a Business Service or Workflow to act as Web Service invocation boundary object. To combine the operations of several Business Services or Workflows into a single service, add them to the Port for the Service.
5 6
In the Operations list applet, model WSDL by configuring methods belonging to the Business Service(s) and/or Workflow(s) listed in the Service Port. Click the Generate WSDL button in the Inbound or Outbound Web Services list applet.
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. Business Service Method Arguments are Web service methods.
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. In all of the Siebel Web service implementations, so far only operations involving the Order Management Configurator have required Stateful context management.

Stateful means that Siebel Object Manager context must be maintained and correlated from one Web service operation invocation to the next. Stateless means that each Web service operation exists independently of any other.
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, then it should be classified as Server-managed. (removed invalid clause pointing to Siebel Tools) When a Web Service operation is classified as Server Managed, the Business Service can participate in either a Stateless or a Stateful Web Service exchange. When Stateless is chosen, a Business Service cannot be enlisted at run time for participation in a Stateful exchange.
19
Siebel CRM Web Services Overview About Siebel Web Service Modeling
Note that, at run time, the encoding of the SOAP header determines whether an operation is Stateful, Stateless or Server Managed. For details, see the Siebel Bookshelf document Siebel Web UI Dynamic Developer Kit. Although the document is specific to the UI Data Service, the description of the SessionType SOAP header element is applicable across the board with Siebel Web Services.
Register Public Methods in Siebel Tools Specify the complete input and output arguments for each of these methods. If any of the argument is a Property Set hierarchy, do the following:

Define the property set structure as an Integration Object in Tools. Specify data type for this argument as Hierarchy and associate with Integration Objects defined in this topic. To specify whether an argument appears in the input operation and/or the output operation, use the Business Service Method Args Type column. Choose Input, Input/Output, or Output to direct the use of the argument in generating the WSDL.
Once the preceding configuration steps in Tools are complete, and the SRF has been compiled and deployed, continue creating a Web service definition for this Business Service in the Siebel Business Application.
In AdministrationWeb Services, configure the Business Service in Service Ports, 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. The WSDL XML namespace should be entered here. Create a record in Service Ports, choose the Business Service in the Business Service/ Business Process name column, set the Transport and URL, and select SOAP_DOC_LITERAL in the Binding column. Create a service operation in Operations, set the WSDL operation name in the Operation Name column, and designate the Business Service method as the Siebel method to execute in the Method Display Name column. Operations are mapped in Operations applet.
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, which is acknowledged to be burdensome. Generally, Siebel has resolved this uniqueness requirement by combining the Service Name with the Method Display Name.
Exposing a Workflow as a Web Service

The following statements can be applied to Workflows consumed as Web services. A Workflow corresponds to a single Web service Operation. Workflow Process Properties are Web service messages. A Workflow PropertySet has no direct external representation but can be mapped to an Integration Object.
20
Siebel CRM Web Services Overview Using the Web Services Deployment Wizard
You can expose workflows as Web services in the following procedure. NOTE: Workflows that are either Persistent or Interactive must be re-factored to work as Web services.
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. Out if used as an output argument. In/Out if used as both input and output.
NOTE: The In, In/Out, and Out arg types are included in the interface definition.
If any Process Property is a Property Set hierarchy, complete the following steps:
a b 3 4 5
Define the property set structure as an Integration Object in tools. Specify data type for this Process Property as Hierarchy and associate with Integration Object.
NOTE: This is important as you must expose a strongly-typed interface, including arguments. In the AdministrationWeb Services view, do the following: Create a new Service record or choose and existing Service in the Inbound Web Services applet. The WSDL XML namespace should be entered here. Create a record in Service Ports, choose the Workflow in the Business Service/Business Process name column, set the Transport and URL, and select SOAP_DOC_LITERAL in the Binding column. NOTE: To model a complete Web Service with more than one operation, several Service Ports might be specified under a single Service. This is normal and expected.
Create a service operation in Operations, set the WSDL operation name in the Operation Name column, and designate RunProcess as the Siebel method to execute in the Method Display Name column.
NOTE: The observation about operation naming uniqueness noted in this topic applies here as well. The Generally, Siebel has resolved this uniqueness requirement by combining the Service Name with an abbreviation of the Workflow Process Name.
Using the Web Services Deployment Wizard

As a convenience, Siebel Tools has a few wizard-style tools to assist in the configuration of Business Services, Workflows and Integration Objects into Web Services. If you already have a Business Service configured and ready for use as a Web Service, right-click on the Business Service and select Deploy as Web Service from the pop-up menu. You can perform this task for Workflows by right-clicking on the desired Workflow Process record.
21
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, Read, Update, Delete (CRUD) and the use of the UDS (UI Data Service) service meets your needs, 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. From the Siebel Tools File Menu, select File, New Object, EAI, and then Data Access Service. NOTE: This wizard does not create ASI-based Services.
About Siebel Web Service Authentication and Performance

In implementations where scalability is critical, a lightweight context management facility for authentication is available and its use is recommended. With this facility, 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, formal authentication is performed prior to the application execution of the Web service operation. If the authentication succeeds, the operation proceeds and a special SessionID token are placed in the SOAP header of the Web service reply. Whenever the SessionID is included by the client in subsequent Web service requests, that SessionID will be used to restore cached session information, thus bypassing the substantially more expensive process of re-executing the authentication. Note that, when presented with both the SessionID and a valid set of user credentials, an attempt will be made to use the SessionID before resorting to the user credentials and re-authentication. As expected, the session that is being tracked by the SessionID is subject to expiration and other security checks.
The facility is a distinct alternative to the basic authentication standard described by WS-Security. Using the UserName token as provided in WS-Security, while fully supported as part of Siebels WSI Basic Profile compliance, will not yield the same benefit as using the higher-performance session optimization facility provided by the Siebel implementation. For detailed information on authentication and security see Integration Platform Technologies: Siebel Enterprise Application Integration.
22
Siebel 8.1 Primary Web Services
This chapter includes detailed descriptions and information about Siebel 8.1 Web services. Web services described include the following: 8.1 Primary Web Services on page 25 8.1 ABOWebService on page 29 8.1 CatalogWebService on page 37 8.1 Product Configurator Web Service on page 41 8.1 PromotionWebService on page 56 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
23
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 8.1 Primary Web Services 8.1 Primary Web Services
Universal Inbox on page 273 UpdateCustomerSiebelJMSProducer on page 275 WC_PickList_Payment_Profile_BS on page 278
8.1 Primary Web Services

Table 2 lists the primary Web services available with Siebel 8.1. The Services are divided by functional area.
Table 2. 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/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI Type Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound
25
Table 2. 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/Account http://siebel.com/SelfService/ Common/Account http://siebel.com/SelfService/ Common/Account http://siebel.com/SelfService/ Common/Contact http://siebel.com/SelfService/ eCommerce/Payment http://siebel.com/SelfService/ Common/Login http://siebel.com/SelfService/ Common/Registration http://siebel.com/SelfService/ Common/Utility http://siebel.com/SelfService/ Common/User http://siebel.com/SelfService/ Common/Utility http://siebel.com/SelfService/ Common/Utility http://siebel.com/SelfService/ Common/Setup Type Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound
26
Table 2. 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/account http://siebel.com/marketing/contact http://siebel.com/marketing/leads http://siebel.com/marketing/leads http://siebel.com/marketing/list http://siebel.com/marketing/prospect http://siebel.com/marketing/ webmarketing http://siebel.com/marketing/ webmarketing http://siebel.com/marketing/response http://siebel.com/marketing/ webmarketing http://siebel.com/loy http://siebel.com/Loyalty/ LoyaltyEnrolmentServices http://siebel.com/Loyalty/ LoyaltyImportService http://siebel.com/Loyalty/ LoyaltyMemberServices http://siebel.com/Loyalty/ LoyaltyRedemptionService http://siebel.com/Loyalty/ LoyaltyVoucherService http://siebel.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
27
Table 2. Area OM
Primary Web Services Web Service Name OrderDetailWebService 8.1 Catalog Web Service CalculatePriceWS QuoteAddItems PriceListsWS QuoteCheckOutWebService QuoteDetailWebService QuotingWebService 8.1 ABO Web Service ProductConfigurator 8.1 Promotion Web Service SessionAccessWS Namespace http://siebel.com/OrderManagement/ Order/Details http://siebel.com/OrderManagement/ Catalog http://siebel.com/OrderManagement/ Quote/PSP http://siebel.com/OrderManagement/ Quote http://siebel.com/OrderManagement/ PriceLists http://siebel.com/OrderManagement/ Quote/Quoting http://siebel.com/OrderManagement/ Quote/Details http://siebel.com/OrderManagement/ Quote/Quoting http://siebel.com/OrderManagement/ ABO http://siebel.com/OrderManagement/ Configurator http://siebel.com/OrderManagement/ Promotion http://www.siebel.com/xml/ SessionAccess http://www.siebel.com/Service/FS/ Assets http://siebel.com/Service/ AssetWarranty 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 8.1 Primary Web Services 8.1 ABOWebService
Table 2. 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:siebel.com/asi/ http://www.siebel.com/xml/ ProductImport http:siebel.com/asi/ http://xmlns.oracle.com/ABCS/Siebel/ Industry/Telco/ AccountBalanceSiebelReqABCS/V1 http://xmlns.oracle.com/ABCS/Siebel/ Industry/Telco/ UnbilledUsageSiebelReqABCS/V1 http://xmlns.oracle.com/ABCS/Siebel/ Industry/Telco/ InvoiceSiebelReqABCS/V1 http://xmlns.oracle.com/ABCSImpl/ Siebel/Industry/Telco/ PaymentSiebelReqABCS/V1 http://xmlns.oracle.com/ABCS/Siebel/ Industry/Telco/ AdjustmentSiebelReqABCS/V1 http://xmlns.oracle.com/ABCS/ Industry/Telco/SalesOrder/ ProcessSalesOrderSiebelJMSProducer http://xmlns.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.1 ABOWebService
NOTE: This Web service is available only for implementations of version 8.1 of Siebel Business Applications. Use this Web service to expose the following Asset-Based Ordering (ABO) functions: convert a quote into an order, submit an order to the back-end office, convert a completed order line item to an asset, modify an asset, disconnect an asset, suspend, or resume an asset. This Web service works only with an Asset-Based Ordering (ABO) enabled environment. A typical application that uses the Web service is Siebel Communication.
29
8.1 ABOWebService Operations

The asset operations Modify, Disconnect, Suspend, or Resume create a new line item, based on the account or contact profile. They have a similar input and output data schema. If AccountId is provided, then it operates on the account profile. If AccountId is not provided it operates on the contact profile. Affix ToQuote in the Web service name means: if an active quote is provided, it will add the quote item to the existing quote. If an active quote is not provided, it generates a new quote and adds the quote item to the new quote. Affix ToOrder in the Web service name means: if an active order is provided it adds the order item to the existing order. If an active order is not provided, it generates a new order and adds the order item into the new order. For a list of operations associated with this Web service, see Table 3. Table 3. Name AutoOrder SubmitOrder AutoAsset ModifyAssetToQuote ModifyAssetToOrder DisconnectAssetToQuote DisconnectAssetToOrder SuspendAssetToQuote SuspendAssetToOrder ResumeAssetToQuote ResumeAssetToOrder 8.1 ABOWebService operations Description Converts a Quote to a Sales Order. Submits an Order. Creates assets from the completed order line items or updates a current asset. Modifies an asset (Service Item), and generates a quote item to update the selected asset. Modifies an asset (Service Item), and generates an order item to update the selected asset. Disconnects an asset (Service Item) to generate a quote item to deactivate the selected asset. Disconnects an asset (Service Item), and generates an order item to deactivate the selected asset. Suspends an active asset (Service Item) to generate a quote item to suspend the selected asset. Suspends an asset (Service Item) and generates an order item to suspend the selected asset. Resumes a suspended asset (Service Item) to generate a quote item to resume the selected asset. Resumes an asset (Service Item), and generates an order item to resume the selected asset.
Request Message Description: AutoOrder The following Web services AutoOrder, SumitOrder, ModifyAssetToOrder, SuspendAssetToOrder, ResumeAssetToOrder and DisconnectAssetToOrder have a common output message format, PDS Order.
30
ModifyAssetToOrder, SuspendAssetToOrder, ResumeAssetToOrder, DisconnectAssetToOrder have a common request message format. ModifyAssetToQuote, SuspendAssetToQuote, ResumeAssetToQuote and DisconnectAssetToQuote have a common request message format, and a common response message format, PDS Quote. For a description of this request message, see Table 4. Table 4. Node Object Id Request Message: AutoOrder Description Required. RowId of the Quote to be converted to the Sale Order.
Response Message Description: AutoOrder The Integration Object Message Format is PDS Order. For a description of this response message, seeTable 5. Table 5. Node PDS Order Header Line Item XA Response Message: AutoOrder Description Instance of Integration object PDS Order. Order Header. Order Line Items. Order Line Item attributes.
Request Message Description: SubmitOrder For a description of this request message, see Table 6. Table 6. Node OrderId Request Message: SubmitOrder Description Required. RowId of the order to be submitted.
Response Message Description: SubmitOrder Integration Object Message Format: PDS Order, which has the same format as the AutoOrder response message.
31
Request Message Description: AutoAsset For a description of this request message, see Table 7. Table 7. Node Object Id LineItemId Request Message; AutoAsset Description Required. RowId of the corresponding Order that contains the Order Line Item to be converted or applied to an asset. Required. RowId of an Order Line Item to be converted or applied to an asset.
Response Message Description: AutoAsset This Integration Object Message Format is PDS Asset. For a description of this response message, seeTable 8. Table 8. Node PDS Asset Header Line Item XA Response Message: AutoAsset Description Required. Integration Object. Asset Header. Asset Asset attributes
Request Message Description: ModifyAssetToQuote For a description of this request message, see Table 9 Table 9. Node AssetIntegrationId AssetNumber ActiveDocumentId Request Message: ModifyAssetToQuote Description Asset Integration Id of the selected asset. Provide either AssetIntegrationId or AssetNumber . Asset Integration Id of the selected asset. 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). ActiveDocumentId refers to the current active Document that the current process is working on. In this Web service call, it is the Quote Id of the active Quote to which the generated quote item has to be added. This is an optional input. Account Id of the account that owns the selected asset (Service Item). Contact Id of the contact who owns the selected asset (Service Item) to be modified.
AccountId ContactId
32
Table 9. Node DueDate
Request Message: ModifyAssetToQuote Description 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. Compound Product Number for the Asset Based Ordering (ABO) network ordering. It is not required if network ordering is not used.
PriceListId CompoundProductNumber
Response Message Description: ModifyAssetToQuote The Integration Object Message Format is PDS Quote. For a description of this response message, see Table 10. Table 10. Node PDS Quote Header Line Item XA Response Message; ModifyAssetToQuote Description Required. Integration Object. Quote Header. Quote Line Item. Quote Line Item attributes.
Request Message Description: ModifyAssetToOrder For a description of this request message, see Table 11 Table 11. Node AssetIntegrationId AssetNumber ActiveDocumentId Request Message: ModifyAssetToOrder Description Asset Integration Id of the selected asset. Provide either AssetIntegrationId or AssetNumber. Asset Integration Id of the selected asset. 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). ActiveDocumentId refers to the current active Document that the current process is working on. In this Web service call, it is the Quote Id of the active Quote to which the generated quote item has to be added. This is an optional input. Account Id of the account that owns the selected asset (Service Item). Contact Id of the contact who owns the selected asset (Service Item) to be modified. The due date of the generated line item.
AccountId ContactId DueDate
33
Table 11. 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. It is required only if network ordering is used.
PriceListId CompoundProduct Number
Response Message Description: ModifyAssetToOrder Integration Object Message Format: PDS Order, which has the same format as the AutoOrder response message.
Request Message Description: SuspendAssetToQuote This is the same request message as ModifyAssetToQuote.
Response Message Description: SuspendAssetToQuote Integration Object Message Format: PDS Quote.
Request Message Description: SuspendAssetToOrder This is the same request message as ModifyAssetToOrder.
Response Message Description: SuspendAssetToOrder Integration Object Message Format: PDS Order.
Request Message Description: ResumeAssetToQuote This is the same request message as ModifyAssetToQuote.
Response Message Description: ResumeAssetToQuote Integration Object Message Format: PDS Quote.
Request Message Description: ResumeAssetToOrder This is the same request message as ModifyAssetToOrder.
Response Message Description: ResumeAssetToOrder Integration Object Message Format: PDS Order.
Request Message Description: DisconnectAssetToQuote This is the same request message as ModifyAssetToQuote.
34
Response Message Description: DisconnectAssetToQuote Integration Object Message Format: PDS Quote.
Request Message Description: DisconnectAssetToOrder This is the same request message as ModifyAssetToOrder.
Response Message Description: DisconnectAssetToOrder Integration Object Message Format: PDS Order.
8.1 ABOWebService 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 12. Table 12. Name SISOMAutoOrderWebService SISOMSubmitWebService SISOMAutoAssetWebService SISOMModifyWebService-Quote SISOMModifyWebService-Order SISOMSuspendWebService-Quote SISOMSuspendWebService-Order SISOMResumeWebService-Quote SISOMResumeWebService-Order SISOMDisconnectWebService-Quote SISOMDisconnectWebService-Order 8.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
35
Data Object (Integration Object) For a description of data objects for this Web service, see Table 13. Table 13. 8.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, 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 (AutoOrder) SSee 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\AutoOrder_response.xml Request (ModifyAssetToQuote) See the following file to view the sample code: ...\81_ABOWebService\ModifyAssetToQuote_request.xml Response (ModifyAssetToQuote) See the following file to view the sample code: ...\81_ABOWebService\ModifyAssetToQuote_response.xml Request (AutoAsset) See the following file to view the sample code: ...\81_ABOWebService\AutoAsset_request.xml Response (AutoAsset) See the following file to view the sample code: ...\81_ABOWebService\AutoAsset_response.xml
36
Siebel 8.1 Primary Web Services 8.1 CatalogWebService
Message Schema (WSDL) for ABOWebservice

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: ...\81_ABOWebService\81_ABOWebService.wsdl
8.1 CatalogWebService
NOTE: This Web service is available only for implementations of version 8.1 of Siebel Business Applications. Use this Web service to expose promotional offerings related to products, as well as related products and categories.
8.1 CatalogWebService Operations

For a list of operations associated with this Web service, see Table 14. Table 14. Name GetRelatedPromotions GetRelatedProducts GetCategory UDSPublishCatalog 8.1 CatalogWebService operations Description Retrieve a list of related promotion. Retrieve a list of related products. Retrieve a flat, non-hierarchical list of categories. Publish a given catalog with category and products with support of pagination and visibility.
Request Message Description: GetRelatedPromotions For a description of this request message, see Table 15 Table 15. Name PDS Related Promotions Interface PricingMode EligibilityMode Request Message: GetRelatedPromotions Description An instance of Integration Object PDS Related Promotions Interface. Y or N (calculates price or not). Optional. The default value is Y. 0, 1 ,2 (eligibility display mode: 0 do not run; 1 run; 2 run but only return eligible products). Optional. The default value is 1. Type Integration Object String String
37
Table 15. Name
Request Message: GetRelatedPromotions Description SiebelContext or ExternalConext. Optional. However, you must provide ContextMode to run pricing and eligibility. An instance of Integration Object PDS Catalog Context. It either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. If ContextMode is provided it is required. Type String
ContextMode
Context
Integration Object
Response Message Description: GetRelatedPromotions For a description of this response message, seeTable 16. Table 16. Name PDS Related Promotions Interface Response Message: GetRelatedPromotions Description PDS Related Promotions Interface. After running Eligibility and Pricing, the List Price, Net Price, Eligibility status and Eligibility Reason fields will be updated. Type Integration Object
Request Message Description: GetRelatedProducts For a description of this request message, see Table 17. Table 17. Name PDS Related Products Interface PricingMode EligibilityMode Request Message: GetRelatedProducts Description An instance of Integration Object PDS Related Products Interface. Y or N (calculates price or not). Optional. The default value is Y. 0, 1 ,2 (eligibility display mode: 0 do not run; 1 run; 2 run but only return eligible products). Optional. The default value is 1. SiebelContext or ExternalContext. Optional. However, provide ContextMode to run pricing and eligibility. An instance of Integration Object PDS Catalog Context. It either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. If ContextMode is provided it is required. Type Integration Object String String
ContextMode
String
Context
Integration Object
38
Response Message Description: GetRelatedProducts For a description of this response message, seeTable 18. Table 18. Name PDS Related Products Interface Response Message: GetRelatedProducts Description An instance of Integration Object PDS Related Products Interface. After running Eligibility and Pricing, the List Price, Net Price, Eligibility status and Eligibility Reason fields will be updated. Type Integration Object
Request Message Description: GetCategory For a description of this request message, see Table 19. Table 19. Name PDS Category Interface Integration Object Request Message: GetCategory Description An instance of Integration Object PDS Category Interface. Type Integration Object
Response Message Description: GetCategory For a description of this response message, seeTable 20. Table 20. Name PDS Category Interface Integration Object Response Message: GetCategory Description An instance of Integration Object PDS Category Interface. Type Integration Object
Request Message Description: UDSPublishCatalog For a description of this request message, see Table 21. Table 21. Name SiebelMessageIn PricingMode EligibilityMode Request Message: UDSPublishCatalog Description An instance of Integration Object PDS UDS Publish Catalog Interface. This is a required input. Y or N (calculates price or not). Optional. The default value is Y. 0, 1 ,2 (eligibility display mode: 0 do not run; 1 run; 2 run but only return eligible products). Optional. The default value is 1. SiebelContext or ExternalConext. Optional. However, provide ContextMode to run pricing and eligibility. Type Integration Object String String
ContextMode
String
39
Table 21. Name Context
Request Message: UDSPublishCatalog Description An instance of Integration Object PDS Catalog Context. It either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. If ContextMode is provided it is required. LIC or LDC. Visibility algorithm used in addition to a search specification to determine which records will be retrieved. Catalog or Organization. Name of a predefined query. Type Integration Object
LOVLanguageMode ViewMode
String String
NamedSearchSpec
String
Response Message Description: UDSPublishCatalog For a description of this response message, seeTable 22. Table 22. Name SiebelMessageOut Response Message: UDSPublishCatalog Description An instance of Integration Object PDS UDS Publish Catalog Interface. Type Integration Object
8.1 CatalogWebService Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 23. Table 23. 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, see Table 24. Table 24. 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 8.1 Primary Web Services 8.1 Product Configurator Web Service
Table 24.
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.1 CatalogWebService

Request See the following file to view the sample code: ...\81_CatalogWebService\81_CatalogWebService_request.xml Response See the following file to view the sample code: ...\81_CatalogWebService\81_CatalogWebService_response.xml
Message Schema (WSDL) for Siebel 8.1 CatalogWebService

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: ...\81_CatalogWebService\81_CatalogWebService.wsdl
8.1 Product Configurator Web Service

NOTE: This Web service is available only for implementations of version 8.1 of Siebel Business Applications. 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.
41
8.1 Product Configurator Web Service Operations

For a list of operations associated with this Web service, see Table 25. Table 25. Name GetCfgObjectStructure GetCfgObjectGroupItems GetCfgObjectDefaultGroup Items BeginConfiguration UpdateConfiguration EndConfiguration 8.1 Product Configurator Web service operations 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.
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 Objects 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. For a description of this request message, see Table 26. Table 26. Node WebChannelObjStructure Object Name Id ObjectType ParentClassId DisplayName Description Request Message: GetCfgObjectStructure 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.
42
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
43
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
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
45
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
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
47
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
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
49
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
Table 28. Node
Request Message: BeginConfiguration Description Value displayed as number. Value displayed in Boolean format. Date and time value. Selected flag indicates whether this value is selected. Excluded flag indicates whether this value is excluded by a Constraint, Eligibility & Compatibility rule or Promotion. Zero or more. Same recursive structure as that defined above. Linked Items. Linked Items. One or more. Name of linked item. Type of value. Details on the error if any Proceed / Undo. 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. List of messages. Zero or more. Source of the messages (Eligibility, Promotion, Cardinality, Proceed Actions and so on). Message text.
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. For more information, see Table 28. GetCfgObjectGroupItems and GetCfgObjectDefaultGroupItems have the same request and response messages. See the response message description for Begin Configuration for details. For a description of this response message, see Table 29. Table 29. Node BeginConfiguration_Output Error_spcCode Error_spcMessage Response Message Description: Begin Configuration Description Required. Error Code if error occurred. Error Message if error occurred.
51
Table 29. Node RootId
Response Message Description: Begin Configuration Description New item root Id. New item root Integration Id. Quote instance if ReturnFullInstance input parameter was set to Y. See BeginConfiguration Request Message for details. The domain information about products / attributes / relationships as well current selections for the attributes / relationships that was requested in the Request Message. See the Request Message for more details. This indicates whether the request was successful or not and contains messages to be displayed. Required Success / Warning / Error. If StatusCode is 'Success', then everything was ok. If it is 'Warning', then there were some conflicts (messages are present in ListOfMessage) that were automically resolved. If it is 'Error', then there were conflicts (messages are present in ListOfMessage) that could not be resolved and further requests to this session will not be honored.
RootIntegrationId ListOfQuote ListOfData
ListOfStatus Status StatusCode
Request Message Description: UpdateConfiguration For a description of this request message, see Table 30. Table 30. Node UpdateConfiguration_Input ConflictAutoResolve FinishInstanceInFlag SaveInstanceInFlag RepriceInstanceInFlag VerifyInstanceInFlag ListOfData ListOfRequest Requests Request Type Zero or more. Type of request (AddItem, RemoveItem, SetItemQuantitty, SetAttribute, ReplaceItem). Request Message Description: UpdateConfiguration Description Required. Proceed or Undo. If set to Proceed, all conflicts are auto resolved. If set to Undo, any conflict will result in an Undo of the entire batch. If set Y, FinishIt is called. If set Y, Instance is saved to db. If set Y, reprice is called. If set Y, verify instance is called. Same as ListOfData in BeginConfiguration Request Message. List of Requests that will be executed on the product instance.
52
Table 30. Node Item
Request Message Description: UpdateConfiguration Description Zero or more requests. Add product Id for AddItem, ReplaceItem. Quantity. Relationship Id which contains the new product for AddItem, ReplaceItem. Integration Id on which the operation will be performed. Zero or more SetAttribute request details. Name or attribute.
AddProductId Quantity RelationshipId IntegrationId Attribute Name ValueType AttributeValue DisplayValue String Number Integer Date Boolean
Zero or more. New display value of attribute Value displayed in a string. Value displayed as number. Value displayed as integer. Date. Value displayed in Boolean format.
Response Message Description: UpdateConfiguration For a description of this response message, see Table 31. Table 31. Node UpdateConfiguration_Output Error_spcCode Error_spcMessage FinishConfigurationOutFlag RepriceOutFlag SaveInstanceOutFlag VerifyOutFlag Response Message Description: UpdateConfiguration Description Required. Error Code if error occurred. Error Message if error occurred. Y or N. Indicates whether Finish Configuration was performed. It might not be performed if there were some errors. Y or N. Indicates whether Reprice was done. It might not be performed if there were some errors. Y or N. Indicates whether Save Instance was done. It might not be performed if there were some conflicts. Y or N. Indicates whether Verify was done. It might not be performed if there were some errors.
53
Table 31. 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. For more details, see Table 30 on page 52. This indicates whether the request was successful or not and contains messages to be displayed. For more information, see Table 29 on page 51.
ListOfData
ListOfStatus
Request Message Description: EndConfiguration For a description of this request message, see Table 32 Table 32. 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 33. Table 33. Node EndConfiguration_Output Error_spcCode Error_spcMessage ListOfQuote Response Message Description: EndConfiguration Description Required. Error Code if error occurred. Error Message if error occurred. Quote instance. For more information, see Table 28 on page 48.
8.1 Product Configurator Web Service Application Interface

54
Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 34. Table 34. Name Cfg Object Broker ConfiguratorWebChannelBeginConfig ConfiguratorWebChannelUpdateConfig ConfiguratorWebChannelEndConfig 8.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, see Table 35. Table 35. 8.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, see Table 36. Table 36. 8.1 Product Configurator Methods Method GetObjStructure GetObjGroupItems GetObjDefaultGroupItems
Operation GetCfgObjectStructure GetCfgObjectGroupItems GetCfgObjectDefaultGroupItems
Example Package for ProductConfigurator

Request (GetObjDefaultGroupItems) See the following file to view the sample code:
55
Siebel 8.1 Primary Web Services 8.1 PromotionWebService
...\81_ProductConfigurator\GetObjDefaultGroupItems_request.xml Response (GetObjDefaultGroupItems) See the following file to view the sample code: ...\81_ProductConfigurator\GetObjDefaultGroupItems_response.xml Request (GetObjGroupItems) See the following file to view the sample code: ...\81_ProductConfigurator\GetObjGroupItems_request.xml Response (GetObjGroupItems) See the following file to view the sample code: ...\81_ProductConfigurator\GetObjGroupItems_response.xml Request (GetObjStructure) See the following file to view the sample code: ...\81_ProductConfigurator\GetObjStructure_request.xml Response (GetObjStructure) See the following file to view the sample code: ...\81_ProductConfigurator\GetObjStructure_response.xml
Message Schema (WSDL) for ProductConfigurator

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: ...\81_ProductConfigurator\81_ProductConfigurator.wsdl
8.1 PromotionWebService
NOTE: This Web service is available only for implementations of version 8.1 of Siebel Business Applications. Use this Web service to get product promotion information, apply product promotion, get promotion commitment information and to upgrade a promotion.
56
8.1 PromotionWebService Operations

For a list of operations associated with this Web service, see Table 37. Table 37. Name getProductPromotionDefinition ApplyProductPromotion getPromotionCommitments UpgradePromotionToQuote UpgradePromotionToOrder 8.1 PromotionWebService Operations Description Returns promotion detail information. Add a promotion and all default components to a quote or order. Get promotion commitment information for a given promotion asset. Upgrade or migrate a promotion instance to another promotion and generate a quote with the updated assets information. Upgrade or migrate a promotion instance to another promotion and generate an order with the updated assets information.
Request Message Description: GetProductPromotionDefinition For a description of this request message, see Table 38. Table 38. Name EligibilityMode PricingMode LoadAllDomainFlag LoadDefaultDomainFlag LoadPromDefFlag ContextMode Context ProdPromRuleType Request Message Description: GetProductPromotionDefinition Description Optional, default value as 2. Could be 0, 1, 2. Optional, default value as Y. Y or N. Required value of Y or N. Required value of Y or N. Required value of Y or N. Required, Siebel Context or External Context. Required, in SiebelMessage format of IO 'PDS Catalog Context. Optional, Product or Pricing. Type Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable
57
Response Message Description: GetProductPromotionDefinition For a description of this response message, see Table 39. Table 39. Name ProdPromDefinition PromDomainProduct Response Message Description: GetProductPromotionDefinition Description In SiebelMessage format of Integration Object ISS Promotion Definition for WS. In SiebelMessage format of Integration Object PDS Product Interface'. Could be either default domain product details or all domain product details depending on input arguments. Error Code if error occurred. Error Message 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 40. Table 40. Name EligibilityMode PricingMode ProdPromId ProdPromInstanceId LineItemId Quantity SiebelMessage Request Message Description: ApplyProductPromotion Description Optional, default value as '2'. Could be 0, 1, 2. Optional, default value as Y. Y or N. Required. Optional, depending on usage scenarios. Optional, depending on usage scenarios. Optional. Default value is 1. Required, in SiebelMessage format of Integration Object PDS Quote. 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, see Table 41. Table 41. Name SiebelMessage Err_spcCode Err_spcMessage Response Message Description: ApplyProductPromotion Description Required. In SiebelMessage format of the Integration Object PDS Quote. Error Code if error occurred. Error Message if error occurred. Type Not applicable Not applicable Not applicable
58
Request Message Description: getPromotionCommitments For a description of this request message, see Table 42. Table 42. Name Asset Integration Id Request Message Description: getPromotionCommitments Description Required. Asset Integration Id of the Promotion Instance Asset. Type String
Response Message Description: getPromotionCommitments For a description of this response message, see Table 43. Table 43. Name PromotionCommitments Response Message Description: getPromotionCommitments Description An instance of the Integration Object ISS Promotion Commitments. Type Integration Object
Request Message Description: UpgradePromotionToQuote For a description of this request message, see Table 44. Table 44. Name NewPromotionId AssetNumber AssetIntegrationId ActiveDocumentId Request Message Description: UpgradePromotionToQuote Description Required. RowId of new promotion. Asset Number of the selected promotion asset. Provide either AssetNumber or AssetIntegrationId. Asset Integration Id of the selected promotion asset. Provide either AssetNumber or AssetIntegrationId. Document in Order Management means a Quote or an Order. Each Document can have multiple children (Quote Items or Order Line Items). ActiveDocumentId means the current active Document that the current process is working on. In this Web service call, it is the Quote Id of the active Quote to which the generated quote item has to be added. This is an optional input. Account Id of the account that owns the selected promotion asset being upgraded. Penalty Amount for upgrading the promotion, if any. If there is a penalty for upgrading the promotion, also pass in the prorate plan used to prorate this penalty, if any. Type String String String String
AccountId OverridePenaltyAmount OverrideProratePlanId
String String String
59
Response Message Description: UpgradePromotionToQuote For a description of this response message, see Table 45. Table 45. Name QuoteIO Response Message Description: UpgradePromotionToQuote Description An instance of the integration object PDS Quote. Type Integration Object
Request Message Description: UpgradePromotionToOrder For a description of this request message, see Table 46. Table 46. Name NewPromotionId AssetNumber AssetIntegrationId ActiveDocumentId Request Message Description: UpgradePromotionToOrder Description Required. RowId of new promotion. Asset Number of the selected promotion asset. Provide either AssetNumber or AssetIntegrationId. Asset Integration Id of the selected promotion asset. Provide either AssetNumber or AssetIntegrationId. Document in Order Management means a Quote or an Order. Each Document can have multiple children (Quote Items or Order Line Items). ActiveDocumentId means the current active Document that the current process is working on. In this Web service call, it is the Order Id of the active Order to which the generated order item has to be added. This is an optional input. Account Id of the account that owns the selected promotion asset being upgraded. Penalty amount for upgrading the promotion, if any. If there is a penalty for upgrading the promotion, also pass in the prorate plan used to prorate this penalty, if any. Type String String String String
AccountId OverridePenaltyAmount OverrideProratePlanId
Response Message Description: UpgradePromotionToOrder For a description of this response message, see Table 47. Table 47. Name OrderIO Response Message Description: UpgradePromotionToOrder Description An instance of the integration object PDS Order. Type Integration Object
60
8.1 PromotionWebService Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 48. Table 48. Name ISS Promotion WS - GetPromotionCommitments ISS Promotion WS-Upgrade Promotion-Quote ISS Promotion WS-Upgrade Promotion-Order 8.1 PromotionWebService Service Objects Boundary Object Type Workflow Workflow Workflow
Data Object (Integration Object) For a description of data objects for this Web service, see Table 49. Table 49. 8.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

Request See the following file to view the sample code: ...\81PromotionWebService\81PromotionWebService_request.xml Response See the following file to view the sample code: ...\81PromotionWebService\81PromotionWebService_response.xml
61
Siebel 8.1 Primary Web Services 8.1 WebMarketing
Message Schema (WSDL) for 8.1 PromotionWebService

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: ...\81_PromotionWebService\81_PromotionWebService.wsdl
8.1 WebMarketing
NOTE: This Web service is available only for implementations of version 8.1 of Siebel Business Applications. Following four new operations have been added to this Web service in Siebel Marketing 8.1. For more information on previous operations, see WebMarketing on page 397.
8.1 WebMarketing Operations

For a list of operations associated with this Web service, see Table 50. Table 50. Name EmailMarketingForwardToFriend EmailMarketingUpdateJobStatus UpdateCampaignRecipient CheckModuleLicense 8.1 WebMarketing Operations Description To forward campaign details to a list of forwardees. Use to update the job status of the task submitted for sending email. Updates the info of a campaign recipient. To check if a particular module is licensed.
Request Message Description: EmailMarketingForwardToFriend Calls Email Marketing - Forward to Friend to forward the emails. For a description of this request message, see Table 51. Table 51. 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. The campaign Id of the campaign for which the info is being forwarded. List of forwardees. Campaign contact Id of the forwarder. Contact Id of the forwarder. Type String String Integration Object String String
62
Table 51. Node
Request Message Description: EmailMarketingForwardToFriend Description Message that the forwarder sends across along with the mails. The prospect Id of the forwarder. Id of the offer for which the email is being sent. The type of response. 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 52. Table 52. Node Dummy Response Message Description: EmailMarketingForwardToFriend Description Error code for the process (OK or NOTOK). Type String
Request Message Description: EmailMarketingUpdateJobStatus This operation is called by Boldfish when a createMailing job is done. It updates the status in the marketing system task table. For a description of this request message, see Table 53. Table 53. Node BatchNumber ErrorCode OfferId OfferName TaskId WaveId Request Message Description: EmailMarketingUpdateJobStatus Description Batch number of the job. Error code (if any) that needs to be passed for the job. The current offer. The name of the offer. Task Id. The campaign wave Id. Type String String String String String String
Response Message Description: EmailMarketingUpdateJobStatus For a description of this response message, see Table 54. Table 54. Node Dummy Response Message Description: EmailMarketingUpdateJobStatus Description Error code for the process (OK or NOTOK). Type String
63
Request Message Description: UpdateCampaignRecipient Calls EAI Siebel Adapter service to update campaign recipients. For a description of this request message, see Table 55. Table 55. Node CampaignRecipientMsgIn LOVLanguageMode Request Message Description: UpdateCampaignRecipient Description The campaign recipient info that needs to be updated. The language mode. Type Integration Object String
Response Message Description: UpdateCampaignRecipient For a description of this response message, see Table 56. Table 56. Node CampaignRecipientMsgOut Response Message Description: UpdateCampaignRecipient Description The updated campaign recipient info. 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. For a description of this request message, see Table 57. Table 57. Node ModuleName Request Message Description: CheckModuleLicense Description The module name which needs to be checked. Type String
Response Message Description: CheckModuleLicense For a description of this response message, see Table 58. Table 58. Node IsModuleLicensed Response Message Description: CheckModuleLicense Description Y or N according as the module is licensed or not respectively. Type String
8.1 WebMarketing Application Interface

64
Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 59. Table 59. Name Email Marketing - Forward to Friend Email Marketing - Update Status Mktg System Task Service Server Requests EAI Siebel Adapter Mktg List Export Service 8.1 WebMarketing Service Objects Boundary Object Type Workflow Workflow Business Service Business Service Business Service Business Service Class Not applicable. Not applicable. CSSSystemTaskService CSSSrmService CSSEAISiebelAdapterService CSSListExportService
Data Object (Integration Object) For a description of data objects for this Web service, see Table 60. Table 60. 8.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.1 WebMarketing

Request (EmailMarketingForwardToFriend) To view the sample code, see the following files in the WebServices ZIP download in the Siebel Bookshelf documentation library on Oracle Technology Network: ...\81_WebMarketing\EmailMktgFwdToFriend_request.xml Response (EmailMarketingForwardToFriend) To view the sample code, see the following files in the WebServices ZIP download in the Siebel Bookshelf documentation library on Oracle Technology Network: ...\81_WebMarketing\EmailMktgFwdToFriend_response.xml
65
Request (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: ...\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: ...\81_WebMarketing\EmailMarketingUpdateJobStatus_request.xml Request (UpdateCampaignRecipient) To view the sample code, see the following files in the WebServices ZIP download in the Siebel Bookshelf documentation library on Oracle Technology Network: ...\81_WebMarketing\UpdateCampaignRecipient_request.xml Response (UpdateCampaignRecipient) To view the sample code, see the following files in the WebServices ZIP download in the Siebel Bookshelf documentation library on Oracle Technology Network: ...\81_WebMarketing\UpdateCampaignRecipient_response.xml Request (CheckModuleLicense) To view the sample code, see the following files in the WebServices ZIP download in the Siebel Bookshelf documentation library on Oracle Technology Network: \81_WebMarketing\CheckModuleLicense_request.xml Response (CheckModuleLicense) To view the sample code, see the following files in the WebServices ZIP download in the Siebel Bookshelf documentation library on Oracle Technology Network: \81_WebMarketing\CheckModuleLicense_response.xml
Message Schema (WSDL) for 8.1 WebMarketing

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: \81_WebMarketing\81_WebMarketing.wsdl
66
Siebel 8.1 Primary Web Services Account
Account
Use this Web service for the basic Siebel Marketing operations such as creating and updating accounts.
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, see Table 61 Table 61. Name AccountCreateAccount AccountUpdateAccount Account Operations Description Creates an account. Updates an existing account.
Request Message Description: AccountCreateAccount For a description of this request message, see Table 62. Table 62. Node Account IO Request Message Description: AccountCreateAccount Description Required. An instance of the integration object Account Integration Object. Account is the Parent header and Account_BusinessAddress is the child. Type Integration Object
Response Message Description: AccountCreateAccount For a description of this response message, see Table 63. Table 63. 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. Error message if any. Flag to indicate success or failure of the operation. Type String String String
67
Siebel 8.1 Primary Web Services Account
Request Message Description: AccountUpdateAccount For a description of this request message, see Table 64. Table 64. Node Account IO Request Message Description: AccountUpdateAccount Description Required. An instance of the integration object Account Integration Object. Account is the Parent header and Account_BusinessAddress is the child. Type Integration Object
Response Message Description: AccountUpdateAccount For a description of this response message, see Table 65. Table 65. Node Error Message Success Flag Response Message Description: AccountUpdateAccount Description Error message if any. Flag to indicate success or failure of the operation. Type String String
Account Application Interface

Data Object (Integration Object) For a description of data objects for this Web service, see Table 66 Table 66. Account Data Object External Name Account IO
Siebel Repository Name Account IO
Example Package for Account

Request (AccountCreate) See the following file to view the sample code: \Account\AccountCreate_request.xml
68
Siebel 8.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.xml
Response (AccountUpdate) See the following file to view the sample code: \Account\AccountUpdate_response.xml
Message Schema (WSDL) for Account

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: \Account\Account.wsdl
AssetManagementComplex
To display the detail of a promotion, CP, or bundle asset, i.e., display the related products for a promotion, the child items for a CP or bundle asset.
AssetManagementComplex Operations
The following operations are used for the AssetManagementComplex Web service. For a list of operations associated with this Web service, see Table 67. Table 67. Name AssetManagementComplexQueryPageQuoteAddItems AssetManagementComplex Operations Description It fetches the details of promotion, CP or bundle asset.
Request Message Description: AssetManagementComplexQueryPage Asset ManagementComplex web service is called to query for the details of a promotion, CP, or bundle asset. Displays the related products for promotion, child items for a CP or bundle asset.
69
For a description of this request message, see Table 68. Table 68. 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
Table 68. 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, see Table 69. Table 69. 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
71
Table 69. 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

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 70. Table 70. Name Asset Management Complex AssetManagementComplext Service Object Boundary Object Type Business Service Class CSSEAIUIDataService
72
Siebel 8.1 Primary Web Services CMU Account Query
Data Object (Integration Object) For a description of data objects for this Web service, see Table 71. Table 71. AssetManagementComplext Data Objects External Name SiebelMessage SiebelMessage SiebelMessageOut
Siebel Repository Name SiebelMessage SiebelMessageIn SiebelMessageOut
Example Package for AssetManagementComplex

Request
See the following file to view the sample code: \AssetManagementComplex\AssetManagementComplex_request.xml
Response
See the following file to view the sample code: \AssetManagementComplex\AssetManagementComplex_response.xml
Message Schema (WSDL) for AssetManagementComplex

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: \AssetManagementComplex\AssetManagementComplex.wsdl
CMU Account Query

Use this Web service to find an account detail in the Siebel CRM application. 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. The account detail that this Web service finds includes details about the contacts, addresses, and billing profiles that are associated with the account. This detail includes only those fields that the billing application needs to synchronize data.
73
Siebel 8.1 Primary Web Services CMU Account Query
The response message returns only an acknowledgement message and not data.
CMU Account Query Operations

For a list of operations associated with this Web service, see Table 72. Table 72. Name CMU Account Query Page CMU Account Query Operations Description Finds the account detail based on the account ID and the billing profile ID.
Request Message Description: CMU Account Query Page For a description of this request message, see Table 73. Table 73. Node AccountId BillingProfileId Request Message Description: CMU Account Query Page Description The ID of the account for the billing profile. The ID of the billing profile for the account.
CMU Account Query Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 74. Table 74. 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 75. Table 75. CMU Account Query Data Object External Name CMU - Account
Siebel Repository Name CMU Query Account Io
74
Siebel 8.1 Primary Web Services CMU Account Update
Methods For a description of methods for this Web service, see Table 76. Table 76. CMU Account Query Methods Method [BS: CMU Account Query Service].QueryPage
Operation CMU Account QueryPage
Example Package for CMU Account Query

Request See the following file to view the sample code: ...\CMUAccountQuery\CMUAccountQuery.xml Response See the following file to view the sample code: ...\CMUAccountQuery\CMUAccountQuery.xml
Message Schema (WSDL) for CMU Account Query

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: ...\CMUAccountQuery\CMUAccountQuery.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. The billing application makes this inbound Web service call to the Siebel CRM application to update the status of the account. 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.
75
Siebel 8.1 Primary Web Services CMU Account Update
CMU Account Update Operations

For a list of operations associated with this Web service, see Table 77. Table 77. 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.
Request Message Description: CMU Account Update For a description of this request message, see Table 78. Table 78. Node AccountId AccountStatus Request Message Description: CMU Account Update Description The ID of the account for the billing profile. The status of the account that was updated in the billing application.
CMU Account Update Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 79. Table 79. 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, see Table 80. Table 80. CMU Account Update Data Object External Name Account
Siebel Repository Name CMU Update Account Io
76
Siebel 8.1 Primary Web Services Contact
Methods For a description of methods for this Web service, see Table 81. Table 81. CMU Account Update Methods Method [BS: CMU Account Update].Update
Operation CMU Account Update
Example Package for CMU Account Update

Request See the following file to view the sample code: ...\CMUAccountUpdate\CMUAccountUpdate.xml Response See the following file to view the sample code: ...\CMUAccountUpdate\CMUAccountUpdate.xml
Message Schema for Account Update

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: ...\CMUAccountUpdate\CMUAccountUpdate.wsdl
Contact
Use this Web service for the basic operations of Siebel Marketing such as to create and update contacts.
77
Contact Operations
For a list of operations associated with this Web service, see Table 82. Table 82. Name ContactCreateContact ContactUpdateContact contact Operations Description Creates a contact. Updates an existing contact.
Request Message Description: ContactCreateContact For a description of this request message, see Table 83. Table 83. Node Contact IO Request Message Description: ContactCreateContact Description Required. An instance of the integration object Contact IO. Contact is the Parent header and Contact_BusinessAddress is the child. Type Integration Object
Response Message Description: ContactCreateContact For a description of this response message, see Table 84. Table 84. 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. Error Message if any. Flag to indicate success or failure of the operation. Type String String String
Request Message Description: ContactUpdateContact For a description of this request message, see Table 85. Table 85. Node Contact IO Request Message Description: ContactUpdateContact Description Required. An instance of the integration object Contact IO. Contact is the Parent header and Contact_BusinessAddress is the child. Type Integration Object
78
Response Message Description: ContactUpdateContact For a description of this response message, see Table 86. Table 86. Node Error Message Success Flag Response Message Description: ContactUpdateContact Description Error message if any. Flag to indicate success or failure of the operation. Type String String
Contact Application Interface

Data Object (Integration Object) For a description of data objects for this Web service, see Table 87. Table 87. Contact Data Object External Name Contact IO
Siebel Repository Name Contact IO
Example Package for Contact

Request (ContactCreate) See the following file to view the sample code: \Contact\ContactCreate_request.xml
Response (ContactCreate) See the following file to view the sample code: \Contact\ContactCreate_response.xml
Request (ContactUpdate) See the following file to view the sample code: \Contact\ContactUpdate_request.xml
79
Siebel 8.1 Primary Web Services ESB_AccountBalanceSiebelReqABCS_Service
Response (ContactUpdate) See the following file to view the sample code: \Contact\ContactUpdate_response.xml
Message Schema (WSDL) for Contact

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: \Contact\Contact.wsdl
ESB_AccountBalanceSiebelReqABCS_Se rvice
Use this Web service to retrieve information about the balance summary, balance groups, and balance details for a billing profile. This Web service retrieves the information from the billing application.
ESB_AccountBalanceSiebelReqABCS_Service Operations
For a list of operations associated with this Web service, see Table 88. Table 88. Name QueryBalanceSummary QueryBalanceDetails ESB_AccountBalanceSiebelReqABCS_Service Operations Description Retrieves the balance summary information for a billing profile. Retrieves the balance group and balance detail information for a billing profile.
Request Message Description: QueryBalanceSummary For a description of this request message, see Table 89. Table 89. Node AccountId AccountName MaximumNumberOfRecords CurrencyCode Request Message Description: QueryBalanceSummary Description The ID of the account for the billing profile. The name of the account for the billing profile. The maximum number of records to retrieve from the external system. The currency code of the account for the billing profile.
80
Table 89. Node
Request Message Description: QueryBalanceSummary Description The name of the billing profile for the account. The ID of the billing profile for the account.
BillingProfileName BillingProfileId
Response Message Description: QueryBalanceSummary For a description of this response message, see Table 90. Table 90. Node CmuBalanceSummaryVbc Response Message Description: QueryBalanceSummary Description The attributes of the balance summary.
Request Message Description: QueryBalanceDetails For a description of this request message, see Table 91. Table 91. Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId Request Message Description: QueryBalanceDetails Description The ID of the account for the billing profile. The name of the account for the billing profile. The maximum number of records to retrieve from the external system. The currency code of the account for the billing profile. The name of the billing profile for the account. The ID of the billing profile for the account.
Response Message Description: QueryBalanceDetails For a description of this response message, see Table 92. Table 92. Node CmuBalanceGroupVbc CmuBalanceVbc CmuBalanceDetailsVbc CmuBalanceGroupServicesVbc Response Message Description: QueryBalanceDetails Description The attributes of the balance group. The attributes of the balances for the balance group. The attributes of the balance details for the balance. The attributes of the service charges for the balance group.
81
ESB_AccountBalanceSiebelReqABCS_Service Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 93. Table 93. 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, see Table 94. Table 94. 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, see Table 95. Table 95. ESB_AccountBalanceSiebelReqABCS_Service Methods Method [BS:AccountBalanceSiebelReqABCS].QueryBalanceSummary [BS:AccountBalanceSiebelReqABCS].QueryBalanceDetails
Operation QueryBalanceSummary QueryBalanceDetails
Example Package for ESB_AccountBalanceSiebelReqABCS_Service

Request See the following file to view the sample code: ...\AccountBalanceSiebelReqABCS\QueryBalanceDetailsReqMsg.xml
82
Siebel 8.1 Primary Web Services ESB_AdjustmentSiebelReqABCS_Service
Response See the following file to view the sample code: ...\AccountBalanceSiebelReqABCS\QueryBalanceDetailsRespMsg.xml
Message Schema (WSDL) for ESB_AccountBalanceSiebelReqABCS_Service

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: ...\AccountBalanceSiebelReqABCS\AccountBalanceSiebelReqABCSService.xml
ESB_AdjustmentSiebelReqABCS_Service
Use this Web service to adjust the bills, item charges, events, and resource balances in a billing profile. Also, use this Web service to retrieve adjustment information for a billing profile.
ESB_AdjustmentSiebelReqABCS_Service Operations
For a list of operations associated with this Web service, see Table 96. Table 96. Name Create Adjustment QueryAdjustment ESB_AdjustmentSiebelReqABCS_Service Operations Description Creates an adjustment for a bill, item charge, event, and resource balance in a billing profile. Retrieves the adjustments for a bill in a billing profile.
83
Request Message Description: CreateAdjustment (Bill Adjustment) The following request and response message information applies to an adjustment for a bill. For a description of this request message, see Table 97. Table 97. 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 ID of the billing profile for the account. The row ID of the adjustment record. The adjustment level (for example, Bill). The date the adjustment is approved. The reason for the adjustment. The type of tax for the adjustment (for example, Include Tax or Exclude Tax). The status of the adjustment. By default, the status is Open. The ID of the bill for the adjustment in the billing application. Comments that the user enters about the adjustment. The approved amount for the adjustment. If this node is included, the ApprovedPercentage node is excluded. The approved percentage for the adjustment. If this node is included, the ApprovedAmt node is excluded.
Response Message Description: CreateAdjustment (Bill Adjustment) For a description of this response message, see Table 98.
Table 98. Node
Response Message Description: CreateAdjustment Description The attributes of the adjustment in the header for the bill in the billing profile.
FsInvoiceAdjustment
84
Request Message Description: Create Adjustment (Item Charge, Event, Resource Balance) The following request and response message information applies to an adjustment for an item charge, event, and resource balance. For a description of this request message, see Table 99. Table 99. 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 ID of the billing profile for the account. The row ID of the adjustment record. The adjustment level (for example, Item Charge, Event Details, and Resource Impact). The date the adjustment is approved.
The following nodes apply to the SiaInvoiceAdjustmentExternalItems node: ReasonForRequest TaxType Status IntegrationId ApprovedDescription ResourceType ApprovedCurrencyCode ApprovedAmt ApprovedPercentage ApprovedValue The reason for the adjustment. The type of tax for the adjustment (for example, Include Tax or Exclude Tax). The status of the adjustment. By default, the status is Open. The ID of the bill for the adjustment in the billing application. Comments that the user enters about the adjustment. The type of resource for the adjustment (for example, Currency or Non Currency). The currency code for the adjustment (for example, USD). The approved amount for the adjustment. If this node is included, the ApprovedPercentage and ApprovedValue nodes are excluded. The approved percentage for the adjustment. If this node is included, the ApprovedAmt and ApprovedValue nodes are excluded. The approved value for the adjustment. If this node is included, the ApprovedAmt and ApprovedPercentage nodes are excluded. This node applies only to a resource balance adjustment.
85
Response Message Description: Create Adjustment (Item Charge, Event, Resource Balance) For a description of this response message, see Table 100. Table 100. 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, event, and resource balance in the billing profile.
Request Message Description: QueryAdjustment For a description of this request message, see Table 101. Table 101. Request Message Description: QueryAdjustment Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId BillPOID Description The ID of the account for the billing profile. The name of the account for the billing profile. The maximum number of records to retrieve from the external system. The currency code of the account for the billing profile. The name of the billing profile for the account. The ID of the billing profile for the account. The ID of the bill.
Response Message Description: QueryAdjustment For a description of this response message, see Table 102. Table 102. Response Message Description: QueryAdjustment Node CmuBilledUsageArItemsVbc Description The attributes of the adjustments for the bill in the billing profile.
ESB_AdjustmentSiebelReqABCS_Service Application Interface

86
Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 103. 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, see Table 104. 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 105. Table 105. ESB_AdjustmentSiebelReqABCS_Service Methods Operation CreateAdjustment QueryAdjustment Method [BS:AdjustmentSiebelReqABCS].CreateAdjustment [BS:AdjustmentSiebelReqABCS].QueryAdjustment
Example Package for ESB_AdjustmentSiebelReqABCS_Service

Request See the following file to view the sample code: ...\AdjusmentSiebelReqABCS\QueryAdjustmentRequestMessage.xml Response See the following file to view the sample code: ...\AdjustmentSiebelReqABCS\QueryAdjustmentResponseMessage.xml
87
Siebel 8.1 Primary Web Services ESB_InvoiceSiebelReqABCS_Service
Message Schema (WSDL) for ESB_AdjustmentSiebelReqABCS_Service

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: ...\AdjustmentSiebelReqABCS\ESB_AdjustmentSiebelReqABCS_Service
ESB_InvoiceSiebelReqABCS_Service
Use this Web service to retrieve bill, usage, event, and resource balance information for bills in a billing profile. This Web service retrieves the information from the billing application.
Operations for ESB_InvoiceSiebelReqABCS_Service

For a list of operations associated with this Web service, see Table 106. Table 106. Operations for ESB_InvoiceSiebelReqABCS_Service Operation Name QueryInvoiceList QueryInvoice QueryEventDetails SearchEventDetails QueryResourceBalance Description Retrieves the bills for a billing profile. Retrieves the detail for a bill. Retrieves the billed event (for example, phone call) detail for an item charge. Finds the billed event detail based on data in the From Amount, To Amount, Start Date, and End Date fields. Retrieves the non-currency resource balance detail for a billed event.
88
Request Message Description: QueryInvoiceList For a description of this request message, see Table 107. Table 107. Request Message Description: QueryInvoiceList Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId Description The ID of the account for the billing profile. The name of the account for the billing profile. The maximum number of records to retrieve from the external system. The currency code of the account for the billing profile. The name of the billing profile for the account. The ID of the billing profile for the account.
Response Message Description: QueryInvoiceList For a description of this response message, see Table 108 Table 108. Response Message Description: QueryInvoiceList Node CmuInvoiceVbc Description The attributes of the header for the bills.
Request Message Description: QueryInvoice For a description of this request message, see Table 109 Table 109. Request Message Description: QueryInvoice Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId BillPOID Description The ID of the account for the billing profile. The name of the account for the billing profile. The maximum number of records to retrieve from the external system. The currency code of the account for the billing profile. The name of the billing profile for the account. The ID of the billing profile for the account. The ID of the bill.
89
Response Message Description: QueryInvoice For a description of this response message, see Table 110. Table 110. Response Message Description: QueryInvoice Node CmuBilledUsageServiceChargesVbc CmuBilledUsageItemChargesVbc Description The attributes of the billed service charges. The attributes of the billed item charges.
Request Message Description: QueryEventDetails For a description of this request message, see Table 111. Table 111. 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. The maximum number of records to retrieve from the external system. The currency code of the account for the billing profile. The name of the billing profile for the account. The ID of the billing profile for the account. The ID of the bill. The ID of the item charge.
Response Message Description: QueryEventDetails For a description of this response message, see Table 112. Table 112. Response Message Description: QueryEventDetails Node CmuCdrDetailsVbc Description The attributes of the billed events.
90
Request Message Description: SearchEventDetails For a description of this request message, see Table 113. 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. The name of the account for the billing profile. The maximum number of records to retrieve from the external system. The currency code of the account for the billing profile. The name of the billing profile for the account. The ID of the billing profile for the account. The ID of the bill. The ID of the item charge. The starting date of the event. The ending date of the event. The minimum amount of the event. The maximum amount of the event.
Response Message Description: SearchEventDetails For a description of this response message, see Table 114. Table 114. Response Message Description: SearchEventDetails Node CmuCdrDetailsVbc Description The attributes for the billed events.
Request Message Description: QueryResourceBalance For a description of this request message, see Table 115. Table 115. Request Message Description: QueryResourceBalance Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName Description The ID of the account for the billing profile. The name of the account for the billing profile. The maximum number of records to retrieve from the external system. The currency code of the account for the billing profile. The name of the billing profile for the account.
91
Table 115. Request Message Description: QueryResourceBalance Node BillingProfileId BillPOID ItemChargeId EventId Description The ID of the billing profile for the account. The ID of the bill. The ID of the item charge. The ID of the event.
Response Message Description: QueryResourceBalance For a description of this response message, see Table 116. Table 116. Response Message Description: QueryResourceBalance Node CmuCdrBalanceDetailsVbc Description The attributes of the non-currency resource balances for the billed event.
ESB_InvoiceSiebelReqABCS_Service Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 117. 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, see Table 118. Table 118. 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
Table 118. 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, see Table 119. Table 119. ESB_InvoiceSiebelReqABCS_Service Methods Operation QueryInvoiceList QueryInvoice QueryEventDetails SearchEventDetails QueryResourceBalance Method [BS:InvoiceSiebelReqABCS].QueryInvoiceList [BS:InvoiceSiebelReqABCS].QueryInvoice [BS:InvoiceSiebelReqABCS].QueryEventDetails [BS:InvoiceSiebelReqABCS].SearchEventDetails [BS:InvoiceSiebelReqABCS].QueryResouceBalance
Example Package for ESB_InvoiceSiebelReqABCS_Service

Request
See the following file to view the sample code: ...\InvoiceSiebelReqABCS\QueryInvoiceListReqMsg.xml
Response
See the following file to view the sample code: ...\InvoiceSiebelReqABCS\QueryInvoiceListRespMsg.xml
Message Schema (WSDL) for ESB_InvoiceSiebelReqABCS_Service

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:
93
Siebel 8.1 Primary Web Services ESB_PaymentSiebelReqABCS_Service
...\InvoiceSiebelReqABCS\InvoiceSiebelReqABCSService.xml
ESB_PaymentSiebelReqABCS_Service
Use this Web service to pay the bills in a billing profile. This Web service transfers payments that users create to the billing application, and the billing application processes these payments. Also, use this Web service to retrieve payment information for the bills in a billing profile. This Web service retrieves the payment information from the billing application.
ESB_PaymentSiebelReqABCS_Service Operations
For a list of operations associated with this Web service, see Table 120. Table 120. ESB_PaymentSiebelReqABCS_Service Operations Operation Name CreatePayment CreateInvoicePayment QueryPayment QueryInvoicePayment SearchPayment Description Creates a payment for a billing profile. Creates a payment for a bill in a billing profile. Retrieves the payments for a billing profile. Retrieves the payments for a bill in a billing profile. Finds the payment detail for a billing profile based on data in the Minimum Amount, Maximum Amount, Start Date, and End Date fields.
Request Message Description: CreatePayment For a description of this request message, see Table 121. Table 121. 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.
Response Message Description: CreatePayment For a description of this response message, see Table 122. Table 122. 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.
94
Request Message Description: CreateInvoicePayment For a description of this request message, see Table 123. Table 123. 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.
Response Message Description: CreateInvoicePayment For a description of this response message, see Table 124. 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 125. Table 125. Request Message Description: QueryPayment Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId Description The ID of the account for the billing profile. The name of the account for the billing profile. The maximum number of records to retrieve from the external system. The currency code of the account for the billing profile. The name of the billing profile for the account. The ID of the billing profile for the account.
Response Message Description: QueryPayment For a description of this response message, see Table 126. Table 126. Response Message Description: QueryPayment Node CmuBillingProfilePaymentsVbc Description The attributes of the payments for the billing profile.
95
Request Message Description: QueryInvoicePayment For a description of this request message, see Table 127. Table 127. Request Message Description: QueryInvoicePayment Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId BillPOID Description The ID of the account for the billing profile. The name of the account for the billing profile. The maximum number of records to retrieve from the external system. The currency code of the account for the billing profile. The name of the billing profile for the account. The ID of the billing profile for the account. The ID of the bill.
Response Message Description: QueryInvoicePayment For a description of this response message, see Table 128. Table 128. Response Message Description: QueryInvoicePayment Node CmuBilledUsagePaymentsVbc Description The attributes of the payments for the bill.
Request Message Description: SearchPayment For a description of this request message, see Table 129. Table 129. 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 name of the account for the billing profile. The maximum number of records to retrieve from the external system. The currency code of the account for the billing profile. The name of the billing profile for the account. The ID of the billing profile for the account. The starting date of the payment. The ending date of the payment. The minimum amount of the payment. The maximum amount of the payment.
96
Response Message Description: SearchPayment For a description of this response message, see Table 130. Table 130. Response Message Description: SearchPayment Node CmuBillingProfilePaymentsVbc Description The attributes of the payments for the billing profile.
ESB_PaymentSiebelReqABCS_Service Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 131. Table 131. 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, see Table 132. Table 132. 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
97
Siebel 8.1 Primary Web Services ESB_UnbilledUsageSiebelReqABCS_Service
Methods For a description of the methods for this Web service, see Table 133. Table 133. ESB_PaymentSiebelReqABCS_Service Methods Operation CreatePayment CreateInvoicePayment QueryPayment QueryInvoicePayment SearchPayment Method [BS: PaymentReceiptSiebelABCS].CreatePayment [BS: PaymentReceiptSiebelABCS].CreateInvoicePayment [BS: PaymentReceiptSiebelABCS].QueryPayment [BS: PaymentReceiptSiebelABCS].QueryInvoicePayment [BS: PaymentReceiptSiebelABCS].SearchPayment
Example Package for ESB_PaymentSiebelReqABCS_Service

Request
See the following file to view the sample code: ...\PaymentReceiptSiebelABCS\QueryPaymentRequestMessage.xml
Response
See the following file to view the sample code: ...\PaymentReceiptSiebelABCS\QueryPaymentResponseMessage.xml
Message Schema (WSDL) for ESB_PaymentSiebelReqABCS_Service

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: ...\PaymentReceiptSiebelABCS\PaymentReceiptSiebelABCSService.xml
ESB_UnbilledUsageSiebelReqABCS_Serv ice
Use this Web service to retrieve usage, event, and resource balance information that is not yet billed for a billing profile. This Web service retrieves the information from the billing application.
98
ESB_UnbilledUsageSiebelReqABCS_Service Operations
For a list of operations associated with this Web service, see Table 134. Table 134. ESB_UnbilledUsageSiebelReqABCS_Service Operations Operation Name QueryUnbilledUsage QueryEventDetails SearchEventDetails QueryResourceDetails Description Retrieves unbilled usage detail for a billing profile. Retrieves unbilled event (for example, phone call) detail for an item charge. Finds the unbilled event detail based on data in the From Amount, To Amount, Start Date, and End Data fields. Retrieves the non-currency resource balance detail for an unbilled event.
Request Message Description: QueryUnbilledUsage For a description of this request message, see Table 135. Table 135. 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 account for the billing profile. The maximum number of records to retrieve from the external system. The currency code of the account for the billing profile. The name of the billing profile for the account. The ID of the billing profile for the account.
Response Message Description: QueryUnbilledUsage For a description of this response message, see Table 136. Table 136. Response Message Description: QueryUnbilledUsage Node CmuUnbilledUsageVbc CmuUnbilledItemChargesVbc Description The attributes of the unbilled service charges. The attributes of the unbilled item charges
99
Request Message Description: QueryEventDetails For a description of this request message, see Table 137. Table 137. Request Message Description: QueryEventDetails Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId UnbilledUsageServiceId UnbilledItemChargesId Description The ID of the account for the billing profile. The name of the account for the billing profile. The maximum number of records to retrieve from the external system. The currency code of the account for the billing profile. The name of the billing profile for the account. The ID of the billing profile for the account. The ID of the unbilled service charge. The ID of the unbilled item charge.
Response Message Description: QueryEventDetails For a description of this response message, see Table 138. Table 138. Response Message Description: QueryEventDetails Node CmuUnbilledItemChargesDetailsVbc Description The attributes of the unbilled events.
Request Message Description: SearchEventDetails For a description of this request message, see Table 139. Table 139. Request Message Description: SearchEventDetails Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId UnbilledUsageServiceId UnbilledItemChargesId StartDate Description The ID of the account for the billing profile. The name of the account for the billing profile. The maximum number of records to retrieve from the external system. The currency code of the account for the billing profile. The name of the billing profile for the account. The ID of the billing profile for the account. The ID of the unbilled service charge. The ID of the unbilled item charge. The starting date of the event.
100
Table 139. Request Message Description: SearchEventDetails Node EndDate FromAmount ToAmount Description The ending date of the event. The minimum amount of the event. The maximum amount of the event.
Response Message Description: SearchEventDetails For a description of this response message, see Table 140. Table 140. Response Message Description: SearchEventDetails Node CmuUnbilledItemChargesDetailsVbc Description The attributes of the unbilled events.
Request Message Description: QueryResouceBalance For a description of this request message, see Table 141. Table 141. Request Message Description: QueryResouceBalance Node AccountId AccountName MaximumNumberOfRecords CurrencyCode BillingProfileName BillingProfileId UnbilledUsageServiceId UnbilledItemChargesId UnbilledEventDetailsId Description The ID of the account for the billing profile. The name of the account for the billing profile. The maximum number of records to retrieve from the external system. The currency code of the account for the billing profile. The name of the billing profile for the account. The ID of the billing profile for the account. The ID of the unbilled service charge. The ID of the unbilled item charge. The ID of the unbilled event.
Response Message Description: QueryResouceBalance For a description of this response message, see Table 142. Table 142. Response Message Description: QueryResouceBalance Node CmuUnbilledBalanceDetailsVbc Description The attributes of the non-currency resource balances for an unbilled event.
10 1
ESB_UnbilledUsageSiebelReqABCS_Service Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 143. Table 143. 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, see Table 144. Table 144. 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, see Table 145. Table 145. ESB_UnbilledUsageSiebelReqABCS_Service Methods Operation QueryUnbilledUsage QueryEventDetails SearchEventDetails QueryResourceBalance Method [BS:UnbilledUsageSiebelReqABCS].QueryUnbilledUsage [BS:UnbilledUsageSiebelReqABCS].QueryEventDetails [BS:UnbilledUsageSiebelReqABCS].SearchEventDetails [BS:UnbilledUsageSiebelReqABCS].QueryBalanceSummary
102
Siebel 8.1 Primary Web Services FS Asset Warranty Service
Example Package for ESB_UnbilledUsageSiebelReqABCS_Service

Request See the following file to view the sample code: ...\UnbilledUsageSiebelReqABCS\UnbilledUsageRequestMessage.xml Response See the following file to view the sample code: ...\UnbilledUsageSiebelReqABCS\UnbilledUsageResponseMessage.xml
Message Schema (WSDL) for ESB_UnbilledUsageSiebelReqABCS_Service

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: ...\UnbilledUsageSiebelReqABCS\UnbilledUsageSiebelReqABCSService.xml
FS Asset Warranty Service

Use this Web service to create asset warranties and to retrieve asset warranty information.
FS Asset Warranty Service Operations

For a list of operations associated with this Web service, see Table 146. Table 146. FS Asset Warranty Service Operations Name CreateAssetWarranty GetAssetWarranty Description Adds the input warranty to the source asset. Used to retrieve all the warranties for a specified asset's product and then add them to the asset if not already done so.
10 3
Siebel 8.1 Primary Web Services FS Asset Warranty Service
Request Message Description: CreateAssetWarranty Adds a specific warranty to an asset. If that warranty has already been added to the asset record, then the service will update the service date. For a description of this request message, see Table 147. Table 147. Request Message Description: CreateAssetWarranty Node Asset Id Warranty Id Serviced Date Description Row Id of asset. Row Id of the warranty. Date from which warranty will start (mm/dd/yyyy). Type String String Date
Response Message Description: CreateAssetWarranty For a description of this response message, see Table 148. Table 148. Response Message Description: CreateAssetWarranty Node StatusMsg Description (Optional). Will give error message in the case of incompatibility of inputs. If there is no imcompatibility, there will be no message. Type String
Request Message Description: GetAssetWarranty This operation will add all the warranty information associated with an asset. The date depends on the start data type of each warranty. If some of the warranties are already attached to the asset, the operation adds the other potenital warranties, 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. For a description of this request message, see Table 149. Table 149. Request Message Description: GetAssetWarranty Node Asset Id Description Row Id of asset. Type String
Response Message Description: GetAssetWarranty This Web service has no response message.
104
Siebel 8.1 Primary Web Services GetMktgWebSurvey
FS Asset Warranty Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 150. Table 150. 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

Request/Response (CreateAssetWarranty) See the following file to view the sample code: \FSAssetWarranty\CreateAssetWarranty Sample IO.doc
Request/Response (GetAssetWarranties) See the following file to view the sample code: \FSAssetWarranty\GetAssetWarranty Sample IO.doc
Message Schema (WSDL) for FS Asset Warranty Service

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: \FSAssetWarranty\CreateAssetWarranty.wsdl
GetMktgWebSurvey
Use this Web service to get Marketing Web Surveys.
10 5
Siebel 8.1 Primary Web Services GetMktgWebSurvey
GetMktgWebSurvey Operations
For a list of operations associated with this Web service, see Table 151. Table 151. GetMktgWebSurvey Operations Name GetMktgWebSurveyQueryPage Description This operation is used to query up a Survey Page.
Request Message Description: GetMktgWebSurveyQueryPage For a description of this request message, see Table 152.
Table 152. Request Message Description: GetMktgWebSurveyQueryPage Node ExecutionMode LOVLanguageMode NamedSearchSpec PickListName SiebelMessageIn ViewMode Description The mode in which the query is to be performed. The language mode from the seeded list. Search Specification of the query. Name of the picklist (if any). An instance of the GetMktgWebSurvey Integration Object. The View Mode set for the Object (Admin, Preserve, and so on). Type String String String String Integration Object String
Response Message Description: GetMktgWebSurveyQueryPage For a description of this response message, see Table 153. Table 153. Response Message Description: GetMktgWebSurveyQueryPage Node SiebelMessageOut Description An instance of the GetMktgWebSurvey Integration Object. Type Integration Object
GetMktgWebSurvey Application Interface

106
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, see Table 154. Table 154. GetMktgWebSurvey Data Object Siebel Repository Name Import Job Integration Object External Name Import Job Integration Object.
Example Package for GetMktgWebSurvey

Request See the following file to view the sample code: \GetMktgWebSurvey\GetMktgWebSurvey_request.xml
Response See the following file to view the sample code: \GetMktgWebSurvey\GetMktgWebSurvey_response.xml
Message Schema (WSDL) for GetMktgWebSurvey

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. \GetMktgWebSurvey\GetMktgWebSurvey.wsdl
ISS Price List Item WS

Use this Web service to add, update, and delete items in a price list in the Siebel CRM application. The response message returns only an acknowledgement message and not data.
10 7
ISS Price List Item WS Operations

For a list of operations associated with this Web service, see Table 155. Table 155. 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, and updates an item in a price list that already contains that item. Adds an item to a price list. Updates an item in a price list. Deletes an item from a price list.
Request Message Description: Price List Item InsertOrUpdate For a description of this request message, see Table 156. Table 156. Request Message Description: Price List Item InsertOrUpdate Node Price List Id Product Id Price List Item Id Description The ID of the price list. This node is used only to insert. The ID of the product to add to the price list. This node is used only to insert. The ID of the price list item to update to the price list. This node is used only to update.
Request Message Description: Price List Item Insert For a description of this request message, see Table 157. Table 157. Request Message Description: Price List Item Insert Node Price List Id Product Id Description The ID of the price list. The ID of the product to add to the price list.
Request Message Description: Price List Item Update For a description of this request message, see Table 158. Table 158. 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.
108
Request Message Description: Price List Item Delete For a description of this request message, see Table 159. Table 159. 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.
ISS Price List Item WS Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 160. Table 160. 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, see Table 161. Table 161. 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 162. Table 162. 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].InsertOrUpdate [BS: ISS Price List Item WS].Insert [BS: ISS Price List Item WS].Update [BS: ISS Price List Item WS].Delete
10 9
Siebel 8.1 Primary Web Services LeadProcessingService
Example Package for ISS Price List Item WS

Request See the following file to view the sample code: ...\ISSPriceListItemWS\ISSPriceListItem.xml Response See the following file to view the sample code: ...\ISSPriceListItemWS\ISSPriceListItem.xml
Message Schema (WSDL) for ISS Price List Item WS

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: ...\ISSPriceListItemWS\ISSPriceListItemWS.wsdl
LeadProcessingService
This service contains the basic operations for processing leads, including assigning, querying, scoring and data cleansing.
Lead Processing Service Operations

For a list of operations associated with this Web service, see Table 163. Table 163. Lead Processing Service Operations Name LeadProcessingServiceAssignLeads LeadProcessingServiceDataCleansing LeadProcessingServiceGetLeads LeadProcessingServiceScoreLeads Description Used to assign leads to sales representatives. Used for data cleansing of marketing data. Queries for leads. Scores leads based on defined characterstics.
110
Request Message Description: LeadProcessingServiceAssignLeads This method is used to assign leads. It accepts the input parameters in a property set. For a description of this request message, see Table 164. Table 164. Request Message Description: LeadProcessingServiceAssignLeads Node Execution Order Search Specification Description Required. Parameter to be passed to the Business Rules Workflow. Required. The input search criteria to search on the Lead Business Component. Type String String
Response Message Description: LeadProcessingServiceAssignLeads For a description of this response message, see Table 165. Table 165. Response Message Description: LeadProcessingServiceAssignLeads Node Error Message Process Instance Id Success Flag Description OK or NOTOK based on errors. This is the Business Rules Workflow process Id. Yes OR No based on success. Type String String String
Request Message Description: LeadProcessingServiceDataCleansing This method calls the Data Cleansing business service to cleanup a property set. For a description of this request message, see Table 166 Table 166. Request Message Description: LeadProcessingServiceDataCleansing Node Business Component Business Object Search Specification Description Required. Business Component to be passed to Data cleansing service. Required. Business Object from which the business component instance is obtained. Required. Search specification to querry the BC and get the values in activated Fields. Type String String String
11 1
Response Message Description: LeadProcessingServiceDataCleansing For a description of this request message, see Table 167. Table 167. Response Message Description: LeadProcessingServiceDataCleansing Node Error Message Success Flag Description OK or NOTOK based on errors. 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. For a description of this request message, see Table 168. Table 168. Request Message Description: LeadProcessingServiceGetLeads Node Search Specification Description Required. The input search criteria to search on Lead Business Component. Type String
Response Message Description: LeadProcessingServiceGetLeads For a description of this response message, see Table 169. Table 169. Response Message Description: LeadProcessingServiceGetLeads Node SiebelMessage Description Required. Has Lead Id and description of the leads. Type Integration Object
Request Message Description: LeadProcessingServiceScoreLeads This method is used to score leads. It accepts the input parameters in a property set. For a description of this request message, see Table 170. Table 170. Request Message Description: LeadProcessingServiceScoreLeads Node Execution Order Description Required. Parameter to be passed to Business Rules Workflow. Type String
112
Response Message Description: LeadProcessingServiceScoreLeads For a description of this response message, see Table 171. Table 171. Response Message Description: LeadProcessingServiceScoreLeads Node Error Message Process Instance Id Success Flag Description OK or NOTOK based on errors. This is the Business Rules Workflow process Id. Yes OR No based on success. Type String String String
LeadProcessingService Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 172. Table 172. 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, see Table 173. Table 173. LeadProcessingService Data Object Siebel Repository Name Lead Integration Object External Name Lead
Example Package for Lead Processing Service

Request (LeadProcessingServiceAssignLeads) See the following file to view the sample code: \LeadProcessingService\LeadProcessingService_AssignLeads_request.xml
11 3
Response (LeadProcessingServiceAssignLeads) See the following file to view the sample code: \LeadProcessingService\LeadProcessingService_AssignLeads_request.xml
Request (LeadProcessingServiceDataCleansing) See the following file to view the sample code: \LeadProcessingService\LeadProcessingService_ScoreLeads_request.xml
Response(LeadProcessingServiceDataCleansing) See the following file to view the sample code: \LeadProcessingService\LeadProcessingService_ScoreLeads_request.xml
Request (LeadProcessingServiceGetLeads) See the following file to view the sample code: \LeadProcessingService\LeadProcessingService_ScoreLeads_request.xml
Response (LeadProcessingServiceGetLeads) See the following file to view the sample code: \LeadProcessingService\LeadProcessingService_ScoreLeads_request.xml
Request (LeadProcessingServiceScoreLeads) 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, 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: \LeadProcessingService\LeadProcessing.wsdl
114
Siebel 8.1 Primary Web Services LeadService
LeadService
Use this Web serviceto perform basic operations on the Lead entity, such create, update, convert, retire and reject leads.
LeadService Operations
For a list of operations associated with this Web service, see Table 174. Table 174. LeadService Operations Name LeadServiceRetireLead LeadServiceCreateLead LeadServiceRejectLead LeadServiceResponseToLead LeadServiceConvertLeadToOpty LeadServiceUpdateLead Description Retires a lead. Creates a lead. Rejects a lead. Converts response to leads. Converts lead to an opportunity. Updates a lead.
Request Message Description: LeadServiceRetireLead This method is used to assign leads. It accepts the input parameters in a property set. For a description of this request message, see Table 175. Table 175. Request Message Description: LeadServiceRetireLead Node LeadId ReasonCode Comments Description Required.The Id of the lead to be retired. Required The reason code for retiring the lead. Comments for retiring (if any). Type String String String
Response Message Description: LeadServiceRetireLead For a description of this response message, see Table 176. Table 176. Response Message Description: LeadServiceRetireLead Node ReturnVal Description Error code (OK or NOTOK). Type String
11 5
Request Message Description: LeadServiceCreateLead For a description of this request message, see Table 177. Table 177. Request Message Description: LeadServiceCreateLead Node Lead IO Description Required.An instance of the Integration Object Lead IO. Type Integration Object
Response Message Description: LeadServiceCreateLead For a description of this response message, see Table 178. Table 178. Response Message Description: LeadServiceCreateLead Node Error Message Success Flag Lead Id Description Error message (if any). Y or N. Id of the lead generated as a result of the lead creation. Type String String String
Request Message Description: LeadServiceRejectLead This method is used to reject a lead. The lead Id is retained, along with a reject comments code, a reject reason code. Optionally an owner Id can be passed to whom the lead will be assigned. For a description of this request message, see Table 179. Table 179. Request Message Description: LeadServiceRejectLead Node LeadId OwnerId ReasonCode Comments Description Required. The Id of the lead to be rejected. Optional. Reason code for rejecting the lead. Comments (if any). Type String String String String
Response Message Description: LeadServiceRejectLead For a description of this response message, see Table 180. Table 180. Response Message Description: LeadServiceRejectLead Node ReturnVal Description Error message(OK or NOTOK). Type String
116
Request Message Description: LeadServiceResponseToLead For a description of this request message, see Table 181. Table 181. Request Message Description: LeadServiceResponseToLead Node Response Id Description Required.The Id of the response to be converted to lead. Type String
Response Message Description: LeadServiceResponseToLead For a description of this response message, see Table 182. Table 182. Response Message Description: LeadServiceResponseToLead Node Error Message Success Flag Lead Id Description Error message (if any). Y or N. The Id of the lead created from the response. Type String String String
Request Message Description: LeadServiceConvertLeadToOpty For a description of this request message, see Table 183. Table 183. Request Message Description: LeadServiceConvertLeadToOpty Node LeadId Contact Id Account Id Description Required . The Id of the lead to be converted. The contact Id of the lead. The account Id of the lead. Type String String String
Response Message Description: LeadServiceConvertLeadToOpty For a description of this response message, see Table 184. Table 184. Response Message Description: LeadServiceConvertLeadToOpty Node Error Message Success Flag Opty Id Description Error message (if any). Y or N. The Id of the opportunity created. Type String String String
Request Message Description: LeadServiceUpdateLead This method is used to update leads. It accepts input parameters in a property set. For a description of
11 7
this request message, see Table 185. Table 185. Request Message Description: LeadServiceUpdateLead Node Lead IO Description Required. An instance of the integration object Lead IO. Type Integration Object
Response Message Description: LeadServiceUpdateLead For a description of this response message, see Table 186. Table 186. Response Message Description: LeadServiceUpdateLead Node Error Message Success Flag Description Error message (if any). Y or N. Type String String
LeadService Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 187. 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 188. Table 188. LeadService Data object Siebel Repository Name Lead IO External Name Lead
Example Package for LeadService

118
Request (LeadServiceRetireLead) See the following file to view the sample code: \LeadService\LeadService_RetireLead_request.xml
Response (LeadServiceRetireLead) See the following file to view the sample code: \LeadService\LeadService_RetireLead_response.xml
Request (LeadServiceCreateLead) See the following file to view the sample code: \LeadService\LeadService_CreateLead_request.xml
Response (LeadServiceCreateLead) See the following file to view the sample code: \LeadService\LeadService_CreateLead_response.xml
Request (LeadServiceRejectLead) See the following file to view the sample code: \LeadService\LeadService_RejectLead_request.xml
Response(LeadServiceRejectLead) See the following file to view the sample code: \LeadService\LeadService_RejectLead_response.xml
Request (LeadServiceResponseToLead) See the following file to view the sample code: \LeadService\LeadService_ResponseToLead_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.xml
11 9
Siebel 8.1 Primary Web Services List
Response (LeadServiceConvertLeadToOpty) See the following file to view the sample code: \LeadService\LeadService_ConvertToOpty_response.xml
Request (LeadServiceUpdateLead) See the following file to view the sample code: \LeadService\LeadService_UpdateLead_request.xml
Response (LeadServiceUpdateLead) See the following file to view the sample code: \LeadService\LeadService_UpdateLead_response.xml
Message Schema (WSDL) for LeadService

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: \LeadService\Lead.wsdl
List
Use this Web service for the basic operations for processing lists.
List Operations
For a list of operations associated with this Web service, see Table 189. Table 189. List Operations Name ListCreateList ListExportList Description Creates a list. Exports a list.
120
Request Message Description: ListCreateList This method is used to create a list. It accepts the input parameters as a property set. For a description of this request message, see Table 190. Table 190. Request Message Description: ListCreateList Node List IO Description Required. An instance of the integration object List IO. Type Integration Object
Response Message Description: ListCreateList For a description of this response message, see Table 191. Table 191. Response Message Description: ListCreateList Node List Id Error Message Success Flag Description List Id of the list created. Error message if any. Y or N. Type String String String
Request Message Description: ListExportList This method is used to export lists. It accepts the input parameters as a property set. For a description of this request message, see Table 192. Table 192. Request Message Description: ListExportList Node Business Component Business Object Export Format Search Specification Description The Business Component whose records need to be exported. The Business Object containing the Business Component. The format (xml or CSV) based on which the filename(s) are to be created. The search specification for the records on the bc (if the records satisfying a condition are only to be picked). Type String String String String
List Application Interface

12 1
Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 193. Table 193. 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, see Table 194. Table 194. List Data Object Siebel Repository Name List IO External Name List IO
Example Package for List

Request (ListCreateList) See the following file to view the sample code: \List\ListCreate_request.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.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, 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: \List\List.wsdl
122
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.
ListMgmtProspect Operations
For a list of operations associated with this Web service, see Table 195. Table 195. ListMgmtProspect Operations Name ListMgmtProspectCreateProspect ListMgmtProspectUpdateProspect Description Creates a Prospect. Updates a Prospect.
Request Message Description: ListMgmtProspectCreateProspect This method takes in an Integration Object called Prospect IO and returns the Prospect Id and Success Flag. For a description of this request message, see Table 196. Table 196. Request Message Description: ListMgmtProspectCreateProspect Node Prospect IO Description Required input parameter. Type Integration Object
Response Message Description: ListMgmtProspectCreateProspect For a description of this response message, see Table 197. Table 197. Response Message Description: ListMgmtProspectCreateProspect Node Prospect Id Error Message Success Flag Description Unique Id of the prospect created. Error message, if any. Y or N. Type String String String
Request Message Description: ListMgmtProspectUpdateProspect This method updates a prospect. For a description of this request message, see Table 198. Table 198. Request Message Description: ListMgmtProspectUpdateProspect Node Prospect IO Description Required input parameter. Type Integration Object
12 3
Siebel 8.1 Primary Web Services ListMgmtProspect
Response Message Description: ListMgmtProspectUpdateProspect For a description of this response message, see Table 199. Table 199. Response Message Description: ListMgmtProspectUpdateProspect Node Error Message Success Flag Description Error message, if any. Y or N. Type String String
Example Package for ListMgmtProspect

Request (ListMgmtProspectCreate) See the following file to view the sample code: ListMgmtProspect\ListMgmtProspectCreate_request.xml
Response (ListMgmtProspectCreate) See the following file to view the sample code:: ListMgmtProspect\ListMgmtProspectCreate_request.xml
Request (ListMgmtProspectUpdate) See the following file to view the sample code: ListMgmtProspect\ListMgmtProspectUpdate_request.xml
Response (ListMgmtProspectUpdate) See the following file to view the sample code: ListMgmtProspect\ListMgmtProspectUpdate_request.xml
Message Schema (WSDL) for ListMgmtProspect

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: \ListMgmtProspect\ListMgmtProspect.wsdl
124
Siebel 8.1 Primary Web Services LoyaltyAccrualService
LoyaltyAccrualService
Use this Web service with the Siebel Loyalty Application to perform operations on orders, including processing, importing from an external file, importing transactions, and exporting promotions.
LoyaltyAccrualService Operations
For a list of operations associated with this Web service, see Table 200. Table 200. LoyaltyAccrualService Operations Name ProcessExternalOrder ImportExternalOrderTxn ProcessExternalOrderTxn Description Process all the transactions with the given order number. Imports the transactions from external file, stamp the given order number to them and process all the transactions. Imports the transactions from given input, stamp the given order number to them and process all the transactions. The Request Mode can be either Process or Simulate. Exports the Promotion of given Program.
ExportPromotions
Request Message Description: ProcessExternalOrder For a description of this request message, see Table 201. Table 201. Request Message Description: ProcessExternalOrder Node Order Number Number Description The number of transactions this order number will be processed. Type Number
Response Message Description: ProcessExternalOrder For a description of this response message, see Table 202. Table 202. Response Message Description: ProcessExternalOrder Node Total Points Description Total Number of Points for a given order. Type Number
Request Message Description: ImportExternalOrderTxn For a description of this request message, see Table 203. Table 203. Request Message Description: ImportExternalOrderTxn Node File Name Description File name that contains the transactions. Type String.
12 5
Response Message Description: ImportExternalOrderTxn For a description of this response message, see Table 204. Table 204. Response Message Description: ImportExternalOrderTxn Node Total Points Siebel Message Description Total Number of Points for a given order. Siebel Message of Transactions. Type Number Hierarchy
Request Message Description: ProcessExternalOrderTxn Imports the transactions from given input, stamp the given order number to them and process all the transactions. The Request Mode can be either Process or Simulate. For a description of this request message, see Table 205. Table 205. Request Message Description: ProcessExternalOrderTxn Node Order Number Total Lines Request Mode LOY EAI Transactions Description Order Number to be stamped to the saved transactions. Total number of transactions in the Input. Can be Process or Simulate. Transactions in Integration Object Format. Type Number Number String Integration Object
Response Message Description: ProcessExternalOrderTxn For a description of this response message, see Table 206. Table 206. Response Message Description: ProcessExternalOrderTxn Node Total Points Number Return Value String Siebel Message Hierarchy Description Total Number of Points for the given order. Failure or Success. Siebel Message of Transactions. Type Number String Hierarchy
Request Message Description: ExportPromotions Exports the promotion of given program. For a description of this request message, see Table 207. Table 207. Request Message Description: ExportPromotions Node Activity Date Description Date should be between the start and end date of the promotion. Type String
126
Table 207. Request Message Description: ExportPromotions Node Export Flag Program Name Description Export Flag can be Y or N. Program Name of which the user want to export the Promotions. Type String String
Response Message Description: ExportPromtions For a description of this response message, see Table 208. Table 208. Response Message Description: ExportPromtions Node Siebel Message Description All the Promotions in LOY EAI Promotion Integration Object Format. Type Integration Object.
Example of Package for LoyaltyAccrualService

To view an example of messages for this Web service, navigate to the documentation library for Siebel applications on the Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Then extract the files in the zip file.
Request (ProcessExternalOrder) See the following file to view the sample code: \LoyaltyAccrualService\ProcessExternalOrder_request.xml
Response (ProcessExternalOrder) See the following file to view the sample code: \LoyaltyAccrualService\ProcessExternalOrder_response.xml
Request (ImportExternalOrderTxn) See the following file to view the sample code: \LoyaltyAccrualService\ProcessExternalOrderTxn_request.xml
Response (ImportExternalOrderTxn) See the following file to view the sample code: \LoyaltyAccrualService\ProcessExternalOrderTxn_response.xml
Request (ImportExternalOrderTxnif Request Mode is Simulate) See the following file to view the sample code:
12 7
\LoyaltyAccrualService\RequestMode_Simulate_request.xml
Response(ImportExternalOrderTxnif Request Mode is Simulate) See the following file to view the sample code: \LoyaltyAccrualService\RequestMode_Simulate_response.xml
Request (ProcessExternalOrderTxn) See the following file to view the sample code: \LoyaltyAccrualService\ProcessExternalOrderTxn_request.xml
Response (ProcessExternalOrderTxn) See the following file to view the sample code: \LoyaltyAccrualService\ProcessExternalOrderTxn_response.xml
Request (ExportPromotions) See the following file to view the sample code: \LoyaltyAccrualService\ExportPromotions_request.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, 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.
WSDL (ProcessExternalOrder) \LoyaltyAccrualService\ProcessExternalOrder.wsdl
WSDL (ImportExternalOrderTxn) \LoyaltyAccrualService\ImportExternalOrderTxn.wsdl
WSDL (ProcessExternalOrderTxn) \LoyaltyAccrualService\ProcessExternalOrderTxn.wsdl
128
Siebel 8.1 Primary Web Services LoyaltyBatchEnrollment
WSDL (ExportPromotions) \LoyaltyAccrualService\ExportPromotions.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.
LoyaltyBatchEnrollment Operations
For a list of operations associated with this Web service, see Table 209. Table 209. LoyaltyBatchEnrollment Operations Name MemberEnrollment Description Enrolls a member into the specified loyalty program and returns the generated Member number, along with the Simulated prices for enrollment, if any. In case of any error, it sends across the member data along with the error message or messages. If the Enrollment entails a payment, this Web service method enrolls the member into Payment Pending status. If there is no Payment required, then the member directly goes into the Active status. MemberUpdate Used to update the member details. 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.
12 9
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
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
13 1
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
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

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
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 8.1 Primary Web Services LoyaltyMemberService
Example Package for LoyaltyImportBusinessService

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
13 5
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, Members 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
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
13 7
Table 222. Request Message Description: PurchasePointsService Node Billing Country Billing State Billing ZipCode CVV Number Description Member billing country. It is required if the payment involves monetary currency and Credit Card details are mentioned. Member billing state. It is required if the payment involves monetary currency and Credit Card details are mentioned. Member billing Zip code. It is required if the payment involves monetary currency and Credit Card details are mentioned. CVV number from member credit card. It is required if the payment involves monetary currency and Credit Card details are mentioned. Credit card holder name. It is required if the payment involves monetary currency. Credit card number. It is required if the payment involves monetary currency. Credit card type, such as Visa, MasterCard, and so on. It is required if the payment involves monetary currency. Currency type used by member. It is required as the payment involves monetary currency. Expiration month of member credit cards. It is required if the payment involves monetary currency. Expiration year of member credit card. It is required if the payment involves monetary currency. 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. It is a mandatory input. If the member wants to override the price details, input would be Y, else it would be N. Member should mention Override Pay when Override flag given is Y. It is the Monetary Amount overridden by the member. Reason to override the pricelist is to be mentioned if the Override Flag is Y. 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
Response Message Description: PurchasePointsService For a description of this response message, see Table 223. Table 223. 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. Order Id of the Point Purchase Service is given. Quote Id of the Point Purchase Service is given. Response Code given by Siebel Order Management after authorizing credit card is sent in the output. Response Message given by Siebel Order Management after authorizing credit card is sent in the output. Transaction Number of the Point Purchase Service is given in the output. Type String String String String String String
Request Message Description: TransferPointService For a description of this request message, see Table 224. Table 224. 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. It is a mandatory input. Loyalty Membership Number of the person for whom the service is to be performed is to be given. The type of Point member wants to transfer 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. Transferee Membership Number to whom the points are to be transferred. 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. Member billing city. It is required if the payment involves monetary currency and Credit Card details are mentioned. Member billing country. It is required if the payment involves monetary currency and Credit Card details are mentioned. Member billing state. It is required if the payment involves monetary currency and Credit Card details are mentioned. Type String String String String String String String String String String
13 9
Table 224. Request Message Description: TransferPointService Node CVV Number Card Holder Name Description Member billing Zip code. It is required if the payment involves monetary currency and Credit Card details are mentioned. CVV number from member credit card. It is required if the payment involves monetary currency and Credit Card details are mentioned. Credit card holder name. It is required if the payment involves monetary currency. Credit card number. It is required if the payment involves monetary currency. Credit card type, such as Visa, MasterCard, and so on. It is required if the payment involves monetary currency. Currency type used by member. It is required as the payment involves monetary currency. Expiration month of member credit cards. It is required if the payment involves monetary currency. Expiration year of member credit card. It is required if the payment involves monetary currency. It is a mandatory input. If the member wants to override the price details, input would be Y, else it would be N. Member should mention Override Pay when Override flag given is Y. It is the Monetary Amount overridden by the member. 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, see Table 225. Table 225. Response Message Description: TransferPointService Node Error Message Order Id Quote Id Siebel Response Code Description Error message if the transaction fails is given. Order Id of the Point Transfer Service is given. Quote Id of the Point Transfer Service is given. Response Code given by Siebel Order Management after authorizing credit card is sent in the output. Type String String String String
140
Table 225. 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. Transaction Number of the Point Transfer Service is given in the output. Type String String
Request Message Description: LoungePurchaseService For a description of this request message, see Table 226. Table 226. Request Message Description: LoungePurchaseService Node Member Number Lounge Period Type 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. Lounge period type as months or years. Lounge period duration for the number of months or years the member want to renew his lounge. 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. Member billing city. It is required if the payment involves monetary currency and credit card details are mentioned. Member billing country. It is required if the payment involves monetary currency and credit card details are mentioned. Member billing state. It is required if the payment involves monetary currency and credit card details are mentioned. Member billing ZIP code. It is required if the payment involves monetary currency and credit card details are mentioned. CVV number from member credit card. It is required if the payment involves monetary currency and credit card details are mentioned. Credit card holder name. It is required if the payment involves monetary currency. Type String String
Lounge Period Duration Billing Address Billing Address2
Billing City Billing Country Billing State
Billing ZipCode CVV Number
String String
Card Holder Name
String
Credit Card Number
String
14 1
Table 226. Request Message Description: LoungePurchaseService Node Credit Card Type Currency Expiration Month Expiration Year Override Flag Override Pay Override Points Description Credit card number. It is required if the payment involves monetary currency. Credit card type, such as Visa, MasterCard, and so on. It is required if the payment involves monetary currency. Currency type used by member. It is required as the payment involves monetary currency. Expiration month of member credit cards. It is required if the payment involves monetary currency. Expiration year of member credit card. It is required if the payment involves monetary currency. It is a mandatory input. If the member wants to override the price details, input would be Y, else it would be N. Member should mention Override Pay when Override flag given is Y. It is the Monetary Amount overridden by the member. Member should mention Override Points when Override flag given is Y and the payment mode selected is Points or Points + Pay. Reason to override the pricelist is to be mentioned if the Override Flag is Y. Override Reason Code is to be mentioned if the Override Flag is Y. Payment mode as Points or Points + Pay or Pay. It is a mandatory input. Type String String String String String String String
Override Reason
String
Override Reason Code, Payment Mode Point Type
Response Message Description: LoungePurchaseService For a description of this response message, see Table 227. Table 227. Response Message Description: LoungePurchaseService Node Error Message Order Id Quote Id Siebel Response Code Description Error message if the transaction fails is given. Order Id of the Lounge Purchase Service is given. Quote Id of the Lounge Purchase Service is given. Response Code given by Siebel Order Management after authorizing credit card is sent in the output. Type String String String String
142
Table 227. 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. Transaction Number of the Lounge Purchase Service is given in the output. Type String String
Request Message Description: RenewMembershipService For a description of this request message, see Table 228. Table 228. 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. It is a mandatory input. Loyalty Membership Number of the person for whom the service is to be performed is to be given. Membership Scheme to which the member wants to be renewed 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. Member billing city. It is required if the payment involves monetary currency and Credit Card details are mentioned. Member billing country. It is required if the payment involves monetary currency and Credit Card details are mentioned. Member billing state. It is required if the payment involves monetary currency and Credit Card details are mentioned. Member billing Zip code. It is required if the payment involves monetary currency and Credit Card details are mentioned. CVV number from member credit card. It is required if the payment involves monetary currency and Credit Card details are mentioned. Credit card holder name. It is required if the payment involves monetary currency. Credit card number. It is required if the payment involves monetary currency. Credit card type, such as Visa, MasterCard, and so on. It is required if the payment involves monetary currency. Type String String String String String String String String String String
Credit Card Number Credit Card Type Currency
14 3
Table 228. Request Message Description: RenewMembershipService Node Expiration Month Expiration Year Override Flag Override Pay Override Points Override Reason Description Currency type used by member. It is required as the payment involves monetary currency. Expiration month of member credit cards. It is required if the payment involves monetary currency. Expiration year of member credit card. It is required if the payment involves monetary currency. It is a mandatory input. If the member wants to override the price details, input would be Y, else it would be N. Member should mention Override Pay when Override flag given is Y. It is the Monetary Amount overridden by the member. Member should mention Override Points when Override flag given is Y and the payment mode selected is Points or Points + Pay. Reason to override the pricelist is to be mentioned if the Override Flag is Y. Override Reason Code is to be mentioned if the Override Flag is Y. Payment mode as Points or Points + Pay or Pay. It is a mandatory input. Type String String String String String String
Override Reason Code Payment Mode Point Type
Response Message Description: RenewMembershipService For a description of this response message, see Table 229. Table 229. 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. Order Id of the Renew Membership Service is given. Quote Id of the Renew Membership Service is given. Response Code given by Siebel Order Management after authorizing credit card is sent in the output. Response Message given by Siebel Order Management after authorizing credit card is sent in the output. Transaction Number of the Renew Membership Service is given in the output. Type String String String String String String
144
Request Message Description: MembershipCancellationService For a description of this request message, see Table 230. Table 230. 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. It is a mandatory input. Fee refund basis is the mandatory input. Prorata or Percentage or NoRefund can be given here. Refund percentage is to be given if the selected fee refund basis is Percentage. Reason for the membership cancellation is to be mentioned here. Membership Cancellation Reason Code is to be given. It is a mandatory input. Credit card number 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. Fee will be refunded to the card number given, if it matches with the previous renewal or enrolment transactions credit card details. 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). This is required when the refund basis is Percentage or Prorata. Fee will be refunded to the card number given, if it matches with the previous renewal or enrolment transactions credit card details. Expiration month 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. 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. It is a mandatory input. If the member wants to override the Refund Price details, input would be Y, else it would be N. Member should mention Override Pay when Override flag given is Y. It is the Refund amount overridden by the member. Type String String String String String String
Credit Card Type
String
Expiration Month
String
Expiration Year
String
Override Flag
String
Override Pay
String
14 5
Table 230. Request Message Description: MembershipCancellationService Node Override Reason Override Reason Code Description Reason for overriding price is mentioned here. Override Reason Code is to be given if the Override Flag is Y. Type String String
Response Message Description: MembershipCancellationService For a description of this response message, see Table 231. Table 231. 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. Error message if the transaction fails is given. Refund Order Id of the Membership Cancellation Service is given. Refund amount is given in the output. Response code given by Siebel Order Management after authorizing credit card is sent in the output. Response Message given by Siebel Order Management after authorizing credit card is sent in the output. Transaction number of the Membership Cancellation is mentioned. Currency in which the fee is refunded is given as output. Type String String String String String String String String
Request Message Description: GetMemberServicePrice For a description of this request message, see Table 232. Table 232. 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. Currency code is to be given if the member wants to get price lists in the given currency only. Lounge Period Duration is to be given if the Transaction Sub Type is Lounge Purchase. Lounge Period Type (Months or Years etc) is to be given if the Transaction Sub Type is Lounge Purchase. Type String String String String
146
Table 232. 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. Number of Points to be given if the Transaction Sub Type is Purchase Points or Transfer Points. Membership Scheme is to be mentioned in the input if the Transaction Sub Type is Membership Renewal. Member Service Type (Points Purchase/Transfer Points/ Membership Renewal/Lounge Purchase) is to be mentioned. It is a mandatory input. Type String
Points Qty Selected Membership Scheme Transaction Sub Type
Response Message Description: GetMemberServicePrice For a description of this response message, see Table 233. Table 233. Response Message Description: GetMemberServicePrice Node Integration Object of the Pricelists Description List of price lines, after applying the promotions on the base prices, are given in the out put as XML file. Type Integration Object
Request Message Description: MemberInquiry For a description of this request message, see Table 234. Table 234. 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. Email address of the member whose details are to be inquired is given. First name of the member whose details are to be inquired is given. 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. Telephone number of the member whose details are to be inquired is given. Transaction type is given to query on the given type of transactions done by the member. ZIP code of the member whose details are to be inquired is given. Type String String String String String String String String
14 7
Response Message Description: GetMemberServicePrice For a description of this response message, see Table 235. Table 235. 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. Type Integration Object
Example Package for LoyaltyMemberServices

Request (PurchasePointsService) See the following file to view the sample code: \LoyaltyMemberServices\PointPurchase_request.xml
Response (PurchasePointsService) See the following file to view the sample code: \LoyaltyMemberServices\PointPurchase_response.xml
Request (TransferPointsService) See the following file to view the sample code: \LoyaltyMemberServices\TransferPoints_request.xml
Response (TransferPointsService) See the following file to view the sample code: \LoyaltyMemberServices\TransferPoints_response.xml
Request (LoungePurchaseService) See the following file to view the sample code: \LoyaltyMemberServices\LoungePurchase_request.xml
Response (LoungePurchaseService) See the following file to view the sample code: \LoyaltyMemberServices\LoungePurchase_response.xml
148
Request (MembershipCancellationService) See the following file to view the sample code: \LoyaltyMemberServices\MembershipCancellationService_request.xml
Response (MembershipCancellationService) See the following file to view the sample code: \LoyaltyMemberServices\MembershipCancellationService_response.xml
Request (RenewMembershipService) See the following file to view the sample code: \LoyaltyMemberServices\RenewMembershipService_request.xml
Response (RenewMembershipService) See the following file to view the sample code: \LoyaltyMemberServices\RenewMembershipService_response.xml
Request (GetMemberServicePrice) See the following file to view the sample code: \LoyaltyMemberServices\GetServicePrice_request.xml
Response (GetMemberServicePrice) See the following file to view the sample code: \LoyaltyMemberServices\GetServicePrice_response.xml
Request (MemberInquiry) See the following file to view the sample code: \LoyaltyMemberServices\MemberInquiry_request.xml
Response (MemberInquiry) See the following file to view the sample code: \LoyaltyMemberServices\MemberInquiry_response.xml
Message Schema (WSDL) for LoyaltyMemberServices

14 9
Siebel 8.1 Primary Web Services LoyaltyRedemptionService
See the following file to view the message schema: \LoyaltyMemberService\LoyaltyMemberServices.wsdl
LoyaltyRedemptionService
User this Web service with the Siebel Loyalty Application to perform all redemption related operations, including Redemption Processing, Redemption Cancellation, Voucher Reissue and Order Management Integration.
LoyaltyRedemptionService Operations
For a list of operations associated with this Web service, see Table 236. Table 236. LoyaltyRedemptionService Operations Name GetPriceOptions CheckPriceOptions Description Returns available price options for a set of redemption activities. Also returns the point balance of the member in all point types. Returns available price options for a set of redemption activities. Also performs the credit check and returns how much loan is required for each point type. If loan is not possible it does the point to pay conversion and returns the prorated pay and points for each transaction. Performs the credit check for a given member and 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. Also performs the credit check and returns how much loan is required for each point type. If loan is not possible it does the point to pay conversion and returns the prorated pay and points for each transaction. Also creates a quote using the given redemption activities (transactions), credit card details (optional) and shipping details (optional). ProcessQuote Takes Quote Id as input and converts the quote to order and order to redemption transactions. Then processes those transactions. Takes as input an Order Number and returns the Transaction details (including activities and Transaction Items if any) for the same. Returns the refund in Points or Points plus Pay for a given redemption transaction, which need to be cancelled.
CheckCredit
GetQuote
GetTransactionDetails
GetRedemptionRefund
150
Table 236. 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. Returns the different fee options for reissuing the given voucher. Checks whether a given fee option for a voucher is valid, and whether the member has enough points to pay in this fee option if the payment mode involves Points. Takes the chosen fee option details for a voucher, credit card details (optional), shipping details (optional), checks whether the fee option is valid, does credit check if the payment mode involves points, and creates a quote with the given data. Takes as input Quote Id, creates Order for Quote, and creates a Loyalty Voucher Reissue transaction and processes it to reissue the voucher. Takes Quote Id and shipping details and updates the quote with the given shipping address. Takes Quote Id, credit card details, billing address and updates the quote with the credit card details.
GetReissueFeeOptions CheckReissueFeeOption
GetReissueQuote
ProcessReissueQuote
UpdateQuoteShippingAddress AddCreditCardToQuote
Request Message Description: GetPriceOptions For a description of this request message, see Table 237. Table 237. Request Message Description: GetPriceOptions Node LOY Redemption Txn Description Contains the redemption activity details. Type Integration Object (Required)
Response Message Description: GetPriceOptions For a description of this response message, see Table 238. Table 238. 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. Contains point balances of the member in all point types. Type Integration Object (Required) Integration Object (Required)
15 1
Request Message Description: CheckPriceOptions For a description of this request message, see Table 239. Table 239. 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, see Table 240. Table 240. 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. Point Summary for each point type including points to be paid, point balance, loan (if any) and Points to Pay Conversion flag. Total amount to be paid if monetary payment is involved. Currency if monetary payment is involved. Type Integration Object Integration Object Number String
Request Message Description: CheckCredit This operation performs a credit check for a given member and point type. Checks whether loan is required and returns how much loan is required to fulfill the redemption transaction. For a description of this request message, see Table 241. Table 241. Request Message Description: CheckCredit Node MemberNumber PointTypeId PointsReq LoanFlag Description Membership number. Id number for point type. The required number of points. Indicates whether loan limit should be considered. Type String String Number String
152
Response Message Description: CheckCredit For a description of this response message, see Table 242. Table 242. 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), credit card details (optional) and shipping details (optional). For a description of this request message, see Table 243.
Table 243. 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. Address of customer being billed. Second address, if necessary of customer being billed. Shipping method, such as Ground, Air or carrier name. Shipping street address. Second shipping street address if needed. Shipping state. Shipping postal code. Shipping Country. Billing city, if different from shipping address. Billing country, if different from shipping address. Billing state, if different from shipping address. Billing ZIP code, if different from shipping address. Type Integration Object String String String String String String String String String String String String String
15 3
Table 243. 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. Expiration year of credit card. Credit card line number. Credit card number. Credit cards type, such as Visa, American Express, and so on. Name of person who will receive shipped goods. Check to save shipping address for future use. 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, see Table 244. Table 244. 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. Point Summary for each point type including points to be paid, point balance, loan (if any) and Points to Pay Conversion flag. Code to indicate which currency being used for transation. Shipping charge for transaction. Id of quote that is created. Total amount of transaction. Total taxed charged on transaction. Type Integration Object Integration Object String String String Number Number
154
Request Message Description: ProcessQuote This operation converts a quote to an order and an order to redemption transactions. It then processes these transactions. For a description of this request message, see Table 245. Table 245. Request Message Description: ProcessQuote Node Quote Id Description String Type Required
Response Message Description: Process Quote For a description of this response message, see Table 246. Table 246. 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, see Table 247. Table 247. Request Message Description: GetTransactionDetails Node Order Number Description Required Type String
Response Message Description: GetTransactionDetails For a description of this response message, see Table 248. Table 248. 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. Type Integration Object.
15 5
Request Message Description: GetRedemptionRefund This operation returns the refund amount for given redemption transaction, which is then cancelled. For a description of this request message, see Table 249. Table 249. Request Message Description: GetRedemptionRefund Node Transaction Id Description Required Type String
Response Message Description: GetRedemptionRefund For a description of this response 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.For a description of this request message, see Table 251. Table 251. 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
Response Message Description:CancelRedemptionTxn For a description of this response message, see Table 252. Table 252. Response Message Description:CancelRedemptionTxn Node New Txn Id Description Id of the cancellation transaction. Type String
Request Message Description: GetReissueFeeOptions This operation returns available fee options for reissue of a voucher with given Id. For a description of this request message, see Table 253. Table 253. 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, see Table 254. Table 254. 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, credit card details (optional), shipping details (optional), checks whether the fee option is valid, does credit check if the payment mode involves points, and creates a quote with the given data. For a description of this request message, see Table 255. Table 255. Request Message Description: GetReissueQuote Node Voucher Id Currency Code Description Required Type String String
15 7
Table 255. 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
Table 255. 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, see Table 256. Table 256. 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, creates and Order for Quote, and creates a Loyalty Voucher Reissue transaction and processes it to reissue the voucher. For a description of this request message, see Table 257.
Table 257. Request Message Description: ProcessReissueQuote Node Quote Id Description Required Type String
Response Message Description: ProcessReissueQuote For a description of this response message, see Table 258. Table 258. Response Message Description: ProcessReissueQuote Node Transaction Number Order Number New Voucher Expiry Date Description Required Required Required Type String String Date
15 9
Table 258. 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, see Table 259. Table 259. Request Message Description: UpdateQuoteShippingAddress Node Quote Id Description Required Type String
Response Message Description: UpdateQuoteShippingAddress For a description of this response message, see Table 260. Table 260. Response Message Description: UpdateQuoteShippingAddress Node Shipping Charge Description Required Type String
Request Message Description: AddCreditCardToQuote This operation takes the Quote Id, credit card details, billing address and updates the quote with the credit card details. For a description of this request message, see Table 261. 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
Response Message Description: GetReissueQuote There are no response messages for this operation.
Example Packages for LoyaltyRedemptionService

Request (GetPriceOptions) See the following file to view the sample code: \LoyaltyRedemptionService\GetPriceOptions_request.xml
Response (GetPriceOptions) See the following file to view the sample code: \LoyaltyRedemptionService\GetPriceOptions_response.xml
Request (CheckPriceOptions) See the following file to view the sample code: \LoyaltyRedemptionService\CheckPriceOptions_request.xml
Response (CheckPriceOptions) See the following file to view the sample code: \LoyaltyRedemptionService\CheckPriceOptions_response.xml
Request (CheckCredit) See the following file to view the sample code: \LoyaltyRedemptionService\CheckCredit_request.xm
Response (CheckCredit) See the following file to view the sample code: \LoyaltyRedemptionService\CheckCredit_response.xml
Request (GetQuote) See the following file to view the sample code: \LoyaltyRedemptionService\GetQuote_request.xml
16 1
Response (GetQuote) See the following file to view the sample code: \LoyaltyRedemptionService\GetQuote_response.xml
Request (ProcessQuote) See the following file to view the sample code: \LoyaltyRedemptionService\ProcessQuote_request.xml
Response (ProcessQuote) See the following file to view the sample code: \LoyaltyRedemptionService\ProcessQuote_response.xml
Request (GetTransactionDetails) See the following file to view the sample code: \LoyaltyRedemptionService\GetTransactionDetails_request.xml
Response(GetTransactionDetails) See the following file to view the sample code: \LoyaltyRedemptionService\GetTransactionDetails_response.xml
Request (GetRedemptionRefund) See the following file to view the sample code: \LoyaltyRedemptionService\GetRedemptionRefund_request.xml
Response (GetRedemptionRefund) See the following file to view the sample code: \LoyaltyRedemptionService\GetRedemptionRefund_response.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.xml
162
Request (GetReissueFeeOptions) See the following file to view the sample code: \LoyaltyRedemptionService\GetReissueFeeOptions_request.xml
Response(GetReissueFeeOptions) See the following file to view the sample code: \LoyaltyRedemptionService\GetReissueFeeOptions_response.xml
Request (GetReissueQuote) See the following file to view the sample code: \LoyaltyRedemptionService\GetReissueQuote_request.xml
Response (GetReissueQuote) See the following file to view the sample code: \LoyaltyRedemptionService\GetReissueQuote_response.xml
Request (ProcessReissueQuote) See the following file to view the sample code: \LoyaltyRedemptionService\ProcessReissueQuote_request.xml
Response(ProcessReissueQuote) See the following file to view the sample code: \LoyaltyRedemptionService\ProcessReissueQuote_response.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
Request (AddCreditCardToQuote) See the following file to view the sample code: \LoyaltyRedemptionService\AddCreditCardToQuote_request.xml
16 3
Siebel 8.1 Primary Web Services LoyaltyVoucherService
Response (AddCreditCardToQuote) See the following file to view the sample code: \LoyaltyRedemptionService\AddCreditCardToQuote_response.xml
Message Schema (WSDL) for LoyaltyRedemptionService

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: \LoyaltyRedemptionService\LoyaltyRedemptionService.wsdl
LoyaltyVoucherService
Use this Web service with the Siebel Loyalty Application to perform all Voucher related Web service operations, including Voucher Validity Check and Status Change.
LoyaltyVoucherService Operations
For a list of operations associated with this Web service, see Table 262. Table 262. LoyaltyVoucherService Operations Name VoucherStatusChange Description Takes in the membership number, partner name, voucher number, activity date and change the status of the voucher to 'Used' in Real time. This involves creation of Availment transaction and processing it in real time.
Request Message Description: VoucherValidityCheck This operation takes in the membership number, Partner Id voucher number and activity date, to validate the voucher and return Success/Failure. For a description of this request message, see Table 263. Table 263. 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 8.1 Primary Web Services LoyaltyVoucherService
Response Message Description: VoucherValidityCheck For a description of this response message, see Table 264. Table 264. Response Message Description: VoucherValidityCheck Node Valid Flag Description Required Type String
Request Message Description: VoucherStatusChange This operation takes in the membership number, partner name, voucher number, activity date and change the status of the voucher to Used in real time. This involves creation of Availment transaction and processing it in real time. For a description of this request message, see Table 265. 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 266. Table 266. 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

Request See the following file to view the sample code: \LoyaltyVoucherService\LoyaltyVoucherService_request.xml
16 5
Siebel 8.1 Primary Web Services MktgDeduplicationService
Response See the following file to view the sample code: \LoyaltyVoucherService\LoyaltyVoucherService_request.xml
Message Schema (WSDL) for LoyaltyVoucherService

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: \LoyaltyVoucherService\LoyaltyVoucherService.wsdl
MktgDeduplicationService
Use this Web service to check if a duplicate record exists for an account, contact, opportunity or prospect.
Mktg Deduplication Service Operations

For a list of operations associated with this Web service, see Table 267. Table 267. 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. Matches the opportunities. Matches the prospects. Matches the contacts.
MktgDeduplicationServiceMatchOpportunity MktgDeduplicationServiceMatchProspect MktgDeduplicationServiceMatchContact
Request Message Description: MktgDeduplicationServiceMatchAccount For a description of this request message, see Table 268. Table 268. Request Message Description: MktgDeduplicationServiceMatchAccount Node DUNS Number Name Primary Account City Primary Account Country Account name. City name. Country name. Description Type String String String String
166
Table 268. Request Message Description: MktgDeduplicationServiceMatchAccount Node Primary Account Postal Code Primary Account State Primary Account Street Address Description City postal code. State. Street address of primary account. Type String String String
Response Message Description: MktgDeduplicationServiceMatchAccount For a description of this response message, see Table 269. Table 269. Response Message Description: MktgDeduplicationServiceMatchAccount Node HasMatch Match Info Description Output String as hasMatch or hasNoMatch. Score of the match and row id of the matchee. Type String Integration Object
Response Message Description: MktgDeduplicationServiceMatchOpportunity For a description of this response message, see Table 270. Table 270. Response Message Description: MktgDeduplicationServiceMatchOpportunity Node Account Id Business Unit Id Name Description Opportunitys account Id. Opportunitys business unit Id. Opportunitys name. Type String String String
Response Message Description: MktgDeduplicationServiceMatchOpportunity For a description of this response message, see Table 271. Table 271. Response Message Description: MktgDeduplicationServiceMatchOpportunity Node HasMatch Match Info Description Output String as hasMatch or hasNoMatch. Score of the match and row id of the matchee. Type String Integration Object
16 7
Request Message Description: MktgDeduplicationServiceMatchProspect For a description of this request message, see Table 272. Table 272. 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. Phone number of prospect. Prospects city. Prospects country. Prospects email address. Prospects first name. Prospects home phone number. Prospects last name. Prospects middle name. Postal code. Prospects social security number. Prospects state of residence. Prospects street address. Prospects work phone number. 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, see Table 273. Table 273. Response Message Description: MktgDeduplicationServiceMatchProspect Node HasMatch Match Info Description Output String as hasMatch or hasNoMatch. Score of the match and row id of the matchee. Type String Integration Object
Request Message Description: MktgDeduplicationServiceMatchContact For a description of this request message, see Table 274. Table 274. Request Message Description: MktgDeduplicationServiceMatchContact Node Account Birth Date Phone Description Account name of contact. Contacts birth date. Contacts phone number. Type String String String
168
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 Contacts city of residence. Contacts country of residence. Contacts email address. Contacts first name. Contacts home phone number. Contacts last name. Contacts middle name. Contacts primary postal code. Contacts social security number. Contacts state of residence. Contacts street address. Contacts work phone number. Type String String String String String String String String String String String String
Response Message Description: MktgDeduplicationServiceMatchContact For a description of this response message, see Table 275. Table 275. Response Message Description: MktgDeduplicationServiceMatchContact Node HasMatch Match Info Description Output String as hasMatch or hasNoMatch. Score of the match and row id of the matchee. Type String Integration Object
MktgImportDeduplicationService Application Interface

Data Object (Integration Object) For a description of data objects for this Web service, see Table 276. Table 276. MktgImportDeduplicationService Data Object Siebel Repository Name Mktg Deduplication External Name Mktg Deduplication
16 9
Example Package for MktgDeduplicationService

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.xml
Request (MatchOpportunity) See the following file to view the sample code: \MktgDeduplicationService\MatchOpportuntity_request.xml
Response (MatchOpportunity) See the following file to view the sample code: \MktgDeduplicationService\MatchOpportuntity_response.xml
Request (MatchProspect) See the following file to view the sample code: \MktgDeduplicationService\MatchProspect_request.xml
Response (MatchProspect) See the following file to view the sample code: \MktgDeduplicationService\MatchProspect_response.xml
Request (MatchContact) See the following file to view the sample code: \MktgDeduplicationService\MatchContact_request.xml
Response (MatchContact) See the following file to view the sample code: \MktgDeduplicationService\MatchContact_response.xml
170
Siebel 8.1 Primary Web Services MktgImportService
Message Schema (WSDL) for Mktg Deduplication Service

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: MktgDeduplicationService\MktgDedup.wsdl
MktgImportService
This Web service is used for all the imports into the Siebel Marketing application such as Leads, Contacts, Prospects and so on.
Mktg Import Service Operations

For a list of operations associated with this Web service, see Table 277. Table 277. Mktg Import Service Operations Node MktgImportServiceInvokeImportJob Description Schedules various import processes for Marketing.
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. For a description of this request message, see Table 278. Table 278. Request Message Description: MktgImportServiceInvokeImportJob Node ImportJobParams Description Required. An instance of the integration object Import Job Integration Object. Type Integration Object
Response Message Description: MktgImportServiceInvokeImportJob For a description of this response message, see Table 279. Table 279. Response Message Description: MktgImportServiceInvokeImportJob Node ErrorCode Error Message Description OK or NOTOK Error message (if any) Type String String
17 1
Siebel 8.1 Primary Web Services MktgImportService
Mktg Import Service Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 280. Table 280. 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 Table 281. Table 281. Mktg Import Service Data Object Siebel Repository Name Import Job Integration Object External Name Import Job Integration Object
Example Package for MktgImportService

Request See the following file to view the sample code: \MktgImportService\MktgImportServiceInvokeImportJob_request.xml
Response See the following file to view the sample code: \MktgImportService\MktgImportServiceInvokeImportJob_response.xml
Message Schema (WSDL) for Mktg Import Service

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: \MktgImportService\MktgImportService.wsdl
172
Siebel 8.1 Primary Web Services OrderDetailWebService
OrderDetailWebService
Use this Web service to query orders based on search criteria, and retrieve details from a particular order. Details include payments,approvals, shipping and billing ,to track the shipment details of an order. Additionally, users can copy current order lines to a cart and/or cancel an order.
OrderDetailWebService Operations
For a list of operations associated with this Web service, see Table 282. Table 282. 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.This operation is used for querying the order details including the payment, approvals, shipping and billing details. Performs update operations on the PDS Order Detail Integration Object as the input. This operation is used for editing the details of an order such as copy lines of the current order and/or cancel order.
OrderDetailUpdate
Request Message Description: OrderDetailQueryPage Based on the view criteria and searchspec set on the Integration Object ,the order query can query the order header, line details of the order, approvals, payment, shipping, billing and shipment details. For a description of this request message, see Table 283. Table 283. Request Message Description: OrderDetailQueryPage Node OrderDetailQueryPage_Input Description The method arguments are Orders IO with query parameters set, Language Mode (value is LDC) and viewMode (All). Type Integration Object
Response Message Description: OrderDetailQueryPage Based on the view criteria and searchspec set on the Integation Object, information about order header, line details of the order, approvals, payment, shipping, billing and shipment details is returned in the response.For a description of this response message, see Table 284. Table 284. Response Message Description: OrderDetailQueryPage Node OrderDetailQueryPage_Output Description The retrieved data for the query set on the view criteria and searchspec. Type Integration Object
17 3
Siebel 8.1 Primary Web Services OrderDetailWebService
Request Message Description: OrderDetailUpdate For a description of this request message, see Table 285. Table 285. Request Message Description: OrderDetailUpdate Node OrderDetailUpdate_Input Description The method arguments are Orders IO with parameters set, Language Mode (value is LDC) and viewMode (All). Type Integration Object
Response Message Description: OrderDetailUpdate For a description of this response message, see Table 286. Table 286. Response Message Description: OrderDetailUpdate Node OrderDetailUpdate_Output Description The retrieved data for the update operation performed. Type Integration Object
OrderDetailWebService 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. This Web service exposes the EAI UI Business Service PDS Order Detail, which provides update and query operations on the Integration Object PDS Order Detail.
Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 287. Table 287. 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, see Table 288. Table 288. OrderDetailWebService Data Object Siebel Repository Name PDS Order Detail External Name PDS Simplified Order
Example Package for OrderDetailWebService

174
Siebel 8.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.xml
Message Schema (WSDL) for OrderDetailWebService

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: \OrderDetailWebService\OrderDetailWebService.wsdl
PDSOrderHeader
Use this Web service to get header information for specific open orders.
PDSOrderHeader Operations
For a list of operations associated with this Web service, see Table 289. Table 289. PDSOrderHeader Operations Name PDSOrderHeaderQueryPage Description Get the header information of open orders for a specific asset.
Request Message Description: PDSOrderHeaderQueryPage For a description of this request message, see Table 290. Table 290. Request Message Description: PDSOrderHeaderQueryPage Node PDSOrderHeaderQueryPage_Input Description The request message includes the search criteria for order status and asset integration Id. Type ComplexType
17 5
Siebel 8.1 Primary Web Services PriceListsWS
Response Message Description: PDSOrderHeaderQueryPage For a description of this response message, see Table 291. Table 291. Response Message Description: PDSOrderHeaderQueryPage Node PDSOrderHeaderQueryPage_Output Description The response message includes list of order headers matching the search criteria. Type ComplexType
Example Package for PDSOrderHeader

Request See the following file to view the sample code: \PDSOrderHeader\PDSOrderHeader_request.xml
Response See the following file to view the sample code: \PDSOrderHeader\PDSOrderHeader_response.xml
Message Schema (WSDL) for PDSOrderHeader

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: \PDSOrderHeader\PDSOrderHeader.wsdl
PriceListsWS
Use this Web service to obtain price lists based on defined search specifications.
PriceListsWS Operations
For a list of operations associated with this Web service, see Table 292. Table 292. PriceListsWS Operations Node GetPriceLists Description Get all the price lists based on search spec.
176
Siebel 8.1 Primary Web Services PriceListsWS
Request Message Description: GetPriceLists For a description of this request message, see Table 293. Table 293. Request Message Description: GetPriceLists Node GetPriceLists_Input Description Request message includes the search spec. Type ComplexType
Response Message Description: GetPriceLists For a description of this response message, see Table 294. Table 294. Response Message Description: GetPriceLists Node GetPriceLists_Output Description Response message includes the price lists matching the search spec. Type ComplexType
Example Package for PriceListsWS

Request See the following file to view the sample code: \PriceListsWS\PriceListsWS_request.xml
Response See the following file to view the sample code: \PriceListsWS\PriceListsWS_response.xml
Message Schema (WSDL) for PriceListsWS

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: \PriceListsWS\PriceListsWS.wsdl
17 7
Siebel 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, if needed, in the billing application. The response message returns only an acknowledgement message and not data.
ProcessSalesOrderSiebelJMSProducer Operations
For a list of operations associated with this Web service, see Table 295. Table 295. ProcessSalesOrderSiebelJMSProducer Operations Operation Name Process Description Submits a sales order to the billing application and creates a customer account, if needed, in the billing application.
Request Message Description: Process For a description of this request message, see Table 296. Table 296. Request Message Description: Process Node Order OrderItem OrderItemXA Description The details of the header for the order. The details of the order item. The properties of the order item.
ProcessSalesOrderSiebelJMSProducer Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 297. Table 297. ProcessSalesOrderSiebelJMSProducer Service Object Name ProcessSalesOrderSiebelJMSProducer Boundary Object Type Business Service Class (If Business Service) CSSWSOutboundDispatcher
178
Siebel 8.1 Primary Web Services ProcessSalesOrderSiebelJMSProducer
Data Object (Integration Object) For a description of data objects for this Web service, see Table 298. Table 298. ProcessSalesOrderSiebelJMSProducer Data Object Siebel Repository Name PDS Order - No Hierarchy External Name PDS Simplified Order
Methods For a description of the methods for this Web service, see Table 299. Table 299. ProcessSalesOrderSiebelJMSProducer Methods Operation process Method [BS: ProcessSalesOrderSiebelJMSProducer].process
Example Package for ProcessSalesOrderSiebelJMSProducer

Request See the following file to view the sample code: ...\ProcessSalesOrderSiebelJMSProducer\ProcessSalesOrderSiebelJMSProducerRequest Message.xml Response See the following file to view the sample code: ...\ProcessSalesOrderSiebelJMSProducer\ProcessSalesOrderSiebelJMSProducerResponse Message.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, 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: ...\ProcessSalesOrderSiebelJMSProducer\ProcessSalesOrderSiebelJMSProducer.xml
17 9
Siebel 8.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. In this Web service, upsert denotes a combination of the insert and update operations. The response message returns only an acknowledgement message and not data.
Product Import Operations

For a list of operations associated with this Web service, see Table 300. Table 300. Product Import Operations Operation Name Product Import Insert Description This operation: Inserts the root product definition. Generates an error if the product definition exists. Upserts the related products in the product structure. Performs the insert operation if the child product structure does not exist. Performs the update operation if the child product structure exists. Upserts the workspace project.
Product Import Update
This operation: Updates the root product definition and the related products in the product structure. Generates an error if the product definition or the child product structure does not exist. Upserts the workspace project.
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. Performs the update operation if the product definition or the child product structure exists. Upserts the workspace project.
Request Message Description: Product Import Insert For a description of this request message, see Table 301. Table 301. Request Message Description: Product Import Insert Node SiebelMessage Description The Siebel message for the integration object of CMU Product Integration.
180
Request Message Description: Product Import Update For a description of this request message, see Table 302. Table 302. Request Message Description: Product Import Update 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 303. Table 303. Request Message Description: Product Import Upsert Node SiebelMessage Description The Siebel message for the integration object of CMU Product Integration.
Application Interface for Product Import

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 304. Table 304. Product Import Service Object Name Product Import Boundary Object Type Business Service Class (If Business Service) CSSCMUProdWebSvc
18 1
Business Service User Property For a description of the user properties for this Business Service, see Table 305. Table 305. 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. Integration Object name for data sync service. Currently not supported. Integration Object name for data sync service. Currently not supported. Integration Object name for data sync service. Integration Object name for data sync service. See the first note after this table. 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.
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
Table 305. 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. 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. 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 first note after this table. See the first note after this table.
18 3
Table 305. 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. 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. 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. 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.
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
Table 305. 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. 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. 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.
NOTE: You must change this value if you use an integration object, integration component, business object, or business component with a different name. NOTE: This value is the field map. The first part is the data type (for example, product, class, and attribute). The second part is the integration component name. The third part is the integration component field name.
Data Object (Integration Object) For a description of data objects for this Web service, see Table 306. Table 306. Product Import Data Object Siebel Repository Name CMU Product Integration External Name CMU Product Integration
18 5
Siebel 8.1 Primary Web Services ProductSearchService
Methods For a description of the methods for this Web service, see Table 307. Table 307. Product Import Methods Operation Product Import Insert Product Import Update Product Import Upsert Method [BS: Product Import].Insert [BS: Product Import]. Update [BS: Product Import]. Upsert
Example Package for Product Import

Request See the following file to view the sample code: ...\ProductImport\ProductImport_request.xml Response See the following file to view the sample code: ...\ProductImport\ProductImport_response.xml
Message Schema for Product Import

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: ...\ProductImport\Product Import.wsdl
ProductSearchService
Business Service (Search Product Service) for Searching Product Business Component and doing eligibility check.
186
ProductSearchService Operations
For a list of operations associated with this Web service, see Table 308. Table 308. ProductSearchService Operations Node ExecuteSearch Description Retrieve Products based on passed criteria. Type Input: SearchProductInputSiebelMessage Output: SearchProductResponseSiebelMessage
Request Message Description: QuoteCheckOut For a description of this request message, see Table 309. Table 309. 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
18 7
Table 309. 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, see Table 310. Table 310. Response Message Description: ExecuteSearch Node TotalRecords ProductId Description Total number of records retrieved. Product Id. Type String String
ProductSearchService Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 311. Table 311. ProductSearchService Service Object Name SearchProductService Boundary Object Type Business Service Class CSSSrchProductSvc
188
Siebel 8.1 Primary Web Services QuoteCheckOutWebService
Data Object (Integration Object) For a description of data objects for this Web service, see Table 312. Table 312. ProductSearchService Data Object Siebel Repository Name Context SearchProductInputSiebelMessage SearchProductResponseSiebelMessage External Name PDS Catalog Context SearchProductInputIO SearchProductResponseIO
Example Package for ProductSearchService

Request See the following file to view the sample code: \ProductSearchService\ProductSearchService_request.xml
Response See the following file to view the sample code: \ProductSearchService\ProductSearchService_response.xml
Message Schema (WSDL) for ProductSearchService

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: \ProductSearchService\ProductSearchService.wsdl
QuoteCheckOutWebService
Use this Web service to perform payment authorizations for quotes.
18 9
Siebel 8.1 Primary Web Services QuoteCheckOutWebService
QuoteCheckOutWebService Operations
For a list of operations associated with this Web service, see Table 313. Table 313. QuoteCheckOutWebService Operations Node QuoteCheckOut Description Performs the payment authorization. If the authorization fails, the operation stops and returns. Otherwise, the quote is submited to order.
Request Message Description: QuoteCheckOut For a description of this request message, see Table 314. Table 314. Request Message Description: QuoteCheckOut Node QuoteCheckOut_Input Description The request message includes the Id of the quote to be submitted, a flag to indicate whether to do credit card authorization, and a flag to indicate whether to submit the quote to order. Type ComplexType
Response Message Description: QuoteCheckOut For a description of this response message, see Table 315. Table 315. Response Message Description: QuoteCheckOut Node QuoteCheckOut_Output Description The response message includes the Id of the order converted from quote. Type ComplexType
Example Package for QuoteCheckOutWebService

Request See the following file to view the sample code: \QuoteCheckOutWebService\QuoteCheckOutWebService_request.xml
Response See the following file to view the sample code: \QuoteCheckOutWebService\QuoteCheckOutWebService_response.xml
190
Siebel 8.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, 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: \QuoteCheckOutWebService\QuoteCheckOutWebService.wsdl
QuoteDetailWebService
Use this Web service to retrieve, update, insert, or delete details on a quote record.
QuoteDetailWebService Operations
For a list of operations associated with this Web service, see Table 316. Table 316. QuoteDetailWebService Operations Node QuoteDetailGet QuoteDetailUpdate QuoteDetailInsert QuoteDetailDelete QuoteDetailInit Description Requests and retrieves quote detail. Updates quote details. Inserts new quote detail. Deletes quote details. Quote is initialized from database.
Request Message Description: QuoteDetailGet For a description of this request message, see Table 317. Table 317. Request Message Description: QuoteDetailGet Node QuoteDetailGet_Input Description Quote object passed to the Web service. It includes the search criteria. Type ComplexType
Response Message Description: QuoteDetailGet For a description of this response message, see Table 318. Table 318. 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
19 1
Request Message Description: QuoteDetailUpdate For a description of this request message, see Table 319. Table 319. Request Message Description: QuoteDetailUpdate Node QuoteDetailUpdate_Input Description Quote to be updated into database. Type ComplexType
Response Message Description: QuoteDetailUpdate For a description of this response message, see Table 320. Table 320. Response Message Description: QuoteDetailUpdate Node QuoteDetailUpdate_Output Description Quote returned with updated information. Type ComplexType
Request Message Description: QuoteDetailInsert For a description of this request message, see Table 321. Table 321. Request Message Description: QuoteDetailInsert Node QuoteDetailInsert_Input Description Quote to be inserted into database. Type ComplexType
Response Message Description: QuoteDetailInsert For a description of this response message, seeTable 322. Table 322. Response Message Description: QuoteDetailInsert Node QuoteDetailDelete_Output Description Quote returned from Web service. Type ComplexType
Request Message Description: QuoteDetailDelete For a description of this request message, see Table 323 Table 323. Request Message Description: QuoteDetailDelete Node QuoteDetailDelete_Input Description Quote to be deleted from database. Type ComplexType
192
Response Message Description: QuoteDetailDelete For a description of this response message, see Table 324. Table 324. Response Message Description: QuoteDetailDelete Node QuoteDetailDelete_Output Description Quote returned from Web service. Type ComplexType
Request Message Description: QuoteDetailInit For a description of this request message, see Table 325. Table 325. Request Message Description: QuoteDetailInit Node QuoteDetailInit_Input Description Quote to be initialized from database. Type ComplexType
Response Message Description: QuoteDetailInit For a description of this response message, see Table 326. Table 326. Response Message Description: QuoteDetailInit Node QuoteDetailInit_Output Description Quote returned from Web service. Type ComplexType
Example Package for QuoteDetailWebService

Request See the following file to view the sample code: \QuoteDetailWebService\QuoteDetailWebService_request.xml
Response See the following file to view the sample code: \QuoteDetailWebService\QuoteDetailWebService_response.xml
Message Schema (WSDL) for QuoteDetailWebService

19 3
Siebel 8.1 Primary Web Services QuotingWebService
See the following file to view the message schema: \QuoteDetailWebService\QuoteDetailWebService.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, see Table 327. Table 327. QuotingWebService Operations Name ExecuteQuoting Description Saves the quote into the database. Checks the eligibility, verifies the promotion, or calculates the price, shipping charge and tax based on the pass-in flag.
Request Message Description: ExecuteQuoting For a description of this request message, see Table 328. Table 328. Request Message Description: ExecuteQuoting Node ExecuteQuoting_Input Description The request message includes the quote to be saved. It also includes the following flags: Flag to indicate whether to check the eligibility. Flag to indicate whether to calculate the price for the quote. Flag to indicate whether to calculate the shipping cost. Flag to indicate whether to calculate the tax. Flag to indicate whether to verify the promotion. Flag to indicate whether to query the quote back from database or just return the quote in memory. Type ComplexType
194
Siebel 8.1 Primary Web Services QuotingWebService
Response Message Description: ExecuteQuoting For a description of this response message, see Table 329. Table 329. Response Message Description: ExecuteQuoting Node ExecuteQuoting_Output Description The response message includes the quote returned from Web service. Type ComplexType
QuotingWebService Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 330. Table 330. 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, see Table 331. Table 331. QuotingWebService Data Object Siebel Repository Name PDS Quote External Name PDS Simplified Quote
Example Package for QuotingWebService

Request See the following file to view the sample code: \QuotingWebService\QuotingWebService_request.xml
Response See the following file to view the sample code: \QuotingWebService\QuotingWebService_response.xml
19 5
Siebel 8.1 Primary Web Services Response
Message Schema (WSDL) for QuotingWebService

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: \QuotingWebService\QuotingWebService.wsdl
Response
Use this Web service for the basic Marketing operations such as creating and updating responses.
Response Operations
For a list of operations associated with this Web service, see Table 332. Table 332. Response Operations Name ResponseCreateResponse ResponseSourceCodeLookup ResponseUpdateResponse Description Creates a Response. This operation is used to determine the campaign history record. Updates a Response.
Request Message Description: ResponseCreateResponse This method takes in an Integration Object called Response IO and returns the Response Id and Success Flag. For a description of this request message, see Table 333. Table 333. Request Message Description: ResponseCreateResponse Node Response IO Description Required input parameter. Type Integration Object
Response Message Description: ResponseCreateResponse For a description of this response message, see Table 334 Table 334. Response Message Description: ResponseCreateResponse Node Response Id Error Message Success Flag Description Row Id of the new response. Error message, if any. Y or N. Type String String String
196
Request Message Description: ResponseSourceCodeLookup This method takes in Ids and Codes of Offer, Campaign and Treatment and returns the S_CAMP_CON_ID. For a description of this request message, see Table 335. Table 335. 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. Campaign Id of response source. Offer code for response. Offer Id for reponse. Source code for response. Treatment code for response. Treatment Id for response. Type String String String String String String String
Response Message Description: ResponseSourceCodeLookup For a description of this response message, see Table 336. Table 336. Response Message Description: ResponseSourceCodeLookup Node S_CAMP_CON_ID Error Message Success Flag Description Row Id of the response. Error message, if any. Y or N. Type String String String
Request Message Description: ResponseUpdateResponse This method updates an existing response. For a description of this request message, see Table 337. Table 337. Request Message Description: ResponseUpdateResponse Node Response IO Description Required input parameter. Type Integration Object
Response Message Description: ResponseUpdateResponse For a description of this response message, see Table 338. Table 338. Response Message Description: ResponseUpdateResponse Node Error Message Success Flag Description Error message, if any. Y or N. Type String String
19 7
Example Package for Response

Request (ResponseCreateResponse) See the following file to view the sample code: \Response\ResponseCreateResponse_request.xml
Response (ResponseCreateResponse) See the following file to view the sample code: \Response\ResponseCreateResponse_response.xml
Request (ResponseSourceCodeLookup) See the following file to view the sample code: \Response\ResponseSourceCodeLookup_request.xml
Response (ResponseSourceCodeLookup) See the following file to view the sample code: \Response\ResponseSourceCodeLookup_response.xml
Request (ResponseUpdateResponse) See the following file to view the sample code: \Response\ResponseUpdateResponse_request.xml
Response (ResponseUpdateResponse) See the following file to view the sample code: \Response\ResponseUpdateResponse_request.xml
Message Schema (WSDL) for Response

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: \Response\Response.wsdl
198
Siebel 8.1 Primary Web Services RetrieveAttachmentService
RetrieveAttachmentService
This Web service has one standard QueryPage method to retrieve attachment documents.
RetrieveAttachmentService Operations
Provides search solution results. Business Service (Search Solution Service) for Searching Solution Business Component. For a list of operations associated with this Web service, see Table 339. 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.
Request Message Description: RetrieveAttachmentService This fetches the Attachment content for a given attachment Id. For a description of this request message, see Table 340. Table 340. 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
19 9
Siebel 8.1 Primary Web Services RetrieveAttachmentService
Table 340. 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, see Table 341. Table 341. 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

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 342. Table 342. RetrieveAttachmentService Service Object Name RetrieveAttachmentService Boundary Object Type Business Service Class CSSEAIUIDataService
200
Siebel 8.1 Primary Web Services searchSolution
Data Object (Integration Object) For a description of data objects for this Web service, see Table 343. Table 343. RetrieveAttachmentService Data Object Siebel Repository Name SiebelMessageIn SiebelMessageOut External Name AttachmentDocIO AttachmentDocIO
Example Package for RetrieveAttachmentService

Request See the following file to view the sample code: \RetrieveAttachmentService\RetrieveAttachmentService_request.xml
Response See the following file to view the sample code: \RetrieveAttachmentService\RetrieveAttachmentService_response.xml
Message Schema (WSDL) for RetrieveAttachmentService

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: \RetrieveAttachmentService\RetrieveAttachmentService.wsdl
searchSolution
Use this Web service to search for solutions based on user inputs, and retrieve a solution as a search result.
20 1
searchSolution Operations
Provides search solution results. Business Service (Search Solution Service) for Searching Solution Business Component. For a list of operations associated with this Web service, see Table 344. Table 344. searchSolution Operations Name searchSolution.searchSolution Parameters Input: SearchInputsIO (SearchText, SolutionType, To, From). Output: SearchResultsIO (Total Records, Solution Id, Solution Title, Last Update Date). searchSolution.getSolution Input: SolutionId. Output: SolutionResultIO (Solution Id, Solution Title, Last Update Date, FAQ, Resolution Text, Solution Type, SolnAttachmentList (Attachment Id, File Name, Last Updated Date, Type) ). Description Performs a search on a solution based on specified input.
Retrieves solution from search results.
Request Message Description: searchSolution Performs a search on a solution based on specified input. For a description of this request message, see Table 345. Table 345. Request Message Description: searchSolution Node SearchText SolutionType From To Description Text to be searched. Type of Solution. Index of Record. Index of Record. Type String String String String
Response Message Description: searchSolution For a description of this response message, see Table 346. Table 346. Response Message Description: searchSolution Node TotalRecords From SolutionId SolutionTitle Description Total number of records fetched. Index of the first record returned. Solution Id. Solution Title. Type String String String String
202
Table 346. Response Message Description: searchSolution Node LastUpdateDate To Description Last update date of the record. Index of the last record fetched. Type String String
Request Message Description: getSolution Retrieves solution from search results. For a description of this request message, see Table 347. Table 347. Request Message Description: getSolution Node SolutionId Description Solution Id Type String
Response Message Description: getSolution For a description of this response message, see Table 348. Table 348. 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

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 349. Table 349. searchSolution Service Object Name Search Solution Service Boundary Object Type Business Service Class CSSSrchSolutionSvc
20 3
Siebel 8.1 Primary Web Services SelfServiceAccount
Data Object (Integration Object) For a description of data objects for this Web service, see Table 350. Table 350. searchSolution Data Object Siebel Repository Name SolutionResultSiebelMessage SearchInputsSiebelMessage SearchResultsSiebelMessage External Name SolutionResultIO SearchInputsIO SearchResultsIO
Example Package for searchSolution

Request See the following file to view the sample code: \searchSolution\searchSolution_request.xml
Response See the following file to view the sample code: \searchSolution\searchSolution_response.xml
Message Schema (WSDL) for searchSolution

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: \searchSolution\searchSolution.wsdl
SelfServiceAccount
This WebService exposes the EAI UI Business Service SelfServiceAccount, which provides CRUD and query operations on Integration Object SS_Account_IO. This WebService exposes the Execute and Query Methods in the SelfServiceAccount Business Service as Web service operations.
204
SelfServiceAccount Operations
For a list of operations associated with this Web service, see Table 351. Table 351. SelfServiceAccount Operations Name SelfServiceAccountExecute Description Performs CRUD operations on the instance of SS_Account_IO provided as input. This operation is used in Siebel Self Service 8.1 for adding, editing and deleting BusinessAddress to an Account. Performs Query operation based on the viewCriteria and searchSpec set on the instance of SS_Account_IO provided as input. This operation is used in Siebel Self Service 8.1 for querying the details of an Account, inclusive of the Business Addresses associated to the account.
SelfServiceAccountQueryPage
Request Message Description: SelfServiceAccountExecute For a description of this request message, see Table 352. Table 352. 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. Set operation accordingly. If account details need to be updated, operation = Update or if the business address needs to be added or updated, set operation to Skipnode. Set the Id of the account as a ViewCriteria, if the purpose is to update the account or create/update business address for the given account. Container element to hold the list of business addresses to be created or updated for the account. Used to create or update the business address of the Account. Set operation appropriately as Insert or Update and set IsPrimaryMVG=Y, if this address needs to be made the primary address on the Account. If the operation is update on AccountBusinessAddress, set this field to the specific address of the account.
ListOfSSAccount/ Account /Id
ListOfSSAccount/ Account / ListOfAccountBusinessAddress ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress
ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ Id
20 5
Table 352. Request Message Description: SelfServiceAccountExecute Node ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ StreetAddress (Similarly StreetAddress2, AddressLine3, State, City, County, 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. Description Set appropriate values for the details of this address.
Set TRUE if the address is the billable address for the account.
Set TRUE to fetch if the address is the shippable address for the account.
Set to TRUE, if only the active addresses of the account need to be retrieved.
Set the ModId while updating, so as to make sure that the record is not updated in the interim. Refer to Siebel EAI. Refer to Siebel EAI. Refer to Siebel EAI.
Response Message Description: SelfServiceAccountExecute For a description of this response message, see Table 353. Table 353. Response Message Description: SelfServiceAccountExecute Node SelfServiceAccountExecute_Output ListOfSSAccount ListOfSSAccount/ Account ListOfSSAccount/ Account /Id ListOfSSAccount/ Account / Mod Id Id of the account. Mod Id for the account record. Description Container element for the Execute Operation response. Corresponds to an instance of SS_Account_IO.
206
Table 353. 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 list of created or updated business address of the account. For each created or updated business address of the account.
Id of the address created or updated.
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. This operation also retrieves the following information for a given account: primary address Id, primary Bill To Address Id, primary Ship To Address Id, as well as determining if each of the retrieved addresses are Billable or Shippable. Siebel SelfService 8.1 uses LOVLanguageMode as LDC and ViewMode as All for this Web service. For a description of this request message, see Table 354. Table 354. 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. Empty; used to fetch the Id of the primary address of the account. Empty; used to fetch the Id of the Primary Bill To address of the account. Empty; used to fetch the Id of the Primary Ship To address of the account. To fetch the business address of the account. Description Container element for the QueryPage Operation request. Corresponds to an instance of SS_Account_IO.
20 7
Table 354. Request Message Description: SelfServiceAccountQueryPage Node ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ Id ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ StreetAddress (Similarly StreetAddress2, AddressLine3, State, City, County, 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; to fetch if the address is the main address for the account. Empty (Set it to retrieve a specific address of this account). Empty; Set appropriate View Criteria for filtering addresses. Description Empty.
Empty; to fetch if the address is the Billable Address for the account.
Empty; to fetch if the address is the Shippable Address for the account.
Set to TRUE, if only the active addresses of the account need to be retrieved.
Empty. Empty; to fetch the ModId to be sent back while updating, so as to make sure that the record is not updated in the interim. Refer to Siebel EAI. Refer to Siebel EAI. Refer to Siebel EAI.
208
Response Message Description: SelfServiceAccountQueryPage For a description of this response message, see Table 355. 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, State, City, County, Country) ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ MainAddressFlag ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ BillAddressFlag ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ ShipAddressFlag True, if the address is the main Address for the account. Details of the business address. Id of the account. Retrieved Id of the Primary Address of the account. Retrieved Id of the Primary Bill To address of the account. Retrieved Id of the Primary Ship To address of the account. Container element for the retrieved Business Address of the account. For each retrieved business address of the account. Id of the address. Description Container element for the QueryPage Operation response. Corresponds to an instance of SS_Account_IO.
True, if the address is the Billable Address for the account.
True, if the address is the Shippable Address for the account.
20 9
Table 355. Response Message Description: SelfServiceAccountQueryPage Node ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ ActiveStatus ListOfBusinessAddress/ BusinessAddress/ ModId Empty; to fetch the ModId to be sent back while updating, so as to make sure that the record is not updated in the interim. Description True, if the address is active.
SelfServiceAccount Application Interface

This topic describes the application objects called by the this Web service. This WebService exposes the EAI UI Business Service SelfServiceAccount, which provides CRUD and query operations on Integration Object SS_Account_IO. 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 356 Table 356. 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, see Table 357. Table 357. SelfServiceAccount Data Object Siebel Repository Name SS_Account_IO External Name SS_Account_IO
Example Package for SelfServiceAccount

Request (SelfServiceAccountExecute) See the following file to view the sample code: \SelfServiceAccount\SelfServiceAccountExecute_request.xml
210
Siebel 8.1 Primary Web Services SelfServiceAccountRootPath
Response (SelfServiceAccountExecute) See the following file to view the sample code: \SelfServiceAccount\SelfServiceAccountExecute_response.xml
Request (SelfServiceAccountQueryPage) See the following file to view the sample code: \SelfServiceAccount\SelfServiceAccountQueryPage_request.xml
Response (SelfServiceAccountQueryPage) See the following file to view the sample code: \SelfServiceAccount\SelfServiceAccountQueryPage_response.xml
Message Schema (WSDL) for SelfServiceAccount

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: \SelfServiceAccountQueryPage\SelfServiceAccount.wsdl
SelfServiceAccountRootPath
This Web service exposes the EAI UI Business Service SelfServiceAccountRootPath, which provides query operations on Integration Object SS_AccountRootPath_IO. This Web service exposes the Query Method in the SelfServiceAccount Business Service as Web service operation. In Siebel Self Service 8.1, this operation is used in the context of Global Accounts - Account Hierarchy. For a given account, 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
For a list of operations associated with this Web service, see Table 358. Table 358. 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. The response contains the list of accounts along the path to the root account and the priceList set for each of these accounts.
21 1
Request Message Description: SelfServiceAccountRootPathQueryPage For a description of this request message, see Table 359. Table 359. 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. Corresponds to an instance of SS_AccountRootPath_IO. Container element, which holds the columns to be queried, and the criteria to be used. Empty. Empty. Empty. Empty. Empty. Id of the Account, from which the path to the root Account needs to be identified. Forward only. LDC. All.
Response Message Description: SelfServiceAccountRootPathQueryPage The response contains the details based on the query set on the payment Integration Object . For a description of this response message, see Table 360. Table 360. Response Message Description: SelfServiceAccountRootPathQueryPage Node SelfServiceAccountRootPathQueryPage_Output ListOfSSAccountRootPath Description Container element for the QueryPage Operation response. Corresponds to an instance of SS_AccountRootPath_IO.
212
Table 360. Response Message Description: SelfServiceAccountRootPathQueryPage Node ListOfSSAccountRootPath /SSAccountRootPath Description Container element, which corresponds to an Account that is present along the path to the root Account. If ParPartyId is null, the retrieved account is deemed as the root account. Else, this account is one of the accounts in the path. Id of the retrieved account. Name of the retrieved account. PriceListId of the retrieved account. SELF or DIRECT or INDIRECT. 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. For more information on application implementation, refer to your application development documentation on Oracle Technology Network. For more information on application implementation, refer to application development documentation.
Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 361. Table 361. 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, see Table 362. Table 362. SelfServiceAccountRootPath Data Object Siebel Repository Name SS_AccountRootPath_IO External Name SS_AccountRootPath_IO
21 3
Siebel 8.1 Primary Web Services SelfServiceAllAccountsList
Example Package for SelfServiceAccountRootPath

Request See the following file to view the sample code: \SelfServiceAccountRootPath\SelfServiceAccountRootPath_request.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. \SelfServiceAccountRootPath\SelfServiceAccountRootPath_response.xml
Message Schema (WSDL) for SelfServiceAccountRootPath

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: \SelfServiceAccountRootPath\SelfServiceAccountRootPath.wsdl
SelfServiceAllAccountsList
This Web service exposes the EAI UI Business Service SelfServiceAllAccountsList, 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. In Siebel Self Service 8.1, this operation is used in the context of Global Accounts - Account Hierarchy. For a given root account, this operation is used for retriving all the children account that are directly or indirectly related to it, including itself.
214
SelfServiceAllAccountsList Operations
For a list of operations associated with this Web service, see Table 363. Table 363. 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. The response contains the list of accounts that are related to the root account.
Request Message Description: SelfServiceAllAccountsListQueryPage For a description of this request message, see Table 364. Table 364. Request Message Description: SelfServiceAllAccountsListQueryPage Node SelfServiceAllAccountsListQueryPage_Input ListOfSSAllAccount ListOfSSAllAccount /SSAllAccountList Description Container element for the QueryPage Operation request. Corresponds to an instance of SS_AllAccount_List_IO. Container element, which holds the columns to be queried, and the criteria to be used. Empty. Set the Root Account Id as the view criteria. Empty. Type String String String
ListOfSSAllAccount /SSAllAccountList /ModId ListOfSSAllAccount /SSAllAccountList / ParentPartyId
21 5
Table 364. 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, see Table 365. Table 365. Response Message Description: SelfServiceAllAccountsListQueryPage Node SelfServiceAllAccountsListQueryPage_Input ListOfSSAllAccount Description Container element for the QueryPage Operation response. Corresponds to an instance of SS_AllAccount_List_IO. Type String String
216
Table 365. 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. Can be SELF, DIRECT or INDIRECT. ListOfSSAllAccount /SSAllAccountList / Level1AccountStatus, Level1ApprovalStatus, Level1BusinessPhone, Level1EmailAddress, Level1FaxNumber, Level1PartyName, Level1PartyLocation, Level1PriceListId, Level1PrimaryAddressId, Level1PrimaryBillToAddressId, Level1PrimaryContactId, Level1PrimaryShipToAddressId, Level1Type ListOfSSAllAccount /SSAllAccountList / Level1ParentPartyId Immediate Parent of this child account. For accounts with RelationTypeCode as DIRECT, it matches the root account Id itelsef. AccountName of the Immediate Parent of this child account. String Retrieved details of the child account. String String Description Container element, which holds the columns to be queried, and the criteria to be used. Empty. AccountId of the child account. Type String
String String
ListOfSSAllAccount /SSAllAccountList / Level2ParentAccountName
String
21 7
SelfServiceAllAccountsList Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 366. 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, see Table 367. Table 367. SelfServiceAllAccountsList Service Object Siebel Repository Name SS_AllAccount_List_IO External Name SS_AllAccount_List_IO
Example Package for SelfServiceAllAccountsList

Request See the following file to view the sample code: \SelfServiceAllAccountsList\SelfServiceAllAccountsList_request.xml
Response See the following file to view the sample code: \SelfServiceAllAccountsList\SelfServiceAllAccountsList_response.xml
Message Schema (WSDL) for SelfServiceAllAccountsList

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: \SelfServiceAllAccountsList\SelfServiceAllAccountsList.wsdl
218
Siebel 8.1 Primary Web Services SelfServiceContact
SelfServiceContact
This Web service exposes the EAI UI Business Service SelfServiceContact, which provides CRUD and query operations on Integration Object SS_Contacts_IO. This Web service exposes the Execute and Query Methods in the SelfServiceContact Business Service as Web service operations. NOTE: Though most of the Contact and Account Management activities can be perforned using SelfServiceContact Web service, Siebel SelfService 8.1 uses SelfServiceRegistration Webservice, which also accepts an instance of Integration Object SS_Contacts_IO. SelfServiceRegistration Web service calls the SelfServiceRegistration workflow, which delegates the Integration Object to SelfServiceContact Business Service, for performing all the contact and account management activities. Hence in SelfService 8.1, SelfServiceContact Web service is mostly used for QueryPage operation.
SelfServiceContact Operations
For a list of operations associated with this Web service, see Table 368. Table 368. 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. This operation is used in Siebel Self Service 8.1 for querying the details of the contact, inclusive of the Personal Addresses associated to the contact. Description
Request Message Description: SelfServiceContactExecute For a description of this request message, see Table 369. Table 369. Request Message Description: SelfServiceContactExecute Node ListOfSSContact Contact Corresponds to a record in SS_Contacts_IO. Set operation accordingly. If Contact details needs to be updated, operation to Update or if child elements like, Personal Address, needs to be added/updated, set operation to SkipNode. Id of the Contact. Set this if the mode on Contact node is Update or SkipNode. String Description Type
Contact /Id
21 9
Table 369. Request Message Description: SelfServiceContactExecute Node Contact /ListOfAccount Description Container element for the assigned accounts of this contact. If mode on Contact is insert, then, accounts specified in this list are inserted and assigned to the newly created contact. If mode on Contact is skipnode, then, accounts specified in this list are made as the only accounts assigned for this contact. All other existing assigned accounts are unassigned by default. Contact /ListOfAccount/ Account Contact /ListOfAccount/ Account/ Name, PrimaryContactId, Type Contact/ ListOfContactCommunicationAddress Contact / ListOfContactCommunicationAddress /ContactCommunicationAddress / AlternateEmailAddress Contact / ListOfContactCommunicationAddress /ContactCommunicationAddress / CommunicationAddressId Alternate email address value to be edited or created. String Details of the assigned account. String Type
Id of the alternate email address value to be edited; blank for adding new alternate email address.
String
Response Message Description: SelfServiceContactExecute For a description of this response message, see Table 370. Table 370. Response Message Description: SelfServiceContactExecute Node SelfServiceContactExecute_Output ListOfSSContact ListOfSSContact/Contact/Id, ModId ListOfSSContact/Contact/ListOfAccount/ Account/Id, Mod Id ListOfSSContact/Contact/ ListOfCommunicationAddress/ CommunicationAddress/Id, Mod Id Description Container element for the Execute Operation request. Corresponds to an instance of SS_Contacts_IO. Id and ModId of Inserted/Updated Contact Record. Id and ModId of Inserted/Updated Account Record. Id and ModId of Inserted/Updated CommunicationAddress Record. String String String Type
220
Request Message Description: SelfServiceContactQueryPage For a description of this request message, see Table 371. Table 371. Request Message Description: SelfServiceContactQueryPage Node SelfServiceContactQueryPage_Input ListOfSSContact ListOfSSContact/Contact Contact/ Id Contact/ ModId Set the Id of the Contact as a ViewCriteria. Retrieve and pass back while updating, to make sure that Contact record is not updated in the interim. Empty (Columns to be retrieved). Description Container element for the QueryPage Operation request. Corresponds to an instance of SS_Contacts_IO. Type Complex Type (Refer WSDL) Complex Type (Refer WSDL) Complex Type (Refer WSDL)
Contact/ FirstName, MiddleName, LastName, Status, EmailAddress, CellularPhone, HomePhone, FaxPhone, WorkPhone, TimeZoneId, EmailSRUpdatesFlag, SendPromotions Contact/ LoginName, ApprovalStatus, ChallengeQuestion, ChallengeAnswer Contact/ PrimaryAccountName, PrimaryAddressId, PrimaryAddressName PrimaryPersonalAddressId Contact/ ListOfContactCommunicationAddress
Empty (Columns to be retrieved). These columns are related to the username information. Empty (Columns to be retrieved).
String
String
Container element for the AlternateEmailAddress to be retrieved. Contact can have similar sub-nodes for querying PersonalAddress, Account and AccountBusinessAddress.
String
Contact / ListOfContactCommunicationAddress /ContactCommunicationAddress
String
22 1
Table 371. Request Message Description: SelfServiceContactQueryPage Node Contact / ListOfContactCommunicationAddress /ContactCommunicationAddress / AlternateEmailAddress Contact / ListOfContactCommunicationAddress /ContactCommunicationAddress / CommunicationAddressId ExecutionMode LOVLanguageMode ViewMode Description Empty (Columns to be retrieved). Alternate Email Address of the contact. Type String
Empty (Columns to be retrieved). Id of the Alternate Email Address of the contact. ForwardOnly. LDC. All.
Complex Type
(Refer WSDL) String Complex Type
Response Message Description: SelfServiceContactExecute For a description of this response message, see Table 372. Table 372. Response Message Description: SelfServiceContactExecute Node SelfServiceContactQueryPage_Output ListOfSSContact ListOfSSContact/Contact Contact/ Id Contact/ ModId Contact/ FirstName, MiddleName, LastName, Status, EmailAddress, CellularPhone, HomePhone, FaxPhone, WorkPhone, TimeZoneId, EmailSRUpdatesFlag, SendPromotions Contact/ LoginName, ApprovalStatus, ChallengeQuestion, ChallengeAnswer Id of the Contact being queried. Container element for the QueryPage Operation response. Primitive details of the contact. EmailSRUpdatesFlag and SendPromotions contain the preferences shown in SelfService 8.1 Registration screens. Description Container element for the QueryPage Operation response. Corresponds to an instance of SS_Contacts_IO. Type Complex Type (Refer WSDL) Complex Type (Refer WSDL) Complex Type (Refer WSDL)
These nodes contain the values for the username information.
String
222
Table 372. Response Message Description: SelfServiceContactExecute Node Contact/ PrimaryAccountName, PrimaryAddressId, PrimaryAddressName PrimaryPersonalAddressId Contact/ ListOfContactCommunicationAddress Contact / ListOfContactCommunicationAddress / ContactCommunicationAddress Contact / ListOfContactCommunicationAddress / ContactCommunicationAddress / AlternateEmailAddress Contact / ListOfContactCommunicationAddress / ContactCommunicationAddress / CommunicationAddressId ExecutionMode LOVLanguageMode ViewMode Alternate Email Address of the contact. Container element for the AlternateEmailAddress retrieved. String String Description These nodes contain the values for the PrimaryAccountName, Primary BusinAddressId, Primary BusinessAddressName and PrimaryPersonalAddressId respectively. Type String
String
Id of the Alternate Email Address of the contact.
Complex Type
ForwardOnly. LDC. All.
(Refer WSDL) String Complex Type
SelfServiceContact Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 373. Table 373. SelfServiceContact Service Object Name SelfServiceContact Boundary Object Type BusinessService Class CSSEAIUIDataService
22 3
Data Object (Integration Object) For a description of data objects for this Web service, see Table 374. Table 374. SelfServiceContact Data Object Siebel Repository Name SS_Contacts_IO External Name SS_Contacts_IO
Example Package for SelfServiceContact

Request (SelfServiceContactQueryPage) See the following file to view the sample code: \SelfServiceContact\SelfServiceContactQueryPage_request.xml
Response (SelfServiceContactQueryPage) See the following file to view the sample code: \SelfServiceContact\SelfServiceContactQueryPage_request.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, 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: \SelfServiceContact\SelfServiceContact.wsdl
224
Siebel 8.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. Payment details like Payment type, Payment profile,transaction amount, type and date for different orders against which the payment was made by a contact can be queried.
SelfServicePaymentHistory Operations
For a list of operations associated with this Web service, see Table 375. Table 375. SelfServicePaymentHistory Operations Name SelfServicePaymentHistoryQueryPage Description Performs query operations set on the SS_PaymentHistory_IO Integration Object as the input.this method is used for querying the payment details for different orders performed by a contact.
Request Message Description: SelfServicePaymentHistoryQueryPage Based on the query criteria set on the Integration Object,payment related details like the payment profile details, transaction amount,type and date along with the order numbers can be queried. For a description of this request message, see Table 376. Table 376. Request Message Description: SelfServicePaymentHistoryQueryPage Node SelfServicePaymentHistory QueryPage_Input Description The method arguments are Payment Integration Object, Language Mode (value is LDC) and viewMode (All). Type Integration Object
Response Message Description: SelfServicePaymentHistoryQueryPage The response contains the details based on the query set on the payment Integration Object. For a description of this response message, see Table 377. Table 377. Response Message Description: SelfServicePaymentHistoryQueryPage Node SelfServicePaymentHistoryQueryPage_Output Description Integration Object Type The retrieved data for the query performed.
SelfServicePaymentHistory Application Interface

This Web service exposes the EAI UI Business Service SelfServicePaymentHistory, which provides update and query operations on Integration Object SS_PaymentHistory_IO. For more information on application implementation, refer to your application development documentation on Oracle Technology Network.
22 5
Siebel 8.1 Primary Web Services SelfServicePaymentHistory
Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 378. Table 378. 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, see Table 379. Table 379. SelfServicePaymentHistory Data Object Siebel Repository Name SS_PaymentHistory_IO External Name Payments
Example Package for SelfServicePaymentHistory

Request See the following file to view the sample code: \SelfServicePaymentHistory\SelfServicePaymentHistory_request.xml
Response See the following file to view the sample code: \SelfServicePaymentHistory\SelfServicePaymentHistory_response.xml
Message Schema (WSDL) for SelfServicePaymentHistory

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: \SelfServicePaymentHistory\SelfServicePaymentHistory.wsdl
226
Siebel 8.1 Primary Web Services SelfServicePostLoginProcess
SelfServicePostLoginProcess
This Web service exposes the SelfServicePostLoginProcess workflow as LoadUserDetails operation. The response of this Web service is determined by the P_Mode request parameter, as displayed in Table 380.
P_Mode Request Parameter

For a description of the P_Mode request parameter, see Table 380. Table 380. P_Mode Request Parameter P_Mode OnlyLoadResponsibilities SkipLoadResponsibilities LoadEverything Response Returns only the responsibilities for the given user name. Returns only the contact details for the given user name. Returns both the contact details and responsibilities for the given user name.
SelfServicePostLoginProcess Operations
For a list of operations associated with this Web service, see Table 381. Table 381. SelfServicePostLoginProcess Operations Name LoadUserDetails Description This operation triggers the SelfServicePostLoginProcess workflow.
Request Message Description: LoadUserDetails For a description of this request message, see Table 382. Table 382. Request Message Description: LoadUserDetails Node P_Mode ListOfSSContact Description See P_Mode Request Parameter table. An SS_Contact_IO instance, where in ListOfSSContact/Contact/LoginName contains the username of the user for whom the details need to be retrived. Refer to the SelfServiceContact.doc for the details on ListOfContact and its subnodes. Username of the user for whom the details need to be retrived. Container element for Responsibilities. Maps to an instance of getUserResponsibilitiesResponse IO String Complex Type (See WSDL) Type String
P_LoginName getUserResponsibilitiesResponse getUserResponsibilitiesResponse / listOfUserResponsibilities/
22 7
Response Message Description: LoadUserDetails For a description of this response message, see Table 383. Table 383. Response Message Description: LoadUserDetails Node LoadUserDetails_Output ListOfSSContact Description Container element for the LoadUserDetails operation response. An SS_Contact_IO instance, where in ListOfSSContact/Contact/Id contains the contactId of the user for whom the details are retrieved. Refer to the SelfServiceContact.doc for the other nodes in ListOfContact and its complex subnodes, like Account and PersonalAddrrss, which will have the retrived accounts(assigned) and PersonalAddress of the contact respectively. Will be blank when mode is SkipLoadResponsibilities. Type Complex Type (See WSDL)
getUserResponsibilitiesResponse
Complex Type
getUserResponsibilitiesResponse / listOfUserResponsibilities/ userResponsibilities/ responsibilityValue Error_spcCode Error_spcMessage
(See WSDL)
Name of the Responsibility. Error Code returned by the Workflow.
Complex Type (See WSDL)
SelfServicePostLoginProcess Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 384. Table 384. SelfServicePostLoginProcess Service Object Name SelfServicePostLoginProcess Boundary Object Type Workflow
228
Data Object (Integration Object) For a description of data objects for this Web service, see Table 385. Table 385. SelfServicePostLoginProcess Data Object Siebel Repository Name SelfServiceContact getUserResponsibilitiesResponse External Name SelfServiceContact getUserResponsibilitiesResponse
Example Package for 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.xml
Request (LoadUserDetails_SkipLoadResponsibilities) See the following file to view the sample code: \SelfServicePostLoginProcess\LoadUserDetails_SkipLoadResponsibilities_request.xml
Response (LoadUserDetails_SkipLoadResponsibilities) See the following file to view the sample code: \SelfServicePostLoginProcess\LoadUserDetails_SkipLoadResponsibilities_response.xml
Message Schema (WSDL) for SelfServicePostLoginProcess

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: \SelfServicePostLoginProcess\SelfServicePostLoginProcess.wsdl
22 9
Siebel 8.1 Primary Web Services SelfServiceRegistration
SelfServiceRegistration
The Enroll operation of this webservice invokes the SelfServiceRegistration workflow, which internally uses the Business Services listed below to manage contacts, assigned accounts, assigned personal/business addresses, create username, manage assigned responsibilities, send welcome or password update notifications and createInboxItems to simulate pending registration approvals. Activity of the workflow is determined by the P_mode input parameter passed to this webservice operation.
P_Mode Request Parameter

For a description of the P_Mode request parameter, see Table 386. Table 386. P_Mode Request Parameter P_Mode CreateContact Response Used for creating a contact without a username. Used in Siebel SelfService 8.1 in contact creation in the Contacts Administration screen, and other usages in the Contacts - Profile, and the Contacts - Account views. UpdateContact Used for updating a contact without a username. Used in Siebel SelfService 8.1 in the Contacts - Administration screen, and the Contacts - Profile, and Contacts - Account views. Also used for Personal Info updating from Contacts - Profile view. CreateUser Used for creating a new contact, create a username in the associated LDAP, assign responsibilities, send welcome notification to the user and create an inbox item to the admin, if approval is needed. Need to pass the Usertype details (like approval required), notification template, inbox and approval types, when the mode is CreateUser. Used in Siebel SelfService 8.1 for making a contact as a user in the Contacts - Administration screen. Also used for all self-service registrations. UpdateUser Used for updating a contact with a username and manage the assigned accounts and responsibilities. Used in Siebel SelfService 8.1 in the Contacts - Administration screen to update user information. ResetPasswordOnly Used for resetting the password of the currently logged in user of the siebel session or in the anonymous session. Also used in Forgot Password Flow (for an anonymous session).
230
SelfServiceRegistration Operations
For a list of operations associated with this Web service, see Table 387. Table 387. SelfServiceRegistration Operations Name Enroll Description Internally calls the business services listed below.
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, see Table 388. Table 388. 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. BeginTransaction will not take any parameters as input.
23 1
SelfServiceContact Business Service For a description of this Business Service, see Table 389. Table 389. Self ServiceContact Business Service SelfServiceContact Business Service Step Business Service Name Business Service Method Create, 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, Account, Contact Address, Contact_Account relationships and Alternate Communication Address. 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. 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. Sample SOAP request portions of SS_Contacts_IO are shown below.
232
PRM ANI Utility Service Business Service For a description of this Business Service, see Table 390. Table 390. 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, given the contact IO. In SelfService 8.1, this step is only applicable during the Register your company flow to retrieve the Id of the newly created corporate account, which is then sent to Trigger Approval, and established as the root account. Hence, the caller (java API that calls the proxy) shall ignore the errors reported by this step.
PRM ANI Utility Service Business Service For a description of this Business Service, seeTable 391. 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
23 3
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, given the contact IO. In SelfService 8.1, this step is only applicable during the Register your company flow to retrieve the Id of the newly created corporate account, which is then sent to Trigger Approval, and established as the root account. Hence, the caller (java API that calls the proxy) shall ignore the errors reported by this step.
SiebelWebRegistrationService Business Service For a description of this Business Service, seeTable 392. Table 392. 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
Table 392. 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. The business service needs to create Web Channel User of Web User Type, LDAP user record, S_USER record and also update the security question and answer.
Self Service User Business Service For a description of this Business Service, seeTable 393. Table 393. 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. It uses a new EAIUI Service named SelfServiceUser that creates the S_PER_RESP records for the given user Id and the responsibility Id.
23 5
EAITransactionService Business Service For a description of this Business Service, see Table 394. Table 394. 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. EndTransaction to commit the transaction. The parameter Is Abort need be set to False to commit the transaction.
236
ISS Approval Bus Service Business Service For a description of this Business Service, see Table 395. Table 395. 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. CreateNewApprovalTasks business service method to create new Inbox Items based on the Inbox Type and Approval Types specified. This step is executed only if approval is required by the user type, based on the P_UsertypeApprovalRequd process property. Note that P_AccountId contains the root account of the corporate account under which the contact/user is being created. Hence, for newly created corporate account (Register your company flow), P_AccountId is set to the Id of the newly created account. For more information, see Siebel Self-Service Application Developers Guide.
23 7
Outbound Communications Manager Business Service For a description of this Business Service, seeTable 396. 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, using the Outbound Communications Manager. CreateRequest. This Business Service Method substitutes the necessary values from the Contact Business Component loaded for the Id specified. For more information, see Siebel Self-Service Application Developers Guide. P_ContactId P_NotificationTemplateName P_Language P_Locale Property Name
238
SessionAccessService Business Service For a description of this Business Service, see Table 397. Table 397. 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. For more information, see Siebel Self-Service Application Developers Guide.. P_NewPassword P_NotificationTemplateName P_Language P_Locale Property Name
Response Message Description: CreateContact For a description of this Business Service, see Table 398. 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. 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
23 9
Table 398. 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. Refer to SelfServiceContact WebService document for more information on the Structure and subnodes of ListOfSSContact. Maps to the P_ContactIO process property in the workflow. P_ContactId P_AccountId Not of consequence in response. Derived Root Account Id Refer to SelfService 8.1 Siebel BookShelf for more details. 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. Not of consequence in response. Not of consequence in response. Username created Not of consequence in response. Value returned by SiebelWebRegistration BusinessService. The status set on the newly created user. Inactive, for pending users. Not of consequence in response. Not of consequence in response. Not of consequence in response. Not of consequence in response. String String String String String String String String String String String String String Type Integration Object
240
Table 398. 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. Refer to SelfServiceUser WebService document for more information on the Structure and subnodes of ListOfSSUser. Maps to the P_UserIO process property in the workflow. P_UsertypeApprovalRequd P_UsertypeApprovalType P_UsertypeInboxType P_UsertypeNotifTemplateName P_RecipientGroup P_Language P_Locale Not of consequence in response. Not of consequence in response. Not of consequence in response. Not of consequence in response. Not of consequence in response. Not of consequence in response. Not of consequence in response. String String String String String String String Type Integration Object
Self Service Registration Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 399. Table 399. Self Service Registration Service Object Name SelfServiceRegistration Boundary Object Type Workflow
24 1
Data Object (Integration Object) For a description of data objects for this Web service, see Table 400. Table 400. 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, 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 and Response Samples are provided for the following scenarios:
1 2 3 4
Create a B2C contact and a username and trigger notification. Create a B2B contact as Inactive and create a username and trigger notification and create Inbox Items for approval. Update Personal addresses of an existing Contact. Update Contact details, Account Assignments, Responsibility Assignments, Password resetting for an existing contact.
Request Create a B2C contact and username and trigger notification. See the following file to view the sample code: \SelfServiceRegistration\SelfServiceRegistration_1_request.xml
Response Create a B2C contact and username and trigger notification. See the following file to view the sample code: \SelfServiceRegistration\SelfServiceRegistration_1_request.xml
Request Create a B2B contact as Inactive and create a username and trigger notification and create Inbox Items for approval. See the following file to view the sample code: \SelfServiceRegistration\SelfServiceRegistration_2_request.xml
242
Response Create a B2B contact as Inactive and create a username and trigger notification and create Inbox Items for approval. See the following file to view the sample code: \SelfServiceRegistration\SelfServiceRegistration_2_response.xml
Request Update Personal Addresses of an existing contact. See the following file to view the sample code: \SelfServiceRegistration\SelfServiceRegistration_3_request.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, Account Assignment, Responsibility Assignment, Password resetting for an existing contact. See the following file to view the sample code: \SelfServiceRegistration\SelfServiceRegistration_4_request.xml
Response Update Contact Details, Account Assignment, Responsibility Assignment, Password resetting for an existing contact See the following file to view the sample code: \SelfServiceRegistration\SelfServiceRegistration_4_response.xml
Message Schema (WSDL) for SelfServiceRegistration

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: \SelfServiceRegistration\SelfServiceRegistration.wsdl
24 3
Siebel 8.1 Primary Web Services SelfServiceResponsibility
SelfServiceResponsibility
This Web service exposes the EAI UI Business Service SelfServiceResponsibility, which provides query operation on Integration Object SS_Responsibility_IO. Additionally, this Web service exposes the Query Method in the SelfServiceResponsibility Business Service as Web service operation.
SelfServiceResponsibility Operations
For a list of operations associated with this Web service, see Table 401. Table 401. 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. This operation is used in Siebel Self Service 8.1 for retrieving the Id and Name of Web Enabled Responsibilities.
Request Message Description: SelfServiceResponsibilityQueryPage For a description of this request message, see Table 402. Table 402. 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. Container element for the list of SS_Responsibility_IO. Corresponds to an SS_Responsibility_IO IO. Corresponds to the primary IC Responsibility. Set to Yes, for retrieving only Web Enabled Responsibilities. Empty; Placeholder for the Id of the responsibility to be retrived. Empty; Placeholder for the name of the responsibility to be retrived.
244
Siebel 8.1 Primary Web Services SelfServiceResponsibility
Response Message Description: SelfServiceResponsibilityQueryPage For a description of this response message, see Table 403. Table 403. Response Message Description: SelfServiceResponsibilityQueryPage Node SelfServiceResponsibilityQueryPage_Output Description Container element for SelfServiceResponsibility WebService output for QueryPage operation. Container element for the list of SS_Responsibility_IO. Corresponds to an SS_Responsibility_IO Integration Object. Corresponds to the primary IC Responsibility. Yes for Web Enabled Responsibility. Retrived Id of the responsibility. Retrived name of the responsibility.
ListOfSSResponsibility
ListOfSSResponsibility/Responsibility ListOfSSResponsibility/Responsibility/ AccessType ListOfSSResponsibility/Responsibility/Id ListOfSSResponsibility/Responsibility/Name
SelfServiceResponsibility Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 404. Table 404. 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, see Table 405. Table 405. SelfServiceResponsibility Data Object Siebel Repository Name SS_Responsibility_IO External Name SS_Responsibility_IO
24 5
Siebel 8.1 Primary Web Services SelfServiceSmtpEmail
Example Package for SelfServiceResponsibility

Request See the following file to view the sample code: \SelfServiceResponsibility\SelfServiceResponsibility_request.xml
Response See the following file to view the sample code: \SelfServiceResponsibility\SelfServiceResponsibility_response.xml
Message Schema (WSDL) for SelfServiceResponsibility

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: \SelfServiceResponsibility\SelfServiceResponsibility.wsdl
SelfServiceSmtpEmail
The SendSmtpEmail operation of this Web service invokes the SelfServiceSmtpEmail workflow, which internally uses the Outbound Communications Manager Business Service for sending non-template based SMTP Email.
SelfServiceSmtpEmail Operations
For a list of operations associated with this Web service, see Table 406. Table 406. SelfServiceSmtpEmail Operations Name SendSmtpEmail Description Invokes SelfServiceSmtpEmail workflow.
246
Request Message Description: SendSmtpEmail For a description of this request message, see Table 407. 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 the TO line. Semicolon-separated list of email addresses for th CC line. Semicolon-separated list of email addresses for th BCC line. Descriptive subject line for the message. Message content in plain-text. Message content in HTML. This parameter when specified would override the parameter MessageBody. Error code, if any. Error message, if any. Object Id. Id of process instance. Id of Siebel operation. Type String String String String String String String String String String String String
Response Message Description: SendSmtpEmail For a description of this response message, see Table 408. Table 408. Response Message Description: SendSmtpEmail Node FromAddress MessageToList MessageCCList MessageBCCList MessageSubject MessageBody MessageHTMLBody Error Code Error Message Description Not of consequence in response. Not of consequence in response. Not of consequence in response. Not of consequence in response. Not of consequence in response. Not of consequence in response. Not of consequence in response. Error code, if any, for exceptions raised while submitting the request. This is automatically set from the workflow. Error details, if any, for exceptions raised while submitting the request. This is automatically set from the workflow. Type String String String String String String String String String
24 7
Table 408. Response Message Description: SendSmtpEmail Node Object Id Process Instance Id Siebel Operation Object Id Description Standard WF Output. Standard WF Output. Standard WF Output. Type String String String
SelfServiceSmtpEmail Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 409. Table 409. SelfServiceSmtpEmail Service Object Name SelfServiceSmtpEmail Boundary Object Type Workflow Process
Example Package for SelfServiceSmtpEmail

Request See the following file to view the sample code: \SelfServiceSmtpEmail\SelfServiceSmtpEmail_request.xml
Response See the following file to view the sample code: \SelfServiceSmtpEmail\SelfServiceSmtpEmail_response.xml
Message Schema (WSDL) for SelfServiceSmtpEmail

248
Siebel 8.1 Primary Web Services SelfServiceTemplateEmail
\SelfServiceSmtpEmail\SelfServiceSmtpEmail.wsdl
SelfServiceTemplateEmail
The SendTemplateEmail operation of this webservice invokes the SelfServiceTemplateEmail workflow, which internally uses the Outbound Communications Manager Business Service for sending template based SMTP Email.
SelfServiceTemplateEmail Operations
For a list of operations associated with this Web service, see Table 410. Table 410. SelfServiceTemplateEmail Operations Name SendTemplateEmail Description Invokes SelfServiceTemplateEmail workflow.
Request Message Description: SendTemplateEmail For a description of this request message, see Table 411. Table 411. Request Message Description: SendTemplateEmail Node TemplateName SourceRecipientGroupName SourceObjectID Description The communication template name to be used in the request. The source recipient group name. Either the name of Siebel-seeded recipient group or a custom one. ROW_ID of the source object component of the recipient group. This would determine the data retrieved for processing the template and recipient address for the email. Language code the template. A template must exist with the name and language combination specified. Defaulting is not recommended. Locale code the template. A template must exist with the name and locale combination specified. Defaulting is not recommended. An optional string that would help trace the outbound communication requests at the server side. Status code for the outbound request placed. Blank. Blank. Type String String String
TemplateLanguageCode
String
TemplateLocaleCode
String
RequestName
String
RequestStatus Error Code Error Message
24 9
Table 411. Request Message Description: SendTemplateEmail Node Object Id Process Instance Id Siebel Operation Object Id Description Blank. Blank. Blank. Type String String String
Response Message Description: SendTemplateEmail For a description of this response message, see Table 412. 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. Not of consequence in response. Not of consequence in response. Not of consequence in response. Error code, if any, for exceptions raised while submitting the request. This is automatically set from the workflow. Error details, if any, for exceptions raised while submitting the request. This is automatically set from the workflow. Standard WF Output. Standard WF Output. Standard WF Output. Type String String String String String String String String
Error Message
String
Object Id Process Instance Id Siebel Operation Object Id
SelfServiceTemplateEmail Application Interface

250
Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 413. Table 413. SelfServiceTemplateEmail Service Object Namep SelfServiceTemplateEmail Boundary Object Type Workflow Process
Data Object (Integration Object) For a description of data objects for this Web service, see Table 414. Table 414. SelfServiceTemplateEmail Data Object Siebel Repository Name Not applicable External Name
Example Package for SelfServiceTemplateEmail

Request See the following file to view the sample code: \SelfServiceTemplateEmail\SelfServiceTemplateEmail_request.xml
Response See the following file to view the sample code: \SelfServiceTemplateEmail\SelfServiceTemplateEmail_response.xml
Message Schema (WSDL) for SelfServiceTemplateEmail

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: \SelfServiceTemplateEmail\SelfServiceTemplateEmail.wsdl
25 1
Siebel 8.1 Primary Web Services SelfServiceTimeZone
SelfServiceTimeZone
This webservice call is used to get all the Siebel Timezone values. These values are got in the session language if it is a Siebel supported locale else it is got in the base language. The language is set using the search spec.
SelfServiceTimeZone Operations
For a list of operations associated with this Web service, see Table 415. Table 415. SelfServiceTimeZone Operations Name SelfServiceTimeZoneQueryPage Description Performs query operations based on the searchspec set on the language as input. This operation is used to get the Siebel timezone values based on the language which is set in the searchspec.
Request Message Description:SelfServiceTimeZoneQueryPage For a description of this request message, see Table 416. Table 416. Request Message Description:SelfServiceTimeZoneQueryPage Node SelfServiceTimeZoneQueryPage_Input Description The method arguments are TimeZone Integration Object with query parameters set, Language Mode as LDC and viewMode (All). Type Integration Object
Response Message Description: SelfServiceTimeZoneQueryPage For a description of this response message, see Table 417. Table 417. 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. Type Integration Object
SelfServiceTimeZone Application Interface

This topic describes the application objects called by the SelfServiceTimeZone. This Web service exposes the Business Service SelfServiceTimeZone, which provides query operation on Integration Object SS_TimeZone_IO. For more information on application implementation, refer to your application development documentation on Oracle Technology Network.
252
Siebel 8.1 Primary Web Services SelfServiceTimeZone
Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 418. Table 418. 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, see Table 419. Table 419. SelfServiceTimeZone Data Object Siebel Repository Name SS_TimeZone_IO External Name Time Zone
Example Package for SelfServiceTimeZone

Request See the following file to view the sample code: \SelfServiceTimeZone\SelfServiceTimeZone_request.xml
Response See the following file to view the sample code: \SelfServiceTimeZone\SelfServiceTimeZone\_response.xml
Message Schema (WSDL) for SelfServiceTimeZone

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: \SelfServiceTimeZone\SelfServiceTimeZone.wsdl
25 3
Siebel 8.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. Additionally, this Web service exposes the Execute and Query methods in the SelfServiceUser Business Service as Web service operations.
SelfServiceUser Operations
For a list of operations associated with this Web service, see Table 420. Table 420. SelfServiceUser Operations Name SelfServiceUserExecute Description Performs CRUD operations on the instance of Users Integration Object provided as input. Though Siebel Self Service 8.1 does not use this Web service operation for managing responsibilities of a user, the SelfServiceRegistration Workflow used instead, leverages the same business service (SelfServiceUser) internally. SelfServiceUserQueryPage Performs Query operation based on the viewCriteria and searchSpec set on the instance of Users Integration Object provided as input. This operation is used in Siebel Self Service 8.1 for retrieving the responsibilities of the users in delegated administration.
Request Message Description:SelfServiceUserExecute For a description of this request message, see Table 421. Table 421. 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. Container element for the list of Users. Corresponds to a Users Integration Object. Corresponds to the primary IC User. Set the mode as skipnode for adding/removing responsibilities of the user. Set the Username for which the associated responsibilities need to be reset. Container element for User_Responsibility IC.
254
Table 421. Request Message Description:SelfServiceUserExecute Node ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Id Description Corresponds to the User_Responsibility IC. Represents a responsibility association, for each responsibility to be added/ retained with the user. Earlier assigned responsibilities that are not listed here are deleted by default. Set the Id of the responsibility to be assigned/retained to the user.
Response Message Description: SelfServiceUserExecute For a description of this response message, see Table 422. Table 422. 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. Container element for the list of Users. Corresponds to a Users Integration Object. Corresponds to the primary IC User. Username for which the assigned responsibilities are updated. Container element for User_Responsibility IC. Corresponds to the User_Responsibility IC. Each entry represents a responsibility assigned to the user. Id of the responsibility assigned to the user.
Request Message Description: SelfServiceUserQueryPage For a description of this request message, see Table 423. Table 423. Request Message Description: SelfServiceUserQueryPage Node SelfServiceUserQueryPage_Input ListOfSSUser Description Container element for SelfServiceUser WebService input for QueryPage operation. Container element for the list of Users. Corresponds to a Users Integration Object.
25 5
Table 423. 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. Set the Username for which the associated responsibilities needs to be loaded. Container element for User_Responsibility IC. Corresponds to the User_Responsibility IC. Represents a responsibility associated to the user. Empty; to query the Id of the responsibility assigned to the user. Empty; to query the Name of the responsibility assigned to the user.
Response Message Description: SelfServiceUserQueryPage For a description of this response message, see Table 424. Table 424. 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. Container element for the list of Users. Corresponds to a Users Integration Object. Corresponds to the primary IC User. Username for which the assigned responsibilities are retrived. Container element for User_Responsibility IC. Corresponds to the User_Responsibility IC. Each entry represents a responsibility assigned to the user. Id of the responsibility assigned to the user.
Name of the responsibility assigned to the user.
256
SelfServiceUser Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 425. Table 425. 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 Table 426. Table 426. SelfServiceUser Data Object Siebel Repository Name Users External Name Users
Example Package for SelfServiceUser

Request See the following file to view the sample code: \SelfServiceUser\SelfServiceUser_request.xml
Response See the following file to view the sample code: \SelfServiceUser\SelfServiceUser_response.xml
Message Schema (WSDL) for SelfServiceUser

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: \SelfServiceUser\SelfServiceUser.wsdl
25 7
Siebel 8.1 Primary Web Services SelfServiceWebSite
SelfServiceWebSite
This Webservice is used for creating /retrieving /updating /deleting sites. This Webservice exposes two methods, Query and the Execute methods in its business service SelfServiceWebSite as Webservice operations.
SelfServiceWebSite Operations
For a list of operations associated with this Web service, see Table 427. Table 427. SelfServiceWebSite Operations Name SelfServiceWebSiteExecute SelfServiceWebSiteQueryPage Description Perform various operations like creating/updating/deleting of sites with SelfServiceWebSite Integration Object as the input. Performs query operations based on the querycriteria. set on SelfServiceWebSite Integration Object as the input. This operation is used to query for the site details.
Request Message Description:SelfServiceWebSiteExecute Creating/updating/deleting operations on a site can be performed based on the query criteria that is set. For a description of this request message, see Table 428. Table 428. Request Message Description:SelfServiceWebSiteExecute Node SelfServiceWebSiteExecute_Input Description The method arguments are Site Integration Object, 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. For a description of this response message, see Table 429. Table 429. Response Message Description: SelfServiceWebSiteExecute Node SelfServiceWebSiteExecute_Output Description The data retrieved based on the query set. Type Integration Object
258
Siebel 8.1 Primary Web Services SelfServiceWebSite
Request Message Description:SelfServiceWebSiteQueryPage Based on the querycriteria set on the Integration Object, site related details are queried. For a description of this request message, see Table 430. Table 430. Request Message Description:SelfServiceWebSiteQueryPage Node SelfServiceWebSiteQueryPage_Input Description The method arguments are Site Integration Object with query parameters set, Language Mode as LDC and viewMode (All). Type Integration Object
Response Message Description: SelfServiceWebSiteQueryPage The response contains the details based on the update query set on the Site Integration Object. For a description of this response message, see Table 431. Table 431. 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. Type Integration Object
SelfServiceWebSite Application Interface

This topic describes the application objects called by the SelfServiceWebSite. This Web service exposes the Business Service SelfServiceWebSite, which provides execute and query operations on Integration Object SS_WebSite_IO. 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 432. Table 432. 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, see Table 433. Table 433. SelfServiceWebSite Data Object Siebel Repository Name SS_WebSite_IO External Name SS_WebSite_BO
25 9
Siebel 8.1 Primary Web Services ServiceRequest
Example Package for SelfServiceWebSite

Request (SelfServiceWebSiteExecute) See the following file to view the sample code: \SelfServiceWebSite\SelfServiceWebSiteExecute_request.xml
Response (SelfServiceWebSiteExecute) See the following file to view the sample code: \SelfServiceWebSite\SelfServiceWebSiteExecute_response.xml
Request (SelfServiceWebSiteQuery) See the following file to view the sample code: \SelfServiceWebSite\SelfServiceWebSiteQuery_request.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, 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: SelfServiceWebSiteQuery\SelfServiceWebSite.wsdl
ServiceRequest
Use this Web service to create, read, update the Service Request and to create, read, update, and delete the child objects like Activities, Attachments, Solutions and Service Request Agreements.
260
ServiceRequest Operations
For a list of operations associated with this Web service, see Table 434. Table 434. ServiceRequest Operations Name ServiceReqInsert_Input ServiceReqUpdate_Input ServiceReqExecute_Input Description Used to Create the Service Request. Used to Update the Service Request. Used to Create and Update the Service Request. Also this is used to Create / Update the child objects like Activities, Attachment, Solution, Service Request Agreement. Used to Query the Service Request and the child objects like Activities, Attachment, Solution, Service Request Agreement. Used to get the default values for the Service Request. Used to delete the child objects like Activities, Attachment, Solution, Service Request Agreement.
ServiceReqQueryPage_Input ServiceReqInit_Input ServiceReqDelete_Input
Request Message Description: ServiceReqInsert_Input For a description of this request message, see Table 435. Table 435. Request Message Description: ServiceReqInsert_Input Node Abstract Description Abstract of the Service Request.
Response Message Description: ServiceReqInsert_Input For a description of this response message, see Table 436. Table 436. Response Message Description: ServiceReqInsert_Input Node Id Mod_Id Description Returns the Row_Id of the Service Request. Returns the Mod_Id of the Service Request.
Request Message Description: ServiceReqUpdate_Input For a description of this request message, see Table 437. Table 437. Request Message Description: ServiceReqUpdate_Input Node Id Description Row Id of the Service Request is required.
26 1
Response Message Description: ServiceReqUpdate_Input For a description of this response message, see Table 438. Table 438. Response Message Description: ServiceReqUpdate_Input Node Id Mod_Id Description Returns the Row_Id of the Service Request. Returns the Mod_Id of the Service Request.
Request Message Description: ServiceReqExecute_Input Request For a description of this request message, see Table 439. Table 439. 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. Activity Id of the Attachment. In this case its Service Request Id. Comments for the Attachment. File Auto Flag for the Attachment. File Defer Flag for the Attachment. File Dock Required Flag for the Attachment. File Dock Status Flag for the Attachment. Type of the Attachment (FILE/ URL). Location of the File or URL for the Attachment. File Name for the Attachment, in case of attachment type FILE. File Revision for the Attachment, in case of attachment type FILE. File Size for the Attachment, in case of attachment type FILE. File extension for the Attachment, in case of attachment type FILE. Contents to be attached. Row Id of the Activity. Type is required. Description of the Activity. Row Id of the Service Request. Abstract of the Service Request is required. Description
262
Table 439. Request Message Description: ServiceReqExecute_Input Request Node ActivityFileBuffer Solution Id Name Agreement Id AgreementName Row Id of the agreement is required. Row Id of the solution is required Name of the Solution. Description Contents to be attached.
Response Message Description: ServiceReqExecute_Input Request For a description of this response message, see Table 440 Table 440. Response Message Description: ServiceReqExecute_Input Request Node Id Mod_Id Description Returns the Row_Id of the Service Request. Also the child objects Row Id. Returns the Mod_Id of the Service Request. Also the child objects Mod Id.
Request Message Description: ServiceReqQueryPage_Input For a description of this request message, see Table 441. Table 441. Request Message Description: ServiceReqQueryPage_Input Node Id Description Row Id of the Service Request.
Response Message Description: ServiceReqQueryPage_Input For a description of this response message, see Table 442. Table 442. Response Message Description: ServiceReqQueryPage_Input Node Service Request Child Objects Description Returns all the information of the Service Request. Returns all the child information for that Service Request.
26 3
Request Message Description: ServiceReqInit_Input For a description of this request message, see Table 443. Table 443. Request Message Description: ServiceReqInit_Input Node Service Request Description Pass the Service Request attributes.
Response Message Description: ServiceReqInit_Input For a description of this response message, see Table 444. Table 444. Response Message Description: ServiceReqInit_Input Node Service Request Description Returns default information of the Service Request.
Request Message Description: ServiceReqDelete_Input For a description of this request message, see Table 445. Table 445. Request Message Description: ServiceReqDelete_Input Node Id Id Id Id Id Description Row Id of the Service Request. Row Id of the Activity. Row Id of the Attachment. Row Id of the Solution. Row Id of the Service Request Agreement.
Response Message Description: ServiceReqDelete_Input For a description of this response message, see Table 446. Table 446. Response Message Description: ServiceReqDelete_Input Node Id Mod_Id Description Returns the Row_Id of the Service Request. Also the child objects Row Id. Returns the Mod_Id of the Service Request. Also the child objects Mod Id.
ServiceRequest Application Interface

264
Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 447. Table 447. 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, see Table 448. Table 448. ServiceRequest Data Object Siebel Repository Name ServiceReqIO External Name Service Request (SelfService)
Example Package for Service Request

Request See the following file to view the sample code: \ServiceRequest\ServiceRequest_request.xml
Response See the following file to view the sample code: \ServiceReqWS\ServiceRequest_response.xml
Message Schema (WSDL) for Service Request

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: \ServiceRequest\ServiceRequest.wsdl
26 5
Siebel 8.1 Primary Web Services SessionAccessWS
SessionAccessWS
This Web service call is used to terminate the Siebel session. 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.
SessionAccessWS Operations
For a list of operations associated with this Web service, see Table 449. Table 449. SessionAccessWS Operations Name sessionAccessPing Description This is used for setting a message as an input .
Request Message Description:sessionAccessPing For a description of this request message, see Table 450. Table 450. Request Message Description:sessionAccessPing Node SessionAccessPing_Input SessionAccessPing_Input/msgIn Description Container Element. Set as Self Service Logout Request. Type Not applicable String
Response Message Description: sessionAccessPing For a description of this response message, see Table 451. Table 451. Response Message Description: sessionAccessPing Node SessionAccessPing_Output SessionAccessPing_Input/msgOut Description Container Element. Sent as 1 which indicates successful termination of the session. Type Not applicable String
SessionAccessWS Application Interface

This topic describes the application objects called by the SessionAccessWS. 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. For more information on application implementation, refer to your application development documentation on Oracle Technology Network.
266
Siebel 8.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, see Table 452. Table 452. SessionAccessWS Service Object Name SessionAccessService Boundary Object Type Class CSSUIFSessionAccessService
Example Package for SessionAccessWS

Request See the following file to view the sample code: \SessionAccessWS\SessionAccess_request.xml
Response See the following file to view the sample code: \SessionAccessWS\SessionAccess_response.xml
Message Schema (WSDL) for SessionAccessWS

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: \SessionAccessWS\SessionAccessWS.wsdl
SWI Update Order Line Item

Use this Web service to update the status of order line items for simple products, complex products, and nested service bundles in the Siebel CRM application when the status of the order line item changes in the billing application. The billing application makes this inbound Web service call to the Siebel CRM application to update the status of the order line item. A business service is exposed in the Siebel CRM application to update the status field. If the order line item contains a complex product or nested service bundle, 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. If the order line item ID is the same as the root line item ID, then this Web service updates the statuses of the entire product hierarchy for the order. The response message returns only an acknowledgement message and not data.
26 7
SWI Update Order Line Item Operations

For a list of operations associated with this Web service, see Table 453. Table 453. 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, complex products, and nested service bundles.
Request Message Descripiton: UpdateLineItems For a description of this request message, see Table 454. Table 454. Request Message Descripiton: UpdateLineItems Node FieldName1 FieldValue1 RootLineItemId OrderLineItemId UpdateSingleLineItem Description The name of the field in the order line item to update. The new value of the field in the order line item to update. The row ID of the root order in the order line item hierarchy. The row ID of the nested product in the order line item hierarchy. The designation for an order with a single line item. If this node has a value of TRUE, the order has a single line item.
SWI Update Order Line Item Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 455. Table 455. 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
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

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
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
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);
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.
27 1
Ulnbox Contact Item Application Interface

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

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

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

Request See the following file to view the sample code: \UniversalInbox\UniversalInbox_request.xml
274
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 Oracles 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.
27 5
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

276
Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 472. 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, see Table 473. Table 473. 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 - Account CMU - Address CMU - Contact CMU - Com Invoice Profile
Methods For a description of methods for this Web service, see Table 474. Table 474. UpdateCustomerSiebelJMSProducer Methods Operation UpdateCustomerParty UpdateCustomerParty Address UpdateCustomerParty BillProfile UpdateCustomerParty Contact Method [BS: UpdateCustomerSiebelJMSProducer].UpdateCustomerParty [BS: UpdateCustomerSiebelJMSProducer].UpdateCustomerPartyAddress [BS: UpdateCustomerSiebelJMSProducer].UpdateCustomerPartyBillProfile [BS: UpdateCustomerSiebelJMSProducer].UpdateCustomerPartyContact
Example Package for UpdateCustomerSiebelJMSProducer

Request See the following file to view the sample code: ...\UpdateCustomerSiebelJMSProducer\CmuAccSyncAccount.xml
27 7
Siebel 8.1 Primary Web Services WC_PickList_Payment_Profile_BS
Response Because this Web service uses an asynchronous call, a response message does not apply.
Message Schema (WSDL) for UpdateCustomerSiebelJMSProducer

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: ...\UpdateCustomerSiebelJMSProducer\UpdateCustomerSiebelJMSProducer.xml
WC_PickList_Payment_Profile_BS
This Web service is used for creating/updating/deleting/listing of payment wallet with payment methods. This Web service exposes the Query and Execute methods in the WC_PickList_Payment_Profile_BS Business Service as Web service operations.
WC_PickList_Payment_Profile_BS Operations
For a list of operations associated with this Web service, see Table 475. Table 475. WC_PickList_Payment_Profile_BS Operations Name WC_PickList_Payment_Profile_BSQueryPage Description Performs query operations based on the querycriteria.set on WC_PickList_Payment_Profile_IO integration object as the input.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. 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.
WC_PickList_Payment_Profile_BSExceute
278
Request Message Description: WC_PickList_Payment_Profile_BSQueryPage Based on the querycriteria set on the Integration Object,payment related details like the payment profile details ,account/contact information can be queried. For a description of this request message, see Table 476. Table 476. Request Message Description: WC_PickList_Payment_Profile_BSQueryPage Node WC_PickList_Payment_Profile_ BSQueryPage_Input Description The container element for the QueryPage Operation request.The method arguments are Payment Integration Object, Language Mode (value is LDC) and viewMode (All). Type Integration Object
Response Message Description: WC_PickList_Payment_Profile_BSQueryPage For a description of this response message, see Table 477. Table 477. Response Message Description: WC_PickList_Payment_Profile_BSQueryPage Node WC_PickList_Payment_Profile_ BSQueryPage_Output Description The method arguments are Payment Integration Object, 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, creating/editing/deleting operations on a wallet can be perfomed. For a description of this request message, see Table 478. Table 478. Request Message Description: WC_PickList_Payment_Profile_BSExecute Node WC_PickList_Payment_Profile_ BSExecute_Input Description The method arguments are Payment Integration Object, 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, see Table 479. Table 479. 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. Type Integration Object
27 9
WC_PickList_Payment_Profile_BS Application Interface

This Web service exposes the EAI UI Business Service WC_PickList_Payment_Profile_BS, which provides update and query operations on WC_PickList_Payment_Profile_IO Integration Object. 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 480. Table 480. 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, see Table 481. Table 481. 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

Request See the following file to view the sample code: \WC_PickList_Payment_Profile_BS\WC_PickList_Payment_Profile_BS_request.xml
Response See the following file to view the sample code: \WC_PickList_Payment_Profile_BS\WC_PickList_Payment_Profile_BS_response.xml
Message Schema (WSDL) for WC_PickList_Payment_Profile_BS

280
\WC_PickList_Payment_Profile_BS\WC_PickList_Payment_Profile_BS.wsdl
28 1
282
Web Services for Siebel CRM 8.0
This chapter lists Web services that are part of 8.0 Version of Oracles Siebel CRM Web services offering. The Web services are grouped in two tables under the following topics: Primary Web Services for Siebel CRM 8.0 Support and Testing Web Services on page 285
Primary Web Services for Siebel CRM 8.0

Table 482 lists the primary Web services available with Siebel 8.0. The Services are divided by functional area.
Table 482. 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.com/ NetworkOrderEntry http://siebel.com/TroubleTicket http://siebel.com/claims http://siebel.com/claims/ http://siebel.com/claims/ http://siebel.com/Service/ AssetWarranty http://siebel.com/Service/FS/ CopyActivity http://siebel.com/Service/FS/ ServiceRequests http://www.siebel.com/Service/ FS/Assets http://www.siebel.com/Service/ FS/Entitlement http://siebel.com/LS/ MarketingCompliance http://siebel.com/LS/ MarketingCompliance Type Inbound Inbound Inbound Outbound Outbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound
28 3
Web Services for Siebel CRM 8.0 Primary Web Services for Siebel CRM 8.0
Table 482. 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/LS/ MarketingCompliance http://siebel.com/LS/ MarketingCompliance http://siebel.com/marketing/ webmarketing http://www.siebel.com/ Marketing/EventData http://www.siebel.com/ Marketing/EventRegistration http://siebel.com/ OrderManagement/ABO http://siebel.com/ OrderManagement/Asset http://siebel.com/ OrderManagement/Catalog http://siebel.com/ OrderManagement/Configurator http://siebel.com/ OrderManagement/Contact http://siebel.com/ OrderManagement/External/PSP http://siebel.com/ OrderManagement/Order http://siebel.com/ OrderManagement/Promotion http://siebel.com/ OrderManagement/Quote http://siebel.com/ OrderManagement/Quote http://siebel.com/ OrderManagement/Quote/PSP http://siebel.com/ OrderManagement/Quote/PSP 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
Web Services for Siebel CRM 8.0 Support and Testing Web Services
Table 482. 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/PRM/ PartnerRegistration http://siebel.com/publicsector http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/Sales/SFA http://siebel.com/Sales/SFA http://siebel.com/Sales/SFA http://www.siebel.com/xml/ LOVService http://www.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.0 Web services used for support or testing. Table 483. 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/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI Type Inbound Inbound Inbound Inbound Inbound
28 5
Table 483. 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.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.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
Table 483. 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/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://siebel.com/CustomUI http://schemas.actuate.com/ actuate7/wsdl http://schemas.actuate.com/ actuate8/wsdl http:// www.sigmadynamics.com/ schema/services/ DecisionService http:// www.sigmadynamics.com/ schema/services/ ExternalChoice Type Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Inbound Outbound Outbound Outbound
Misc
ExternalChoiceService
Outbound
28 7
Table 483. 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.siebel.analytics.web/ soap/v1 com.siebel.analytics.web/ soap/v1 urn:xml-send-mailing http://www.siebel.com/ collab/ http://www.siebel.com/ collab/ http://siebel.com/CustomUI http://www.siebel.com/ SharepointIntegration com.siebel.analytics.web/ soap/v1 http://siebel.com/PSR/FS/ PSRUnitTest 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.com/asi/ http://siebel.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
Table 483. 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.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.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
28 9
Table 483. 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://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.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/ 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
Table 483. 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/asi/ http://siebel.com/asi/ http://www.siebel.com/xml/ SessionAccess http://siebel.com/CustomUI http://siebel.com/CustomUI Type Inbound Inbound Inbound Inbound Inbound
29 1
292
Primary Web Services for Siebel CRM 8.0
This chapter includes detailed descriptions and information about version 8.0 of Siebel CRM Web services. 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
29 3
Primary Web Services for Siebel CRM 8.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, submit an order to the back-end office, convert a completed order line item to an asset, modify an asset, disconnect an asset, suspend, or resume an asset. This Web service works only with an Asset-Based Ordering (ABO) enabled environment. A typical application that uses the Web service is Siebel Communication.
ABOWebService Operations
The asset operations Modify, Disconnect, Suspend, or Resume create a new line item, based on the account or contact profile. They have a similar input and output data schema. If AccountId is provided, then it operates on the account profile. If AccountId is not provided it operates on the contact profile. Affix ToQuote in the Web service name means: if an active quote is provided, it will add the quote item to the existing quote. If an active quote is not provided, it generates a new quote and adds the quote item to the new quote.
294
Affix ToOrder in the Web service name means: if an active order is provided it adds the order item to the existing order. If an active order is not provided, it generates a new order and adds the order item into the new order. For a list of operations associated with this Web service, see Table 484
Table 484. ABOWebService Operations Name AutoOrder SubmitOrder AutoAsset ModifyAssetToQuote ModifyAssetToOrder DisconnectAssetToQuote DisconnectAssetToOrder SuspendAssetToQuote SuspendAssetToOrder ResumeAssetToQuote ResumeAssetToOrder Description Converts a Quote to a Sales Order. Submits an Order. Creates assets from the completed order line items or updates a current asset. Modifies an asset (Service Item), and generates a quote item to update the selected asset. Modifies an asset (Service Item), and generates an order item to update the selected asset. Disconnects an asset (Service Item) to generate a quote item to deactivate the selected asset. Disconnects an asset (Service Item), and generates an order item to deactivate the selected asset. Suspends an active asset (Service Item) to generate a quote item to suspend the selected asset. Suspends an asset (Service Item) and generates an order item to suspend the selected asset. Resumes a suspended asset (Service Item) to generate a quote item to resume the selected asset. Resumes an asset (Service Item), and generates an order item to resume the selected asset.
Request Message Description: AutoOrder The following Web services AutoOrder, SubmitOrder, ModifyAssetToOrder, SuspendAssetToOrder, ResumeAssetToOrder and DisconnectAssetToOrder have a common output message format, PDS Order. ModifyAssetToOrder, SuspendAssetToOrder, ResumeAssetToOrder, DisconnectAssetToOrder have a common request message format. ModifyAssetToQuote, SuspendAssetToQuote, ResumeAssetToQuote and DisconnectAssetToQuote have a common request message format, and a common response message format, PDS Quote.
29 5
For a description of this request message, see Table 485. Table 485. Request Message Description: AutoOrder Node Object Id Description Required. RowId of the Quote to be converted to the Sale Order.
Response Message Description: AutoOrder Integration Object Message Format: PDS Order. For a description of this response message, seeTable 486. Table 486. Response Message Description: AutoOrder Node PDS Order Header Line Item XA Description Instance of Integration object PDS Order. Order Header. Order Line Items. Order Line Item attributes.
Request Message Description: SubmitOrder For a description of this request message, see Table 487. Table 487. Request Message Description: SubmitOrder Node OrderId Description Required. RowId of the order to be submitted.
Response Message Description: SubmitOrder Integration Object Message Format: PDS Order, which has the same format as the AutoOrder response message.
Request Message Description: AutoAsset For a description of this request message, see Table 488. Table 488. Request Message Description: AutoAsset Node Object Id LineItemId Description Required. RowId of the corresponding Order that contains the Order Line Item to be converted or applied to an asset. Required. RowId of an Order Line Item to be converted or applied to an asset.
296
Response Message Description: AutoAsset Integration Object Message Format: PDS Asset. For a description of this response message, see Table 489. Table 489. Response Message Description: AutoAsset Node PDS Asset Header Line Item XA Description Required. Integration Object. Asset Header. Asset. Asset attributes.
Request Message Description: ModifyAssetToQuote For a description of this request message, see Table 490. Table 490. Request Message Description: ModifyAssetToQuote Node AssetIntegrationId AssetNumber ActiveDocumentId Description Asset Integration Id of the selected asset. Provide either AssetIntegrationId or AssetNumber. Asset Integration Id of the selected asset. Provide either AssetIntegrationId or AssetNumber. Document in Order Management means a Quote or an Order. Each Document can have multiple children (Quote Items or Order Line Items). ActiveDocumentId means the current active Document that the current process is working on. In this Web service call, it is the Quote Id of the active Quote to which the generated quote item has to be added. This is an optional input. Account Id of the account that owns the selected asset (Service Item). Contact Id of the contact who owns the selected asset (Service Item) to be modified. 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. Compound Product Number for the Asset Based Ordering (ABO) network ordering. It is not required if network ordering is not used.
AccountId ContactId DueDate PriceListId CompoundProductNumber
29 7
Response Message Description: ModifyAssetToQuote Integration Object Message Format: PDS Quote. For a description of this response message, see Table 491. Table 491. Response Message Description: ModifyAssetToQuote Node PDS Quote Header Line Item XA Description Required. Integration Object. Quote Header. Quote Line Item. Quote Line Item attributes.
Request Message Description: ModifyAssetToOrder For a description of this request message, see Table 492. Table 492. Request Message Description: ModifyAssetToOrder Node AssetIntegrationId AssetNumber ActiveDocumentId Description Asset Integration Id of the selected asset. Provide either AssetIntegrationId or AssetNumber. Asset Integration Id of the selected asset. Provide either AssetIntegrationId or AssetNumber. Document in Order Management means a Quote or an Order. Each Document can have multiple children (Quote Items or Order Line Items). ActiveDocumentId means the current active Document that the current process is working on. In this Web service call, it is the Order Id of the active Order to which the generated order line item has to be added. This is an optional input. Account Id of the account that owns the selected asset (Service Item). Contact Id of the contact who owns the selected asset (Service Item) to be modified. The due date of the generated line item. Specifies a Prices List Id associated with the quote if a new quote is requested. Compound Product Number for ABO network ordering. Required only if network ordering if used.
AccountId ContactId DueDate PriceListId CompoundProductNumber
Response Message Description: ModifyAssetToOrder Integration Object Message Format: PDS Order, which has the same format as the AutoOrder response message.
298
Request Message Description: SuspendAssetToQuote This is the same request message as ModifyAssetToQuote.
Response Message Description: SuspendAssetToQuote Integration Object Message Format: PDS Quote.
Request Message Description: SuspendAssetToOrder This is the same request message as ModifyAssetToOrder.
Response Message Description: SuspendAssetToOrder Integration Object Message Format: PDS Order.
Request Message Description: ResumeAssetToQuote This is the same request message as ModifyAssetToQuote.
Response Message Description: ResumeAssetToQuote Integration Object Message Format: PDS Quote.
Request Message Description: ResumeAssetToOrder This is the same request message as ModifyAssetToOrder.
Response Message Description: ResumeAssetToOrder Integration Object Message Format: PDS Order.
Request Message Description: DisconnectAssetToQuote This is the same request message as ModifyAssetToQuote.
Response Message Description: DisconnectAssetToQuote Integration Object Message Format: PDS Quote.
Request Message Description: DisconnectAssetToOrder This is the same request message as ModifyAssetToOrder.
Response Message Description: DisconnectAssetToOrder Integration Object Message Format: PDS Order.
29 9
ABOWebService Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 493. Table 493. 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, see Table 494. 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

300
Primary Web Services for Siebel CRM 8.0 Asset Management
Request (AutoOrder) See the following file to view the sample code: \ABOWebService\AutoOrder_request.xml Response (AutoOrder) See the following file to view the sample code: ...\ABOWebService\AutoOrder_response.xml Request (ModifyAssetToQuote) See the following file to view the sample code: ...\ABOWebService\ModifyAssetToQuote_request.xml Response (ModifyAssetToQuote) See the following file to view the sample code: ...\ABOWebService\ModifyAssetToQuote_response.xml Request (AutoAsset) See the following file to view the sample code: ...\ABOWebService\AutoAsset_request.xml Response (AutoAsset) See the following file to view the sample code: ...\ABOWebService\AutoAsset_response.xml
Message Schema (WSDL) for ABOWebservice

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. ...\ABOWebService\ABOWebService.wsdl
Asset Management
Use this Web service to create, read, and update Asset records.
30 1
Asset Mangement Operations

Note that all operations for this service share a common data format. Because of this similarity, all the operations for this service are grouped together. However, because of the nature of the schema generation for the WSDL file, the message formats for each operation have their own message names. For a list of operations associated with this Web service, see Table 495. Table 495. 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. Queries for an Asset record. Description Creates an Asset record.
Common Request Message Description All operations in this Web service work with a common request message format and a common response message format. The request message consists of fields from the Asset Mgmt Business Component.
Common Response Message Description Same as request message format.
Asset Management Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 496. Table 496. Asset Management Service Object Name Asset Management Boundary Object Type Business Service Class (If BusService) CSSEAIUIDataService
302
Data Object (Integration Object) For a description of data objects for this Web service, see Table 497. 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, see Table 498. Table 498. Asset Management Methods Operation Asset_spcManagement_AssetManagementInsert Asset_spcManagement_AssetManagementQueryPage Asset_spcManagement_AssetManagementUpdate Method [BS:Asset Management].[Insert] [BS:Asset Management].[QueryPage] [BS:Asset Management].[Update]
Example Package for AssetManagement

Request See the following file to view the sample code: ...\AssetManagement\AssetManagement_request.xml Response See the following file to view the sample code: ...\AssetManagement\AssetManagement_response.xml
Message Schema (WSDL) for AssetManagement

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. ...\AssetManagement\AssetManagement.wsdl
30 3
Primary Web Services for Siebel CRM 8.0 AssetWebService
AssetWebService
To view the sample code, 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 documents Quote price.
CalculatePriceWS Operations
For a list of operations associated with this Web service, see Table 499. Table 499. CalculatePriceWS Operations Name CalculatePrice Description Calculate price for the input Quote Document. The Web service invokes the Web Channel Pricing Driver Workflow.
Request Message Description: CheckQuoteEligibilityCompatibility For a description of this request message, see Table 500. Table 500. Request Message Description: CheckQuoteEligibilityCompatibility Node QuoteIO Description Required. An instance of the Integration Object PDS Quote.
Response Message Description: CheckQuoteEligibilityCompatibility For a description of this response message, see Table 501. Table 501. Response Message Description: CheckQuoteEligibilityCompatibility Node QuoteIO Description An instance of the Integration Object PDS Quote.
CalculatePriceWS 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. This Web service invokes the Web Channel Pricing Driver Workflow Workflow. The input and output are based on the PSP Common Integration Object.
304
Primary Web Services for Siebel CRM 8.0 CalculatePriceWS
This is the Web service version of the PSP Driver Workflow Process. For a description of the workflows steps, see Table 502. Table 502. 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. Creates Context Row Set from the Property Set hierarchy. Creates Row Set from Property Set hierarchy. Sets the Pricing Date to the current time stamp or the date provided by the Joint Workspace Scenario Builder. Calls the Dynamic Pricing Procedure to perform pricing. Clears the price totals on the Context Row Set. Calculates the Totals for the Non Recurring Charge and Monthly Recurring Charge on the Context Row Set. Writes the updated Row Set back to the 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
30 5
Primary Web Services for Siebel CRM 8.0 CalculatePriceWS
Table 502. 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. Converts the Property Hierarchy to the Integration Object Hierarchy.
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. Table 503. 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, see Table 504. Table 504. CalculatePriceWS Data Objects Siebel Repository Name PDS Quote Structure: Header |-----LineItem |----- XA External Name PDS Quote
Methods For a description of methods for this Web service, see Table 505. Table 505. CalculatePriceWS Data Objects Operation CalculatePrice Method RunProcess
306
Primary Web Services for Siebel CRM 8.0 CatalogWebService
Example Package for CalculatePriceWS

Request See the following file to view the sample code: ...\CalculatePriceWS\CalculatePriceWS_request.xml Response See the following file to view the sample code: ...\CalculatePriceWS\CalculatePriceWS_response.xml
Message Schema (WSDL) of CalculatePriceWS

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. ...\CalculatePriceWS\http_siebel.com_OrderManagement_Quote_PSP_CalculatePriceWS.wsdl
CatalogWebService
Use this set of Web services to expose the catalog functions, including get catalog, get catalog category, get category product, get search options, get search parameters, execute search, get product promotions, and so on.
CatalogWebService Operations
For a list of operations associated with this Web service, see Table 506. Table 506. CatalogWebService Operations Name Get Catalog Get Catalog Categories Get Category Products Publish Catalog Get Product Details Description Retrieves a list of catalogs. Retrieves a list of categories for a given catalog. Retrieves a list of products for a given catalog, category and other contextual parameters. Retrieves the full structure of a given Catalog including category and products. Retrieves the basic product information along with the attributes.
30 7
Table 506. 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, such as 'Product Literature', 'Features', and so on. Retrieves all the possible values for a given product attribute. Retrieves all the related Promotions for a given product. Retrieves the search options for a specific product family or class. For example, enter 'Printer Speed', 'Color', and so on for the 'Printer' Class. Retrieves a list of fields or attributes that are available for a search option. For example, enter '100dpm', '200dpm' for the 'Printer Speed' option. Returns the search results based on the search options and parameter values.
Get Search Parameters
Execute Search
Request Message Description: GetCatalogs For a description of this request message, see Table 507. Table 507. Request Message Description: GetCatalogs Node PDS Catalog Interface Description Required. An instance of Integration Object PDS Catalog Interface.
Response Message Description: GetCatalogs Integration Object Message Format: PDS Catalog Interface. For a description of this response message, see Table 508. Table 508. Response Message Description: GetCatalogs Node PDS Catalog Interface Description An instance of Integration Object PDS Catalog Interface.
Request Message Description: GetCatalogCategory For a description of this request message, see Table 509. Table 509. Request Message Description: GetCatalogCategory Node PDS Catalog Category Interface Description Required. An instance of Integration Object PDS Catalog Category Interface.
308
Response Message Description: GetCatalogCategory Integration Object Message Format: PDS Catalog Category Interface. For a description of this response message, see Table 510. Table 510. Response Message Description: GetCatalogCategory Node PDS Catalog Category Interface Description An instance of Integration Object PDS Catalog Category Interface.
Request Message Description: GetCategoryProducts For a description of this request message, see Table 511. Table 511. Request Message Description: GetCategoryProducts Node PDS Category Product Interface PricingMode EligibilityMode Description Required. An instance of Integration Object PDS Category Product Interface. Y or N (calculates price or not). Optional. The default value is Y. 0, 1 ,2 (eligibility display mode: 0 do not run; 1 run; 2 run but only return eligible products). Optional. The default value is 1. SiebelContext or ExternalConext. Optional. However, provide ContextMode to run pricing and eligibility. An instance of Integration Object PDS Catalog Context. It either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. If ContextMode is provided it is required.
ContextMode Context
Response Message Description: GetCategoryProducts Integration Object Message Format: PDS Category Product Interface. For a description of this response message, see Table 512. Table 512. Response Message Description: GetCategoryProducts Node PDS Category Product Interface Description An instance of Integration Object PDS Catalog Category Interface. After running Eligibility and Pricing, the List Price, Net Price, Eligibility status and Eligibility Reason fields will be updated.
30 9
Request Message Description: PublishCatalog For a description of this request message, see Table 513. Table 513. Request Message Description: PublishCatalog Node PDS Publish Catalog Interface PricingMode EligibilityMode Description Required. An instance of Integration Object PDS Category Product Interface. Y or N (calculates price or not). Optional. The default value is Y. 0, 1 ,2 (eligibility display mode: 0 do not run; 1 run; 2 run but only return eligible products ). Optional. The default value is 1. SiebelContext or ExternalContext. Optional. However, you must provide ContextMode to run pricing and eligibility. An instance of Integration Object PDS Catalog Context. It either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. If ContextMode is provided it is required. Y or N (includes price waterfall or does not).
ContextMode Context
IncludePriceWaterfall
Response Message Description: PublishCatalog Integration Object Message Format: PDS Publish Catalog Interface. For a description of this response message, see Table 514. Table 514. Response Message Description: PublishCatalog Node PDS Publish Catalog Interface Description An instance of Integration Object PDS Publish Catalog Interface. After running Eligibility and Pricing, the List Price, Net Price, Eligibility status and Eligibility Reason fields will be updated.
Request Message Description: GetProductDetails For a description of this request message, see Table 515. Table 515. Request Message Description: GetProductDetails Node PDS Product Details Interface PricingMode EligibilityMode Description Required. An instance of Integration Object PDS Product Details Interface. Y or N (calculates price or not). Optional. The default value is Y. 0, 1 ,2 (eligibility display mode: 0 do not run; 1 run; 2 run but only return eligible products ). Optional. The default value 1.
310
Table 515. Request Message Description: GetProductDetails Node ContextMode Context Description SiebelContext or ExternalConext. Optional. However, provide ContextMode to run pricing and eligibility. An instance of Integration Object PDS Catalog Context. It either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. If ContextMode is provided it is required.
Response Message Description: GetProductDetails Integration Object Message Format: PDS Product Details Interface. For a description of this response message, see Table 516. Table 516. Response Message Description: GetProductDetails Node PDS Product Details Interface Description An instance of Integration Object PDS Product Details Interface. After running Eligibility and Pricing, the List Price, Net Price, Eligibility status and Eligibility Reason fields will be updated.
Request Message Description: GetProductChildren For a description of this request message, see Table 517. Table 517. Request Message Description: GetProductChildren Node PDS Product Children Interface PricingMode: EligibilityMode ContextMode Context Description Required. An instance of Integration Object PDS Product Children Interface. Y or N (calculates price or not). Optional. The default value is Y. 0, 1, 2 (eligibility display mode: 0 do not run; 1 run; 2 run but only return eligible products). Optional. The default value 1. SiebelContext or ExternalConext. Optional. However, provide ContextMode to run pricing and eligibility. An instance of Integration Object PDS Catalog Context. It either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. If ContextMode is provided it is required.
31 1
Response Message Description: GetProductChildren Integration Object Message Format: PDS Product Children Interface. For a description of this response message, see Table 518. Table 518. Response Message Description: GetProductChildren Node PDS Product Children Interface Description An instance of Integration Object PDS Product Children Interface.
Request Message Description: GetSearchOptions For a description of this request message, see Table 519. Table 519. Request Message Description: GetSearchOptions Node PDS Searchable Product Class Interface Description Required. An instance of Integration Object PDS Searchable Product Class Interface.
Response Message Description: GetSearchOptions Integration Object Message Format: PDS Searchable Product Class Interface. For a description of this response message, see Table 520. Table 520. Response Message Description: GetSearchOptions Node PDS Searchable Product Class Interface Description An instance of Integration Object PDS Searchable Product Class Interface.
Request Message Description: GetSearchParameters Retrieves a List of Fields or Attributes Available for a Search Option along with Attribute Domain Values If LOV Type. For a description of this request message, see Table 521. Table 521. Request Message Description: GetSearchParameters Node PDS Searchable Product Class Interface FieldNameClassId LookupFromCache MaximumAttributes Description Required. An instance of Integration Object PDS Searchable Product Class Interface. Property name for the class Id field. Optional. The default value is Class Id. It is recommend that this field not be changed. Y or N (lookup search parameters from cache). Optional. The default value is N. (It will be made obsolete. Do not use this parameter.) The maximum number of attributes returned for each product class. Optional. The default value is 15.
312
Response Message Description: GetSearchParameters Integration Object Message Format: PDS Product Class Attributes Interface. For a description of this response message, see Table 522. Table 522. Response Message Description: GetSearchParameters Node PDS Product Class Attributes Interface Description An instance of Integration Object PDS Product Class Attributes Interface.
Request Message Description: GetProductAttributeDomain Retrieves all the Possible Values for a Given Product Attribute. For a description of this request message, see Table 523. Table 523. Request Message Description: GetProductAttributeDomain Node Attribute Id Product Configuration Model Id Description Product attribute Id. This is a required input. Product Configuration Model Id. This is a required input. This field value can be looked up from the product integration object.
Response Message Description: GetProductAttributeDomain Integration Object Message Format: PDS Product Attribute Domain Interface. For a description of this response message, see Table 524. Table 524. Response Message Description: GetProductAttributeDomain Node PDS Product Attribute Domain Interface Description An instance of Integration Object PDS Product Attribute Domain Interface.
Request Message Description: ExecuteSearch Performs an Attribute Search, Returns the Search Results Based on the Search Options and Parameter Values. For a description of this request message, see Table 525. Table 525. Request Message Description: ExecuteSearch Node SearchOption PDS Product Interface PricingMode EligibilityMode Description Required. SearchByProduct or SearchByClass. An instance of Integration Object PDS Product Interface. This is a required input for the SearchByProduct search option. Y or N (calculates price or not). Optional. The default value is Y. 0,1,2 (eligibility display mode: 0 do not run; 1 run; 2 run but only return eligible products ). Optional. The default value is 1.
31 3
Table 525. Request Message Description: ExecuteSearch Node ContextMode Context Description SiebelContext or ExternalConext. Optional. However, provide ContextMode to run pricing and eligibility. An instance of Integration Object PDS Catalog Context. It either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. If ContextMode is provided it is required. Price field search expression. For example, greater than > 100 and less than < 1000. Optional. Search specification for the product business component, for example, [Name] like "IBM*". Optional. Number of products returned. Optional. The default value is 100. An instance of Integration Object PDS Product Class Attributes Interface. This is a required input for the SearchByClass search option.
PriceSearchExpression ProductSearchSpec ResultSize PDS Product Class Attributes Interface
Response Message Description: ExecuteSearch Integration Object Message Format: PDS Product Interface. For a description of this response message, see Table 526. Table 526. Response Message Description: ExecuteSearch Node PDS Product Interface Description An instance of Integration Object PDS Product Interface. After running Eligibility and Pricing, the List Price, Net Price, Eligibility status, and Eligibility Reason fields will be updated.
CatalogWebService Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 527. Table 527. CatalogWebService Service Object Name PDS Product Data Service Boundary Object Type BusService Class (if BusService) CSSProdDataSvc
314
Data Object (Integration Object) For a description of data objects for this Web service, see Table 528. Table 528. 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

Request See the following file to view the sample code: ...\CatalogWebService\CatalogWebService_request.xml Response See the following file to view the sample code: ...\CatalogWebService\CatalogWebService_response.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, 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. ...\CatalogWebService\CatalogWebService.wsdl
31 5
Primary Web Services for Siebel CRM 8.0 ContextServiceWrapperService
ContextServiceWrapperService
These Web services invoke the QuotesAndOrdersValidate signal through the context service wrapper service. They validate the quotes and orders, or selected line items in the whole document.
ContextServiceWrapperService Operations
For a list of operations associated with this Web service, see Table 529. Table 529. ContextServiceWrapperService Operations Node ContextServiceWrapperService-QuoteHeader-Verify Description Validates a Quote, including all of its items, or validates the selected quote items under a quote. The signal invoked is QuotesAndOrdersValidate. Validates a Quote, including all of its items, or validates the selected quote items under a quote. The signal invoked is QuotesAndOrdersValidate. Validates an Order, including all of its items, or validates the selected order items under an order. The signal invoked is QuotesAndOrdersValidate. Validates an Order, including all of its items, or validates the selected order items under an order. The signal invoked is QuotesAndOrdersValidate.
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. Therefore, the request message is in a structure that is consistent with the WS Quote integration object definition. For a description of this request message, see Table 530. Table 530. Request Message Description: ContextServiceWrapperService-QuoteHeader-Verify Node Header Line Item XA Description Quote (Quote Ids, UIActive, UISelected required) Quote Item Quote Item attributes
316
Response Message Description: ContextServiceWrapperService-QuoteHeader-Verify For a description of this response message, see Table 531. Table 531. 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. Promotion: returns a validation message from the promotion verify workflow. All: returns a validation message after validating all Customizable Products (CP) under the Quotes or Orders. Data Validation: returns a validation message for validating a Quote or Order against the Data Validation Rule Set.
Request Message Description: ContextServiceWrapperService-QuoteItem-Verify For a description of this request message, see Table 532. Table 532. Request Message Description: ContextServiceWrapperService-QuoteItem-Verify Node Header Line Item XA Description Quote (Quote Id required) Quote Item (Quote Items Ids, UIActive, UISelected required) Quote Item attributes
Response Message Description: ContextServiceWrapperService-QuoteItem-Verify For a description of this response message, see Table 533. Table 533. 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. Promotion: returns a validation message from the promotion verify workflow. Validate CP All: returns a validation message after validating all Customizable Products (CP) under the Quotes or Orders. Data Validation: returns a validation message for validating a Quote or Order against the Data Validation Rule Set.
31 7
Request Message Description: ContextServiceWrapperService-OrderHeader-Verify For a description of this request message, see Table 534. Table 534. Request Message Description: ContextServiceWrapperService-OrderHeader-Verify Node Header Line Item XA Description Order Entry - Orders (Order Id required) Order Entry - Line Items (Order Items Ids, UIActive, UISelected required) Order Item attributes
Response Message Description: ContextServiceWrapperService-OrderHeader-Verify For a description of this response message, see Table 535. Table 535. 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. Validate CP All: returns a validation message after validating all Customizable Products (CP) under the Quotes or Orders. Data Validation: returns a validation message for validating a Quote or Order against the Data Validation Rule Set.
Request Message Description: ContextServiceWrapperService-OrderItem-Verify For a description of this request message, see Table 536. Table 536. Request Message Description: ContextServiceWrapperService-OrderItem-Verify Node Header Line Item XA Description Order Entry - Orders (Order Id required) Order Entry - Line Items (Order Items Ids, UIActive, UISelected required) Order Item attributes
318
Response Message Description: ContextServiceWrapperService-OrderItem-Verify For a description of this response message, see Table 537. 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. Promotion: returns a validation message from the promotion verify workflow. Validate CP All: returns a validation message after validating all Customizable Products (CP) under the Quotes or Orders. Data Validation: returns a validation message for validating a Quote or Order against the Data Validation Rule Set.
ContextServiceWrapperService Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 538. Table 538. 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, see Table 539. Table 539. ContextServiceWrapperService Data Objects Siebel Repository Name WS Quote WS Order External Name WS Quote WS Order
31 9
Methods For a description of methods for this Web service, see Table 540. Table 540. ContextServiceWrapperService Methods Operation ValidateQuotes ValidateQuoteItems ValidateOrders ValidateOrderItems Method RunProcess RunProcess RunProcess RunProcess
Example Packages for ContextServiceWrapperService

Request (ValidateQuotes) See the following file to view the sample code: ...\ContextServiceWrapperService\ValidateQuote_request.xml Response (ValidateQuotes) See the following file to view the sample code: ...\ContextServiceWrapperService\ValidateQuotes_response.xml Request (ValidateQuoteItems) See the following file to view the sample code: ...\ContextServiceWrapperService\ValidateQuoteItems_request.xml Response (ValidateQuoteItems) See the following file to view the sample code: ...\ContextServiceWrapperService\ValidateQuoteItems_response.xml
Message Schema (WSDL) of ContextServiceWrapperService

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. ...\ContextServiceWrapperService\ContextServiceWrapperService.wsdl
320
Primary Web Services for Siebel CRM 8.0 CopyActivity
CopyActivity
Use this Web service to instantiate activities from an activity template for a Service Request.
CopyActivity Operations
For a list of operations associated with this Web service, see Table 541. Table 541. CopyActivity Operations Name WSCopyServiceActivityRunProcess Description Creates activity records.
Request Message Description: WSCopyServiceActivityRunProcess For a description of this request message, see Table 542. Table 542. Request Message Description: WSCopyServiceActivityRunProcess Node SRId TemplateId ActPlanId Description Row Id of service request. Row Id of Activity Template. Row Id of Activity Plan.
Response Message Description: WSCopyServiceActivityRunProcess There is response message for this operation.
CopyActivity Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 543. Table 543. CopyActivity Service Object Name WS Copy Service Activity Boundary Object Type Workflow
32 1
Primary Web Services for Siebel CRM 8.0 EAILOVWS
Methods For a description of the methods for this Web service, see Table 544. Table 544. CopyActivity Methods Operation WSCopyServiceActivityRunProcess Method [WF: WS Copy Service Activity].[RunProcess]
Example Package for CopyActivity

Request (WSCopyServiceActivityRunProcess) See the following file to view the sample code: ...\CopyActivity\CopyActivity_request.xml Response (WSCopyServiceActivityRunProcess) See the following file to view the sample code: ...\CopyActivity\CopyActivity_response.xml
Message Schema (WSDL) of CopyActivity

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. ...\CopyActivity\CopyActivity.wsdl
EAILOVWS
EligibilityCompatibility
Use this Web service to validate the documents (Quote) eligibility and compatibility status.
322
Primary Web Services for Siebel CRM 8.0 EligibilityCompatibility
EligibilityCompatibility Operations
For a list of operations associated with this Web service, see Table 545. Table 545. EligibilityCompatibility Operations Name CheckQuoteEligibilityCompatibility Description Checks the eligibility and compatibility status for the input Quote Object.
Request Message Description: CheckQuoteEligibilityCompatibility For a description of this request message, see Table 546. Table 546. Request Message Description: CheckQuoteEligibilityCompatibility Node QuoteIO Description Required. An instance of the Integration Object PDS Quote. Some of the fields used in the eligibility and compatibility process are shown in the following table: Eligibility and Compatibility User Fields. The default is External PDS Quote. This parameter will be parsed as Mode used in the Variable Map. Can be Pre-Pick or Post-Pick. Pre-Pick will trigger only the eligibility check. Post-Pick will have both the eligibility and compatibility checks executed. An instance of the Projected Asset Integration Object. It is used for a compatibility check with the current quote.
PSPMode PickMode ProjectedAssetIO
Eligibility and Compatibility Used Fields For a description of the Eligibility and Compatibility used fields, see Table 547. Table 547. 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)
32 3
Table 547. 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, see Table 548. Table 548. 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). Product Class (used in the Compatibility Matrix). Checks if the product is effective. Checks if the product is effective. Defines the type of rules it will use. If it is Y, it will compare with the Inclusive rules. Otherwise, it will compare with the Exclusive rules. For more information about eligibility rules, see Siebel Product Administration Guide and the chapter about defining product and promotion eligibility rules. Name of the line item. Defines if the line item will trigger the eligibility and compatibility checking. It must be 'Y' to trigger the eligibility and compatibility check. Price List (checks if the product is included in the price list). Product (used in the Eligibility and Compatibility Matrix). Product Line (used in the Eligibility and Compatibility Matrix).
Name PrePickCD
Name Pre Pick
PriceListId ProductId ProductLineId
Price List Id Product Id Product Line Id
324
Response Message Description: CheckQuoteEligiblityCompatibility For a description of this response message, see Table 549. Table 549. Response Message Description: CheckQuoteEligiblityCompatibility Node QuoteIO Description An instance of the Integration Object PDS Quote. After running the eligibility and compatibility process, the Eligibility Status and Eligibility Reason fields will be updated.
EligibilityCompatibility Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 550. Table 550. 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, see Table 551. Table 551. EligibilityCompatibility Data Objects Siebel Repository Name PDS Quote Projected Asset External Name PDS Simplified Quote Projected Asset
Example Package for EligibilityCompatibility

Request Go to the following directory in the SampleCode.zip file to view the sample code: ...\EligibilityCompatibility\EligibilityCompatibility_request.xml
32 5
Primary Web Services for Siebel CRM 8.0 EventManagement
Response Go to the following directory in the SampleCode.zip file to view the sample code: ...\EligibilityCompatibility\EligibilityCompatibility_response.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, 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. ...\EligibilityCompatibility\EligibilityCompatibility.wsdl
EventManagement
This Web service allows enables you to retrieve event, session and registration details based on the Event Id and Contact Id Inputs. It also allows for event registration by a Contact with the same input parameters.
EventManagement Operations
For a list of operations associated with this Web service, see Table 552. Table 552. EventManagement Operations Name GetEvents GetEventDetails GetSessions GetRegisteredEvents RegisterForEvent Description Retrieves a list of events based on Status or Date Search Specification. Retrieves event details for an event preferably based on an Id Search Specification. Retrieves a list of sessions. Retrieves a list of events registered by a specified contact. Enroll a contact into a specified event which invokes the Event Registration Service.
Request Message Description: GetEvents For a description of this request message, see Table 553. Table 553. Request Message Description: GetEvents Node Id Name Status Event Type Description Row Id of Event Name of Event Event Status Event Format
326
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. Parent Event Id. Session Name. Session Description. Session Start Date. Session End Date. Session Region. All. Description Maximum Number of Attendees than can enroll for the Event. Event Start Date. Event End Date. Event Description. Event Plan.
Response Message Description: GetEvents This Response Message is the same as the Request Message. For more information, see Table 553.
Request Message Description: GetEventDetails For a description of this request message, see Table 554. Table 554. Request Message Description: GetEventDetails Node Id Name Status Event Type Max Attendees Start Date End Date Description Participant Type Description Row Id of Event. Name of Event. Event Status. Event Format. Maximum Number of Attendees than can enroll for the Event. Event Start Date. Event End Date. Event Description. Event Participant Type.
32 7
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. Parent Event Id. Session Name. Session Description. Session Start Date. Session End Date. Session Region. All. Description Region where the Event takes Place. Event Plan. Event Invitation deadline. Event Organization. Event Partner. Name of the Venue where the Event happens. Web URL for Events. Event Period. Event Budget Period.
Response Message Description: GetEventDetails This Response Message is the same as the Request Message. For more information, see Table 554.
Request Message Description: GetRegisteredEvents For a description of this request message, see Table 555. Table 555. Request Message Description: GetRegisteredEvents Node Id Event Id Attendee Id Name Status Description Row Id of Event Attendee. Event for which the attendee is registering to. Contact Id. Event Name. Event Registration Status.
328
Table 555. Request Message Description: GetRegisteredEvents Node Event Type Max Attendees Start End View Mode Description Event Format. Maximum Number of attendees allowed to enroll into the Event. Start Date of Event.. End Date of Event. All.
Response Message Description: GetRegisteredEvents This Response Message is the same as the Request Message. For more information, see Table 555.
Request Message Description: GetSessions For a description of this request message, see Table 556. Table 556. 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. Parent Event Id. Session Name. Session Description. Session Start Date. Session End Date. Session Region. All. Description Row Id of Event. Name of Event. Event Status. Event Format. Maximum Number of Attendees than can enroll for the Event. Event Start Date. Event End Date. Event Description. Event Plan.
32 9
Response Message Description: GetSessions This Response Message is the same as the Request Message. For more information, see Table 556.
Request Message Description: RegisterForEvent For a description of this request message, see Table 557. Table 557. Request Message Description: RegisterForEvent Node Status Registration date Contact Id Reg Id Event Id User Type Description Registration status. Date when the registration occurs. Attendee Id of event. Registration Id. Event being enrolled to. Denotes type of Attendee.
Response Message Description: RegisterForEvent For a description of this response message, see Table 558. Table 558. Response Message Description: RegisterForEvent Node Output Type Return Val Reg Id Description Message to Indicate detailed status. Outcome Status. Registration Id.
EventManagement Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 559. Table 559. EventManagement Service Object Name Event Data Service Event Detail Service Boundary Object Type Business Service Business Service Class (if Bus Service) CSSEAIUIDataService CSSEAIUIDataService
330
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, see Table 560. Table 560. 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. Table 561. EventManagement Methods Operation QueryPage QueryPage QueryPage QueryPage EnrollUser Display Name GetEvents GetEventDetails Session Data Service GetRegisteredEvents RegisterForEvent Method [BS: Event Data Service].[QueryPage] [BS: Event Detail Service].[QueryPage] [BS: Session Data Service].[QueryPage] [BS: Event Attendee Data Service].[QueryPage] BS: Event Registration Service].[ EnrollUser]
Example Package for EventManagement

Request See the following file to view the sample code: ...\EventManagement\EventManagement_request.xml Response See the following file to view the sample code:
33 1
Primary Web Services for Siebel CRM 8.0 Event Registration
...\EventManagement\EventManagement_response.xml
Message Schema (WSDL) for EventManagement

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. ...\EventManagement\EventManagement.wsdl
Event Registration
ExternalAutoPolicy
See INSClaims on page 350 for a description of this Web service.
ExternalPropertyPolicy
See INSClaims on page 350 for a description of this Web service.
Forecast
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. \Forecast\Forecast.wsdl
GetHealthCareProfessionalProfileInfor mation
Use this Web service to read a complete profile for a Health Care Provider including Marketing Compliance information, lists of Alerts and lists of Service Requests.
GetHealthCareProfessionalProfileInformation Operations
Due to the nature of the schema generation for the WSDL file, the message formats for each operation have their own message names.
332
Primary Web Services for Siebel CRM 8.0 GetHealthCareProfessionalProfileInformation
For a list of operations associated with this Web service, see Table 562. Table 562. GetHealthCareProfessionalProfileInformation Operations Name LSMCProfileQueryById LSMCProfileQueryByExample Description Read the profile of an HCP specified by his/her Siebel Contact Row Id. Read the profile of an HCP specified by a combination of several attributes.
Request Message Description: LSMCProfileQueryById The operations in this Web service work with a common response message format but have different request message format. For a description of this request message, see Table 563. Table 563. Request Message Description: LSMCProfileQueryById Node <PrimaryRowId> Description Required - represents the Siebel Row Id of the Contact Object.
33 3
Request Message Description: LSMCProfileQueryByExample For a description of this request message, see Table 564. Table 564. 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.
334
Common Response Message Description The column Node represents a respective Siebel field if not specified otherwise. For a description of this response message, see Table 565. Table 565. 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>
33 5
Table 565. 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
Table 565. 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>
33 7
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
Table 565. 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

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 566. Table 566. 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, see Table 567. Table 567. GetHealthCareProfessionalProfileInformation Data Object Siebel Repository Name LSMCProfile External Name Contact
Methods For a descripition of methods for this Web service, see Table 568. Table 568. GetHealthCareProfessionalProfileInformation Methods Operation LSMCProfileQueryById LSMCProfileQueryByExample Method QueryById QueryByExample
33 9
Primary Web Services for Siebel CRM 8.0 GetHeathCareProfessionalComplianceDetails
Example Package for GetHeathcareProfessionalProfileInformation

Request See the following file to view the sample code: ...\GetHeathcareProfessionalProfileInformation\Request.xml Response See the following file to view the sample code: ...\GetHeathcareProfessionalProfileInformation\Response.xml
Message Schema (WSDL) for GetHeathcareProfessionalProfileInformation

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. ...\GetHeathcareProfessionalProfileInformation\GetHeathcareProfessionalProfileInformat ion.wsdl
GetHeathCareProfessionalComplianceD etails
Use this Web service to read the detail data of a Health Care Provider including Marketing Compliance information.
GetHealthCareProfessionalComplianceDetails Operations
Due to the nature of the schema generation for the WSDL file, the message formats for each operation have their own message names. For a list of operations associated with this Web service, see Table 569 Table 569. GetHealthCareProfessionalComplianceDetails Operations Name LSMCDetailsQueryById LSMCDetailsQueryByExample Description Reads the profile of the Health Care Provider specified by his/her Siebel Contact Row Id. Reads the profile of the Health Care Provider specified by a combination of several attributes.
340
Request Message Description: LSMCDetailsQueryById The operations in this Web service work with a common response message format but have a different request message format. For a description of this request message, see Table 570. Table 570. Request Message Description: LSMCDetailsQueryById Node <PrimaryRowId> Description Required. Represents the Siebel Row Id of the Contact Object.
34 1
Request Message Description: LSMCDetailsQueryByExample For a description of this request message, see Table 571. Table 571. 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. A combination of attributes to uniquely identify a Contact.
342
Common Response Message Description The column Node represents a respective Siebel field if not specified otherwise. For a description of this response message, see Table 572. 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>
34 3
Table 572. 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
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
34 5
Table 572. Common Response Message Description Node <LoggedById> <ProcessStatus> <ReportingState> <TransactionState> Parent LsMcContactExpenseItemAllocation LsMcContactExpenseItemAllocation LsMcContactExpenseItemAllocation LsMcContactExpenseItemAllocation Description
GetHealthCareProfessionalComplianceDetails Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 573. 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, see Table 574. Table 574. GetHealthCareProfessionalComplianceDetails Data Object Siebel Repository Name LSMCDetails External Name Contact
Methods For a description of methods for this Web service, see Table 575. Table 575. GetHealthCareProfessionalComplianceDetails Methods Operation LSMCDetailsQueryById LSMCDetailsQueryByExample Method QueryById QueryByExample
346
Primary Web Services for Siebel CRM 8.0 GetUnallocatedExpenseItem
Example Package for GetHeathcareProfessionalComplianceDetails

Request See the following file to view the sample code: ...\GetHeathcareProfComplianceDetails\GetHeathcareProfessionalComplianceDetails_reques t.xml Response See the following file to view the sample code: ...\GetHeathcareProfComplianceDetails\GetHeathcareProfessionalComplianceDetails_respon se.xml
Message Schema (WSDL) for GetHeathcareProfessionalComplianceDetails

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. ...\GetHeathcareProfessionalComplianceDetails\GetHeathcareProfessionalComplianceDetail s.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.
GetUnallocatedExpenseItem Operations
Because of the nature of the schema generation for the WSDL file, the message formats for each operation have their own message names. For a list of operations associated with this Web service, see Table 576. Table 576. GetUnallocatedExpenseItem Operations Name LSMCGetUnallocatedExpenseItemQueryById LSMCGetUnallocatedExpenseItemQueryByExample Description Read the data of an expense item specified by its Siebel Row Id. Read the data of an expense item specified by a combination of several attributes.
34 7
Request Message Description: LSMCGetUnallocatedExpenseItemQueryById The operations in this Web service work with a common response message format but have different request message format. For a description of this request message, see Table 577. Table 577. Request Message Description: LSMCGetUnallocatedExpenseItemQueryById Node <PrimaryRowId> Description Required. Represents the Siebel Row Id of the Expense Item Object.
Request Message Description: LSMCGetUnallocatedExpenseItemQueryByExample For a description of this request message, see Table 578. Table 578. Request Message Description: LSMCGetUnallocatedExpenseItemQueryByExample Node <Contact> <Id> <LSMCAllocationDate> <LSMCAllocationStatusCode> <LSMCComplianceFlag> <LSMCTransactionState> <ExpenseItemType> <Amount> <ExchangeRate> Description Required. A combination of attributes to uniquely identify an expense Item.
NOTE: Retrieving the data of an expense item by a combination of attributes using the operation LSMCGetUnallocatedExpenseItemQueryByExample is not recommended, 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.
Common Response Message Description The column Node represents a respective Siebel field if not specified otherwise. For a description of this response message, see Table 579. Table 579. Common Response Message Description Node <ListOfLSMCGetUnallocatedExpenseItem xmlns><Tag> <ExpenseItem soapenc ...> <ExpenseItem> <Id> <LSMCAllocationDate> Parent N/A ListOfLSMCGetUnallocatedExpenseItem ExpenseItem soapenc ExpenseItem ExpenseItem Description <Tag> <Tag> <Tag>
348
Table 579. Common Response Message Description Node <LSMCAllocationStatusCode> <LSMCComplianceFlag> <LSMCTransactionState> <ExpenseItemType> <Amount> <ExchangeRate> <ListOfLSMCContactExpenseItem> <LSMCContactExpenseItem soapenc ...> <LSMCContactExpenseItem> <Id> <ListOfLSMCBudgetContact> <LSMCBudgetContact soapenc ...> <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

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 580. Table 580. GetUnallocatedExpenseItem Service Object Name LSMCGetUnallocatedExpenseItem Boundary Object Type Business Service Class (if BusService) CSSEAIDataSyncService
34 9
Primary Web Services for Siebel CRM 8.0 INSClaims
Data Object (Integration Object) For a description of data objects for this Web service, see Table 581. Table 581. GetUnallocatedExpenseItem Data Object Siebel Repository Name LSMCGetUnallocatedExpenseItem External Name LSMCGetUnallocatedExpenseItem
Methods For a description of methods for this Web service, see Table 582. Table 582. GetUnallocatedExpenseItem Methods Operation LSMCGetUnallocatedExpenseItemQueryById LSMCGetUnallocatedExpenseItemQueryByExample Method QueryById QueryByExample
Example Package for GetUnallocatedExpenseItem

Request See the following file to view the sample code: ...\GetUnallocatedExpenseItem\GetUnallocatedExpenseItem_request.xml Response See the following file to view the sample code: ...\GetUnallocatedExpenseItem\GetUnallocatedExpenseItem_response.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 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. ...\GetUnallocatedExpenseItem\GetUnallocatedExpenseItem.wsdl
INSClaims
Use this Web service to query for, and update claims and claim elements.
350
INSClaimsOperations
For a list of operations associated with this Web service, see Table 583. Table 583. INSClaimsOperations Name INSClaimsQueryByExample INSClaimsInsertOrUpdate ClaimElementQueryByExample ClaimElementInsertOrUpdate Description Retrieves the claim record. Updates the claim record. Retrieves a claim element. Updates a claim element.
Request Message Description: INSClaimsQueryByExample For a description of this request message, see Table 584. Table 584. Request Message Description: INSClaimsQueryByExample Node SiebelMessage Description Required. Based on integration object INS Claims.
Request Message Description: INSClaimsInsertOrUpdate For a description of this request message, see Table 585. Table 585. Request Message Description: INSClaimsInsertOrUpdate Node SiebelMessage Description Required. Based on integration object INS Claims.
Request Message Description: ClaimElementQueryByExample For a description of this request message, see Table 586. Table 586. Request Message Description: ClaimElementQueryByExample Node SiebelMessage Description Required. Based on integration object FINS Claim Elements.
Request Message Description: ClaimElementInsertOrUpdate For a description of this request message, see Table 587. Table 587. Request Message Description: ClaimElementInsertOrUpdate Node SiebelMessage Description Required. Based on integration object FINS Claim Elements.
35 1
Common Response Message Description The response messages for these operations are the same as the request messages.
INSClaims Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 588. Table 588. 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, see Table 589. Table 589. 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, see Table 590. Table 590. INSClaims Methods Operation INSClaimsQueryByExample INSClaimsInsertOrUpdate ClaimElementQueryByExample ClaimElementInsertOrUpdate Method INS Claims.QueryByExample INS Claims.InsertOrUpdate FINS Claim Elements.QueryByExample FINS Claim Elemetns.InsertOrUpdate
Example Package for INSClaims

352
Request (INSClaims) See the following file to view the sample code: ...\INSClaims\INSClaims_request.xml Response (INSClaims) See the following file to view the sample code: ...\INSClaims\INSClaim_response.xml Request (ClaimElementQueryByExample) See the following file to view the sample code: ...\ClaimElementQueryByExample\ClaimElementQueryByExample_request.xml Response (ClaimElementQueryByExample) See the following file to view the sample code: ...\ClaimElementQueryByExample\ClaimElementQueryByExample_response.xml Request (ClaimElementsInsertOrUpdate) See the following file to view the sample code: ...\ClaimElementsInsertOrUpdate\ClaimElementsInsertOrUpdate_request.xml Request (GetAutoPolicy) See the following file to view the sample code: ...\GetAutoPolicy\GetAutoPolicy_request.xml Response (GetAutoPolicy) See the following file to view the sample code: ...\GetAutoPolicy\GetAutoPolicy_response.xml Request (GetPropertyPolicy) See the following file to view the sample code: ...\GetPropertyPolicy\GetPropertyPolicy_request.xml Response (GetPropertyPolicy) See the following file to view the sample code: ...\GetPropertyPolicy\GetPropertyPolicy_response.xml
35 3
Primary Web Services for Siebel CRM 8.0 IntegrationObjectInfo
Request (INSClaimsInsertOrUpdate) See the following file to view the sample code: ...\INSClaimsInsertOrUpdate\INSClaimsInsertOrUpdate_request.xml
Message Schema (WSDL) for INSClaims

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. INSClaims\INSClaims.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.
IntegrationObjectInfo Operations
For a list of operations associated with this Web service, see Table 591. Table 591. IntegrationObjectInfo Operations Name GetIntegrationObjectInfo Description Retrieves fields from both an integration object and an integration component.
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. For a description of this request message, see Table 592. Table 592. Request Message Description: GetIntegrationObjectInfo Node IntegrationObjectName IntegrationCompName Description Integration Object name. Integration Component name from which fields are retrieved.
354
Primary Web Services for Siebel CRM 8.0 IntegrationObjectInfo
Response Message Description: GetIntegrationObjectInfo Response Message includes all the repository integration component field names. For a description of this response message, see Table 593. Table 593. Response Message Description: GetIntegrationObjectInfo Node RepositoryIntegrationObject RepositoryIntegrationComponent ListOfRepositoryIntegrationComponentField Description Integration Object name. Integration Component name. List of repository Integration Component field names.
IntegrationObjectInfo Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 594. Table 594. 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, see Table 595. Table 595. 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 596. Methods Business Service Operation GetIntegrationObjectInfo Method GetIntegrationObjectInfo
35 5
Primary Web Services for Siebel CRM 8.0 NetworkOrderEntry
Example Package for IntegrationObjectInfo

Request See the following file to view the sample code: ...\IntegrationObjectInfo\IntegrationObjectInfo_request.xml Response See the following file to view the sample code: ...\IntegrationObjectInfo\IntegrationObjectInfo_response.xml
Message Schema (WSDL) for IntegrationObjectInfo

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. ...\IntegrationObjectInfo\IntegrationObjectInfo.wsdl
NetworkOrderEntry
Use this Web service to access network assets, as well as related attributes, attached files, and open orders. Additionally, use this service to validate a network based on product rules, and, return projected assets for a network.
NetworkOrderEntry Operations
For a list of operations associated with this Web service, see Table 597. Table 597. NetworkOrderEntry Operations Name GetNetworkAssets GetNetworkAssetAttributes GetNetworkAssetAttachments GetOpenNetworkOrders ValidateNetworkOrder QueryProjectedNetworkAsset Description Return the network asset based on the asset Id. Return the attribute of a network asset (regardless whether it is network, network node, or network connection). Return the file attachment for a network asset. Return the open order line items for a network asset. Validate a network based on the product rules. If the network is invalid, return the error messages. Return the projected asset for a network.
356
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

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

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
358
Primary Web Services for Siebel CRM 8.0 PartnerRegistration
PartnerRegistration
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 Objects 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.
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
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
36 1
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
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.
36 3
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
Table 603. Request Message Description:GetCfgObjectGroupItems/GetCfgObjectDefaultGroupItems Node Id Description 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 / 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 name value pairs. 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. Unique value. Object properties name value pairs. 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. Unique value.
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, see Table 604. Table 604. Request Message Description: BeginConfiguration Node BeginConfiguration_Input Description Required.
36 5
Table 604. Request Message Description: BeginConfiguration Node InitInstanceOperation Description 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. 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. 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. This will add a new line item to the hierarchy object from the ListOfQuote parameter (PDS Quote integration object). ProductId is required.
DEFAULT
SET
ADD
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 / relationships on which user requires domain information (with exclusions) in CfgInteractData integration object format.
ListOfData
ProductData Item 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.
366
Table 604. Request Message Description: BeginConfiguration Node ProductId Description 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. Has Generics Flag. Used to indicate whether the line item is incomplete. Eligibility Status. Eligibility Reason.
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. List of Relationships on which information is required. Name of relationship to query for. If empty, all relationships are returned. Id. Always returned whether specified in Request or not. Zero or more. Domain Items of the relationship. Always returned whether specified in Request or not. Name of domain item. Id of domain item. 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.
36 7
Table 604. 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. 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 Value displayed as number Value displayed in Boolean format. Date and time value. Selected Flag indicates whether this value is selected. Excluded Flag indicates whether this value is excluded by a Constraint, Eligibility & Compatibility rule or Promotion. Zero or more. Same recursive structure as that defined in this topic. List of linked items. Linked items. One or more. Name of linked item. Type of Value.
Response Message Description: Begin Configuration GetCfgObjectStructure has the same request and response message. See the preceding table for details. GetCfgObjectGroupItems and GetCfgObjectDefaultGroupItems have the same request and response messages. See request message description for details. For a description of this response message, see Table 605. Table 605. Response Message Description: Begin Configuration Node BeginConfiguration_Output Error_spcCode Error_spcMessage RootId RootIntegrationId Description Required. Error code if error occurred. Error message if error occurred. Root Id of new item. Integration Id of new root item.
368
Table 605. Response Message Description: Begin Configuration Node ListOfQuote ListOfData Description Quote instance if ReturnFullInstance input parameter was set to Y. See BeginConfiguration Request Message for details. The domain information about products / attributes / relationships as well current selections for the attributes / relationships that was requested in the Request Message. See the Request Message for more details. This indicates whether the request was successful or not and contains messages to be displayed. Required. Success / Warning / Error. If StatusCode is 'Success', then everything was ok. If it is 'Warning', then there were some conflicts (messages are present in ListOfMessage) that were automically resolved. If it is 'Error', then there were conflicts (messages are present in ListOfMessage) that could not be resolved and further requests to this session will not be honored. Details on the error if any. Proceed / Undo. 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. List of messages. Zero or more. Source of the messages (Eligibility, Promotion, Cardinality, Proceed Actions, and so on). Message text.
ListOfStatus Status StatusCode
StatusText ConflictResolution
Messages MessageType MessageSource Message
Request Message Description: UpdateConfiguration For a description of this request message, see Table 606. Table 606. Request Message Description: UpdateConfiguration Node UpdateConfiguration_Input ConflictAutoResolve FinishInstanceInFlag SaveInstanceInFlag RepriceInstanceInFlag VerifyInstanceInFlag Description Required. Proceed or Undo. If set to Proceed, all conflicts are auto resolved. If set to Undo, any conflict will result in an Undo of the entire batch. If set Y, FinishIt is called. If set Y, Instance is saved to db. If set Y, reprice is called. If set Y, verify instance is called.
36 9
Table 606. 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. Type of request (AddItem, RemoveItem, SetItemQuantitty, SetAttribute, ReplaceItem). Zero or more requests. Add product Id for AddItem, ReplaceItem. Quantity. Relationship Id which contains the new product for AddItem, ReplaceItem. Integration Id on which the operation will be performed. Zero or more SetAttribute request details. Name or attribute. Value type: string, integer or number. Zero or more. New display value of attribute. Value displayed in a string. Value displayed as number. Value displayed as integer. Date and time value. Value displayed in Boolean format. Description Same as ListOfData in BeginConfiguration Request Message. List of Requests that will be executed on the product instance.
Response Message Description: UpdateConfiguration For a description of this response message, see Table 607. Table 607. Response Message Description: UpdateConfiguration Node UpdateConfiguration_Output Error_spcCode Error_spcMessage FinishConfigurationOutFlag Description Required. Error Code if error occurred. Error Message if error occurred. Y / N. Indicates whether Finish Configuration was performed. It might not be performed if there were some errors.
370
Table 607. Response Message Description: UpdateConfiguration Node RepriceOutFlag SaveInstanceOutFlag VerifyOutFlag ListOfData Description Y / N. Indicates whether Reprice was done. It might not be performed if there were some errors. Y / N. Indicates whether Save Instance was done. It might not be performed if there were some conflicts. Y / N. Indicates whether Verify was done. It might not be performed if there were some errors. The domain information about products / attributes / relationships as well current selections for the attributes / relationships that was requested in the Request Message. See the Request Message for more details. This indicates whether the request was successful or not and contains messages to be displayed. See BeginConfiguration Response Message.
ListOfStatus
Request Message Description: EndConfiguration For a description of this request message, see Table 608. Table 608. Request Message Description: EndConfiguration Node EndConfiguration_Input SaveInstanceFlag Description Required Save Instance flag
Response Message Description: EndConfiguration For a description of this response message, see Table 609. Table 609. Response Message Description: EndConfiguration Node EndConfiguration_Output Error_spcCode Error_spcMessage ListOfQuote Description Required. Error Code if error occurred. Error Message if error occurred. Quote instance. See BeginConfiguration Request Message for details.
ProductConfigurator Application Interface

37 1
Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 610. 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 611. Table 611. 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, see Table 612. Table 612. ProductConfigurator Methods Operation GetCfgObjectStructure GetCfgObjectGroupItems GetCfgObjectDefaultGroupItems Method GetObjStructure GetObjGroupItems GetObjDefaultGroupItems
Example Package for ProductConfigurator

Request (GetObjDefaultGroupItems) See the following file to view the sample code:
372
Primary Web Services for Siebel CRM 8.0 ProductRecommendation
...\ProductConfigurator\GetObjDefaultGroupItems_request.xml Response (GetObjDefaultGroupItems) See the following file to view the sample code: ...\ProductConfigurator\GetObjDefaultGroupItems_response.xml Request (GetObjGroupItems) See the following file to view the sample code: ...\ProductConfigurator\GetObjGroupItems_request.xml Response (GetObjGroupItems) See the following file to view the sample code: ...\ProductConfigurator\GetObjGroupItems_response.xml Request (GetObjStructure) See the following file to view the sample code: ...\ProductConfigurator\GetObjStructure_request.xml Response (GetObjStructure) See the following file to view the sample code: ...\ProductConfigurator\GetObjStructure_response.xml
Message Schema (WSDL) for ProductConfigurator

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\ProductConfigurator.wsdl
ProductRecommendation
Use this Web service to generate the Recommended Products, based on the input Quote line items.
37 3
ProductRecommendation Operations
For a list of operations associated with this Web service, see Table 613. Table 613. ProductRecommendation Operations Name GetRecommendedProductsForQuote Description Generate Recommended Products
Request Message Description: GetRecommendedProductsForQuote For a description of this request message, see Table 614. Table 614. Request Message Description: GetRecommendedProductsForQuote Node QuoteIO PSP Mode Description Required. An instance of the Integration Object PDS Quote. This is a required input. The default is External PDS Quote. This parameter will be parsed as the Mode used in the Variable Map.
Recommended Products Used Fields For a description of recommended products used fields, see Table 615. Table 615. 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). 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. Table 616. 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
Response Message Description: GetRecommendedProductsForQuote For a description of this response message, see Table 617. Table 617. Response Message Description: GetRecommendedProductsForQuote Node RecommendedProductIO Description An instance of the integration object Recommended Products. It contains the product information, pricing, eligibility, and recommended reason and score.
ProductRecommendation Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 618. Table 618. 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, see Table 619. Table 619. ProductRecommendation Data Objects Siebel Repository Name Recommended Products PDS Quote External Name Recommended Products PDS Simplified Quote
Example Package for ProductRecommendation

Request See the following file to view the sample code: ...\ProductRecommendation\ProductRecommendation_request.xml
37 5
Primary Web Services for Siebel CRM 8.0 PromotionWebService
Response See the following file to view the sample code: ...\ProductRecommendation\ProductRecommendation_response.xml
Message Schema (WSDL) for ProductRecommendation

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. ...\ProductRecommendation\ProductRecommendation.wsdl
PromotionWebService
Use this Web service to get product promotion information, apply product promotion.
PromotionWebService Operations
For a list of operations associated with this Web service, see Table 620. Table 620. 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, see Table 621. Table 621. Request Message Description: GetProductPromotionDefinition Node EligibilityMode PricingMode LoadAllDomainFlag LoadDefaultDomainFlag LoadPromDefFlag ContextMode Description Optional, default value as '2'. Could be 0, 1, 2. Optional, default value as 'Y'. Y/N. Required, Y/N. Required, Y/N. Required, Y/N. Required, 'Siebel Context' or 'External Context'.
376
Table 621. Request Message Description: GetProductPromotionDefinition Node Context ProdPromRuleType ProdPromId ProdPromRuleId ApplyProductPromotion EligibilityMode PricingMode ProdPromId ProdPromInstanceId LineItemId SiebelMessage Optional, default value as '2'. Could be 0, 1, 2. Optional, default value as 'Y'. Y/N. Required. Optional, depending on usage scenarios. Optional, depending on usage scenarios. Required, in SiebelMessage format of IO 'PDS Quote'. Description Required, in SiebelMessage format of IO 'PDS Catalog Context'. Optional, 'Product' or 'Pricing'. Optional, depending on usage scenarios. Optional, depending on usage scenarios.
Response Message Description: GetProductPromotionDefinition For a description of this response message, see Table 622. Table 622. Response Message Description: GetProductPromotionDefinition Node ProdPromDefinition PromDomainProduct Description In SiebelMessage format of IO 'ISS Promotion Definition for WS'. In SiebelMessage format of IO 'PDS Product Interface'. Could be either default domain product details or all domain product details depending on input arguments. Error Code if error occurred. Error Message if error occurred.
Err_spcCode Err_spcMessage
Request Message Description: ApplyProductPromotion For a description of this request message, see Table 623. Table 623. Request Message Description: ApplyProductPromotion Node EligibilityMode PricingMode ProdPromId ProdPromInstanceId Description Optional, default value as '2'. Could be 0, 1, 2. Optional, default value as 'Y'. Y/N. Required. Optional, depending on usage scenarios.
37 7
Table 623. Request Message Description: ApplyProductPromotion Node LineItemId SiebelMessage Description Optional, depending on usage scenarios. Required, in SiebelMessage format of IO 'PDS Quote'.
Response Message Description: ApplyProductPromotion For a description of this response message, see Table 624. Table 624. Response Message Description: ApplyProductPromotion Node SiebelMessage Err_spcCode Err_spcMessage Description Required, in SiebelMessage format of IO 'PDS Quote'. Error Code if error occurred. Error Message if error occurred.
PromotionWebService Application Objects

This topic describes the application objects called by this Web service. For more information on application implementation, refer to application development documentation.
Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 625. Table 625. PromotionWebService Service Object Name ISS Promotion WS - GetProductPromotionDetails ISS Promotion WS - ApplyProductPromotion ISS Promotion WS - 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, see Table 626. Table 626. 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
Primary Web Services for Siebel CRM 8.0 QuoteWebService and OrderWebService
Example Package for PromotionWebService

Request See the following file to view the sample code: ...\PromotionWebService\PromotionWebService_request.xml
Message Schema (WSDL) for PromotionWebService

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. ...\PromotionWebService\PromotionWebService.wsdl
QuoteWebService and OrderWebService

Use this set of Web services to manipulate the Quote or Order data.
QuoteWebService and OrderWebService Operations

For a list of operations associated with this Web service, see Table 627. Table 627. 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 order. Updates the quote header information. Updates the line items for a specific quote. Deletes a given order. Deletes the line items on a specific order. Deletes a given quote. Deletes the line items on a specific quote. Inserts an order. Adds the line items on a given order. Inserts a quote. Adds the line items on a given quote.
37 9
Table 627. QuoteWebService and OrderWebService Operations Name Get Quote Get Order Description Queries the quote. Queries an order.
Request Message Description: Query, Update, Delete Quote For a description of this request message, see Table 628. Table 628. Request Message Description: Query, Update, Delete Quote QueryByExample/QueryById/InsertQuote/DeleteQuote Request Message Node QuoteIO Description Required. An instance of the Integration Object PDS Quote.
Response Message Description: Query, Update, Delete, Quote For a description of this response message, see Table 629. Table 629. Response Message Description: Query, Update, Delete, Quote QueryByExample/QueryById/InsertQuote/DeleteQuote Response Message Node QuoteIO Description Required. An instance of the Integration Object PDS Quote.
Request Message Description: Query, Update, Delete Quote Item For a description of this request message, see Table 630. Table 630. Request Message Description: Query, Update, Delete Quote Item QueryByExample/UpdateQuoteItem/InsertQuoteItem/DeleteQuoteItem Request Message Node QuoteItemIO Description Required. An instance of the Integration Object PDS Quote Item.
Response Message Description: Query, Update, Delete Quote Item For a description of this response message, see Table 631. Table 631. Response Message Description: Query, Update, Delete Quote Item QueryByExample/UpdateQuoteItem/InsertQuoteItem/DeleteQuoteItem Response Message Node QuoteItemIO Description Required. An instance of the Integration Object PDS Quote Item.
380
Request Message Description: Query, Update, Delete Order For a description of this request message, see Table 632. Table 632. Request Message Description: Query, Update, Delete Order QueryByExample/QueryById/InsertOrder/DeleteOrder Request Message Node OrderIO Description Required. An instance of the Integration Object PDS Order.
Response Message Description: Query, Update, Delete Order For a description of this response message, see Table 633. Table 633. Response Message Description: Query, Update, Delete Order QueryByExample/QueryById/InsertOrder/DeleteOrder Response Message Node OrderIO Description Required. An instance of the Integration Object PDS Order.
Request Message Description: Query, Update, Delete Order Item For a description of this request message, see Table 634. Table 634. Request Message Description: Query, Update, Delete Order Item QueryByExample/UpdateOrderItem/InsertOrderItem/DeleteOrderItem Request Message Node OrderItemIO Description Required. An instance of the Integration Object PDS Order Item.
Response Message Description: Query, Update, Delete Order Item For a description of this response message, see Table 635. Table 635. Response Message Description: Query, Update, Delete Order Item QueryByExample/UpdateOrderItem/InsertOrderItem/DeleteOrderItem Response Message Node OrderItemIO Description Required. An instance of the Integration Object PDS Order Item.
QuoteWebService and OrderWebService Application Interface

38 1
Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 636. Table 636. 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, see Table 637. Table 637. 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

Request See the following file to view the sample code: ...\Quote_and_Order\QuoteWebService_request.xml Response See the following file to view the sample code: ...\Quote_and_Order\QuoteWebService_response.xml
Message Schema (WSDL) for QuoteWebService

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

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 641. Table 641. 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, see Table 642. Table 642. QuoteAddItems Data Objects Siebel Repository Name Added Products PDS Quote External Name None (XML) PDS Simplified Quote
Example Package for QuoteAddItems

Request See the following file to view the sample code: ...\QuoteAddItemsWS\QuoteAddItemsWS_request.xml Response See the following file to view the sample code: ...\QuoteAddItemsWS\QuoteAddItemsWS_response.xml
Message Schema (WSDL) for QuoteAddItems

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. ...\QuoteAddItemsWS\http_siebel.com_OrderManagement_Quote_QuoteAddItemsWS.wsdl
384
Primary Web Services for Siebel CRM 8.0 SerializationService
SerializationService
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. ...\SerializationService\SerializationService.wsdl
ServiceRequest
Use this Web service to create, read, update, and delete service requests.
ServiceRequest Operations
Note that all operations for this service share a common data format. Because of this similarity, all the operations for this service are grouped together. However, because of the nature of the schema generation for the WSDL file, the message formats for each operation have their own message names. For a list of operations associated with this Web service, see Table 643. Table 643. 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. The request message consists of fields from the Service Request business component.
38 5
Primary Web Services for Siebel CRM 8.0 ServiceRequest
Common Response Message Description Same as Request Message format.
ServiceRequest Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 644. Table 644. 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. Table 645. ServiceRequest Data Object Siebel Repository Name Service Request External Name Service Request
Methods For a description of methods for this Web service, see Table 646. Table 646. ServiceRequest Methods Operation Service_spcRequest_ServiceRequestInsert Service_spcRequest_ServiceRequestQueryPage Service_spcRequest_ServiceRequestUpdate Service_spcRequest_ServiceRequestDelete Method [BS:Service Request].[Insert] [BS:Service Request].[QueryPage] [BS:Service Request].[Update] [BS:Service Request].[Delete]
Example Package for ServiceRequest

386
Primary Web Services for Siebel CRM 8.0 SessionAccessWS
Request See the following file to view the sample code: ...\ServiceRequest\ServiceRequest_request.xml Response See the following file to view the sample code: ...\ServiceRequest\ServiceRequest_response.xml
Message Schema (WSDL) for ServiceRequest

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. ...\ServiceRequest\ServiceRequest.wsdl
SessionAccessWS
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. ...\SessionAccessWS\SessionAccessWS.wsdl
SetAllocatedExpenseItem
Use this Web service to set the allocation data for a specific expense item record. This functionality is specific for allocating expenses for Marketing Compliance in ePharma.
SetAllocatedExpenseItem Operations
Because of the nature of the schema generation for the WSDL file, the message formats for each operation have their own message names. For a list of operations associated with this Web service, see Table 647. Table 647. SetAllocatedExpenseItem Operations Name LSMCSetAllocatedExpenseItemSynchronize Description Set the allocation data for an expense item.
38 7
Primary Web Services for Siebel CRM 8.0 SetAllocatedExpenseItem
Request Message Description: LSMCSetAllocatedExpenseItemSynchronize The Node column represents a respective Siebel field if not specified otherwise. For a description of this request message, see Table 648. Table 648. Request Message Description: LSMCSetAllocatedExpenseItemSynchronize Node <ListOfLSMCSetAllocatedExpenseItem> <ExpenseItem ...> <ExpenseItem> <Id> <LSMCAllocationDate> <LSMCAllocationStatusCode> <LSMCComplianceFlag> <ListOfLSMCContactExpenseItem> <LSMCContactExpenseItem ...> <LSMCContactExpenseItem> <Id> <ListOfLSMCContactExpenseItemAllocation> <LSMCContactExpenseItemAllocation ...> <LSMCContactExpenseItemAllocation> <ExpenseItemContactId> <ReportingState> <Description> <AllocatedAmount> 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

388
Primary Web Services for Siebel CRM 8.0 SetAllocatedExpenseItem
Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 649. Table 649. 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, see Table 650. Table 650. SetAllocatedExpenseItem Data Object Siebel Repository Name LSMCSetAllocatedExpenseItem External Name LSMCSetAllocatedExpenseItem
Methods For a description of methods for this Web service, see Table 651. Table 651. SetAllocatedExpenseItem Method Operation LSMCSetAllocatedExpenseItemSynchronize Method Synchronize
Example Package for SetAllocatedExpenseItem

Request See the following file to view the sample code: ...\SetAllocatedExpenseItem\SetAllocatedExpenseItem_request.xml Response See the following file to view the sample code: ...\SetAllocatedExpenseItem\SetAllocatedExpenseItem_response.xml
Message Schema (WSDL) for SetAllocatedExpenseItem

38 9
Primary Web Services for Siebel CRM 8.0 SFA_Activity_BS
...\SetAllocatedExpenseItem\SetAllocatedExpenseItem.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.
SFA_Activity_BS Operations
These operations are listed in the WSDL that is presented as a WSDL to the clients accessing it. For a list of operations associated with this Web service, see Table 652. Table 652. SFA_Activity_BS Operations Name SFAInsertActivity Description Creates an activity record in the database and associates a contact record to it.
Response Message Description: SFAInsertActivity For a description of this request message, see Table 653. Table 653. Response Message Description: SFAInsertActivity Node SFA_Activity_IO Description Required
Response Message Description: SFAInsertActivity For a description of this response message, see Table 654. Table 654. Response Message Description: SFAInsertActivity Node SFA_Activity_IO Description Required
SFA_Activity_BS Application Interface

390
Primary Web Services for Siebel CRM 8.0 SFA_Activity_BS
Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 655. 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, see Table 656. Table 656. 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. Table 657. SFA_Activity_BS Method Operation Insert Method Insert
Example Package for SFA_Activity_BS

Request See the following file to view the sample code: ...\SFA_Activity_BS\SFA_Activity_BS_request.xml Response See the following file to view the sample code: ...\SFA_Activity_BS\SFA_Activity_BS_response.xml
Message Schema (WSDL) for SFA_Activity_BS

39 1
Primary Web Services for Siebel CRM 8.0 SiebelUserProfileService
...\SFA_Activity_BS\SFA_Activity_BS.wsdl
SiebelUserProfileService
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. ...\SiebelUserProfileService\SiebelUserProfileService.wsdl
SiebelWebRegistration
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. ...\SiebelWebRegistration\SiebelWebRegistration.wsdl
TroubleTicket
Use this Web service to create, update, retrieve and set status for trouble tickets.
TroubleTicket Operations
For a list of operations associated with this Web service, see Table 658. Table 658. TroubleTicket Operations Name CreateTroubleTicket UpdateTroubleTicket GetTroubleTicket SetTroubleTicketStatus Description Create a new network trouble ticket, including the resource(s) and service(s) affected. Update additional attributes on the trouble ticket. Return the existing trouble tickets that meet criteria specified in a search spec. Update the status of an existing network trouble ticket; typically to cancel or close a network alarm.
Common Request Message Description This Web service has four operations. Each operation does not share a common request message format.
392
Primary Web Services for Siebel CRM 8.0 TroubleTicket
Common Response Message Description This Web service has four operations. Each operation does not share a common response message format.
TroubleTicket Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 659. 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, see Table 660. Table 660. 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, see Table 661. Table 661. TroubleTicket Methods Operation CreateTroubleTicket UpdateTroubleTicket GetTroubleTicket SetTroubleTicketStatus Business Service Trouble Ticket Trouble Ticket Trouble Ticket Trouble Ticket Lightweight Method Insert Update QueryByExample Update
39 3
Primary Web Services for Siebel CRM 8.0 VerifyEntitlement
Example Package for TroubleTicket

Request See the following file to view the sample code: ...\TroubleTicket\TroubleTicket_request.xml Response See the following file to view the sample code: ...\TroubleTicket\TroubleTicket_response.xml
Message Schema (WSDL) for TroubleTicket

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. ...\TroubleTicket\TroubleTicket.wsdl
VerifyEntitlement
Use this Web service to obtain the best response time for Service Requests based on customer entitlements.
VerifyEntitlement Operations
For a list of operations associated with this Web service, see Table 662. Table 662. VerifyEntitlement Operations Name FSVerifyEntitlementRunProcess Description Verifies customer entitlements at time of service request creation to ensure fastest response time.
394
Primary Web Services for Siebel CRM 8.0 VerifyEntitlement
Request Message Description: FSVerifyEntitlement For a description of this request message, see Table 663. Table 663. 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, see Table 664. Table 664. 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

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 665. Table 665. VerifyEntitlement Service Object Name FS Verify Entitlement Boundary Object Type Workflow Class (if BusService) Not applicable
39 5
Primary Web Services for Siebel CRM 8.0 Warranty
Methods For a description of the method used for this Web services, see Table 666. Table 666. VerifyEntitlement Methods Operation FSVerifyEntitlementRunProcess Method [WF: FS Verify Entitlement].[RunProcess]
Example Package for VerifyEntitlement

Request See the following file to view the sample code: ...\VerifyEntitlement\VerifyEntitlement_request.xml Response See the following file to view the sample code: ...\VerifyEntitlement\VerifyEntitlement_response.xml
Message Schema (WSDL) for VerifyEntitlement

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. ...\VerifyEntitlement\VerifyEntitlement.wsdl
Warranty
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. ...\Warranty\CreateWarranty.wsdl ...\Warranty\CheckWarranty.wsdl
WC_Account_BS
396
Primary Web Services for Siebel CRM 8.0 WC_Contacts_BS
...\WC_Account_BS\WC_Account_BS.wsdl
WC_Contacts_BS
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. ...\WC_Contacts_BS\WC_Contacts_BS.wsdl
WC_Opportunity_BS
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. ...\WC_Opportunity_BS\WC_Opportunity_BS.wsdl
WC_Service_Request_BS
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. ...\WC_Service_Request_BS\WC_Service_Request_BS.wsdl
WebMarketing
Use this Web service to retrieve personalized content from Web offers, and details based on the offer treatment Id and Contact Id. Additionally, you can get subscription list information, and create responses for tracking click events.
WebMarketing Operations
For a list of operations associated with this Web service, see Table 667. Table 667. WebMarketing Operations Name CreateWebMarketingResponse GetActiveLists Description Create response records to track click events. Retrieve a list of all active subscription lists.
39 7
Primary Web Services for Siebel CRM 8.0 WebMarketing
Table 667. WebMarketing Operations Name GetListMembers GetWebTreatment Description Retrieve a list of subscription lists that the contact/prospect is subscribed to. Retrieves Web offer treatment and related Web surveys, products, events, URLs and template. If context information is provided, personalization Web content will also be returned.
Request Message Description: CreateWebMarketingResponse For a description of this request message, see Table 668. Table 668. 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. Row Id of Account. Required. Delivery Method. Required. Description of the response. Hyperlink name of response URL. Response URL. Row Id of Event. Event Registration Id. Response Row Id. Row Id of Prospect. Either PRSP_CON_ID or PR_CON_ID must be filled in. Row Id of Contact. Either PRSP_CON_ID or PR_CON_ID must be filled in. Response Method. Required. Response Type. Row Id of Campaign. Row Id of Campaign Contact. Status Code. Subscribe to Direct Mail Action Code. Subscribe to Email Action Code. Subscribe to Fax Action Code. Subscribe to Phone Action Code. Row Id of Subscription List.
398
Table 668. Request Message Description: CreateWebMarketingResponse Node Summary Treatment Id Description Summary. Required. Row Id of Offer Treatment.
Response Message Description: CreateWebMarketingResponse For a description of this response message, see Table 669. Table 669. Response Message Description: CreateWebMarketingResponse Node Same as request message Description Not applicable
Request Message Description: GetActiveLists For a description of this request message, see Table 670. Table 670. Request Message Description: GetActiveLists Node List Description Id Name ViewMode Description Required. Description of the response. Row Id of subscription list. Name of subscription list. Visibility algorithm used to determine which records will be retrieved.
Response Message Description: GetActiveLists For a description of this response message, see Table 671. Table 671. Response Message Description: GetActiveLists Node Same as request message Description Not applicable
Request Message Description: GetListMembers For a description of this request message, see Table 672. Table 672. Request Message Description: GetListMembers Node List Members Contact Id Description Required Row Id of Contact
39 9
Table 672. 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, see Table 673. Table 673. Response Message Description: GetListMembers Node Same as request message Description Not applicable
Request Message Description: GetWebTreatment For a description of this request message, see Table 674. Table 674. Request Message Description: GetWebTreatment Node WebTreatment Id Context ContactId ProspectId CampConId CampaignId WebServer Row Id of Contact. Row Id of Prospect. Row Id of Campaign Contact. Row Id of Campaign. Web Server URL to be substituted in response forms. Description Required. Required. Row Id of Web Treatment.
Response Message Description: GetWebTreatment For a description of this response message, see Table 675. Table 675. Response Message Description: GetWebTreatment Node WebTreatment Active For Inbound Flag Description Id Description Required. Flag to indicate if the Web treatment is inbound. Description of the response. Row Id of Web Treatment.
400
Table 675. 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. Locale Code. Name of Web Treatment. Row Id of PriceList Id. Valid End Date. Valid Start Date. Template type. Row Id of Treatment Template. Personalized Content of Web treatment. Web survey to associate. Row Id of Web Survey. Name of Web Survey. Related product to retrieve. Row Id of Product. Name of Product. Related events to retreive. Row Id of Event. Name of Event.
WebMarketing Application Interface

Service Object (Business Service or Workflow) For a description of the service objects for this Web service, see Table 676. Table 676. WebMarketing Service Object Name WebMarketingService Boundary Object Type Business Service Class (if BusService) CSSWebMarketingService
40 1
Data Object (Integration Object) For a description of data objects for this Web service, see Table 677. Table 677. 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, see Table 678. Table 678. WebMarketing Methods Operation CreateWebMarketingResponse GetActiveLists GetListMembers GetWebTreatment Method [BS: WebMarketingService].[CreateResponse] [BS: WebMarketingService].[GetActiveLists] [BS: WebMarketingService].[GetListMembers] [BS: WebMarketingService].[GetWebTreatment]
Example Package for WebMarketing

Request See the following file to view the sample code: ...\WebMarketing\WebMarketing_request.xml Response See the following file to view the sample code: ...\WebMarketing\WebMarketing_response.xml
402
Message Schema (WSDL) for WebMarketing

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. ...\WebMarketing\WebMarketing.wsdl
40 3
404
Index
Numerics
8.0 Primary Web services, list of 283 8.1 ABOWebService, Web service 29 application interface 35 example package, schema 36 operations 30 8.1 CatalogWebService, Web service 37 application interface 40 example package, message schema 41 operations 37 8.1 primary web services 25 8.1 Product Configurator Web Service 41 application interface 54 example package, schema 55 operations 42 8.1 PromotionWebService, Web service 56 application interface 61 example package, schema 61 operations 57 8.1 WebMarketing, Web service 62 application interface 64 example package, schema 65 operations 62
A
ABOWebService, Web service 294 application interface 300 example package, schema 300 operations 294 Account, Web service 67 application interface 68 example package, schema 68 operations 67 Asset Management, Web service 301 application interface 302 example package, schema 303 operations 302 AssetManagementComplex, Web service 69 application interface 72 example package, schema 73 operations 69 AssetWebService, Web service 304
application interface 304 example package, schema 307 operations 304 CatalogWebService, Web service 307 application interface 314 example package, schema 315 operations 307 CMU Account Query, Web Service example package, schema 75 CMU Account Query, Web service 73 CMU Account Update message schema for 77 operation for 76 Contact, Web service 77 application interface 79 example package, schema 79 operations 78 ContextServiceWrapperService, Web service 316 application interface 319 example package, schema 320 operations 316 CopyActivity, Web Service 321 application interface 321 example package, schema 322 operations 321
E
EAILOVWS, Web service 322 EligibilityCompatibility, Web service 322 application interface 325 example package, 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 application interface 330 example package, schema 331 EventRegistration, Web service 332 ExternalAutoPolicy, Web service 332
C
CalculatePriceWS, Web service 304
40 5
Index F
ExternalPropertyPolicy, Web service
332
F
Forecast, Web service 332
G
GetHealthCareProfessionalProfileInformatio n, Web service 332 application interface 339 example package, schema 340 operations 332 GetHeathCareProfessionalComplianceDetail s, Web service 340 application interface 346 example package, schema 347 operations 340 GetMktgWebSurvey, Web service 105 application interface 106 example package, schema 107 operations 106 GetUnallocatedExpenseItem, Web service 347 application interface 349 example package, schema 350 operations 347
example package, schema 133 operations 129 LoyaltyImportBusinessService, Web service 134 example package, schema 135 operations 134 LoyaltyMemberService, Web service 135 example package, schema 148 operations 136 LoyaltyRedemptionService, Web service 150 example package, schema 161 operations 150 LoyaltyVoucherService, Web service 164 example package, schema 165 operations 164
M
MktgDeduplicationService, Web service application interface 169 example package, schema 170 operations 166 MktgImportService, Web service 171 application objects 172 example package, schema 172 operations 171 166
I
INSClaims, Web service 350 application interface 352 example package, schema 352 operations 351
N
NetworkOrderEntry, Web service application interface 357 example package, schema 358 operations 356 356
L
LeadProcessingService, Web service 110 application interface 113 example package, schema 113 operations 110 LeadService, Web service 115 application interface 118 example package, schema 118 operations 115 List, Web service 120 application interface 121 example package, schema 122 operations 120 ListMgmtProspect, Web service 123 example package, schema 124 operations 123 LoyaltyAccrualService, Web service 125 example package, schema 127 operations 125 LoyaltyBatchEnrollment, Web service 129
O
OrderDetailWebService, Web service 173 application interface 174 example package, schema 174 operations 173 OrderWebService, Web service 379 application interface 381 operations 379
P
PartnerPrograms, Web service 358 PartnerRegistration, Web service 359 PDSOrderHeader, Web service 175 example package, schema 176 operations 175 PriceListsWS, Web service 176 example package, schema 177 operations 176 Product Import
406
Index Q
message schema for 186 ProductConfigurator, Web service 359 application interface 371 example package, schema 372 operations 359 ProductRecommendation, Web service 373 application interface 375 example package, schema 375 operations 374 ProductSearchService, Web service 186 application interface 188 example package, schema 189 operations 187 PromotionWebService, Web service 376 application objects 378 example package, schema 379 operations 376
Q
QuoteAddItemsWS, Web service 383 application interface 384 example package, schema 384 operations 383 QuoteCheckOutWebService, Web service 189 example package, schema 190 operations 190 QuoteDetailWebService, Web service 191 example package, schema 193 operations 191 QuoteWebService, Web service 379 application interface 381 example package, schema 382 QuotingWebService, Web service 194 application interface 195 example package, schema 195 operations 194
R
Response, Web service 196 example package, schema 198 operations 196 RetrieveAttachmentService, Web service 199 application interface 200 example package, schema 201 operations 199
S
searchSolution, Web service 201 application interface 203 example package, schema 204 operations 202
SelfServiceAccount, Web service 204 application objects 210 example package, schema 210 operations 205 SelfServiceAccountRootPath, Web service 211 application interface 213 example package, schema 214 operations 211 SelfServiceAllAccountsList, Web service 214 application interface 218 example package, schema 218 operations 215 SelfServiceContact, Web service 219 application interface 223 example package, schema 224 operations 219 SelfServicePaymentHistory, Web service 225 operations 225 SelfServicePostLoginProcess, Web service 227 example package, schema 229 operations 227 P_mode request parameter 227 SelfServiceRegistration, Web service 230 application interface 241 enroll operation, business services called by 231 example package, schema 242 operations 231 P_mode request parameter 230 SelfServiceResponsibility, Web service 244 application interface 245 example package, schema 246 operations 244 SelfServiceSmtpEmail, Web service 246 application interface 248 example package, schema 248 operations 246 SelfServiceTemplateEmail, Web service 249 application interface 250 example package, schema 251 operations 249 SelfServiceTimeZone, Web service 252 application interface 252 example package, schema 253 operations 252 SelfServiceUser, Web service 254 application interface 257 example package, schema 257 operations 254 SelfServiceWebSite, Web service 258
40 7
Index T
application interface 259 example package, schema 260 operations 258 SerializationService, Web service 385 ServiceRequest, Web service 260, 385 application interface 264 application objects 386 example package, schema 265, 386 operations 261, 385 SessionAccessWS, Web service 266, 387 application interface 266 example package, schema 267 operations 266 SetAllocatedExpenseItem, Web service 387 application interface 388 example package, schema 389 operations 387 SFA_Activity_BS, Web service 390 application interface 390 example package, schema 391 operations 390 Siebel Web Service, modeling 19 exposing business service as web service 19 exposing workflow as web service 20 Siebel Web Service, process of exposing assembling the services 18 determining which objects to expose 17 Siebel Web service, process of exposing 17 Siebel Web Services authentication and performance 22 SiebelUserProfileService, Web service 392 SiebelWebRegistration, Web service 392 Simple Access Protocol (SOAP), about 13
UpdateCustomerSiebelJMSProducer described 275 example package for 277 message schema for 278
V
VerifyEntitlement, Web service 394 application interface 395 example package, schema 396 operations 394
W
Warranty, Web service 396 WC_Picklist_Payment_Profile_BS, Web service 278 application interface 280 example package, 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, outbound 14 integration objects 15 Siebel architecture 17 Siebel support 14 support and testing, list 285 Web Services Deployment Wizard, using 21 Web Services Description Language (WSDL), about 12 Web services, core technologies SOAP 13 WSDL 12 XML, XML schema 13 WebMarketing, Web service 397 application interface 401 example package, schema 402 operations 397 WS_Account_BS, Web service 396 WS_Contact_BS, Web service 397 WS_Opportunity_BS, Web service 397 WS_Service_Request_BS, Web service 397
T
TroubleTicket, Web service 392 application interface 393 example package, schema 394 operations 392
U
Ulnbox Contact Item, Web service 270 application interface 272 example package, schema 272 operations 270 parameters, specifying 271 Universal Inbox, Web service 273 application interface 274 example package, schema 274 operations 273
X
XML, XML Schema, about 13
408

CRMWeb

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

CRMWeb

Uploaded by

Copyright:

Available Formats

Siebel CRM Web Services Reference

Version 8.1 November 2008

Siebel CRM Web Services Reference 1

About Siebel Web Service Authentication and Performance

Chapter 3: Siebel 8.1 Primary Web Services

8.1 Product Configurator Web Service 62

Message Schema (WSDL) for Account

AssetManagementComplex CMU Account Query CMU Account Update Contact 77 73 75

Siebel CRM Web Services Reference Version 8.1

ESB_UnbilledUsageSiebelReqABCS_Service 103 105 107 110

LoyaltyAccrualService LoyaltyBatchEnrollment LoyaltyMemberService LoyaltyVoucherService

125 129 134 135 150 166 173 164

Siebel CRM Web Services Reference Version 8.1

RetrieveAttachmentService searchSolution 201 204 SelfServiceAccount

211 214 225 227

244 246 249

SWI Update Order Line Item Operations

Chapter 4: Web Services for Siebel CRM 8.0

Chapter 5: Primary Web Services for Siebel CRM 8.0

Siebel CRM Web Services Reference Version 8.1

CalculatePriceWS CatalogWebService CopyActivity EAILOVWS 321 322

304 307 316

EligibilityCompatibility EventManagement Event Registration ExternalAutoPolicy Forecast 332

326 332 332 332 332 340

QuoteWebService and OrderWebService

SetAllocatedExpenseItem SiebelUserProfileService SiebelWebRegistration

Siebel CRM Web Services Reference Version 8.1

TroubleTicket Warranty 396

392 394 396 397 397 397

VerifyEntitlement WC_Account_BS WC_Contacts_BS

WC_Opportunity_BS WebMarketing 397

Siebel CRM Web Services Reference Version 8.1

Siebel CRM Web Services Reference Version 8.1

Whats New in This Release

Whats New in Siebel CRM Web Services Reference, Version 8.1

Siebel CRM Web Services Reference Version 8.1

Whats New in This Release

This guide has been updated to reflect product name changes.

Siebel CRM Web Services Reference Version 8.1

Siebel CRM Web Services Overview

How Siebel Applications Are Web Service Deployed

About Web Services

Siebel CRM Web Services Reference Version 8.1

Web Service as a Server-Side Service

Interoperability Standards XML Coarse-grained exposure of functionality

Core Technologies for Web Services

About Web Services Description Language (WSDL)

Additionally, WSDL describes the following:

The operations provided by a Web service.

Siebel CRM Web Services Reference Version 8.1

Siebel CRM Web Services Overview Web Services Deployment Cycle

About XML and XML Schema

About Simple Object Access Protocol (SOAP)

Web Services Deployment Cycle

Siebel CRM Web Services Reference Version 8.1

Siebel CRM Web Services Overview Siebel Web Service Documentation

Siebel Web Service Documentation

Support for Siebel Web Services

Inbound and Outbound Web Services

Inbound and Outbound Web services

Siebel CRM Web Services Reference Version 8.1

Siebel CRM Web Services Reference Version 8.1

Siebel CRM Web Services Reference Version 8.1

Siebel CRM Web Services Overview Siebel Web Services Architecture