Siebel CRM Web Services Reference PDF

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
11
Core Technologies for Web Services

Web Services Deployment Cycle
13
Siebel Web Service Documentation

Support for Siebel Web Services
12
14
14
Siebel Web Services Architecture
17
Process of Exposing a Siebel Web Service

About Siebel Web Service Modeling
17
19
Using the Web Services Deployment Wizard
21
About Siebel Web Service Authentication and Performance
22
Chapter 3: Siebel 8.1 Primary Web Services

8.1 Primary Web Services
8.1 ABOWebService
25
29
8.1 CatalogWebService
37
8.1 Product Configurator Web Service

8.1 PromotionWebService
8.1 WebMarketing
Account
56
62
67
Message Schema (WSDL) for Account
AssetManagementComplex
CMU Account Query
CMU Account Update
Contact
41
69
69
73
75
77
Siebel CRM Web Services Reference Version 8.1
Contents
ESB_AccountBalanceSiebelReqABCS_Service
ESB_AdjustmentSiebelReqABCS_Service
ESB_InvoiceSiebelReqABCS_Service
ESB_PaymentSiebelReqABCS_Service
83
88
94
ESB_UnbilledUsageSiebelReqABCS_Service
FS Asset Warranty Service
GetMktgWebSurvey
103
107
LeadProcessingService
List
110
115
120
ListMgmtProspect
123
ListMgmtProspect Operations
LoyaltyAccrualService
123
125
LoyaltyBatchEnrollment
129
LoyaltyImportBusinessService
LoyaltyMemberService
LoyaltyVoucherService
150
164
MktgDeduplicationService
MktgImportService
PriceListsWS
166
171
OrderDetailWebService
PDSOrderHeader
134
135
LoyaltyRedemptionService
173
175
176
ProcessSalesOrderSiebelJMSProducer
Product Import
186
QuoteCheckOutWebService
QuoteDetailWebService
QuotingWebService
Response
178
180
ProductSearchService
98
105
ISS Price List Item WS

LeadService
80
189
191
194
196
Contents
RetrieveAttachmentService
searchSolution
199
201
SelfServiceAccount
204
SelfServiceAccountRootPath
SelfServiceAllAccountsList
SelfServiceContact
211
214
219
SelfServicePaymentHistory
225
SelfServicePostLoginProcess
SelfServiceRegistration
230
SelfServiceResponsibility
SelfServiceSmtpEmail
244
246
SelfServiceTemplateEmail
SelfServiceTimeZone
SelfServiceUser
249
252
254
SelfServiceWebSite
ServiceRequest
227
258
260
SessionAccessWS
266
SWI Update Order Line Item
267
SWI Update Order Line Item Operations
Ulnbox Contact Item

Universal Inbox
268
270
273
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
283
285
Chapter 5: Primary Web Services for Siebel CRM 8.0

ABOWebService
294
Asset Management
AssetWebService
301
304
Contents
CalculatePriceWS
304
CatalogWebService
307
ContextServiceWrapperService
CopyActivity
EAILOVWS
321
322
EligibilityCompatibility
EventManagement
322
326
Event Registration
332
ExternalAutoPolicy
332
ExternalPropertyPolicy
Forecast
316
332
332
GetHealthCareProfessionalProfileInformation
GetHeathCareProfessionalComplianceDetails
GetUnallocatedExpenseItem
INSClaims
340
347
350
IntegrationObjectInfo
354
NetworkOrderEntry
PartnerPrograms
356
358
PartnerRegistration
359
ProductConfigurator
359
ProductRecommendation
PromotionWebService
373
376
QuoteWebService and OrderWebService

QuoteAddItemsWS
383
SerializationService
385
ServiceRequest
SessionAccessWS
SFA_Activity_BS
379
385
387
SetAllocatedExpenseItem
387
390
SiebelUserProfileService
SiebelWebRegistration
332
392
392
Contents
TroubleTicket
392
VerifyEntitlement
Warranty
394
396
WC_Account_BS
396
WC_Contacts_BS
397
WC_Opportunity_BS
397
WC_Service_Request_BS
WebMarketing
397
397
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.
New Product Features in Siebel CRM Web Services Reference, Version 8.1
Topic
Description
Integration Objects on page 15
Added additional information on Internal Component field.
Determine Which Siebel Objects to

Expose on page 17
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.
Process of Exposing a Siebel Web

Service on page 17
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.
Assemble the Services on page 18
Enhanced topic. Clarified the task steps.
About Siebel Web Service

Modeling on page 19
New topic. Reorganized Web service modeling discussion.

Added a new discussion of classifying state requirements, and
registering public methods in Siebel Tools.
Using the Web Services

Deployment Wizard on page 21
New topic. Brief overview of Web services deployment wizards.
CMU Account Query on page 73
Added new Web service topic.
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.
New Product Features in Siebel CRM Web Services Reference, Version 8.1
Topic
Description
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:
12
The operations provided by a Web service.
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.
Integration Objects on page 15
Business Services on page 15

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.
14
Inbound and Outbound Web services
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.
16
Business Services
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
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.
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:
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.
Primary Web Services
Area
Web Service Name
Namespace
Type
Custom
UI
http://siebel.com/CustomUI
Inbound
Inbound
Search Solution
Inbound
MKTGDeduplicationService
Inbound
WC_Picklist_Payment_Profile_BS
Inbound
Universal Inbox
Inbound
SiebelWebPasswdMgmtService
Inbound
SiebelWebRegistrationService
Inbound
SiebelWebRespMgmt
Inbound
PDS Order Header
Inbound
Ulnbox Contact Item
Inbound
25
Table 2.
Area
Web Service Name
Namespace
Type
Self
Service
SelfServiceAccount
http://siebel.com/SelfService/
Common/Account
Inbound
Common/Account
Inbound
Common/Account
Inbound
SelfServiceContact
Common/Contact
Inbound
eCommerce/Payment
Inbound
SelfServicePostLogin
Common/Login
Inbound
Common/Registration
Inbound
Common/Utility
Inbound
SelfService User
Common/User
Inbound
Common/Utility
Inbound
SelfServiceTimeZone
Common/Utility
Inbound
SelfServiceWebSite
Common/Setup
Inbound
26
Table 2.
Area
Web Service Name
Namespace
Type
Mktg
Account
http://siebel.com/marketing/account
Inbound
Contact
http://siebel.com/marketing/contact
Inbound
Lead
http://siebel.com/marketing/leads
Inbound
LeadProcessing
http://siebel.com/marketing/leads
Inbound
List
http://siebel.com/marketing/list
Inbound
List Mgmt Prospect
http://siebel.com/marketing/prospect
Inbound
MKTGImportWebService
http://siebel.com/marketing/
webmarketing
Inbound
GetMKTGWebSurvey
webmarketing
Inbound
Response
http://siebel.com/marketing/response
Inbound
WebMarketing
webmarketing
Inbound
LoyaltyAccrual
http://siebel.com/loy
Inbound
http://siebel.com/Loyalty/
LoyaltyEnrolmentServices
Inbound
LoyaltyImportService
Inbound
LoyaltyMemberServices
LoyaltyMemberServices
Inbound
Inbound
Inbound
Service Request
http://siebel.com/Service/ServiceReqs
Inbound
Loyalty
Service
27
Table 2.
Area
Web Service Name
Namespace
Type
OM
http://siebel.com/OrderManagement/
Order/Details
Inbound
8.1 Catalog Web Service
Catalog
Inbound
CalculatePriceWS
Quote/PSP
Inbound
QuoteAddItems
Quote
Inbound
PriceListsWS
PriceLists
Inbound
Quote/Quoting
Inbound
Quote/Details
Inbound
QuotingWebService
Quote/Quoting
Inbound
8.1 ABO Web Service
ABO
Inbound
ProductConfigurator
Configurator
Inbound
8.1 Promotion Web Service
Promotion
Inbound
SessionAccessWS
http://www.siebel.com/xml/
SessionAccess
Inbound
http://www.siebel.com/Service/FS/
Assets
Inbound
FS Asset Warranty
http://siebel.com/Service/
AssetWarranty
Inbound
CMU Account Query
http:siebel.com/asi/
Inbound
FS
Comm
28
Siebel 8.1 Primary Web Services 8.1 ABOWebService
Table 2.
Area
Web Service Name
Namespace
Type
CMU Account Update
Inbound
Inbound
Product Import
ProductImport
Inbound
Inbound
ESB_AccountBalanceSiebelReqABC
S_Service
http://xmlns.oracle.com/ABCS/Siebel/
Industry/Telco/
AccountBalanceSiebelReqABCS/V1
Outboun
d
ESB_UnbilledUsageSiebelReqABCS
_Service
Industry/Telco/
UnbilledUsageSiebelReqABCS/V1
Outboun
d
ESB_InvoiceSiebelReqABCS_Servi
ce
Industry/Telco/
InvoiceSiebelReqABCS/V1
Outboun
d
ESB_PaymentSiebelReqABCS_Serv
ice
http://xmlns.oracle.com/ABCSImpl/
Siebel/Industry/Telco/
PaymentSiebelReqABCS/V1
Outboun
d
ESB_AdjustmentSiebelReqABCS_S
ervice
Industry/Telco/
AdjustmentSiebelReqABCS/V1
Outboun
d
ProcessSalesOrderSiebelJMSProdu
cer
http://xmlns.oracle.com/ABCS/
Industry/Telco/SalesOrder/
Outboun
d
UpdateCustomerSiebelJMSProduce
r
Industry/Telco/
UpdateCustomerSiebelJMSProducer/V1
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.
8.1 ABOWebService operations
Name
Description
AutoOrder
Converts a Quote to a Sales Order.
SubmitOrder
Submits an Order.
AutoAsset
Creates assets from the completed order line items

or updates a current asset.
ModifyAssetToQuote
Modifies an asset (Service Item), and generates a

quote item to update the selected asset.
ModifyAssetToOrder
Modifies an asset (Service Item), and generates an

order item to update the selected asset.
DisconnectAssetToQuote
Disconnects an asset (Service Item) to generate a

quote item to deactivate the selected asset.
DisconnectAssetToOrder
Disconnects an asset (Service Item), and generates

an order item to deactivate the selected asset.
SuspendAssetToQuote
Suspends an active asset (Service Item) to generate

a quote item to suspend the selected asset.
SuspendAssetToOrder
Suspends an asset (Service Item) and generates an

order item to suspend the selected asset.
ResumeAssetToQuote
Resumes a suspended asset (Service Item) to

generate a quote item to resume the selected asset.
ResumeAssetToOrder
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.
Request Message: AutoOrder
Node
Description
Object Id
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.
Response Message: AutoOrder
Node
Description
PDS Order
Instance of Integration object PDS Order.
Header
Order Header.
Line Item
Order Line Items.
XA
Order Line Item attributes.
Request Message Description: SubmitOrder

Table 6.
Request Message: SubmitOrder
Node
Description
OrderId
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

Table 7.
Request Message; AutoAsset
Node
Description
Object Id
Required. RowId of the corresponding Order that contains the

Order Line Item to be converted or applied to an asset.
LineItemId
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.
Response Message: AutoAsset
Node
Description
PDS Asset
Required. Integration Object.
Header
Asset Header.
Line Item
Asset
XA
Asset attributes
Request Message Description: ModifyAssetToQuote

For a description of this request message, see Table 9
Table 9.
Request Message: ModifyAssetToQuote
Node
Description
AssetIntegrationId
Asset Integration Id of the selected asset. Provide either

AssetIntegrationId or AssetNumber .
AssetNumber

AssetIntegrationId or AssetNumber .
ActiveDocumentId
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.
AccountId
Account Id of the account that owns the selected asset (Service

Item).
ContactId
Contact Id of the contact who owns the selected asset (Service

Item) to be modified.
32
Table 9.
Request Message: ModifyAssetToQuote
Node
Description
DueDate
The due date of the generated line item.
PriceListId
Specifies a Price List Id that is associated with the quote if a new

quote is requested to generate.
CompoundProductNumber
Compound Product Number for the Asset Based Ordering (ABO)

network ordering. It is not required if network ordering is not used.
Response Message Description: ModifyAssetToQuote

The Integration Object Message Format is PDS Quote. For a description of this response message,
see Table 10.
Table 10.
Response Message; ModifyAssetToQuote
Node
Description
PDS Quote
Header
Quote Header.
Line Item
Quote Line Item.
XA
Quote Line Item attributes.
Request Message Description: ModifyAssetToOrder

Table 11.
Request Message: ModifyAssetToOrder
Node
Description
AssetIntegrationId
Asset Integration Id of the selected asset. Provide either AssetIntegrationId

or AssetNumber.
AssetNumber
Asset Integration Id of the selected asset. Provide either AssetIntegrationId

or AssetNumber.
ActiveDocumentId
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.
AccountId
Account Id of the account that owns the selected asset (Service Item).
ContactId
Contact Id of the contact who owns the selected asset (Service Item) to be
modified.
DueDate
33
Table 11.
Request Message: ModifyAssetToOrder
Node
Description
PriceListId
Specifies a Price List Id associated with the quote if a new quote is requested.
CompoundProduct
Number
Compound Product Number for ABO network ordering. It is required only if

network ordering is used.
Response Message Description: ModifyAssetToOrder

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

Response Message Description: ResumeAssetToQuote

Request Message Description: ResumeAssetToOrder

Response Message Description: ResumeAssetToOrder

Request Message Description: DisconnectAssetToQuote

34
Response Message Description: DisconnectAssetToQuote

Request Message Description: DisconnectAssetToOrder

Response Message Description: DisconnectAssetToOrder

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.
8.1 ABOWebService Application Interface
Name
Boundary Object Type
Class (if Business Service)
SISOMAutoOrderWebService
Workflow
Not applicable
SISOMSubmitWebService
Workflow
Not applicable
SISOMAutoAssetWebService
Workflow
Not applicable
SISOMModifyWebService-Quote
Workflow
Not applicable
SISOMModifyWebService-Order
Workflow
Not applicable
SISOMSuspendWebService-Quote
Workflow
Not applicable
SISOMSuspendWebService-Order
Workflow
Not applicable
SISOMResumeWebService-Quote
Workflow
Not applicable
SISOMResumeWebService-Order
Workflow
Not applicable
SISOMDisconnectWebService-Quote
Workflow
Not applicable
SISOMDisconnectWebService-Order
Workflow
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
Siebel Repository Name
External Name
PDS Quote
PDS Quote
PDS Order
PDS Order
PDS Asset
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)
...\81_ABOWebService\ModifyAssetToQuote_request.xml
Response (ModifyAssetToQuote)
...\81_ABOWebService\ModifyAssetToQuote_response.xml
Request (AutoAsset)
...\81_ABOWebService\AutoAsset_request.xml
Response (AutoAsset)
...\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
Applications.
Use this Web service to expose promotional offerings related to products, as well as related products
and categories.
8.1 CatalogWebService Operations

Table 14.
8.1 CatalogWebService operations
Name
Description
GetRelatedPromotions
Retrieve a list of related promotion.
GetRelatedProducts
Retrieve a list of related products.
GetCategory
Retrieve a flat, non-hierarchical list of categories.
UDSPublishCatalog
Publish a given catalog with category and products

with support of pagination and visibility.
Request Message Description: GetRelatedPromotions

Table 15.
Request Message: GetRelatedPromotions
Name
Description
Type
PDS Related
Promotions Interface
An instance of Integration Object PDS Related

Promotions Interface.
Integration Object
PricingMode
Y or N (calculates price or not). Optional. The default

value is Y.
String
EligibilityMode
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.
String
37
Table 15.
Request Message: GetRelatedPromotions
Name
Description
Type
ContextMode
SiebelContext or ExternalConext. Optional. However,

you must provide ContextMode to run pricing and
eligibility.
String
Context
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.
Integration Object
Response Message Description: GetRelatedPromotions

For a description of this response message, seeTable 16.
Table 16.
Response Message: GetRelatedPromotions
Name
Description
Type
PDS Related
Promotions Interface
PDS Related Promotions Interface. After running

Eligibility and Pricing, the List Price, Net Price,
Eligibility status and Eligibility Reason fields will
be updated.
Integration Object
Request Message Description: GetRelatedProducts

Table 17.
Request Message: GetRelatedProducts
Name
Description
Type
PDS Related
Products Interface

Products Interface.
Integration Object
PricingMode

value is Y.
String
EligibilityMode

String
ContextMode
SiebelContext or ExternalContext. Optional.

However, provide ContextMode to run pricing and
eligibility.
String
Context

Integration Object
38
Response Message Description: GetRelatedProducts

Table 18.
Response Message: GetRelatedProducts
Name
Description
Type
PDS Related
Products Interface

Products Interface. After running Eligibility and
Pricing, the List Price, Net Price, Eligibility status and
Eligibility Reason fields will be updated.
Integration Object
Request Message Description: GetCategory

Table 19.
Request Message: GetCategory
Name
Description
Type
PDS Category Interface

Integration Object
An instance of Integration Object

PDS Category Interface.
Integration Object
Response Message Description: GetCategory

Table 20.
Response Message: GetCategory
Name
Description
Type

Integration Object

PDS Category Interface.
Integration Object
Request Message Description: UDSPublishCatalog

Table 21.
Request Message: UDSPublishCatalog
Name
Description
Type
SiebelMessageIn
An instance of Integration Object PDS UDS Publish

Catalog Interface. This is a required input.
Integration Object
PricingMode

value is Y.
String
EligibilityMode

String
ContextMode
SiebelContext or ExternalConext. Optional.

However, provide ContextMode to run pricing and
eligibility.
String
39
Table 21.
Request Message: UDSPublishCatalog
Name
Description
Type
Context

Integration Object
LOVLanguageMode
LIC or LDC.
String
ViewMode
Visibility algorithm used in addition to a search

specification to determine which records will be
retrieved. Catalog or Organization.
String
NamedSearchSpec
Name of a predefined query.
String
Response Message Description: UDSPublishCatalog

Table 22.
Response Message: UDSPublishCatalog
Name
Description
Type
SiebelMessageOut
An instance of Integration Object PDS

UDS Publish Catalog Interface.
Integration Object
8.1 CatalogWebService Application Interface

Technology Network.

Table 23.
CatalogWebService Application Interface
Name
Class
PDS Product Data Service
BusService
CSSProdDataSvc

Table 24.
CatalogWebService Data Objects
External Name
PDS Related Promotions Interface
PDS Related Promotions Interface
PDS Related Products 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 UDS Publish Catalog Interface
PDS UDS Publish Catalog Interface
Example Package for Siebel 8.1 CatalogWebService

Request
...\81_CatalogWebService\81_CatalogWebService_request.xml
Response
...\81_CatalogWebService\81_CatalogWebService_response.xml
Message Schema (WSDL) for Siebel 8.1 CatalogWebService

...\81_CatalogWebService\81_CatalogWebService.wsdl
8.1 Product Configurator Web Service

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

Table 25.
8.1 Product Configurator Web service operations
Name
Description
GetCfgObjectStructure
Get Product Relationships, Attributes, Linked Items and Resources.
GetCfgObjectGroupItems
Get Product UI Definition, UI Group and Group Items.
GetCfgObjectDefaultGroup
Items
Get Default Product Group Items (group items will be based off all
relationships, attributes, linked items and resources).
BeginConfiguration
Enables Customization of products stored in Siebel DB. Initializes the

configurator session with a Quote Instance and product model.
UpdateConfiguration
Executes operations on the Quote instance initialized in

BeginConfiguration.
EndConfiguration
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.
Table 26.
Request Message: GetCfgObjectStructure
Node
Description
WebChannelObjStructure
Required. This structure identified the objects that will be

queries as well the data that will be returned about the objects.
Object
Required. One or more must be specified.
Name
Required. Name of Object (product or class). Either Name or Id

is required.
Id
Required. Id of Object (product or class). Either Name or Id is

required.
ObjectType
Required. Product or Class.
ParentClassId
Class Id of the parent.
DisplayName
Display Name.
Description
Description.
42
Table 26.
Node
Description
Attribute
Zero or more (only those child objects that are specified will be
queried for).
Name
Name of Attribute. If empty, all attributes are returned.
LocalType
Local type.
InternalType
Internal type.
OrigId
Internal Id.
DisplayName
Display name.
Hidden
Hidden flag.
Required
Required flag.
ReadOnly
Read Only flag.
ValidationSpec
Validation Specification.
UnitOfMeasure
Unit of Measure.
Description
Description.
AttributeDomain
Zero or more.
LocalValue
Local value.
InternalValue
Internal value.
AttributeDomainDecoration
Zero or more. Attribute Domain specific properties name value

pairs.
Name
Name of Attribute.
Value
Value of attribute.
AttributeDefaultValue
Default value of the attribute. Only one of the value types will
be populated depending on the type of the value.
DisplayValue
Display value.
String
String value.
Number
Number value.
Integer
Integer value.
Date
Date value.
Boolean
Boolean value.
AttributeRejectedValue
Rejected value of the attribute. Only one of the value types will
DisplayValue
Display value.
String
String value.
43
Table 26.
Node
Description
Number
Number value.
Integer
Integer value.
Date
Date value.
Boolean
Boolean value.
AttributeDecoration
Zero or more.
Name
Attribute properties name.
Value
Value pairs.
Relationship
queried for).
Name
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
Id of relationship. If Name and, or Id is specified, only that

DisplayName
Display name.
ClassName
Class name.
ClassId
Class Id.
DefaultProductId
Default product Id.
DefaultCardinality
Default Cardinality.
MinimumCardinality
Minimum Cardinality.
MaximumCardinality
Maximum Cardinality.
RelationshipDomain
Zero or more.
Name
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
Id of product. If Name and, or Id is specified, only that

DisplayName
Display Name.
OrigId
Orig Id.
Description
Description.
RelationshipDomainDecoration
Zero or more.
Name
Relationship domain specific properties name.
44
Table 26.
Node
Description
Value
Value pairs.
RelationshipDecoration
Zero or more.
Name
Relationship properties name
Value
Value pairs.
LinkedItem
queried for).
Name
Name of Linked item.
Id
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.
DisplayName
Display name.
VariableName
Variable Name.
SortSpec
Sort specification.
SearchSpec
Search specification.
NeedsExecution
Needs execution flag for Business Component based query.
Expression
Expression.
DefaultValue
Default Value.
BusinessObject
Business Object for Business Component based query.
BusinessComponent
Business Component for Business Component based query.
FieldName
Field name in BC.
Active
Active flag.
LinkedItemDecoration
Linked Item properties.
Name
Name value.
Value
Pairs.
Resource
queried for).
Name
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
Id of resource. If Name and/or Id is specified, only that

DisplayName
Display name.
45
Table 26.
Node
Description
ResourceDecoration
Resource properties.
Name
Name value.
Value
Pairs.
ObjectDecoration
Object properties.
Name
Name value.
Value
Pairs.
Request Message Description: GetCfgObjectGroupItems/ GetCfgObjectDefaultGroupItems

Table 27.
Request Message: GetCfgObjectGroupItems/GetCfgObjectDefaultGroupItems
Node
Description
WebChannelObjGroupItems
Required. This structure identified the objects that will be queries as

well the data that will be returned about the objects.
Object
Name
Required. Name of Object (product or class). Either Name or Id is

required.
Id
Required. Id of Object (product or class). Either Name or Id is

required.
ObjectType
Required. Product oR Class.
ParentClassId
Class Id of the parent.
DisplayName
Display Name.
Description
Description.
UIOption
Zero or more.
Name
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
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
Type.
DisplayName
Display Name.
Sequence
Sequence.
BaseTheme
Base Theme.
46
Table 27.
Node
Description
ProductTheme
Product theme.
Responsibility
Zero or more.
Name
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
Id of responsibility. If Name and, or Id is specified, only that

Group
Zero or more.
Name
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
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.
DisplayName
Display Name.
Sequence
Sequence.
GroupTheme
Group Theme.
Description
Description.
GroupItem
Zero or more.
Id
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
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
Sequence.
GroupItemTheme
Group Item Theme.
Attribute
Refer to Attribute child object of GetCfgObjectStructure Request

Message.
Relationship
Refer to Relationship child object of GetCfgObjectStructure Request

Message.
LinkedItem
Refer to LinkedItem child object of GetCfgObjectStructure Request

Message.
Resource
Refer to Resource child object of GetCfgObjectStructure Request

Message.
GroupDecoration
Group properties.
47
Table 27.
Node
Description
Name
Name value.
Value
Pairs.
Object Decoration
Object properties name value pairs.
Request Message Description: BeginConfiguration

Table 28.
Request Message: BeginConfiguration
Node
Description
BeginConfiguration_Input
Required.
InitInstanceOperation
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
Required for InitInstanceOperation of LOAD / DEFAULT. Row Id of the

Header.
RootId
Required for InitInstanceOperation of LOAD / SET. Row Id for the root

line item.
ProductId
Required for InitInstanceOperation of DEFAULT / ADD. Product Id for

the root line item.
ListOfQuote
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.
ListOfData
List of products, attributes, or relationships on which user requires

domain information (with exclusions) in CfgInteractData integration
object format.
ProductData
48
Table 28.
Node
Description
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.
ProductId
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
Name of the product.
Quantity
Quantity
RelationshipName
Relationship Name. For sub line items, RelationshipName can be

specified to limit the search to a particular Relationship.
RootIntegrationId
Integration Id of the Root line item.
PortId
Relationship Id
ParentProductId
Parent Product Id
ParentIntegrationId
Parent Integration Id
CanDrilldown
Can Drilldown Flag. Used to indicate whether the line item is a

Customizable product.
ListPrice
List Price
NRCCxTotal
Non-recurring Total Price - only set on the root line item
MRCCxTotal
Recurring Total Price - only set on the root line item
CurrentPrice
Current Price of the Item after all the discounts have been factored in
ExchangeDate
Exchange Date of the pricing field values
CurrencyCode
Currency Code of the pricing field values
HasGenericsFlag
Has Generics Flag. Used to indicate whether the line item is

incomplete
EligibilityStatus
Eligibility Status
EligibilityReason
Eligibility Reason
Explanation
Explanation, if required.
ExplanationText
Text of explanation.
Relationship
Zero or more. List of Relationships on which information is required.
49
Table 28.
Node
Description
Name
Name of relationship to query for. If empty, all relationships are

returned.
Id
Id. Always returned whether specified in Request or not.
HasGenericsFlag
Has Generics Flag. Used to indicate whether the relationship is

incomplete.
Request Type
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.
DomainItem
Zero or more. Domain items of the relationship. Always returned

whether specified in Request or not.
Name
Name of domain item
Id
Id of domain item
ListPrice
List Price
ExchangeDate
Exchange Date of the pricing field values
CurrencyCode
Currency Code of the pricing field values
PriceType
Indicated the type of List Price: One-time or Recurring
CanDrilldown
Can Drilldown flag. Used to indicate whether the line item is a

customizable product.
Excluded
Excluded flag indicates the whether this domain item is excluded by

a Constraint, Eligibility & Compatibility rule, or Promotion.
Attribute
Zero or more. List of attributes on which information is required.
Name
Name of attribute to query for. If empty, all attributes are returned.
ValueType
Type of attribute. Always returned whether specified in Request or

not.
AttributeValue
Zero or more. List of Attribute values. Always returned whether

specified in Request or not.
DisplayValue
Display value.
StringValue
Value displayed in a string.
IntegerValue
Value displayed as integer.
50
Table 28.
Node
Description
NumberValue
Value displayed as number.
BooleanValue
Value displayed in Boolean format.
DateTimeValue
Date and time value.
Selected
Selected flag indicates whether this value is selected.
Excluded
Excluded flag indicates whether this value is excluded by a

Constraint, Eligibility & Compatibility rule or Promotion.
Item
Zero or more. Same recursive structure as that defined above.
ListOfLinkedItems
Linked Items.
LinkedItems
Linked Items.
LinkedItemValue
One or more.
Name
Name of linked item.
ValueType
Type of value.
StatusText
Details on the error if any
ConflictResolution
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).
Messages
Zero or one. List of messages.
MessageType
Zero or more.
MessageSource
Source of the messages (Eligibility, Promotion, Cardinality, Proceed

Actions and so on).
Message
Message text.
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
Description
BeginConfiguration_Output
Required.
Error_spcCode
Error Code if error occurred.
Error_spcMessage
Error Message if error occurred.
51
Table 29.
Node
Description
RootId
New item root Id.
RootIntegrationId
New item root Integration Id.
ListOfQuote
Quote instance if ReturnFullInstance input parameter was set to Y.

See BeginConfiguration Request Message for details.
ListOfData
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.
ListOfStatus
This indicates whether the request was successful or not and

contains messages to be displayed.
Status
Required
StatusCode
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.
Request Message Description: UpdateConfiguration

Table 30.
Node
Description
UpdateConfiguration_Input
Required.
ConflictAutoResolve
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.
FinishInstanceInFlag
If set Y, FinishIt is called.
SaveInstanceInFlag
If set Y, Instance is saved to db.
RepriceInstanceInFlag
If set Y, reprice is called.
VerifyInstanceInFlag
If set Y, verify instance is called.
ListOfData
Same as ListOfData in BeginConfiguration Request Message.
ListOfRequest
List of Requests that will be executed on the product instance.
Requests
Request
Zero or more.
Type
Type of request (AddItem, RemoveItem, SetItemQuantitty,

SetAttribute, ReplaceItem).
52
Table 30.
Node
Description
Item
Zero or more requests.
AddProductId
Add product Id for AddItem, ReplaceItem.
Quantity
Quantity.
RelationshipId
Relationship Id which contains the new product for AddItem,

ReplaceItem.
IntegrationId
Integration Id on which the operation will be performed.
Attribute
Zero or more SetAttribute request details.
Name
Name or attribute.
ValueType
AttributeValue
Zero or more.
DisplayValue
New display value of attribute
String
Number
Integer
Date
Date.
Boolean
Response Message Description: UpdateConfiguration

Table 31.
Node
Description
UpdateConfiguration_Output
Required.
Error_spcCode
Error_spcMessage
FinishConfigurationOutFlag
Y or N. Indicates whether Finish Configuration was performed. It

might not be performed if there were some errors.
RepriceOutFlag
Y or N. Indicates whether Reprice was done. It might not be

performed if there were some errors.
SaveInstanceOutFlag
Y or N. Indicates whether Save Instance was done. It might not be

performed if there were some conflicts.
VerifyOutFlag
Y or N. Indicates whether Verify was done. It might not be

53
Table 31.
Node
Description
ListOfData
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.
ListOfStatus

contains messages to be displayed. For more information, see
Table 29 on page 51.
Request Message Description: EndConfiguration

Table 32.
Node
Description
EndConfiguration_Input
Required
SaveInstanceFlag
Save instance flag
Response Message Description: EndConfiguration

Table 33.
Node
Description
EndConfiguration_Output
Required.
Error_spcCode
Error_spcMessage
ListOfQuote
Quote instance. For more information, see

Table 28 on page 48.
8.1 Product Configurator Web Service Application Interface

Technology Network.
54

Table 34.
8.1 Product Configurator Service Objects
Name
Class (if BusService)
Cfg Object Broker
Business Service
CSSCfgObjBrokerService
ConfiguratorWebChannelBeginConfig
Workflow
Not applicable
ConfiguratorWebChannelUpdateConfig
Workflow
Not applicable
ConfiguratorWebChannelEndConfig
Workflow
Not applicable

Table 35.
8.1 Product Configurator Data Objects
External Name
CfgInteractData
ListOfData
CfgInteractRequest
ListOfRequest
CfgInteractStatus
ListOfStatus
CfgLinkedItems
ListOfLinkedItems
PDS Quote
ListOfQuote
Methods
For a description of the methods for this Web service, see Table 36.
Table 36.
8.1 Product Configurator Methods
Operation
Method
GetObjStructure
GetObjGroupItems
GetCfgObjectDefaultGroupItems
GetObjDefaultGroupItems
Example Package for ProductConfigurator

Request (GetObjDefaultGroupItems)
55
Siebel 8.1 Primary Web Services 8.1 PromotionWebService
...\81_ProductConfigurator\GetObjDefaultGroupItems_request.xml
Response (GetObjDefaultGroupItems)
...\81_ProductConfigurator\GetObjDefaultGroupItems_response.xml
Request (GetObjGroupItems)
...\81_ProductConfigurator\GetObjGroupItems_request.xml
Response (GetObjGroupItems)
...\81_ProductConfigurator\GetObjGroupItems_response.xml
Request (GetObjStructure)
...\81_ProductConfigurator\GetObjStructure_request.xml
Response (GetObjStructure)
...\81_ProductConfigurator\GetObjStructure_response.xml
Message Schema (WSDL) for ProductConfigurator

...\81_ProductConfigurator\81_ProductConfigurator.wsdl
8.1 PromotionWebService
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

Table 37.
8.1 PromotionWebService Operations
Name
Description
getProductPromotionDefinition
Returns promotion detail information.
ApplyProductPromotion
Add a promotion and all default components to a quote or order.
getPromotionCommitments
Get promotion commitment information for a given promotion

asset.
UpgradePromotionToQuote
Upgrade or migrate a promotion instance to another promotion

and generate a quote with the updated assets information.
UpgradePromotionToOrder
Upgrade or migrate a promotion instance to another promotion

and generate an order with the updated assets information.
Request Message Description: GetProductPromotionDefinition

Table 38.
Name
Description
Type
EligibilityMode
Optional, default value as 2. Could be 0, 1, 2.
Not applicable
PricingMode
Optional, default value as Y. Y or N.
Not applicable
LoadAllDomainFlag
Required value of Y or N.
Not applicable
LoadDefaultDomainFlag
Not applicable
LoadPromDefFlag
Not applicable
ContextMode
Required, Siebel Context or External Context.
Not applicable
Context
Required, in SiebelMessage format of IO 'PDS

Catalog Context.
Not applicable
ProdPromRuleType
Optional, Product or Pricing.
Not applicable
57
Response Message Description: GetProductPromotionDefinition

Table 39.
Name
Description
Type
ProdPromDefinition
In SiebelMessage format of Integration Object ISS

Promotion Definition for WS.
Not applicable
PromDomainProduct
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.
Not applicable
Err_spcCode
Not applicable
Err_spcMessage
Not applicable
Request Message Description: ApplyProductPromotion

Table 40.
Name
Description
Type
EligibilityMode
Optional, default value as '2'. Could be 0, 1, 2.
Not applicable
PricingMode
Optional, default value as Y. Y or N.
Not applicable
ProdPromId
Required.
Not applicable
Optional, depending on usage scenarios.
Not applicable
Not applicable
Optional. Default value is 1.
Not applicable
Required, in SiebelMessage format of Integration

Object PDS Quote.
Not applicable
ProdPromInstanceId
LineItemId
Quantity
SiebelMessage
Response Message Description: ApplyProductPromotion

Table 41.
Name
Description
Type
SiebelMessage
Required. In SiebelMessage format of the Integration Object

PDS Quote.
Not applicable
Err_spcCode
Not applicable
Err_spcMessage
Not applicable
58
Request Message Description: getPromotionCommitments

Table 42.
Request Message Description: getPromotionCommitments
Name
Description
Type
Asset Integration Id
Required. Asset Integration Id of the

Promotion Instance Asset.
String
Response Message Description: getPromotionCommitments

Table 43.
Response Message Description: getPromotionCommitments
Name
Description
Type
PromotionCommitments
An instance of the
Integration Object ISS
Promotion Commitments.
Integration Object
Request Message Description: UpgradePromotionToQuote

Table 44.
Request Message Description: UpgradePromotionToQuote
Name
Description
Type
NewPromotionId
Required. RowId of new promotion.
String
AssetNumber
Asset Number of the selected promotion asset. Provide

either AssetNumber or AssetIntegrationId.
String
AssetIntegrationId
Asset Integration Id of the selected promotion asset. Provide

String
ActiveDocumentId
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.
String
AccountId
Account Id of the account that owns the selected promotion

asset being upgraded.
String
OverridePenaltyAmount
Penalty Amount for upgrading the promotion, if any.
String
OverrideProratePlanId
If there is a penalty for upgrading the promotion, also pass

in the prorate plan used to prorate this penalty, if any.
String
59
Response Message Description: UpgradePromotionToQuote

Table 45.
Response Message Description: UpgradePromotionToQuote
Name
Description
Type
QuoteIO
An instance of the integration object PDS Quote.
Integration Object
Request Message Description: UpgradePromotionToOrder

Table 46.
Request Message Description: UpgradePromotionToOrder
Name
Description
Type
NewPromotionId
Required. RowId of new promotion.
String
AssetNumber
Asset Number of the selected promotion asset. Provide

String
AssetIntegrationId
Asset Integration Id of the selected promotion asset.

Provide either AssetNumber or AssetIntegrationId.
String
ActiveDocumentId
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.
String
AccountId
Account Id of the account that owns the selected promotion

asset being upgraded.
String
OverridePenaltyAmount
Penalty amount for upgrading the promotion, if any.
String
OverrideProratePlanId
If there is a penalty for upgrading the promotion, also pass

in the prorate plan used to prorate this penalty, if any.
String
Response Message Description: UpgradePromotionToOrder

Table 47.
Response Message Description: UpgradePromotionToOrder
Name
Description
Type
OrderIO
An instance of the integration object PDS Order.
Integration Object
60
8.1 PromotionWebService Application Interface

Technology Network.

Table 48.
8.1 PromotionWebService Service Objects
Name
ISS Promotion WS - GetPromotionCommitments
Workflow
ISS Promotion WS-Upgrade Promotion-Quote
Workflow
ISS Promotion WS-Upgrade Promotion-Order
Workflow

Table 49.
8.1 PromotionWebService Data Objects
External Name
ISS Promotion Commitments
ISS Promotion Commitments
PDS Quote
PDS Quote
PDS Order
PDS Order
Example Package for 8.1 PromotionWebService

Request
...\81PromotionWebService\81PromotionWebService_request.xml
Response
...\81PromotionWebService\81PromotionWebService_response.xml
61
Siebel 8.1 Primary Web Services 8.1 WebMarketing
Message Schema (WSDL) for 8.1 PromotionWebService

...\81_PromotionWebService\81_PromotionWebService.wsdl
8.1 WebMarketing
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

Table 50.
8.1 WebMarketing Operations
Name
Description
EmailMarketingForwardToFriend
To forward campaign details to a list of forwardees.
EmailMarketingUpdateJobStatus
Use to update the job status of the task submitted for sending
email.
UpdateCampaignRecipient
Updates the info of a campaign recipient.
CheckModuleLicense
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
Description
Type
Account Id
Account Id of the forwarder of the email.
String
Campaign Id
The campaign Id of the campaign for which the

info is being forwarded.
String
Forwardee Collection
List of forwardees.
Integration Object
Forwarder Camp Con Id
Campaign contact Id of the forwarder.
String
Forwarder Contact Id
Contact Id of the forwarder.
String
62
Table 51.
Node
Description
Type
Forwarder Message
Message that the forwarder sends across along

with the mails.
String
Forwarder Prospect Id
The prospect Id of the forwarder.
String
Offer Id
Id of the offer for which the email is being sent.
String
Response Type
The type of response.
String
Response Message Description: EmailMarketingForwardToFriend

Table 52.
Response Message Description: EmailMarketingForwardToFriend
Node
Description
Type
Dummy
Error code for the process (OK or NOTOK).
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.
Request Message Description: EmailMarketingUpdateJobStatus
Node
Description
Type
BatchNumber
Batch number of the job.
String
ErrorCode
Error code (if any) that needs to be passed for the job.
String
OfferId
The current offer.
String
OfferName
The name of the offer.
String
TaskId
Task Id.
String
WaveId
The campaign wave Id.
String
Response Message Description: EmailMarketingUpdateJobStatus

Table 54.
Response Message Description: EmailMarketingUpdateJobStatus
Node
Description
Type
Dummy
Error code for the process (OK or NOTOK).
String
63
Request Message Description: UpdateCampaignRecipient

Calls EAI Siebel Adapter service to update campaign recipients. For a description of this request
Table 55.
Request Message Description: UpdateCampaignRecipient
Node
Description
Type
CampaignRecipientMsgIn
The campaign recipient info that

needs to be updated.
Integration Object
LOVLanguageMode
The language mode.
String
Response Message Description: UpdateCampaignRecipient

Table 56.
Response Message Description: UpdateCampaignRecipient
Node
Description
Type
CampaignRecipientMsgOut
The updated campaign recipient info.
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.
Request Message Description: CheckModuleLicense
Node
Description
Type
ModuleName
The module name which needs to be checked.
String
Response Message Description: CheckModuleLicense

Table 58.
Response Message Description: CheckModuleLicense
Node
Description
Type
IsModuleLicensed
Y or N according as the module is licensed or

not respectively.
String
8.1 WebMarketing Application Interface

Technology Network.
64

Table 59.
8.1 WebMarketing Service Objects
Name
Class
Email Marketing - Forward to Friend
Workflow
Not applicable.
Email Marketing - Update Status
Workflow
Not applicable.
Mktg System Task Service
Business Service
CSSSystemTaskService
Server Requests
Business Service
CSSSrmService
EAI Siebel Adapter
Business Service
CSSEAISiebelAdapterService
Mktg List Export Service
Business Service
CSSListExportService

Table 60.
8.1 WebMarketing Data Objects
External Name
Marketing Email Forwardee
Forwardee Collection
Marketing Campaign Recipient
CampaignRecipientMsgIn
Marketing Campaign Recipient
CampaignRecipientMsgOut
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)
...\81_WebMarketing\EmailMktgFwdToFriend_response.xml
65
Request (EmailMarketingUpdateJobStatus)
...\81_WebMarketing\EmailMarketingUpdateJobStatus_request.xml
Response (EmailMarketingUpdateJobStatus)
...\81_WebMarketing\EmailMarketingUpdateJobStatus_request.xml
Request (UpdateCampaignRecipient)
...\81_WebMarketing\UpdateCampaignRecipient_request.xml
Response (UpdateCampaignRecipient)
...\81_WebMarketing\UpdateCampaignRecipient_response.xml
Request (CheckModuleLicense)
\81_WebMarketing\CheckModuleLicense_request.xml
Response (CheckModuleLicense)
\81_WebMarketing\CheckModuleLicense_response.xml
Message Schema (WSDL) for 8.1 WebMarketing

\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.
Account Operations
Name
Description
AccountCreateAccount
Creates an account.
AccountUpdateAccount
Updates an existing account.
Request Message Description: AccountCreateAccount

Table 62.
Request Message Description: AccountCreateAccount
Node
Description
Type
Account IO
Required. An instance of the integration object

Account Integration Object. Account is the Parent
header and Account_BusinessAddress is the child.
Integration Object
Response Message Description: AccountCreateAccount

Table 63.
Response Message Description: AccountCreateAccount
Node
Description
Type
Account Id
The new Account Id generated as a result of the new

account creation.
String
Error Message
Error message if any.
String
Success Flag
Flag to indicate success or failure of the operation.
String
67
Siebel 8.1 Primary Web Services Account
Request Message Description: AccountUpdateAccount

Table 64.
Request Message Description: AccountUpdateAccount
Node
Description
Type
Account IO

Account Integration Object. Account is the Parent
header and Account_BusinessAddress is the child.
Integration Object
Response Message Description: AccountUpdateAccount

Table 65.
Response Message Description: AccountUpdateAccount
Node
Description
Type
Error Message
String
Success Flag
String
Account Application Interface

Technology Network.

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

Request (AccountCreate)
\Account\AccountCreate_request.xml
68
Siebel 8.1 Primary Web Services AssetManagementComplex
Response (AccountCreate)
\Account\AccountCreate_response.xml
Request (AccountUpdate)
\Account\AccountUpdate_request.xml
Response (AccountUpdate)
\Account\AccountUpdate_response.xml
Message Schema (WSDL) for Account

\Account\Account.wsdl
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.
Table 67.
AssetManagementComplex Operations
Name
Description
AssetManagementComplexQueryPageQuoteAddItems
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

Table 68.
Node
Description
Type
AssetManagementComplex IO
Required
Integration Object
AssetDescription
List Price
String
AssetNumber
Adjusted Value
String
BillingAccount
Billing Account
String
BillingAccountId
Billing Account ID
String
InstallDate
Install Date
String
IntegrationId
Integration ID
String
OwnerContactId
Owner Contact ID
String
ProductDescription
Product Description
String
ProductId
Product ID
String
ProductName
Product Name
String
ProductPartNumber
Product Number
String
SerialNumber
Serial Number
String
ServiceAccount
Service Account
String
ServiceAccountId
Service Account ID
String
Status
Status
String
NRCCxTotal
String
MRCCxTotal
String
Id
ID
String
AdjustedListPrice
Adjusted List Price
String
AssetCurrencyCode
Asset Currency Code
String
AssetDescription
Asset Description
String
AssetId
Asset ID
String
AssetNumber
Asset Number
String
Comments
Comments
String
InstallDate
Install Date
String
IntegrationId
Integration ID
String
Name
Asset Name
String
ParentAssetId
Parent Asset ID
String
PriceType
Price Type
String
70
Table 68.
Node
Description
Type
ProdPromId
Product Prom ID
String
ProductDefTypeCode
Product Def Type Code
String
ProductId
Product ID
String
ProductName
Product Name
String
ProductPartNumber
Product Part Number
String
ProductType
Product Type
String
Quantity2
Quantity
String
RootAssetId
Root Asset ID
String
UnitofMeasure
Unit of Measure
String
DataType
Asset Data Type
String
Description
Asset Description
String
DisplayName
Asset Display Name
String
Value
Asset Value
String
Response Message Description: AssetManagementComplexQueryPage

Table 69.
Node
Description
Type
AssetDescription
Asset Description
String
AssetNumber
Asset Number
String
BillingAccount
Billing Account
String
BillingAccountId
Billing Account ID
String
InstallDate
Install Date
String
IntegrationId
Integration ID
String
OwnerContactId
Owner contact ID
String
ProductDescription
Product Description
String
ProdPromId
Product Prom ID
String
ProductDefTypeCode
Product Code
String
ProductId
Product ID
String
ProductName
Product Name
String
ProductPartNumber
Product Part Number
String
71
Table 69.
Node
Description
Type
ProductType
Product Number
String
PriceType
Price Type
String
SerialNumber
Service Number
String
ServiceAccount
Service Account
String
ServiceAccountId
Service Account ID
String
Status
Status
String
Id
ID
String
AdjustedListPrice
Asjusted List Price
String
AssetCurrencyCode
Asset Currency Code
String
Comments
Comments
String
Name
Asset Name
String
ParentAssetId
Parent Asset ID
String
Quantity2
Quantity
String
RootAssetId
Root Asset ID
String
UnitofMeasure
Unit of Measure
String
DataType
Asset Data Type
String
Description
Asset Description
String
DisplayName
Asset Display Name
String
Value
Asset Value
String
AssetManagementComplex Application Interface

Technology Network.

Table 70.
AssetManagementComplext Service Object
Name
Class
Asset Management Complex
Business Service
CSSEAIUIDataService
72
Siebel 8.1 Primary Web Services CMU Account Query

Table 71.
AssetManagementComplext Data Objects
External Name
SiebelMessage
SiebelMessage
SiebelMessageIn
SiebelMessage
SiebelMessageOut
SiebelMessageOut
Example Package for AssetManagementComplex

Request
\AssetManagementComplex\AssetManagementComplex_request.xml
Response
\AssetManagementComplex\AssetManagementComplex_response.xml
Message Schema (WSDL) for AssetManagementComplex

\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

Table 72.
CMU Account Query Operations
Name
Description
CMU Account Query Page
Finds the account detail based on the account ID and

the billing profile ID.
Request Message Description: CMU Account Query Page

Table 73.
Request Message Description: CMU Account Query Page
Node
Description
AccountId
The ID of the account for the billing profile.
BillingProfileId
The ID of the billing profile for the account.
CMU Account Query Application Interface

Technology Network.

Table 74.
CMU Account Query Service Object
Name
Class (If Business Service)
CMU Account Query Service
Business Service
CSSEAIUIDataService

Table 75.
CMU Account Query Data Object
External Name
CMU Query Account Io
CMU - Account
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
Operation
Method
CMU Account QueryPage
[BS: CMU Account Query Service].QueryPage
Example Package for CMU Account Query

Request
...\CMUAccountQuery\CMUAccountQuery.xml
Response
...\CMUAccountQuery\CMUAccountQuery.xml
Message Schema (WSDL) for CMU Account Query

...\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.
75
Siebel 8.1 Primary Web Services CMU Account Update
CMU Account Update Operations

Table 77.
CMU Account Update Operations
Name
Description
CMU Account
Update
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

Table 78.
Request Message Description: CMU Account Update
Node
Description
AccountId
AccountStatus
The status of the account that was updated in the billing application.
CMU Account Update Application Interface

Technology Network.

Table 79.
CMU Account Update Service Object
Name
CMU Account Update
Business Service
CSSEAIDataSyncService

Table 80.
CMU Account Update Data Object
External Name
CMU Update Account Io
Account
76
Siebel 8.1 Primary Web Services Contact
Methods
Table 81.
CMU Account Update Methods
Operation
Method
CMU Account Update
[BS: CMU Account Update].Update
Example Package for CMU Account Update

Request
...\CMUAccountUpdate\CMUAccountUpdate.xml
Response
...\CMUAccountUpdate\CMUAccountUpdate.xml
Message Schema for Account Update

...\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
Table 82.
contact Operations
Name
Description
ContactCreateContact
Creates a contact.
ContactUpdateContact
Updates an existing contact.
Request Message Description: ContactCreateContact

Table 83.
Request Message Description: ContactCreateContact
Node
Description
Type
Contact IO

Contact IO. Contact is the Parent header and
Contact_BusinessAddress is the child.
Integration Object
Response Message Description: ContactCreateContact

Table 84.
Response Message Description: ContactCreateContact
Node
Description
Type
Contact Id
The new Contact Id generated as a result of the new

contact creation.
String
Error Message
Error Message if any.
String
Success Flag
String
Request Message Description: ContactUpdateContact

Table 85.
Request Message Description: ContactUpdateContact
Node
Description
Type
Contact IO

Contact IO. Contact is the Parent header and
Contact_BusinessAddress is the child.
Integration Object
78
Response Message Description: ContactUpdateContact

Table 86.
Response Message Description: ContactUpdateContact
Node
Description
Type
Error Message
String
Success Flag
String
Contact Application Interface

Technology Network.

Table 87.
Contact Data Object
External Name
Contact IO
Contact IO
Example Package for Contact

Request (ContactCreate)
\Contact\ContactCreate_request.xml
Response (ContactCreate)
\Contact\ContactCreate_response.xml
Request (ContactUpdate)
\Contact\ContactUpdate_request.xml
79
Siebel 8.1 Primary Web Services ESB_AccountBalanceSiebelReqABCS_Service
Response (ContactUpdate)
\Contact\ContactUpdate_response.xml
Message Schema (WSDL) for Contact

\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
Table 88.
ESB_AccountBalanceSiebelReqABCS_Service Operations
Name
Description
QueryBalanceSummary
Retrieves the balance summary information for a billing profile.
QueryBalanceDetails
Retrieves the balance group and balance detail information for a billing
profile.
Request Message Description: QueryBalanceSummary

Table 89.
Node
Description
AccountId
AccountName
The name of the account for the billing profile.
MaximumNumberOfRecords
The maximum number of records to retrieve from the external

system.
CurrencyCode
The currency code of the account for the billing profile.
80
Table 89.
Node
Description
BillingProfileName
The name of the billing profile for the account.
BillingProfileId
Response Message Description: QueryBalanceSummary

Table 90.
Response Message Description: QueryBalanceSummary
Node
Description
CmuBalanceSummaryVbc
The attributes of the balance summary.
Request Message Description: QueryBalanceDetails

Table 91.
Request Message Description: QueryBalanceDetails
Node
Description
AccountId
AccountName

system.
CurrencyCode
BillingProfileName
BillingProfileId
Response Message Description: QueryBalanceDetails

Table 92.
Response Message Description: QueryBalanceDetails
Node
Description
CmuBalanceGroupVbc
The attributes of the balance group.
CmuBalanceVbc
The attributes of the balances for the balance group.
CmuBalanceDetailsVbc
The attributes of the balance details for the balance.
CmuBalanceGroupServicesVbc
The attributes of the service charges for the balance group.
81
ESB_AccountBalanceSiebelReqABCS_Service Application Interface

Technology Network.

Table 93.
ESB_AccountBalanceSiebelReqABCS_Service Service Object
Name
AccountBalanceSiebelReqABCS
Business Service
CSSWSOutboundDispatcher

Table 94.
ESB_AccountBalanceSiebelReqABCS_Service Data Objects
External Name
CMU Request Billing Profile IO
Account
CMU Response Balance Group IO
Account
Methods
Table 95.
ESB_AccountBalanceSiebelReqABCS_Service Methods
Operation
Method
QueryBalanceSummary
[BS:AccountBalanceSiebelReqABCS].QueryBalanceSummary
QueryBalanceDetails
[BS:AccountBalanceSiebelReqABCS].QueryBalanceDetails
Example Package for ESB_AccountBalanceSiebelReqABCS_Service

Request
...\AccountBalanceSiebelReqABCS\QueryBalanceDetailsReqMsg.xml
82
Siebel 8.1 Primary Web Services ESB_AdjustmentSiebelReqABCS_Service
Response
...\AccountBalanceSiebelReqABCS\QueryBalanceDetailsRespMsg.xml
Message Schema (WSDL) for

ESB_AccountBalanceSiebelReqABCS_Service
...\AccountBalanceSiebelReqABCS\AccountBalanceSiebelReqABCSService.xml
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
Table 96.
ESB_AdjustmentSiebelReqABCS_Service Operations
Name
Description
Create Adjustment
Creates an adjustment for a bill, item charge, event, and resource balance
in a billing profile.
QueryAdjustment
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.
Request Message Description: CreateAdjustment
Node
Description
The following nodes apply to the FsInvoiceAdjustment node:

AccountId
BillingProfileId
AdjustmentID
The row ID of the adjustment record.
AdjustmentLevelType
The adjustment level (for example, Bill).
ApprovedDate
The date the adjustment is approved.
ReasonForRequest
The reason for the adjustment.
TaxType
The type of tax for the adjustment (for example, Include Tax or Exclude
Tax).
Status
The status of the adjustment. By default, the status is Open.
IntegrationId
The ID of the bill for the adjustment in the billing application.
DecisionDescription
Comments that the user enters about the adjustment.
ApprovedAmt
The approved amount for the adjustment. If this node is included, the
ApprovedPercentage node is excluded.
ApprovedPercentage
The approved percentage for the adjustment. If this node is included,

the ApprovedAmt node is excluded.
Response Message Description: CreateAdjustment (Bill Adjustment)

Table 98.
Response Message Description: CreateAdjustment
Node
Description
FsInvoiceAdjustment
The attributes of the adjustment in the header for the bill

in the billing profile.
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.
Request Message Description: Create Adjustment
Node
Description
The following nodes apply to the FsInvoiceAdjustment node:

AccountId
BillingProfileId
AdjustmentID
The row ID of the adjustment record.
AdjustmentLevelType
The adjustment level (for example, Item Charge, Event Details, and
Resource Impact).
ApprovedDate
The date the adjustment is approved.
The following nodes apply to the SiaInvoiceAdjustmentExternalItems node:

ReasonForRequest
The reason for the adjustment.
TaxType
The type of tax for the adjustment (for example, Include Tax or
Exclude Tax).
Status
The status of the adjustment. By default, the status is Open.
IntegrationId
The ID of the bill for the adjustment in the billing application.
ApprovedDescription
Comments that the user enters about the adjustment.
ResourceType
The type of resource for the adjustment (for example, Currency or

Non Currency).
ApprovedCurrencyCode
The currency code for the adjustment (for example, USD).
ApprovedAmt
The approved amount for the adjustment. If this node is included, the
ApprovedPercentage and ApprovedValue nodes are excluded.
ApprovedPercentage
The approved percentage for the adjustment. If this node is included,

the ApprovedAmt and ApprovedValue nodes are excluded.
ApprovedValue
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)
Table 100. Response Message Description: Create Adjustment
Node
Description
FsInvoiceAdjustment
The attributes of the adjustment in the header for the bill

in the billing profile.
SiaInvoiceAdjustmentExternalItems
The attributes of the adjustment for the item charge,

event, and resource balance in the billing profile.
Request Message Description: QueryAdjustment

Table 101. Request Message Description: QueryAdjustment
Node
Description
AccountId
AccountName

system.
CurrencyCode
BillingProfileName
BillingProfileId
BillPOID
The ID of the bill.
Response Message Description: QueryAdjustment

Table 102. Response Message Description: QueryAdjustment
Node
Description
CmuBilledUsageArItemsVbc
The attributes of the adjustments for the bill in the billing profile.
ESB_AdjustmentSiebelReqABCS_Service Application Interface

Technology Network.
86

Table 103. ESB_AdjustmentSiebelReqABCS_Service Service Object
Name
AdjustmentSiebelReqABCS
Business Service

Table 104. ESB_AdjustmentSiebelReqABCS_Service Data Object
External Name
CMU Request Adjustment IO
Account
CMU Response Adjustment IO
Account
CMU Request Billed Usage IO
Account
CMU Response Billed Usage AR Items IO
Account
Methods
Table 105. ESB_AdjustmentSiebelReqABCS_Service Methods
Operation
Method
CreateAdjustment
[BS:AdjustmentSiebelReqABCS].CreateAdjustment
QueryAdjustment
[BS:AdjustmentSiebelReqABCS].QueryAdjustment
Example Package for ESB_AdjustmentSiebelReqABCS_Service

Request
...\AdjusmentSiebelReqABCS\QueryAdjustmentRequestMessage.xml
Response
...\AdjustmentSiebelReqABCS\QueryAdjustmentResponseMessage.xml
87
Siebel 8.1 Primary Web Services ESB_InvoiceSiebelReqABCS_Service
Message Schema (WSDL) for ESB_AdjustmentSiebelReqABCS_Service

...\AdjustmentSiebelReqABCS\ESB_AdjustmentSiebelReqABCS_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

Table 106. Operations for ESB_InvoiceSiebelReqABCS_Service
Operation Name
Description
QueryInvoiceList
Retrieves the bills for a billing profile.
QueryInvoice
Retrieves the detail for a bill.
QueryEventDetails
Retrieves the billed event (for example, phone call) detail for an
item charge.
SearchEventDetails
Finds the billed event detail based on data in the From Amount,
To Amount, Start Date, and End Date fields.
QueryResourceBalance
Retrieves the non-currency resource balance detail for a billed

event.
88
Request Message Description: QueryInvoiceList

Table 107. Request Message Description: QueryInvoiceList
Node
Description
AccountId
AccountName

system.
CurrencyCode
BillingProfileName
BillingProfileId
Response Message Description: QueryInvoiceList

For a description of this response message, see Table 108
Table 108. Response Message Description: QueryInvoiceList
Node
Description
CmuInvoiceVbc
The attributes of the header for the bills.
Request Message Description: QueryInvoice

Table 109. Request Message Description: QueryInvoice
Node
Description
AccountId
AccountName

system.
CurrencyCode
BillingProfileName
BillingProfileId
BillPOID
The ID of the bill.
89
Response Message Description: QueryInvoice

Table 110. Response Message Description: QueryInvoice
Node
Description
CmuBilledUsageServiceChargesVbc
The attributes of the billed service charges.
CmuBilledUsageItemChargesVbc
The attributes of the billed item charges.
Request Message Description: QueryEventDetails

Table 111. Request Message Description: QueryEventDetails
Node
Description
AccountId
AccountName

system.
CurrencyCode
BillingProfileName
BillingProfileId
BillPOID
The ID of the bill.
ItemChargeId
The ID of the item charge.
Response Message Description: QueryEventDetails

Table 112. Response Message Description: QueryEventDetails
Node
Description
CmuCdrDetailsVbc
The attributes of the billed events.
90
Request Message Description: SearchEventDetails

Table 113. Request Message Description: SearchEventDetails
Node
Description
AccountId
AccountName

system.
CurrencyCode
BillingProfileName
BillingProfileId
BillPOID
The ID of the bill.
ItemChargeId
StartDate
The starting date of the event.
EndDate
The ending date of the event.
FromAmount
The minimum amount of the event.
ToAmount
The maximum amount of the event.
Response Message Description: SearchEventDetails

Table 114. Response Message Description: SearchEventDetails
Node
Description
CmuCdrDetailsVbc
The attributes for the billed events.
Request Message Description: QueryResourceBalance

Table 115. Request Message Description: QueryResourceBalance
Node
Description
AccountId
AccountName

system.
CurrencyCode
BillingProfileName
91
Table 115. Request Message Description: QueryResourceBalance

Node
Description
BillingProfileId
BillPOID
The ID of the bill.
ItemChargeId
EventId
The ID of the event.
Response Message Description: QueryResourceBalance

Table 116. Response Message Description: QueryResourceBalance
Node
Description
CmuCdrBalanceDetailsVbc
The attributes of the non-currency resource balances for the billed

event.
ESB_InvoiceSiebelReqABCS_Service Application Interface

Technology Network.

Table 117. ESB_InvoiceSiebelReqABCS_Service Service Object
Name
InvoiceSiebelReqABCS
Business Service

Table 118. ESB_InvoiceSiebelReqABCS_Service Data Object
External Name
Account
CMU Response Billing Invoice IO
Account
Account
CMU Response Billed Usage IO
Account
CMU Request CDR Details IO
Account
92
Table 118. ESB_InvoiceSiebelReqABCS_Service Data Object

External Name
CMU Response CDR Details IO
Account
CMU Request CDR Details Search IO
Account
CMU Request CDR Balance Details IO
Account
CMU Response CDR Balance Details IO
Account
Methods
Table 119. ESB_InvoiceSiebelReqABCS_Service Methods
Operation
Method
QueryInvoiceList
[BS:InvoiceSiebelReqABCS].QueryInvoiceList
QueryInvoice
[BS:InvoiceSiebelReqABCS].QueryInvoice
QueryEventDetails
[BS:InvoiceSiebelReqABCS].QueryEventDetails
SearchEventDetails
[BS:InvoiceSiebelReqABCS].SearchEventDetails
[BS:InvoiceSiebelReqABCS].QueryResouceBalance
Example Package for ESB_InvoiceSiebelReqABCS_Service

Request
...\InvoiceSiebelReqABCS\QueryInvoiceListReqMsg.xml
Response
...\InvoiceSiebelReqABCS\QueryInvoiceListRespMsg.xml
Message Schema (WSDL) for ESB_InvoiceSiebelReqABCS_Service

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
Table 120. ESB_PaymentSiebelReqABCS_Service Operations
Operation Name
Description
CreatePayment
Creates a payment for a billing profile.
CreateInvoicePayment
Creates a payment for a bill in a billing profile.
QueryPayment
Retrieves the payments for a billing profile.
QueryInvoicePayment
Retrieves the payments for a bill in a billing profile.
SearchPayment
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

Table 121. Request Message Description: CreatePayment
Node
Description
CmuCaptureNewPaymentVbc
The attributes of the payment for the billing profile which include
the payment method and the payment method details.
Response Message Description: CreatePayment

Table 122. Response Message Description: CreatePayment
Node
Description
CmuCaptureNewPaymentVbc
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

Table 123. Request Message Description: CreateInvoicePayment
Node
Description
CmuCaptureNewPaymentInvoiceVbc
The attributes of the payment for the bill which include the
payment method and the payment method details.
Response Message Description: CreateInvoicePayment

Table 124. Response Message Description: CreateInvoicePayment
Node
Description
CmuCaptureNewPaymentInvoiceVbc
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

Table 125. Request Message Description: QueryPayment
Node
Description
AccountId
AccountName

system.
CurrencyCode
BillingProfileName
BillingProfileId
Response Message Description: QueryPayment

Table 126. Response Message Description: QueryPayment
Node
Description
CmuBillingProfilePaymentsVbc
The attributes of the payments for the billing profile.
95
Request Message Description: QueryInvoicePayment

Table 127. Request Message Description: QueryInvoicePayment
Node
Description
AccountId
AccountName

system.
CurrencyCode
BillingProfileName
BillingProfileId
BillPOID
The ID of the bill.
Response Message Description: QueryInvoicePayment

Table 128. Response Message Description: QueryInvoicePayment
Node
Description
CmuBilledUsagePaymentsVbc
The attributes of the payments for the bill.
Request Message Description: SearchPayment

Table 129. Request Message Description: SearchPayment
Node
Description
AccountId
AccountName

system.
CurrencyCode
BillingProfileName
BillingProfileId
StartDate
The starting date of the payment.
EndDate
The ending date of the payment.
MinimumAmount
The minimum amount of the payment.
MaximumAmount
The maximum amount of the payment.
96
Response Message Description: SearchPayment

Table 130. Response Message Description: SearchPayment
Node
Description
CmuBillingProfilePaymentsVbc
The attributes of the payments for the billing profile.
ESB_PaymentSiebelReqABCS_Service Application Interface

Technology Network.

Table 131. ESB_PaymentSiebelReqABCS_Service Service Object
Name
PaymentReceiptSiebelABCS
Business Service

Table 132. ESB_PaymentSiebelReqABCS_Service Data Object
External Name
CMU Request New Payment Capture IO
Account
CMU Response New Payments IO
Account
Account
CMU Response Billing Profile Payments IO
Account
CMU Request New Payment Capture Invoice IO
Account
CMU Response New Payment Invoice IO
Account
Account
CMU Response Billed Usage Payments IO
Account
CMU Request Billing Profile Payments Search IO
Account
97
Siebel 8.1 Primary Web Services ESB_UnbilledUsageSiebelReqABCS_Service
Methods
Table 133. ESB_PaymentSiebelReqABCS_Service Methods
Operation
Method
CreatePayment
[BS: PaymentReceiptSiebelABCS].CreatePayment
CreateInvoicePayment
[BS: PaymentReceiptSiebelABCS].CreateInvoicePayment
QueryPayment
[BS: PaymentReceiptSiebelABCS].QueryPayment
QueryInvoicePayment
[BS: PaymentReceiptSiebelABCS].QueryInvoicePayment
SearchPayment
[BS: PaymentReceiptSiebelABCS].SearchPayment
Example Package for ESB_PaymentSiebelReqABCS_Service

Request
...\PaymentReceiptSiebelABCS\QueryPaymentRequestMessage.xml
Response
...\PaymentReceiptSiebelABCS\QueryPaymentResponseMessage.xml
Message Schema (WSDL) for ESB_PaymentSiebelReqABCS_Service

...\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
Table 134. ESB_UnbilledUsageSiebelReqABCS_Service Operations
Operation Name
Description
QueryUnbilledUsage
Retrieves unbilled usage detail for a billing profile.
QueryEventDetails
Retrieves unbilled event (for example, phone call) detail for an item
charge.
SearchEventDetails
Finds the unbilled event detail based on data in the From Amount, To
Amount, Start Date, and End Data fields.
QueryResourceDetails
Retrieves the non-currency resource balance detail for an unbilled

event.
Request Message Description: QueryUnbilledUsage

Table 135. Request Message Description: QueryUnbilledUsage
Node
Description
AccountId
AccountName

system.
CurrencyCode
BillingProfileName
BillingProfileId
Response Message Description: QueryUnbilledUsage

Table 136. Response Message Description: QueryUnbilledUsage
Node
Description
CmuUnbilledUsageVbc
The attributes of the unbilled service charges.
CmuUnbilledItemChargesVbc
The attributes of the unbilled item charges
99
Request Message Description: QueryEventDetails

Table 137. Request Message Description: QueryEventDetails
Node
Description
AccountId
AccountName

system.
CurrencyCode
BillingProfileName
BillingProfileId
UnbilledUsageServiceId
The ID of the unbilled service charge.
UnbilledItemChargesId
The ID of the unbilled item charge.
Response Message Description: QueryEventDetails

Table 138. Response Message Description: QueryEventDetails
Node
Description
CmuUnbilledItemChargesDetailsVbc
The attributes of the unbilled events.
Request Message Description: SearchEventDetails

Node
Description
AccountId
AccountName

system.
CurrencyCode
BillingProfileName
BillingProfileId
StartDate
The starting date of the event.
100

Node
Description
EndDate
The ending date of the event.
FromAmount
The minimum amount of the event.
ToAmount
The maximum amount of the event.
Response Message Description: SearchEventDetails

Table 140. Response Message Description: SearchEventDetails
Node
Description
CmuUnbilledItemChargesDetailsVbc
The attributes of the unbilled events.
Request Message Description: QueryResouceBalance

Table 141. Request Message Description: QueryResouceBalance
Node
Description
AccountId
AccountName

system.
CurrencyCode
BillingProfileName
BillingProfileId
UnbilledEventDetailsId
The ID of the unbilled event.
Response Message Description: QueryResouceBalance

Table 142. Response Message Description: QueryResouceBalance
Node
Description
CmuUnbilledBalanceDetailsVbc
The attributes of the non-currency resource balances for an

unbilled event.
10 1
ESB_UnbilledUsageSiebelReqABCS_Service Application Interface

Technology Network.

Table 143. ESB_UnbilledUsageSiebelReqABCS_Service Service Object
Name
UnbilledUsageSiebelReqABCS
Business Service

Table 144. ESB_UnbilledUsageSiebelReqABCS_Service Data Objects
External Name
Account
CMU Response Unbilled Usage IO
Account
CMU Request Unbilled Details IO
Account
CMU Response Unbilled Details IO
Account
CMU Request Unbilled Details Search IO
Account
CMU Request Unbilled Balance Details IO
Account
CMU Response Unbilled Balance Details IO
Account
Methods
Table 145. ESB_UnbilledUsageSiebelReqABCS_Service Methods
Operation
Method
QueryUnbilledUsage
[BS:UnbilledUsageSiebelReqABCS].QueryUnbilledUsage
QueryEventDetails
[BS:UnbilledUsageSiebelReqABCS].QueryEventDetails
SearchEventDetails
[BS:UnbilledUsageSiebelReqABCS].SearchEventDetails
[BS:UnbilledUsageSiebelReqABCS].QueryBalanceSummary
102
Siebel 8.1 Primary Web Services FS Asset Warranty Service
Example Package for ESB_UnbilledUsageSiebelReqABCS_Service

Request
...\UnbilledUsageSiebelReqABCS\UnbilledUsageRequestMessage.xml
Response
...\UnbilledUsageSiebelReqABCS\UnbilledUsageResponseMessage.xml

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

Table 146. FS Asset Warranty Service Operations
Name
Description
CreateAssetWarranty
Adds the input warranty to the source asset.
GetAssetWarranty
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
Description
Type
Asset Id
Row Id of asset.
String
Warranty Id
Row Id of the warranty.
String
Serviced Date
Date from which warranty will start

(mm/dd/yyyy).
Date
Response Message Description: CreateAssetWarranty

Table 148. Response Message Description: CreateAssetWarranty
Node
Description
Type
StatusMsg
(Optional). Will give error message in the

case of incompatibility of inputs. If there
is no imcompatibility, there will be no
message.
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.
Table 149. Request Message Description: GetAssetWarranty
Node
Description
Type
Asset Id
Row Id of asset.
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

Technology Network.

Table 150. FS Asset Warranty Service Object
Name
Class
BS: FS Asset Warranty Service
Business Service
CSSFSAssetWrntyService
Busiiness Service
CSSFSAssetWrntyService
Operation: CreateAssetWarranty
BS: FS Asset Warranty Service
Operation: GetAssetWarranties
Example Package for FS Asset Warranty Service

Request/Response (CreateAssetWarranty)
\FSAssetWarranty\CreateAssetWarranty Sample IO.doc
Request/Response (GetAssetWarranties)
\FSAssetWarranty\GetAssetWarranty Sample IO.doc
Message Schema (WSDL) for FS Asset Warranty Service

\FSAssetWarranty\CreateAssetWarranty.wsdl
GetMktgWebSurvey
Use this Web service to get Marketing Web Surveys.
10 5
Siebel 8.1 Primary Web Services GetMktgWebSurvey
GetMktgWebSurvey Operations
Table 151. GetMktgWebSurvey Operations
Name
Description
GetMktgWebSurveyQueryPage
This operation is used to query up a Survey Page.
Request Message Description: GetMktgWebSurveyQueryPage

Table 152. Request Message Description: GetMktgWebSurveyQueryPage

Node
Description
Type
ExecutionMode
The mode in which the query is to be

performed.
String
LOVLanguageMode
The language mode from the seeded list.
String
NamedSearchSpec
Search Specification of the query.
String
PickListName
Name of the picklist (if any).
String
SiebelMessageIn
An instance of the GetMktgWebSurvey

Integration Object.
Integration
Object
ViewMode
The View Mode set for the Object

(Admin, Preserve, and so on).
String
Response Message Description: GetMktgWebSurveyQueryPage

Table 153. Response Message Description: GetMktgWebSurveyQueryPage
Node
Description
Type
SiebelMessageOut
An instance of the GetMktgWebSurvey

Integration Object.
Integration Object
GetMktgWebSurvey Application Interface

Technology Network.
106
Siebel 8.1 Primary Web Services ISS Price List Item WS

Table 154. GetMktgWebSurvey Data Object
External Name
Import Job Integration Object
Import Job Integration Object.
Example Package for GetMktgWebSurvey

Request
\GetMktgWebSurvey\GetMktgWebSurvey_request.xml
Response
\GetMktgWebSurvey\GetMktgWebSurvey_response.xml
Message Schema (WSDL) for GetMktgWebSurvey

\GetMktgWebSurvey\GetMktgWebSurvey.wsdl

Use this Web service to add, update, and delete items in a price list in the Siebel CRM application.
10 7
ISS Price List Item WS Operations

Table 155. ISS Price List Item WS Operations
Name
Description
Price List Item

InsertorUpdate
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.
Price List Item Insert
Adds an item to a price list.
Price List Item Update
Updates an item in a price list.
Price List Item Delete
Deletes an item from a price list.
Request Message Description: Price List Item InsertOrUpdate

Table 156. Request Message Description: Price List Item InsertOrUpdate
Node
Description
Price List Id
The ID of the price list. This node is used only to insert.
Product Id
The ID of the product to add to the price list. This node is used only to insert.
Price List Item Id
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

Table 157. Request Message Description: Price List Item Insert
Node
Description
Price List Id
The ID of the price list.
Product Id
The ID of the product to add to the price list.
Request Message Description: Price List Item Update

Table 158. Request Message Description: Price List Item Update
Node
Description
Price List Item Id
The ID of the price list item to update in the price list.
108
Request Message Description: Price List Item Delete

Table 159. Request Message Description: Price List Item Delete
Node
Description
Price List Item Id
The ID of the price list item to delete from the price list.
ISS Price List Item WS Application Interface

Technology Network.

Table 160. ISS Price List Item WS Service Object
Name
Business Service

Table 161. ISS Price List Item WS Data Object
External Name
ISS Price List Item Integration Object
Admin Price List
Methods
Table 162. ISS Price List Item WS Methods
Operation
Method
Price List Item InsertOrUpdate
[BS: ISS Price List Item WS].InsertOrUpdate
Price List Item Insert
[BS: ISS Price List Item WS].Insert
Price List Item Update
[BS: ISS Price List Item WS].Update
Price List Item Delete
[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
...\ISSPriceListItemWS\ISSPriceListItem.xml
Response
...\ISSPriceListItemWS\ISSPriceListItem.xml
Message Schema (WSDL) for ISS Price List Item WS

CRM Web Services Reference to access a zip file. Extract the files in the zip file..
...\ISSPriceListItemWS\ISSPriceListItemWS.wsdl
LeadProcessingService
This service contains the basic operations for processing leads, including assigning, querying, scoring
and data cleansing.
Lead Processing Service Operations

Table 163. Lead Processing Service Operations
Name
Description
LeadProcessingServiceAssignLeads
Used to assign leads to sales representatives.
LeadProcessingServiceDataCleansing
Used for data cleansing of marketing data.
LeadProcessingServiceGetLeads
Queries for leads.
LeadProcessingServiceScoreLeads
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
Table 164. Request Message Description: LeadProcessingServiceAssignLeads
Node
Description
Type
Execution Order
Required. Parameter to be passed to the Business Rules

Workflow.
String
Search Specification
Required. The input search criteria to search on the Lead

Business Component.
String
Response Message Description: LeadProcessingServiceAssignLeads

Table 165. Response Message Description: LeadProcessingServiceAssignLeads
Node
Description
Type
Error Message
OK or NOTOK based on errors.
String
Process Instance Id
This is the Business Rules Workflow process Id.
String
Success Flag
Yes OR No based on success.
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
Description
Type
Business Component
Required. Business Component to be passed to Data cleansing

service.
String
Business Object
Required. Business Object from which the business component

instance is obtained.
String
Required. Search specification to querry the BC and get the

values in activated Fields.
String
11 1
Response Message Description: LeadProcessingServiceDataCleansing

Table 167. Response Message Description: LeadProcessingServiceDataCleansing
Node
Description
Type
Error Message
String
Success Flag
String
Request Message Description: LeadProcessingServiceGetLeads

This method is used to get leads based on the input criteria. For a description of this request
Table 168. Request Message Description: LeadProcessingServiceGetLeads
Node
Description
Type
Required. The input search criteria to

search on Lead Business Component.
String
Response Message Description: LeadProcessingServiceGetLeads

Table 169. Response Message Description: LeadProcessingServiceGetLeads
Node
Description
Type
SiebelMessage
Required. Has Lead Id and description of

the leads.
Integration
Object
Request Message Description: LeadProcessingServiceScoreLeads

This method is used to score leads. It accepts the input parameters in a property set. For a
Table 170. Request Message Description: LeadProcessingServiceScoreLeads
Node
Execution Order
112
Description
Type
Required. Parameter to be passed to

Business Rules Workflow.
String
Response Message Description: LeadProcessingServiceScoreLeads

Table 171. Response Message Description: LeadProcessingServiceScoreLeads
Node
Description
Type
Error Message
String
Process Instance Id
This is the Business Rules Workflow process Id.
String
Success Flag
String
LeadProcessingService Application Interface

Technology Network.

Table 172. LeadProcessingService Service Object
Name
Business Rules Workflow
WorkFlow
Data Cleansing
Busiiness Service

Table 173. LeadProcessingService Data Object
External Name
Lead Integration Object
Lead
Example Package for Lead Processing Service

Request (LeadProcessingServiceAssignLeads)
\LeadProcessingService\LeadProcessingService_AssignLeads_request.xml
11 3
Response (LeadProcessingServiceAssignLeads)
\LeadProcessingService\LeadProcessingService_AssignLeads_request.xml
Request (LeadProcessingServiceDataCleansing)
\LeadProcessingService\LeadProcessingService_ScoreLeads_request.xml
Response(LeadProcessingServiceDataCleansing)
Request (LeadProcessingServiceGetLeads)
Response (LeadProcessingServiceGetLeads)
Request (LeadProcessingServiceScoreLeads)
Response (LeadProcessingServiceScoreLeads)
Message Schema (WSDL) for Lead Processing Service

\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
Table 174. LeadService Operations
Name
Description
LeadServiceRetireLead
Retires a lead.
LeadServiceCreateLead
Creates a lead.
LeadServiceRejectLead
Rejects a lead.
LeadServiceResponseToLead
Converts response to leads.
LeadServiceConvertLeadToOpty
Converts lead to an opportunity.
LeadServiceUpdateLead
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
Table 175. Request Message Description: LeadServiceRetireLead
Node
Description
Type
LeadId
Required.The Id of the lead to be retired.
String
ReasonCode
Required The reason code for retiring the lead.
String
Comments
Comments for retiring (if any).
String
Response Message Description: LeadServiceRetireLead

Table 176. Response Message Description: LeadServiceRetireLead
Node
Description
Type
ReturnVal
Error code (OK or NOTOK).
String
11 5
Request Message Description: LeadServiceCreateLead

Table 177. Request Message Description: LeadServiceCreateLead
Node
Description
Type
Lead IO
Required.An instance of the Integration Object Lead IO.
Integration Object
Response Message Description: LeadServiceCreateLead

Table 178. Response Message Description: LeadServiceCreateLead
Node
Description
Type
Error Message
Error message (if any).
String
Success Flag
Y or N.
String
Lead Id
Id of the lead generated as a result of the lead creation.
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
Table 179. Request Message Description: LeadServiceRejectLead
Node
Description
Type
LeadId
Required. The Id of the lead to be rejected.
String
OwnerId
Optional.
String
ReasonCode
Reason code for rejecting the lead.
String
Comments
Comments (if any).
String
Response Message Description: LeadServiceRejectLead

Table 180. Response Message Description: LeadServiceRejectLead
Node
Description
Type
ReturnVal
Error message(OK or NOTOK).
String
116
Request Message Description: LeadServiceResponseToLead

Table 181. Request Message Description: LeadServiceResponseToLead
Node
Description
Type
Response Id
Required.The Id of the response to be converted to lead.
String
Response Message Description: LeadServiceResponseToLead

Table 182. Response Message Description: LeadServiceResponseToLead
Node
Description
Type
Error Message
String
Success Flag
Y or N.
String
Lead Id
The Id of the lead created from the response.
String
Request Message Description: LeadServiceConvertLeadToOpty

Table 183. Request Message Description: LeadServiceConvertLeadToOpty
Node
Description
Type
LeadId
Required . The Id of the lead to be converted.
String
Contact Id
The contact Id of the lead.
String
Account Id
The account Id of the lead.
String
Response Message Description: LeadServiceConvertLeadToOpty

Table 184. Response Message Description: LeadServiceConvertLeadToOpty
Node
Description
Type
Error Message
String
Success Flag
Y or N.
String
Opty Id
The Id of the opportunity created.
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
Description
Type
Lead IO
Required. An instance of the integration object Lead IO.
Integration Object
Response Message Description: LeadServiceUpdateLead

Table 186. Response Message Description: LeadServiceUpdateLead
Node
Description
Type
Error Message
String
Success Flag
Y or N.
String
LeadService Application Interface

Technology Network.

Table 187. LeadService Service Object
Name
Response To Lead Conversion
Workflow
Lead To Opty Conversion
Workflow

Table 188. LeadService Data object
External Name
Lead IO
Lead
Example Package for LeadService

118
Request (LeadServiceRetireLead)
\LeadService\LeadService_RetireLead_request.xml
Response (LeadServiceRetireLead)
\LeadService\LeadService_RetireLead_response.xml
Request (LeadServiceCreateLead)
\LeadService\LeadService_CreateLead_request.xml
Response (LeadServiceCreateLead)
\LeadService\LeadService_CreateLead_response.xml
Request (LeadServiceRejectLead)
\LeadService\LeadService_RejectLead_request.xml
Response(LeadServiceRejectLead)
\LeadService\LeadService_RejectLead_response.xml
Request (LeadServiceResponseToLead)
\LeadService\LeadService_ResponseToLead_request.xml
Response (LeadServiceResponseToLead)
\LeadService\LeadService_ResponseToLead_response.xml
Request (LeadServiceConvertLeadToOpty)
\LeadService\LeadService_ConvertToOpty_request.xml
11 9
Siebel 8.1 Primary Web Services List
Response (LeadServiceConvertLeadToOpty)
\LeadService\LeadService_ConvertToOpty_response.xml
Request (LeadServiceUpdateLead)
\LeadService\LeadService_UpdateLead_request.xml
Response (LeadServiceUpdateLead)
\LeadService\LeadService_UpdateLead_response.xml
Message Schema (WSDL) for LeadService

\LeadService\Lead.wsdl
List
Use this Web service for the basic operations for processing lists.
List Operations
Table 189. List Operations
Name
Description
ListCreateList
Creates a list.
ListExportList
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
Table 190. Request Message Description: ListCreateList
Node
Description
Type
List IO
Required. An instance of the integration object List IO.
Integration Object
Response Message Description: ListCreateList

Table 191. Response Message Description: ListCreateList
Node
Description
Type
List Id
List Id of the list created.
String
Error Message
String
Success Flag
Y or N.
String
Request Message Description: ListExportList

This method is used to export lists. It accepts the input parameters as a property set. For a
Table 192. Request Message Description: ListExportList
Node
Description
Type
Business Component
The Business Component whose records need to be exported.
String
Business Object
The Business Object containing the Business Component.
String
Export Format
The format (xml or CSV) based on which the filename(s) are

to be created.
String
The search specification for the records on the bc (if the

records satisfying a condition are only to be picked).
String
List Application Interface

Technology Network.
12 1

Table 193. List Service Object
Name
EAI XML Write to File
Business Service

Table 194. List Data Object
External Name
List IO
List IO
Example Package for List

Request (ListCreateList)
\List\ListCreate_request.xml
Response (ListCreateList)
\List\ListCreate_response.xml
Request (ListExportList)
\List\ListExport_request.xml
Message Schema (WSDL) for List

\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
Table 195. ListMgmtProspect Operations
Name
Description
ListMgmtProspectCreateProspect
Creates a Prospect.
ListMgmtProspectUpdateProspect
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
Description
Type
Prospect IO
Required input parameter.
Integration Object
Response Message Description: ListMgmtProspectCreateProspect

Table 197. Response Message Description: ListMgmtProspectCreateProspect
Node
Description
Type
Prospect Id
Unique Id of the prospect created.
String
Error Message
Error message, if any.
String
Success Flag
Y or N.
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
Description
Type
Prospect IO
Integration Object
12 3
Siebel 8.1 Primary Web Services ListMgmtProspect
Response Message Description: ListMgmtProspectUpdateProspect

Table 199. Response Message Description: ListMgmtProspectUpdateProspect
Node
Description
Type
Error Message
String
Success Flag
Y or N.
String
Example Package for ListMgmtProspect

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

\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
Table 200. LoyaltyAccrualService Operations
Name
Description
ProcessExternalOrder
Process all the transactions with the given order number.
ImportExternalOrderTxn
Imports the transactions from external file, stamp the given order
number to them and process all the transactions.
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.
ExportPromotions
Exports the Promotion of given Program.
Request Message Description: ProcessExternalOrder

Table 201. Request Message Description: ProcessExternalOrder
Node
Description
Type
Order Number Number
The number of transactions this order

number will be processed.
Number
Response Message Description: ProcessExternalOrder

Table 202. Response Message Description: ProcessExternalOrder
Node
Description
Type
Total Points
Total Number of Points for a given order.
Number
Request Message Description: ImportExternalOrderTxn

Table 203. Request Message Description: ImportExternalOrderTxn
Node
Description
Type
File Name
File name that contains the transactions.
String.
12 5
Response Message Description: ImportExternalOrderTxn

Table 204. Response Message Description: ImportExternalOrderTxn
Node
Description
Type
Total Points
Total Number of Points for a given order.
Number
Siebel Message
Siebel Message of Transactions.
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
Description
Type
Order Number
Order Number to be stamped to the saved

transactions.
Number
Total Lines
Total number of transactions in the Input.
Number
Request Mode
Can be Process or Simulate.
String
LOY EAI Transactions
Transactions in Integration Object Format.
Integration Object
Response Message Description: ProcessExternalOrderTxn

Table 206. Response Message Description: ProcessExternalOrderTxn
Node
Description
Type
Total Points Number
Total Number of Points for the given order.
Number
Return Value String
Failure or Success.
String
Siebel Message Hierarchy
Siebel Message of Transactions.
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
Description
Type
Activity Date
Date should be between the start and end date of

the promotion.
String
126
Table 207. Request Message Description: ExportPromotions

Node
Description
Type
Export Flag
Export Flag can be Y or N.
String
Program Name
Program Name of which the user want to export the

Promotions.
String
Response Message Description: ExportPromtions

Table 208. Response Message Description: ExportPromtions
Node
Description
Type
Siebel Message
All the Promotions in LOY EAI Promotion

Integration Object Format.
Integration Object.
Example of Package for LoyaltyAccrualService

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)
\LoyaltyAccrualService\ProcessExternalOrder_request.xml
Response (ProcessExternalOrder)
\LoyaltyAccrualService\ProcessExternalOrder_response.xml
Request (ImportExternalOrderTxn)
\LoyaltyAccrualService\ProcessExternalOrderTxn_request.xml
Response (ImportExternalOrderTxn)
\LoyaltyAccrualService\ProcessExternalOrderTxn_response.xml
Request (ImportExternalOrderTxnif Request Mode is Simulate)

12 7
\LoyaltyAccrualService\RequestMode_Simulate_request.xml
Response(ImportExternalOrderTxnif Request Mode is Simulate)

\LoyaltyAccrualService\RequestMode_Simulate_response.xml
Request (ProcessExternalOrderTxn)
\LoyaltyAccrualService\ProcessExternalOrderTxn_request.xml
Response (ProcessExternalOrderTxn)
\LoyaltyAccrualService\ProcessExternalOrderTxn_response.xml
Request (ExportPromotions)
\LoyaltyAccrualService\ExportPromotions_request.xml
Response (ExportPromotions)
\LoyaltyAccrualService\ExportPromotions_response.xml
Message Schema (WSDL) for LoyaltyAccrualService

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
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
Table 209. LoyaltyBatchEnrollment Operations
Name
Description
MemberEnrollment
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
Description
EnrollmentPaymentProcessing
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

Table 210. Request Message Description: MemberEnrollment
Node
Description
Type
Siebel
Message
Hierarchy of the Member details. Uses the Integration

Object LOY Member
Hierarchy
(Integration Object :
LOY Member).
Required Input:
130
Action Type must be Enrollment.
Program Id.
Membership Scheme Id.
Member Type.
Contact Details.
Account/Household details based on the member type.
Response Message Description: MemberEnrollment

Table 211. Response Message Description: MemberEnrollment
Node
Description
Type
Siebel
Message
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.
Hierarchy
LOY Member).
If the member is created successfully and payment is

involved for the membership scheme, then the property set
contains the enrolment simulated price lists.
Request Message Description: MemberUpdate

Table 212. Request Message Description: MemberUpdate
Node
Description
Type
Siebel
Message
Hierarchy of the Member details. Uses the Integration Object

LOY Member.
Hierarchy
LOY Member)
Required Input:
Action type must be Update.
Member Number.
Response Message Description: MemberUpdate

Table 213. Response Message Description: MemberUpdate
Node
Description
Type
Siebe
lMessage
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.
Hierarchy
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.
13 1
Request Message Description: EnrolmentPaymentProcessing

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

Table 215. Response Message Description: EnrolmentPaymentProcessing
Node
Description
Type
MemberNumber
Member Number.
String
Status
Status of the Member.
String
Payment Errors
The list of error messages occurred during the

enrolment payment processing.
Hierarchy (Integration
Object: LOY ENR Payment
Errors)
132
Request Message Description: GeneratePreAllottedMemberships

Table 216. Request Message Description: GeneratePreAllottedMemberships
Node
Description
Type
Program Id
Program Id.
String
Number of Members
The total number of pre-allotted

memberships to be generated.
Number
Response Message Description: GeneratePreAllottedMemberships

Table 217. Response Message Description: GeneratePreAllottedMemberships
Node
Description
Type
MemberNumbers
The hierarchy of the list of membership

numbers generated in Pre-allotted status.
Hierarchy (Integration Object:

LOY Preallotted Member)
Example Package for LoyaltyBatchEnrollment

Request
\LoyaltyBatchEnrollment\LoyaltyBatchEnrollment_request.xml
Response
\LoyaltyBatchEnrollment\LoyaltyBatchEnrollment_response.xml
Message Schema (WSDL) for LoyaltyBatchEnrollment

\LoyaltyBatchEnrollment\LoyaltyBatchEnrollment.wsdl
13 3
Siebel 8.1 Primary Web Services 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
Table 218. LoyaltyImportBusinessService Operations
Name
Description
VoucherImport
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
Description
Type
File Format
String
Required
File Name
String
Required
IO Name
String
Required
Method Name
String
Required
Service Name
String
Required
Response Message Description: VoucherImport

Table 220. Response Message Description: VoucherImport
Node
Description
Type
ValidFlag
Required
String
134
Siebel 8.1 Primary Web Services LoyaltyMemberService
Example Package for LoyaltyImportBusinessService

Request
\LoyaltyImportBusService\LoyaltyImportBusService_request.xml
Response
\LoyaltyImportBusService\LoyaltyImportBusService_response.xml
Message Schema (WSDL) for LoyaltyImportBusinessService

\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
Description
PurchasePointsService
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
Description
RenewMembershipService
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

Table 222. Request Message Description: PurchasePointsService
Node
Description
Type
Member Number
Membership Number.
String
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
The type of Point member wants to purchase is to be given. It is

a mandatory input.
String
Points
The number of Points member wants to purchase is to be given.

It is a mandatory input.
String
Billing Address
Member billing address. It is required if the payment involves

monetary currency and Credit Card details are mentioned.
String
Billing Address2
Secondary member billing address. It is required if the payment

involves monetary currency and Credit Card details are
mentioned.
String
Billing City
Member billing city. It is required if the payment involves

String
13 7
Table 222. Request Message Description: PurchasePointsService

Node
Description
Type
Billing Country
Member billing country. It is required if the payment involves

String
Billing State
Member billing state. It is required if the payment involves

String
Billing ZipCode
Member billing Zip code. It is required if the payment involves

String
CVV Number
CVV number from member credit card. It is required if the

payment involves monetary currency and Credit Card details are
mentioned.
String
Card Holder Name
Credit card holder name. It is required if the payment involves

monetary currency.
String
Credit Card Number
Credit card number. It is required if the payment involves

monetary currency.
String
Credit Card Type
Credit card type, such as Visa, MasterCard, and so on. It is

required if the payment involves monetary currency.
String
Currency
Currency type used by member. It is required as the payment

involves monetary currency.
String
Expiration Month
Expiration month of member credit cards. It is required if the

payment involves monetary currency.
String
Expiration Year
Expiration year of member credit card. It is required if the

String
Member Number
Membership Number.
String
Override Flag

String
Override Pay
It is a mandatory input. If the member wants to override the

price details, input would be Y, else it would be N.
String
Override Reason
Member should mention Override Pay when Override flag given

is Y. It is the Monetary Amount overridden by the member.
String
Override Reason
Code
Reason to override the pricelist is to be mentioned if the Override

Flag is Y.
String
138
Response Message Description: PurchasePointsService

Table 223. Response Message Description: PurchasePointsService
Node
Description
Type
Error Message
Error message if the transaction fails is given.
String
Order Id
Order Id of the Point Purchase Service is given.
String
Quote Id
Quote Id of the Point Purchase Service is given.
String
Siebel Response Code
Response Code given by Siebel Order Management

after authorizing credit card is sent in the output.
String
Siebel Response
Message
Response Message given by Siebel Order Management

String
Transaction Number
Transaction Number of the Point Purchase Service is

given in the output.
String
Request Message Description: TransferPointService

Table 224. Request Message Description: TransferPointService
Node
Description
Type
Member Number
Membership Number.
String
Point Type

String
Points
The type of Point member wants to transfer is to be given. It is

a mandatory input.
String
Transferee Member
Number
The number of Points member wants to purchase is to be given.

It is a mandatory input.
String
Billing Address
Transferee Membership Number to whom the points are to be

transferred.
String
Billing Address2

String
Billing City
Secondary member billing address. It is required if the payment

involves monetary currency and Credit Card.
String
Billing Country

String
Billing State

String
Billing ZipCode

String
13 9
Table 224. Request Message Description: TransferPointService

Node
Description
Type
CVV Number

String
Card Holder Name

payment involves monetary currency and Credit Card details are
mentioned.
String
Credit Card Number

monetary currency.
String
Credit Card Type

monetary currency.
String
Currency

String
Expiration Month

String
Expiration Year

String
Override Flag

String
Override Pay

String
Override Reason

String
Override Reason
Code
Reason to override the pricelist is to be mentioned if the

Override Flag is Y.
String
Response Message Description: TransferPointService

Table 225. Response Message Description: TransferPointService
Node
Description
Type
Error Message
String
Order Id
Order Id of the Point Transfer Service is given.
String
Quote Id
Quote Id of the Point Transfer Service is given.
String
Response Code given by Siebel Order Management after

authorizing credit card is sent in the output.
String
140
Table 225. Response Message Description: TransferPointService

Node
Description
Type
Siebel Response Message

String
Transaction Number
Transaction Number of the Point Transfer Service is given

in the output.
String
Request Message Description: LoungePurchaseService

Table 226. Request Message Description: LoungePurchaseService
Node
Description
Type
Member Number
Membership Number.
String
Lounge Period Type

person for whom the service is to be performed is to be
given.
String
Lounge Period Duration
Lounge period type as months or years.
String
Billing Address
Lounge period duration for the number of months or years

the member want to renew his lounge.
String
Billing Address2
Member billing address. It is required if the payment

involves monetary currency and credit card details are
mentioned.
String
Billing City
Secondary member billing address. It is required if the

payment involves monetary currency and credit card.
String
Billing Country

monetary currency and credit card details are mentioned.
String
Billing State
Member billing country. It is required if the payment

mentioned.
String
Billing ZipCode

monetary currency and credit card details are mentioned.
String
CVV Number
Member billing ZIP code. It is required if the payment

mentioned.
String
Card Holder Name

payment involves monetary currency and credit card details
are mentioned.
String
Credit Card Number
Credit card holder name. It is required if the payment

String
14 1
Table 226. Request Message Description: LoungePurchaseService

Node
Description
Type
Credit Card Type

monetary currency.
String
Currency

String
Expiration Month
Currency type used by member. It is required as the

String
Expiration Year
Expiration month of member credit cards. It is required if

the payment involves monetary currency.
String
Override Flag

String
Override Pay

String
Override Points
Member should mention Override Pay when Override flag

given is Y. It is the Monetary Amount overridden by the
member.
String
Override Reason
Member should mention Override Points when Override flag

given is Y and the payment mode selected is Points or Points
+ Pay.
String
Override Reason Code,

Override Flag is Y.
String
Payment Mode
Override Reason Code is to be mentioned if the Override

Flag is Y.
String
Point Type
Payment mode as Points or Points + Pay or Pay. It is a

mandatory input.
String
Response Message Description: LoungePurchaseService

Table 227. Response Message Description: LoungePurchaseService
Node
Description
Type
Error Message
String
Order Id
Order Id of the Lounge Purchase Service is given.
String
Quote Id
Quote Id of the Lounge Purchase Service is given.
String

String
142
Table 227. Response Message Description: LoungePurchaseService

Node
Description
Type
Response Message given by Siebel Order Management after

String
Transaction Number
Transaction Number of the Lounge Purchase Service is

String
Request Message Description: RenewMembershipService

Table 228. Request Message Description: RenewMembershipService
Node
Description
Type
Member Number
Membership Number.
String
Membership Scheme

String
Billing Address
Membership Scheme to which the member wants to be

renewed is to be given. It is a mandatory input.
String
Billing Address2

String
Billing City
Secondary member billing address. It is required if the

payment involves monetary currency and Credit Card.
String
Billing Country

String
Billing State

String
Billing ZipCode

String
CVV Number

String
Card Holder Name

payment involves monetary currency and Credit Card details
are mentioned.
String
Credit Card Number

monetary currency.
String
Credit Card Type

monetary currency.
String
Currency

String
14 3
Table 228. Request Message Description: RenewMembershipService

Node
Description
Type
Expiration Month

String
Expiration Year

String
Override Flag

String
Override Pay

String
Override Points

String
Override Reason
Member should mention Override Points when Override flag

given is Y and the payment mode selected is Points or Points +
Pay.
String
Override Reason Code

Override Flag is Y.
String
Payment Mode
Override Reason Code is to be mentioned if the Override Flag

is Y.
String
Payment mode as Points or Points + Pay or Pay. It is a

mandatory input.
String
Point Type
Response Message Description: RenewMembershipService

Table 229. Response Message Description: RenewMembershipService
Node
Description
Type
Error Message
String
Order Id
Order Id of the Renew Membership Service is given.
String
Quote Id
Quote Id of the Renew Membership Service is given.
String

String

String
Transaction Number
Transaction Number of the Renew Membership Service is

String
144
Request Message Description: MembershipCancellationService

Table 230. Request Message Description: MembershipCancellationService
Node
Description
Type
Member Number
Membership number of the member whose membership

has to be cancelled is given here. It is a mandatory input.
String
Fee Refund Basis
Fee refund basis is the mandatory input. Prorata or

Percentage or NoRefund can be given here.
String
Refund Percentage
Refund percentage is to be given if the selected fee refund

basis is Percentage.
String
Cancellation Reason
Reason for the membership cancellation is to be

mentioned here.
String
Cancellation Reason Code
Membership Cancellation Reason Code is to be given. It is

a mandatory input.
String
Credit Card Number
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.
String
Credit Card Type
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.
String
Expiration Month
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.
String
Expiration Year
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.
String
Override Flag
It is a mandatory input. If the member wants to override

the Refund Price details, input would be Y, else it would be
N.
String
Override Pay
Member should mention Override Pay when Override flag

given is Y. It is the Refund amount overridden by the
member.
String
14 5
Table 230. Request Message Description: MembershipCancellationService

Node
Description
Type
Override Reason
Reason for overriding price is mentioned here.
String
Override Reason Code is to be given if the Override Flag

is Y.
String
Response Message Description: MembershipCancellationService

Table 231. Response Message Description: MembershipCancellationService
Node
Description
Type
Currency
Currency in which the fee is refunded is given as output.
String
Error Message
String
Order Id
Refund Order Id of the Membership Cancellation Service is

given.
String
Quote Id
Refund amount is given in the output.
String
Refund Amount
Response code given by Siebel Order Management after

String

String
Transaction number of the Membership Cancellation is

mentioned.
String
Transaction Number
Currency in which the fee is refunded is given as output.
String
Request Message Description: GetMemberServicePrice

Table 232. Request Message Description: GetMemberServicePrice
Node
Description
Type
Member Number
Membership number of the member who wants to get

member service price details is to be given here.
String
Currency Code
Currency code is to be given if the member wants to get

price lists in the given currency only.
String
Lounge Period Duration
Lounge Period Duration is to be given if the Transaction

Sub Type is Lounge Purchase.
String
Lounge Period Type
Lounge Period Type (Months or Years etc) is to be given if

the Transaction Sub Type is Lounge Purchase.
String
146
Table 232. Request Message Description: GetMemberServicePrice

Node
Description
Type
Point Type
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.
String
Points Qty
Number of Points to be given if the Transaction Sub Type

is Purchase Points or Transfer Points.
String
Selected Membership
Scheme
Membership Scheme is to be mentioned in the input if the

Transaction Sub Type is Membership Renewal.
String
Transaction Sub Type
Member Service Type (Points Purchase/Transfer Points/

Membership Renewal/Lounge Purchase) is to be
mentioned. It is a mandatory input.
String
Response Message Description: GetMemberServicePrice

Table 233. Response Message Description: GetMemberServicePrice
Node
Description
Type
Integration Object of the

Pricelists
List of price lines, after applying the promotions on the

base prices, are given in the out put as XML file.
Integration
Object
Request Message Description: MemberInquiry

Table 234. Request Message Description: MemberInquiry
Node
Description
Type
Member Number
Membership Number of the member whose details are to be

inquired is given.
String
Email Address
Email address of the member whose details are to be inquired is

given.
String
First Name
First name of the member whose details are to be inquired is given.
String
Last Name
Last name of the member whose details are to be inquired is given.
String
Middle Name
Middle name of the member whose details are to be inquired is

given.
String
Telephone Number
Telephone number of the member whose details are to be inquired

is given.
String
Transaction Type
Transaction type is given to query on the given type of transactions

done by the member.
String
ZIP Code
ZIP code of the member whose details are to be inquired is given.
String
14 7
Response Message Description: GetMemberServicePrice

Table 235. Response Message Description: GetMemberServicePrice
Node
Description
Type
Siebel Message (Integration Object

of the LOY Member Inquiry)
Member details are given in the

Integration Object and can be
extracted as XML file.
Integration
Object
Example Package for LoyaltyMemberServices

Request (PurchasePointsService)
\LoyaltyMemberServices\PointPurchase_request.xml
Response (PurchasePointsService)
\LoyaltyMemberServices\PointPurchase_response.xml
Request (TransferPointsService)
\LoyaltyMemberServices\TransferPoints_request.xml
Response (TransferPointsService)
\LoyaltyMemberServices\TransferPoints_response.xml
Request (LoungePurchaseService)
\LoyaltyMemberServices\LoungePurchase_request.xml
Response (LoungePurchaseService)
\LoyaltyMemberServices\LoungePurchase_response.xml
148
Request (MembershipCancellationService)
\LoyaltyMemberServices\MembershipCancellationService_request.xml
Response (MembershipCancellationService)
\LoyaltyMemberServices\MembershipCancellationService_response.xml
Request (RenewMembershipService)
\LoyaltyMemberServices\RenewMembershipService_request.xml
Response (RenewMembershipService)
\LoyaltyMemberServices\RenewMembershipService_response.xml
Request (GetMemberServicePrice)
\LoyaltyMemberServices\GetServicePrice_request.xml
Response (GetMemberServicePrice)
\LoyaltyMemberServices\GetServicePrice_response.xml
Request (MemberInquiry)
\LoyaltyMemberServices\MemberInquiry_request.xml
Response (MemberInquiry)
\LoyaltyMemberServices\MemberInquiry_response.xml
Message Schema (WSDL) for LoyaltyMemberServices

14 9
Siebel 8.1 Primary Web Services LoyaltyRedemptionService

\LoyaltyMemberService\LoyaltyMemberServices.wsdl
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
Table 236. LoyaltyRedemptionService Operations
Name
Description
GetPriceOptions
Returns available price options for a set of redemption activities.

Also returns the point balance of the member in all point types.
CheckPriceOptions

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

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.
GetTransactionDetails
Takes as input an Order Number and returns the Transaction

details (including activities and Transaction Items if any) for the
same.
GetRedemptionRefund
Returns the refund in Points or Points plus Pay for a given

redemption transaction, which need to be cancelled.
150
Table 236. LoyaltyRedemptionService Operations

Name
Description
CancelRedemptionTxn
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.
GetReissueFeeOptions
Returns the different fee options for reissuing the given voucher.
CheckReissueFeeOption
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.
GetReissueQuote
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.
ProcessReissueQuote
Takes as input Quote Id, creates Order for Quote, and creates a
Loyalty Voucher Reissue transaction and processes it to reissue
the voucher.
UpdateQuoteShippingAddress
Takes Quote Id and shipping details and updates the quote with
the given shipping address.
AddCreditCardToQuote
Takes Quote Id, credit card details, billing address and updates
the quote with the credit card details.
Request Message Description: GetPriceOptions

Table 237. Request Message Description: GetPriceOptions
Node
Description
Type
LOY Redemption Txn
Contains the redemption activity details.
Integration Object (Required)
Response Message Description: GetPriceOptions

Table 238. Response Message Description: GetPriceOptions
Node
Description
Type
LOY Redemption Txn
Contains the redemption activity details

and the price options for each activity.
Integration Object
(Required)
LOY Redemp Points

Summary
Contains point balances of the member

in all point types.
Integration Object
(Required)
15 1
Request Message Description: CheckPriceOptions

Table 239. Request Message Description: CheckPriceOptions
Node
Description
Type
LOY Redemption Txn
Integration Object
(Required)
Response Message Description: CheckPriceOptions

Table 240. Response Message Description: CheckPriceOptions
Node
Description
Type
LOY Redemption Txn
Contains the redemption activity details and one price

option for each activity.
Integration
Object
LOY Redemp Points

Summary
Point Summary for each point type including points to be

paid, point balance, loan (if any) and Points to Pay
Conversion flag.
Integration
Object
Pay
Total amount to be paid if monetary payment is involved.
Number
Pay Currency Code
Currency if monetary payment is involved.
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
Description
Type
MemberNumber
Membership number.
String
PointTypeId
Id number for point type.
String
PointsReq
The required number of points.
Number
LoanFlag
Indicates whether loan limit should be considered.
String
152
Response Message Description: CheckCredit

Table 242. Response Message Description: CheckCredit
Node
Description
Type
CCResult
Required
String
Available Balance
Required
String
EligLoan
Number
Error Message
String
LoanAllowed
Required
String
LoanFlag
String
PointsShortage
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
Description
Type
LOY Redemption Txn
Integration
Object
Billing Address
Address of customer being billed.
String
Billing Address2
Second address, if necessary of customer being billed.
String
Shipping Method
Shipping method, such as Ground, Air or carrier name.
String
Ship To Street Address
Shipping street address.
String
Ship To Street Address 2
Second shipping street address if needed.
String
Ship To State
Shipping state.
String
Ship To Postal Code
Shipping postal code.
String
Ship To Country
Shipping Country.
String
Billing City
Billing city, if different from shipping address.
String
Billing Country
Billing country, if different from shipping address.
String
Billing State
Billing state, if different from shipping address.
String
Billing ZipCode
Billing ZIP code, if different from shipping address.
String
CVV Number
String
15 3
Table 243. Request Message Description: GetQuote

Node
Description
Type
Card Holder Name
Name of credit card holder.
String
Credit Card Expiration

Month
Expiration date of credit card.
String

Year
Expiration year of credit card.
String
Credit Card Line Number
Credit card line number.
String
Credit Card Number
Credit card number.
String
Credit Card Type
Credit cards type, such as Visa, American Express, and

so on.
String
Recipient Name
Name of person who will receive shipped goods.
String
Save Shipping Address

Flag
Check to save shipping address for future use.
String
Select Primary Shipping

Address Flag
Flag to indicate primary address for account.
String
Ship To Address Id
String
Ship To City
String
Response Message Description:GetQuote

Table 244. Response Message Description:GetQuote
Node
Description
Type
LOY Redemption Txn
Contains the redemption activity details and one price

option for each activity.
Integration
Object
LOY Redmp Points

Summary
Point Summary for each point type including points to be

paid, point balance, loan (if any) and Points to Pay
Conversion flag.
Integration
Object
Currency Code
Code to indicate which currency being used for

transation.
String
Shipping Charge
Shipping charge for transaction.
String
Quote Id
Id of quote that is created.
String
Pay
Total amount of transaction.
Number
Tax
Total taxed charged on transaction.
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.
Table 245. Request Message Description: ProcessQuote
Node
Description
Type
Quote Id
String
Required
Response Message Description: Process Quote

Table 246. Response Message Description: Process Quote
Node
Description
Status
Order Id
Type
String
Required
String
Request Message Description: GetTransactionDetails

Table 247. Request Message Description: GetTransactionDetails
Node
Description
Type
Order Number
Required
String
Response Message Description: GetTransactionDetails

Table 248. Response Message Description: GetTransactionDetails
Node
Description
Type
LOY Redemption Txn
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.
Integration
Object.
15 5
Request Message Description: GetRedemptionRefund

This operation returns the refund amount for given redemption transaction, which is then cancelled.
Table 249. Request Message Description: GetRedemptionRefund
Node
Description
Type
Transaction Id
Required
String
Response Message Description: GetRedemptionRefund

Table 250. Response Message Description: GetRedemptionRefund
Node
Description
Pay
Type
String
Point Type
Required
String
Points
Required
String
Currency
Payment Type
String
Required
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
Table 251. Request Message Description: CancelRedemptionTxn
Node
Description
Type
Override Expiry Date
String
Override Expiry Date Flag
String
Override Pay
String
Override Points
String
Override Price Flag
String
Transaction Id
Required

Payment Mode
String
String
Required
String
Simulate Pay
String
Override Reason
String
156
Response Message Description:CancelRedemptionTxn

Table 252. Response Message Description:CancelRedemptionTxn
Node
Description
Type
New Txn Id
Id of the cancellation transaction.
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
Description
Currency Code
Voucher Id
String
Required
Point Type Id
Payment Type Code
Type
String
String
Required
String
Response Message Description:GetReissueFeeOptions

Table 254. Response Message Description:GetReissueFeeOptions
Node
Description
Type
Product Point Id
Required
String
Fee Points
Number
Fee Amount
Number
Error Message
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
Table 255. Request Message Description: GetReissueQuote
Node
Description
Type
Voucher Id
Required
String
Currency Code
String
15 7

Node
Description
Type
Payment Type Code
Required
String
Point Type Id
String
Override Amount
Number
Override Flag
String
Override Points
Number
Override Reason
String
String
Billing Address
String
Billing Address2
String
Shipping Method
String
Ship To Street Address 2
String
Ship To Street Address
String
Ship To State
String
Ship To Postal Code
String
Ship To Country
String
Billing City
String
Billing Country
String
Billing State
String
Billing ZipCode
String
CVV Number
String
Card Holder Name
String

Month
String

Year
String
Credit Card Number
String
Credit Card Type
String
Recipient Name
String
Save Shipping Address

Flag
String
Select Primary Shipping

Address Flag
String
158

Node
Description
Type
Ship To Address Id
String
Ship To City
String
Response Message Description: GetReissueQuote

Table 256. Response Message Description: GetReissueQuote
Node
Description
Currency Code
Quote Id
Type
String
Required
String
Error Message
String
Fee Amount
Number
Fee Points
Number
Shipping Charge
String
Tax Amount
String
Currency Code
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
Table 257. Request Message Description: ProcessReissueQuote

Node
Description
Type
Quote Id
Required
String
Response Message Description: ProcessReissueQuote

Table 258. Response Message Description: ProcessReissueQuote
Node
Description
Type
Transaction Number
Required
String
Order Number
Required
String
New Voucher Expiry Date
Required
Date
15 9
Table 258. Response Message Description: ProcessReissueQuote

Node
Description
Type
New Voucher Number
Required
String
New Voucher Status
Required
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
Description
Type
Quote Id
Required
String
Response Message Description: UpdateQuoteShippingAddress

Table 260. Response Message Description: UpdateQuoteShippingAddress
Node
Description
Type
Shipping Charge
Required
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
Description
Type
Billing Address
Required
String
Billing Address 2
String
Billing City
String
Billing Country
Required
String
Billing ZipCode
String
CVV Number
Number
Card Holder Name
String
Credit Card Number
Number
Credit Card Type
String
Expiration Month
String
Expiration Year
String
160
Response Message Description: GetReissueQuote

There are no response messages for this operation.
Example Packages for LoyaltyRedemptionService

Request (GetPriceOptions)
\LoyaltyRedemptionService\GetPriceOptions_request.xml
Response (GetPriceOptions)
\LoyaltyRedemptionService\GetPriceOptions_response.xml
Request (CheckPriceOptions)
\LoyaltyRedemptionService\CheckPriceOptions_request.xml
Response (CheckPriceOptions)
\LoyaltyRedemptionService\CheckPriceOptions_response.xml
Request (CheckCredit)
\LoyaltyRedemptionService\CheckCredit_request.xm
Response (CheckCredit)
\LoyaltyRedemptionService\CheckCredit_response.xml
Request (GetQuote)
\LoyaltyRedemptionService\GetQuote_request.xml
16 1
Response (GetQuote)
\LoyaltyRedemptionService\GetQuote_response.xml
Request (ProcessQuote)
\LoyaltyRedemptionService\ProcessQuote_request.xml
Response (ProcessQuote)
\LoyaltyRedemptionService\ProcessQuote_response.xml
Request (GetTransactionDetails)
\LoyaltyRedemptionService\GetTransactionDetails_request.xml
Response(GetTransactionDetails)
\LoyaltyRedemptionService\GetTransactionDetails_response.xml
Request (GetRedemptionRefund)
\LoyaltyRedemptionService\GetRedemptionRefund_request.xml
Response (GetRedemptionRefund)
\LoyaltyRedemptionService\GetRedemptionRefund_response.xml
Request (CancelRedemptionTxn)
\LoyaltyRedemptionService\CancelRedemptionTxn_request.xml
Response (CancelRedemptionTxn)
\LoyaltyRedemptionService\CancelRedemptionTxn_response.xml
162
Request (GetReissueFeeOptions)
\LoyaltyRedemptionService\GetReissueFeeOptions_request.xml
Response(GetReissueFeeOptions)
\LoyaltyRedemptionService\GetReissueFeeOptions_response.xml
Request (GetReissueQuote)
\LoyaltyRedemptionService\GetReissueQuote_request.xml
Response (GetReissueQuote)
\LoyaltyRedemptionService\GetReissueQuote_response.xml
Request (ProcessReissueQuote)
\LoyaltyRedemptionService\ProcessReissueQuote_request.xml
Response(ProcessReissueQuote)
\LoyaltyRedemptionService\ProcessReissueQuote_response.xml
Request (UpdateQuoteShippingAddress)
\LoyaltyRedemptionService\UpdateQuoteShippingAddress_request.xml
Response (UpdateQuoteShippingAddress)
\LoyaltyRedemptionService\UpdateQuoteShippingAddress_response.xml
Request (AddCreditCardToQuote)
\LoyaltyRedemptionService\AddCreditCardToQuote_request.xml
16 3
Siebel 8.1 Primary Web Services LoyaltyVoucherService
Response (AddCreditCardToQuote)
\LoyaltyRedemptionService\AddCreditCardToQuote_response.xml
Message Schema (WSDL) for LoyaltyRedemptionService

\LoyaltyRedemptionService\LoyaltyRedemptionService.wsdl
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
Table 262. LoyaltyVoucherService Operations
Name
Description
VoucherStatusChange
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
Description
Type
Voucher Number
Required
String
Activity Date
Required
String
Member Number
Required
String
Partner Id
Required
String
164
Siebel 8.1 Primary Web Services LoyaltyVoucherService
Response Message Description: VoucherValidityCheck

Table 264. Response Message Description: VoucherValidityCheck
Node
Description
Type
Valid Flag
Required
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
Description
Type
Voucher Number
Optional
String
Member Number
Required
String
Partner Name
Required
String
Activity Date
Required
String
Order Number
Optional
Number
Response Message Description: VoucherStatusChange

Table 266. Response Message Description: VoucherStatusChange
Node
Description
Type
Voucher Number
Optional
String
Order Number
Optional
Number
Voucher Type
Required
String
Return Value
Required
String
Example Package for LoyaltyVoucherService

Request
\LoyaltyVoucherService\LoyaltyVoucherService_request.xml
16 5
Siebel 8.1 Primary Web Services MktgDeduplicationService
Response
\LoyaltyVoucherService\LoyaltyVoucherService_request.xml
Message Schema (WSDL) for LoyaltyVoucherService

\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

Table 267. Mktg Deduplication Service Operations
Node
Description
MktgDeduplicationServiceMatchAccount
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.
MktgDeduplicationServiceMatchOpportunity
Matches the opportunities.
MktgDeduplicationServiceMatchProspect
Matches the prospects.
MktgDeduplicationServiceMatchContact
Matches the contacts.
Request Message Description: MktgDeduplicationServiceMatchAccount

Table 268. Request Message Description: MktgDeduplicationServiceMatchAccount
Node
Description
DUNS Number
Type
String
Name
Account name.
String
Primary Account City
City name.
String
Primary Account Country
Country name.
String
166
Table 268. Request Message Description: MktgDeduplicationServiceMatchAccount

Node
Description
Type
Primary Account Postal Code
City postal code.
String
Primary Account State
State.
String
Primary Account Street Address
Street address of primary account.
String
Response Message Description: MktgDeduplicationServiceMatchAccount

Table 269. Response Message Description: MktgDeduplicationServiceMatchAccount
Node
Description
Type
HasMatch
Output String as hasMatch or hasNoMatch.
String
Match Info
Score of the match and row id of the matchee.
Integration Object
Response Message Description: MktgDeduplicationServiceMatchOpportunity

Table 270. Response Message Description: MktgDeduplicationServiceMatchOpportunity
Node
Description
Type
Account Id
Opportunitys account Id.
String
Business Unit Id
Opportunitys business unit Id.
String
Name
Opportunitys name.
String
Response Message Description: MktgDeduplicationServiceMatchOpportunity

Table 271. Response Message Description: MktgDeduplicationServiceMatchOpportunity
Node
Description
Type
HasMatch
String
Match Info
Integration Object
16 7
Request Message Description: MktgDeduplicationServiceMatchProspect

Table 272. Request Message Description: MktgDeduplicationServiceMatchProspect
Node
Description
Type
Account
Account name of prospect.
String
Phone
Phone number of prospect.
String
City
Prospects city.
String
Country
Prospects country.
String
Email Address
Prospects email address.
String
First Name
Prospects first name.
String
Home Phone #
Prospects home phone number.
String
Last Name
Prospects last name.
String
Middle Name
Prospects middle name.
String
Primary Postal Code
Postal code.
String
Social Security Number
Prospects social security number.
String
State
Prospects state of residence.
String
Street Address
Prospects street address.
String
Work Phone #
Prospects work phone number.
String
Response Message Description: MktgDeduplicationServiceMatchProspect

Table 273. Response Message Description: MktgDeduplicationServiceMatchProspect
Node
Description
Type
HasMatch
String
Match Info
Integration Object
Request Message Description: MktgDeduplicationServiceMatchContact

Table 274. Request Message Description: MktgDeduplicationServiceMatchContact
Node
Description
Type
Account
Account name of contact.
String
Birth Date
Contacts birth date.
String
Phone
Contacts phone number.
String
168
Table 274. Request Message Description: MktgDeduplicationServiceMatchContact

Node
Description
Type
City
Contacts city of residence.
String
Country
Contacts country of residence.
String
Email Address
Contacts email address.
String
First Name
Contacts first name.
String
Home Phone #
Contacts home phone number.
String
Last Name
Contacts last name.
String
Middle Name
Contacts middle name.
String
Primary Postal Code
Contacts primary postal code.
String
Social Security Number
Contacts social security number.
String
State
Contacts state of residence.
String
Street Address
Contacts street address.
String
Work Phone #
Contacts work phone number.
String
Response Message Description: MktgDeduplicationServiceMatchContact

Table 275. Response Message Description: MktgDeduplicationServiceMatchContact
Node
Description
Type
HasMatch
String
Match Info
Integration Object
MktgImportDeduplicationService Application Interface

Technology Network.

Table 276. MktgImportDeduplicationService Data Object
External Name
Mktg Deduplication
Mktg Deduplication
16 9
Example Package for MktgDeduplicationService

Request (MatchAccount)
\MktgDeduplicationService\MatchAccount_request.xml
Response (MatchAccount)
\MktgDeduplicationService\MatchAccount_response.xml
Request (MatchOpportunity)
\MktgDeduplicationService\MatchOpportuntity_request.xml
Response (MatchOpportunity)
\MktgDeduplicationService\MatchOpportuntity_response.xml
Request (MatchProspect)
\MktgDeduplicationService\MatchProspect_request.xml
Response (MatchProspect)
\MktgDeduplicationService\MatchProspect_response.xml
Request (MatchContact)
\MktgDeduplicationService\MatchContact_request.xml
Response (MatchContact)
\MktgDeduplicationService\MatchContact_response.xml
170
Siebel 8.1 Primary Web Services MktgImportService
Message Schema (WSDL) for Mktg Deduplication Service

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

Table 277. Mktg Import Service Operations
Node
Description
MktgImportServiceInvokeImportJob
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
Description
Type
ImportJobParams
Required. An instance of the integration

object Import Job Integration Object.
Integration Object
Response Message Description: MktgImportServiceInvokeImportJob

Table 279. Response Message Description: MktgImportServiceInvokeImportJob
Node
Description
Type
ErrorCode
OK or NOTOK
String
Error Message
Error message (if any)
String
17 1
Siebel 8.1 Primary Web Services MktgImportService
Mktg Import Service Application Interface

Technology Network.

Table 280. Mktg Import Service Service Object
Name
Mktg System Task Service
Business Service
CSSSystemTaskService

Table 281. Mktg Import Service Data Object
External Name
Example Package for MktgImportService

Request
\MktgImportService\MktgImportServiceInvokeImportJob_request.xml
Response
\MktgImportService\MktgImportServiceInvokeImportJob_response.xml
Message Schema (WSDL) for Mktg Import Service

\MktgImportService\MktgImportService.wsdl
172
Siebel 8.1 Primary Web Services 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
Table 282. OrderDetailWebService Operations
Name
Description
OrderDetailQueryPage
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.
OrderDetailUpdate
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.
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.
Table 283. Request Message Description: OrderDetailQueryPage
Node
Description
Type
OrderDetailQueryPage_Input
The method arguments are Orders IO with

query parameters set, Language Mode
(value is LDC) and viewMode (All).
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
Description
Type
OrderDetailQueryPage_Output
The retrieved data for the query set on

the view criteria and searchspec.
Integration Object
17 3
Siebel 8.1 Primary Web Services OrderDetailWebService
Request Message Description: OrderDetailUpdate

Table 285. Request Message Description: OrderDetailUpdate
Node
Description
Type
OrderDetailUpdate_Input
The method arguments are Orders IO with parameters set,

Language Mode (value is LDC) and viewMode (All).
Integration
Object
Response Message Description: OrderDetailUpdate

Table 286. Response Message Description: OrderDetailUpdate
Node
Description
Type
OrderDetailUpdate_Output
The retrieved data for the update operation performed.
Integration
Object
OrderDetailWebService Application Interface

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.

Table 287. OrderDetailWebService Service Object
Name
Class
PDS Order Detail
Integration Object
CSSEAIUIDataService

Table 288. OrderDetailWebService Data Object
External Name
PDS Order Detail
PDS Simplified Order
Example Package for OrderDetailWebService

174
Siebel 8.1 Primary Web Services PDSOrderHeader
Request
\OrderDetailWebService\OrderDetailWebService_request.xml
Response
\OrderDetailWebService\OrderDetailWebService_response.xml
Message Schema (WSDL) for OrderDetailWebService

\OrderDetailWebService\OrderDetailWebService.wsdl
PDSOrderHeader
Use this Web service to get header information for specific open orders.
PDSOrderHeader Operations
Table 289. PDSOrderHeader Operations
Name
Description
PDSOrderHeaderQueryPage
Get the header information of open orders for a specific asset.
Request Message Description: PDSOrderHeaderQueryPage

Table 290. Request Message Description: PDSOrderHeaderQueryPage
Node
Description
Type
PDSOrderHeaderQueryPage_Input
The request message includes the search

criteria for order status and asset integration
Id.
ComplexType
17 5
Siebel 8.1 Primary Web Services PriceListsWS
Response Message Description: PDSOrderHeaderQueryPage

Table 291. Response Message Description: PDSOrderHeaderQueryPage
Node
Description
Type
PDSOrderHeaderQueryPage_Output
The response message includes list of

order headers matching the search criteria.
ComplexType
Example Package for PDSOrderHeader

Request
\PDSOrderHeader\PDSOrderHeader_request.xml
Response
\PDSOrderHeader\PDSOrderHeader_response.xml
Message Schema (WSDL) for PDSOrderHeader

\PDSOrderHeader\PDSOrderHeader.wsdl
PriceListsWS
Use this Web service to obtain price lists based on defined search specifications.
PriceListsWS Operations
Table 292. PriceListsWS Operations
Node
Description
GetPriceLists
Get all the price lists based on search spec.
176
Siebel 8.1 Primary Web Services PriceListsWS
Request Message Description: GetPriceLists

Table 293. Request Message Description: GetPriceLists
Node
Description
Type
GetPriceLists_Input
Request message includes the search spec.
ComplexType
Response Message Description: GetPriceLists

Table 294. Response Message Description: GetPriceLists
Node
Description
Type
GetPriceLists_Output
Response message includes the price

lists matching the search spec.
ComplexType
Example Package for PriceListsWS

Request
\PriceListsWS\PriceListsWS_request.xml
Response
\PriceListsWS\PriceListsWS_response.xml
Message Schema (WSDL) for PriceListsWS

\PriceListsWS\PriceListsWS.wsdl
17 7
Siebel 8.1 Primary Web Services 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.
ProcessSalesOrderSiebelJMSProducer Operations
Table 295. ProcessSalesOrderSiebelJMSProducer Operations
Operation Name
Description
Process
Submits a sales order to the billing application and creates a customer

account, if needed, in the billing application.
Request Message Description: Process

Table 296. Request Message Description: Process
Node
Description
Order
The details of the header for the order.
OrderItem
The details of the order item.
OrderItemXA
The properties of the order item.
ProcessSalesOrderSiebelJMSProducer Application Interface

Technology Network.

Table 297. ProcessSalesOrderSiebelJMSProducer Service Object
Name
Business Service
178
Siebel 8.1 Primary Web Services ProcessSalesOrderSiebelJMSProducer

Table 298. ProcessSalesOrderSiebelJMSProducer Data Object
External Name
PDS Order - No Hierarchy
Methods
Table 299. ProcessSalesOrderSiebelJMSProducer Methods
Operation
Method
process
[BS: ProcessSalesOrderSiebelJMSProducer].process
Example Package for ProcessSalesOrderSiebelJMSProducer

Request
...\ProcessSalesOrderSiebelJMSProducer\ProcessSalesOrderSiebelJMSProducerRequest
Message.xml
Response
...\ProcessSalesOrderSiebelJMSProducer\ProcessSalesOrderSiebelJMSProducerResponse
Message.xml
Message Schema (WSDL) for ProcessSalesOrderSiebelJMSProducer

...\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.
Product Import Operations

Table 300. Product Import Operations
Operation Name
Description
Product Import Insert
This operation:
Product Import Update
Product Import Upsert
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.
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.
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.
Request Message Description: Product Import Insert

Table 301. Request Message Description: Product Import Insert
Node
Description
SiebelMessage
The Siebel message for the integration object of CMU Product Integration.
180
Request Message Description: Product Import Update

Table 302. Request Message Description: Product Import Update
Node
Description
SiebelMessage
Request Message Description: Product Import Upsert

Table 303. Request Message Description: Product Import Upsert
Node
Description
SiebelMessage
Application Interface for Product Import

Technology Network.

Table 304. Product Import Service Object
Name
Product Import
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
Value
Comment
Data Sync Service
EAI Siebel Adapter
EAI Adapter service that

is invoked.
Data Sync Service:

Attribute
CMU Attribute
Integration Object
name for data sync
service. Currently not
supported.
Data Sync Service: Class
CMU Product Class
Integration Object
name for data sync
service. Currently not
supported.
Data Sync Service:

Product
CMU Product
Integration Object
name for data sync
service.
Data Sync Service:

Workspace
CMU Joint Workspace
Integration Object
name for data sync
service.
Definition Business
Component
CMU Product Definition VBC
See the first note after

this table.
Definition Business
Object
CMU Admin ISS Product Definition

this table.
Detail Business
Component
CMU ISS Product Details BusComp

this table.
Integration Field Map:

Auto Explode Flag
Product|CMU Internal Product VOD|

Auto Explode Flag
See the second note

after this table.

Billable Flag

Billable Flag
See the second note

after this table.

Billing Service Type

Billing Service Type
See the second note

after this table.

Billing Type

Billing Type
See the second note

after this table.

Business Unit Id

Primary Organization Id
See the second note

after this table.

Check Eligibility Flag

Pre Pick CD
See the second note

after this table.

Description

Description
See the second note

after this table.
182

Name
Value
Comment

Effective End Time

End Date
See the second note

after this table.

Effective Start Time

Start Date
See the second note

after this table.

Inclusive Eligibility Flag

Inclusive Eligibility Flag
See the second note

after this table.

Orderable Flag

Orderable
See the second note

after this table.

Price Type

Price Type
See the second note

after this table.

Product Id

Id
See the second note

after this table.

Product Name

Name
See the second note

after this table.

Product Type

Product Type Code
See the second note

after this table.

Sales Product Flag

Sales Product Flag
See the second note

after this table.

Service Instance Flag

Service Instance
See the second note

after this table.

Service Product Flag

Sales Service Flag
See the second note

after this table.

Structure Type

Product Def Type Code
See the second note

after this table.

Track As Asset Flag

Track As Asset Flag
See the second note

after this table.

Type

Type
See the second note

after this table.

Unit of Measure

Unit of Measure
See the second note

after this table.

Vendor Id

Vendor Id
See the second note

after this table.
Integration Object:
External
CMU Product Integration

this table.
Integration Object:
Product
CMU Admin ISS Product Definition

this table.
18 3

Name
Value
Comment
Integration Object:
Product Structure
CMU Admin ISS Product Structure

this table.
Integration Object:
Workspace
CMU Admin ISS Joint Workspace Definition

this table.
Preset Value: CMU

Attribute VOD BusComp
VOD Type:ISS_ATTR_DEF

this table.
Preset Value: CMU

Attribute Versions
BusComp
Version:1

this table.
Preset Value: CMU ISS

Product Attribute
BusComp
Last Version:0

this table.

Product Details
BusComp
Last Version:0

this table.

Product Structure Admin
BusComp
Last Version:0

this table.

Product VOD BusComp
VOD Type:ISS_PROD_DEF

this table.

Product Versions
BusComp
Released Flag:N

this table.
Preset Value: CMU

Internal Product
Organization
Organization Id:

this table.
Product Business
Component
CMU Internal Product VOD

this table.
Required Integration
Component 1
CMU Attribute Versions BusComp

this table.
Component 2
CMU ISS Product VOD BusComp

this table.
Component 3
CMU ISS Product Versions BusComp

this table.
Component 4
CMU ISS Product Details BusComp

this table.
Component 5
CMU Internal Product Organization

this table.
184

Name
Value
Comment
Structure Business
Component
CMU Product Structure VBC

this table.
Structure Internal
Business Component
CMU ISS Product Structure Admin BusComp

this table.
Version Business
Component
CMU ISS Product Versions BusComp

this table.
Workspace Business
Component
CMU ISS Joint Workspace BusComp

this table.
Workspace Business
Object
CMU Admin ISS Joint Workspace Definition

this table.
Workspace Object
Business Component
CMU ISS Joint Workspace Object BusComp

this table.
Workspace Project
Business Component
ISS Joint Workspace BusComp

this table.
Workspace Project
Business Object
Admin ISS Joint Workspace Definition

this table.
Workspace Project Item

Business Component
ISS Joint Workspace VOD Pick BusComp

this table.
Workspace Project Lock

Business Component
ISS Joint Workspace VOD Lock BusComp

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.

Table 306. Product Import Data Object
External Name
18 5
Siebel 8.1 Primary Web Services ProductSearchService
Methods
Table 307. Product Import Methods
Operation
Method
Product Import Insert
[BS: Product Import].Insert
Product Import Update
[BS: Product Import]. Update
Product Import Upsert
[BS: Product Import]. Upsert
Example Package for Product Import

Request
...\ProductImport\ProductImport_request.xml
Response
...\ProductImport\ProductImport_response.xml
Message Schema for Product Import

...\ProductImport\Product Import.wsdl
Business Service (Search Product Service) for Searching Product Business Component and doing
eligibility check.
186
ProductSearchService Operations
Table 308. ProductSearchService Operations
Node
Description
Type
ExecuteSearch
Retrieve Products based

on passed criteria.
Input: SearchProductInputSiebelMessage
Output:
SearchProductResponseSiebelMessage
Request Message Description: QuoteCheckOut

Table 309. Request Message Description: QuoteCheckOut
Node
Description
Type
EligibilityMode
String
ABOFlag
String
AccountContractedProduc
tsOnlyFlag
String
AccountId
String
AccountType
Type of Account
ClassId
String
String
CurrencyCode
Currency code
String
DiscountPercent
Discount in percent
String
DisplayName
Display name
String
EligibilityDisplayMode
String
ExchangeDate
String
HeaderId
String
Mode
String
PriceListId
Price List Id
String
City
City name
String
PostalCode
Postal code
String
State
State name
String
Country
Country name
String
BusObjName
String
BusCompName
String
18 7

Node
Description
Type
SignalMode
String
ContextRowId
String
ContextMode
String
SearchText
Search Criteria
String
Hits
Records to be fetched
String
Threshold
String
Timeout
Timeout value
String
FromPrice
Price Range
String
ToPrice
Price Range
String
Attribute
Attribute name
String
Feature
String
Response Message Description: ExecuteSearch

Table 310. Response Message Description: ExecuteSearch
Node
Description
Type
TotalRecords
Total number of records retrieved.
String
ProductId
Product Id.
String
ProductSearchService Application Interface

Technology Network.

Table 311. ProductSearchService Service Object
Name
Class
SearchProductService
Business Service
CSSSrchProductSvc
188
Siebel 8.1 Primary Web Services QuoteCheckOutWebService

Table 312. ProductSearchService Data Object
External Name
Context
PDS Catalog Context
SearchProductInputSiebelMessage
SearchProductInputIO
SearchProductResponseSiebelMessage
SearchProductResponseIO
Example Package for ProductSearchService

Request
\ProductSearchService\ProductSearchService_request.xml
Response
\ProductSearchService\ProductSearchService_response.xml
Message Schema (WSDL) for ProductSearchService

\ProductSearchService\ProductSearchService.wsdl
Use this Web service to perform payment authorizations for quotes.
18 9
Siebel 8.1 Primary Web Services QuoteCheckOutWebService
QuoteCheckOutWebService Operations
Table 313. QuoteCheckOutWebService Operations
Node
Description
QuoteCheckOut
Performs the payment authorization. If the authorization fails, the

operation stops and returns. Otherwise, the quote is submited to order.
Request Message Description: QuoteCheckOut

Node
Description
Type
QuoteCheckOut_Input
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.
ComplexType
Response Message Description: QuoteCheckOut

Table 315. Response Message Description: QuoteCheckOut
Node
Description
Type
QuoteCheckOut_Output
The response message includes the Id of the

order converted from quote.
ComplexType
Example Package for QuoteCheckOutWebService

Request
\QuoteCheckOutWebService\QuoteCheckOutWebService_request.xml
Response
\QuoteCheckOutWebService\QuoteCheckOutWebService_response.xml
190
Siebel 8.1 Primary Web Services QuoteDetailWebService
Message Schema (WSDL) for QuoteCheckOutWebService

\QuoteCheckOutWebService\QuoteCheckOutWebService.wsdl
Use this Web service to retrieve, update, insert, or delete details on a quote record.
QuoteDetailWebService Operations
Table 316. QuoteDetailWebService Operations
Node
Description
QuoteDetailGet
Requests and retrieves quote detail.
QuoteDetailUpdate
Updates quote details.
QuoteDetailInsert
Inserts new quote detail.
QuoteDetailDelete
Deletes quote details.
QuoteDetailInit
Quote is initialized from database.
Request Message Description: QuoteDetailGet

Table 317. Request Message Description: QuoteDetailGet
Node
Description
Type
QuoteDetailGet_Input
Quote object passed to the Web service.

It includes the search criteria.
ComplexType
Response Message Description: QuoteDetailGet

Table 318. Response Message Description: QuoteDetailGet
Node
Description
Type
QuoteDetailGet_Output
Quote object returned. It includes the

detail of the quote header and the
payment information.
ComplexType
19 1
Request Message Description: QuoteDetailUpdate

Table 319. Request Message Description: QuoteDetailUpdate
Node
Description
Type
QuoteDetailUpdate_Input
Quote to be updated into database.
ComplexType
Response Message Description: QuoteDetailUpdate

Table 320. Response Message Description: QuoteDetailUpdate
Node
Description
Type
QuoteDetailUpdate_Output
Quote returned with updated

information.
ComplexType
Request Message Description: QuoteDetailInsert

Table 321. Request Message Description: QuoteDetailInsert
Node
Description
Type
QuoteDetailInsert_Input
Quote to be inserted into database.
ComplexType
Response Message Description: QuoteDetailInsert

Table 322. Response Message Description: QuoteDetailInsert
Node
Description
Type
QuoteDetailDelete_Output
Quote returned from Web service.
ComplexType
Request Message Description: QuoteDetailDelete

Table 323. Request Message Description: QuoteDetailDelete
Node
Description
Type
QuoteDetailDelete_Input
Quote to be deleted from database.
ComplexType
192
Response Message Description: QuoteDetailDelete

Table 324. Response Message Description: QuoteDetailDelete
Node
Description
Type
QuoteDetailDelete_Output
ComplexType
Request Message Description: QuoteDetailInit

Table 325. Request Message Description: QuoteDetailInit
Node
Description
Type
QuoteDetailInit_Input
Quote to be initialized from database.
ComplexType
Response Message Description: QuoteDetailInit

Table 326. Response Message Description: QuoteDetailInit
Node
Description
Type
QuoteDetailInit_Output
ComplexType
Example Package for QuoteDetailWebService

Request
\QuoteDetailWebService\QuoteDetailWebService_request.xml
Response
\QuoteDetailWebService\QuoteDetailWebService_response.xml
Message Schema (WSDL) for QuoteDetailWebService

19 3
Siebel 8.1 Primary Web Services QuotingWebService

\QuoteDetailWebService\QuoteDetailWebService.wsdl
QuotingWebService
Use this Web service to process quotes and commit them to the database.
QuotingWebService Operations
Table 327. QuotingWebService Operations
Name
Description
ExecuteQuoting
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

Table 328. Request Message Description: ExecuteQuoting
Node
Description
Type
ExecuteQuoting_Input
The request message includes the quote to be

saved. It also includes the following flags:
ComplexType
194
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.
Siebel 8.1 Primary Web Services QuotingWebService
Response Message Description: ExecuteQuoting

Table 329. Response Message Description: ExecuteQuoting
Node
Description
Type
ExecuteQuoting_Output
The response message includes the quote returned

from Web service.
ComplexType
QuotingWebService Application Interface

Technology Network.

Table 330. QuotingWebService Service Object
Name
Web Channel Quoting Workflow
Not applicable

Table 331. QuotingWebService Data Object
External Name
PDS Quote
PDS Simplified Quote
Example Package for QuotingWebService

Request
\QuotingWebService\QuotingWebService_request.xml
Response
\QuotingWebService\QuotingWebService_response.xml
19 5
Siebel 8.1 Primary Web Services Response
Message Schema (WSDL) for QuotingWebService

\QuotingWebService\QuotingWebService.wsdl
Response
Use this Web service for the basic Marketing operations such as creating and updating responses.
Response Operations
Table 332. Response Operations
Name
Description
ResponseCreateResponse
Creates a Response.
ResponseSourceCodeLookup
This operation is used to determine the campaign history record.
ResponseUpdateResponse
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
Description
Type
Response IO
Integration Object
Response Message Description: ResponseCreateResponse

Table 334. Response Message Description: ResponseCreateResponse
Node
Description
Response Id
Row Id of the new response.
Type
String
Error Message
String
Success Flag
Y or N.
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
Description
Type
Campaign Code
Campaign code of response source.
String
Campaign Id
Campaign Id of response source.
String
Offer Code
Offer code for response.
String
Offer Id
Offer Id for reponse.
String
Source Code
Source code for response.
String
Treatment Code
Treatment code for response.
String
Treatment Id
Treatment Id for response.
String
Response Message Description: ResponseSourceCodeLookup

Table 336. Response Message Description: ResponseSourceCodeLookup
Node
Description
Type
S_CAMP_CON_ID
Row Id of the response.
String
Error Message
String
Success Flag
Y or N.
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
Description
Type
Response IO
Integration
Object
Response Message Description: ResponseUpdateResponse

Table 338. Response Message Description: ResponseUpdateResponse
Node
Description
Type
Error Message
String
Success Flag
Y or N.
String
19 7
Example Package for Response

Request (ResponseCreateResponse)
\Response\ResponseCreateResponse_request.xml
Response (ResponseCreateResponse)
\Response\ResponseCreateResponse_response.xml
Request (ResponseSourceCodeLookup)
\Response\ResponseSourceCodeLookup_request.xml
Response (ResponseSourceCodeLookup)
\Response\ResponseSourceCodeLookup_response.xml
Request (ResponseUpdateResponse)
\Response\ResponseUpdateResponse_request.xml
Response (ResponseUpdateResponse)
\Response\ResponseUpdateResponse_request.xml
Message Schema (WSDL) for Response

\Response\Response.wsdl
198
Siebel 8.1 Primary Web Services 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
Parameters
Description
QueryPage
Input: Attachment Id
This retrieves the Attachment

content for a given attachment Id.
Output: AttachmentDocIO
(Attachment File Content)
Request Message Description: RetrieveAttachmentService

This fetches the Attachment content for a given attachment Id. For a description of this request
Table 340. Request Message Description: RetrieveAttachmentService
Node
Description
Type
Id
Document Id
String
ModId
Modification Id
String
ResFileAutoUpdFlg
Y or N
String
ResFileDate
File Date
String
ResFileDeferFlg
Y or N
String
ResFileDockReqFlg
Y or N
String
ResFileDockStatFlg
Y or N
String
ResFileDockStatus
Y or N
String
ResFileExt
File Extension
String
ResFileName
File Name
String
ResFileRev
File Id
String
ResFileSize
File Size
String
ResFileSrcPath
File Source Path
String
ResFileSrcType
File Source Type
String
ResFileBuffer
File Buffer
String
LOVLanguageMode
Language Independent code
String
19 9
Siebel 8.1 Primary Web Services RetrieveAttachmentService
Table 340. Request Message Description: RetrieveAttachmentService

Node
Description
Type
ExecutionMode
Execution Mode
String
ViewMode
Visibility Access Mode
String
Response Message Description: RetrieveAttachmentService

Table 341. Response Message Description: RetrieveAttachmentService
Node
Description
Type
Id
Document Id
String
ModId
Modification Id
String
ResFileAutoUpdFlg
Y or N
String
ResFileDate
File Date
String
ResFileDeferFlg
Y or N
String
ResFileDockReqFlg
Y or N
String
ResFileDockStatus
Y or N
String
ResFileExt
File Extension
String
ResFileName
File Name
String
ResFileRev
File Id
String
ResFileSize
File Size
String
ResFileSrcPath
File Source Path
String
ResFileSrcType
File Source Type
String
ResFileBuffer
File Buffer
String
RetrieveAttachmentService Application Interface

Technology Network.

Table 342. RetrieveAttachmentService Service Object
Name
Class
Business Service
CSSEAIUIDataService
200
Siebel 8.1 Primary Web Services searchSolution

Table 343. RetrieveAttachmentService Data Object
External Name
SiebelMessageIn
AttachmentDocIO
SiebelMessageOut
AttachmentDocIO
Example Package for RetrieveAttachmentService

Request
\RetrieveAttachmentService\RetrieveAttachmentService_request.xml
Response
\RetrieveAttachmentService\RetrieveAttachmentService_response.xml
Message Schema (WSDL) for RetrieveAttachmentService

\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
Parameters
Description
searchSolution.searchSolution
Input: SearchInputsIO (SearchText,

SolutionType, To, From).
Performs a search on
a solution based on
specified input.
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) ).
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
Description
Type
SearchText
Text to be searched.
String
SolutionType
Type of Solution.
String
From
Index of Record.
String
To
Index of Record.
String
Response Message Description: searchSolution

Table 346. Response Message Description: searchSolution
Node
Description
Type
TotalRecords
Total number of records fetched.
String
From
Index of the first record returned.
String
SolutionId
Solution Id.
String
SolutionTitle
Solution Title.
String
202
Table 346. Response Message Description: searchSolution

Node
Description
Type
LastUpdateDate
Last update date of the record.
String
To
Index of the last record fetched.
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
Description
Type
SolutionId
Solution Id
String
Response Message Description: getSolution

Table 348. Response Message Description: getSolution
Node
Description
Type
FAQ
Frequently Asked Question
String
LastUpdateDate
Last update date of the record
String
AttachmentId
Attachment ID
String
AttachmentType
Type of Attachment
String
Name
Name
String
ResolutionText
Resolution Text message
String
searchSolution Application Interface

Technology Network.

Table 349. searchSolution Service Object
Name
Class
Search Solution Service
Business Service
CSSSrchSolutionSvc
20 3
Siebel 8.1 Primary Web Services SelfServiceAccount

Table 350. searchSolution Data Object
External Name
SolutionResultSiebelMessage
SolutionResultIO
SearchInputsSiebelMessage
SearchInputsIO
SearchResultsSiebelMessage
SearchResultsIO
Example Package for searchSolution

Request
\searchSolution\searchSolution_request.xml
Response
\searchSolution\searchSolution_response.xml
Message Schema (WSDL) for searchSolution

\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
Table 351. SelfServiceAccount Operations
Name
Description
SelfServiceAccountExecute
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.
SelfServiceAccountQueryPage
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.
Request Message Description: SelfServiceAccountExecute

Table 352. Request Message Description: SelfServiceAccountExecute
Node
Description
SelfServiceAccountExecute_Input
Container element for the Execute Operation

request.
ListOfSSAccount
Corresponds to an instance of SS_Account_IO.
ListOfSSAccount/ Account
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.
ListOfSSAccount/ Account /Id
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.
ListOfSSAccount/ Account /
Container element to hold the list of business

addresses to be created or updated for the account.
ListOfAccountBusinessAddress
ListOfAccountBusinessAddress/
AccountBusinessAddress
AccountBusinessAddress/ Id
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.
20 5
Table 352. Request Message Description: SelfServiceAccountExecute

Node
Description
Set appropriate values for the details of this address.
AccountBusinessAddress/ StreetAddress
(Similarly StreetAddress2, AddressLine3,
State, City, County, Country)
AccountBusinessAddress/ MainAddressFlag
AccountBusinessAddress/ BillAddressFlag
AccountBusinessAddress/ ShipAddressFlag
AccountBusinessAddress/ ActiveStatus
Set to TRUE if the address is the main address for the

account.
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.
AccountBusinessAddress/ ModId
Set the ModId while updating, so as to make sure

that the record is not updated in the interim.
ExecutionMode
Refer to Siebel EAI.
LOVLanguageMode
ViewMode
Response Message Description: SelfServiceAccountExecute

Table 353. Response Message Description: SelfServiceAccountExecute
Node
Description
SelfServiceAccountExecute_Output
Container element for the Execute Operation response.
ListOfSSAccount
Id of the account.
ListOfSSAccount/ Account / Mod Id
Mod Id for the account record.
206
Table 353. Response Message Description: SelfServiceAccountExecute

Node
Description
Container element for the list of created or updated

business address of the account.
ListOfBusinessAddress
For each created or updated business address of the

account.
ListOfBusinessAddress/
BusinessAddress
Id of the address created or updated.
BusinessAddress/ Id
ModId of the address record created or updated.
BusinessAddress/ ModId
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
Description
SelfServiceAccountQueryPage_Input
Container element for the QueryPage Operation

request.
ListOfSSAccount
Set the Id of the aAccount as a ViewCriteria.
PrimaryAddressId
Empty; used to fetch the Id of the primary address

of the account.
PrimaryBillToAddressId
Empty; used to fetch the Id of the Primary Bill To

PrimaryShipToAddressId
Empty; used to fetch the Id of the Primary Ship To

To fetch the business address of the account.
20 7
Table 354. Request Message Description: SelfServiceAccountQueryPage

Node
Description
Empty.
ListOfBusinessAddress/ BusinessAddress
ListOfBusinessAddress/ BusinessAddress/ Id
ListOfBusinessAddress/ BusinessAddress/
StreetAddress
Empty (Set it to retrieve a specific address of this

account).
Empty; Set appropriate View Criteria for filtering
addresses.

MainAddressFlag
BillAddressFlag
ShipAddressFlag
ActiveStatus
Empty; to fetch if the address is the main address

for the account.
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.
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.
ExecutionMode
LOVLanguageMode
ViewMode
208
Response Message Description: SelfServiceAccountQueryPage

Table 355. Response Message Description: SelfServiceAccountQueryPage
Node
Description
SelfServiceAccountQueryPage_Output

response.
ListOfSSAccount
Id of the account.
ListOfSSAccount/ Account / PrimaryAddressId
Retrieved Id of the Primary Address of the

account.
PrimaryBillToAddressId
Retrieved Id of the Primary Bill To address of the

account.
PrimaryShipToAddressId
Retrieved Id of the Primary Ship To address of the

account.
Container element for the retrieved Business

Address of the account.
ListOfBusinessAddress/ BusinessAddress
For each retrieved business address of the

account.
Id of the address.
ListOfBusinessAddress/ BusinessAddress/ Id
Details of the business address.
StreetAddress
MainAddressFlag
BillAddressFlag
ShipAddressFlag
True, if the address is the main Address for the

account.
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
Description
True, if the address is active.
ActiveStatus
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.
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.

For a description of the service objects for this Web service, see Table 356
Table 356. SelfServiceAccount Service Object
Name
Class
SelfServiceAccount
Business Service
CSSEAIUIDataService

Table 357. SelfServiceAccount Data Object
External Name
SS_Account_IO
SS_Account_IO
Example Package for SelfServiceAccount

Request (SelfServiceAccountExecute)
\SelfServiceAccount\SelfServiceAccountExecute_request.xml
210
Siebel 8.1 Primary Web Services SelfServiceAccountRootPath
Response (SelfServiceAccountExecute)
\SelfServiceAccount\SelfServiceAccountExecute_response.xml
Request (SelfServiceAccountQueryPage)
\SelfServiceAccount\SelfServiceAccountQueryPage_request.xml
Response (SelfServiceAccountQueryPage)
\SelfServiceAccount\SelfServiceAccountQueryPage_response.xml
Message Schema (WSDL) for SelfServiceAccount

\SelfServiceAccountQueryPage\SelfServiceAccount.wsdl
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
Table 358. SelfServiceAccountRootPath Operations
Name
Description
SelfServiceAccountRootPathQueryPage

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

Table 359. Request Message Description: SelfServiceAccountRootPathQueryPage
Node
Description
SelfServiceAccountRootPathQueryPage_Input

request.
ListOfSSAccountRootPath
Corresponds to an instance of
SS_AccountRootPath_IO.
ListOfSSAccountRootPath /
SSAccountRootPath
Container element, which holds the columns to be

queried, and the criteria to be used.
SSAccountRootPath /ParPartyId
Empty.
SSAccountRootPath /PartyId
Empty.
SSAccountRootPath /PartyName
Empty.
SSAccountRootPath /PriceListId
Empty.
SSAccountRootPath /RelationTypeCode
Empty.
SSAccountRootPath /Level1PartyId
Id of the Account, from which the path to the root

Account needs to be identified.
ExecutionMode
Forward only.
LOVLanguageMode
LDC.
ViewMode
All.
Response Message Description: SelfServiceAccountRootPathQueryPage

The response contains the details based on the query set on the payment Integration Object .
Table 360. Response Message Description: SelfServiceAccountRootPathQueryPage
Node
Description
SelfServiceAccountRootPathQueryPage_Output
Container element for the QueryPage

Operation response.
ListOfSSAccountRootPath
SS_AccountRootPath_IO.
212
Table 360. Response Message Description: SelfServiceAccountRootPathQueryPage

Node
Description
ListOfSSAccountRootPath /SSAccountRootPath
Container element, which corresponds to an

Account that is present along the path to the
root Account.
ListOfSSAccountRootPath /SSAccountRootPath /
ParPartyId
If ParPartyId is null, the retrieved account is

deemed as the root account. Else, this account
is one of the accounts in the path.
PartyId
Id of the retrieved account.
PartyName
Name of the retrieved account.
PriceListId
PriceListId of the retrieved account.
RelationTypeCode
SELF or DIRECT or INDIRECT.
Level1PartyId
DIRECT=> Account is the parent the

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.

Table 361. SelfServiceAccountRootPath Service Object
Name
Class
Business Service
CSSEAIUIDataService

Table 362. SelfServiceAccountRootPath Data Object
External Name
SS_AccountRootPath_IO
SS_AccountRootPath_IO
21 3
Siebel 8.1 Primary Web Services SelfServiceAllAccountsList
Example Package for SelfServiceAccountRootPath

Request
\SelfServiceAccountRootPath\SelfServiceAccountRootPath_request.xml
Response
NOTE: You need to filter out unnecessary SELF relationship records returned in this response.
\SelfServiceAccountRootPath\SelfServiceAccountRootPath_response.xml
Message Schema (WSDL) for SelfServiceAccountRootPath

\SelfServiceAccountRootPath\SelfServiceAccountRootPath.wsdl
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
Table 363. SelfServiceAllAccountsList Operations
Name
Description
SelfServiceAllAccountsListQueryPage
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

Table 364. Request Message Description: SelfServiceAllAccountsListQueryPage
Node
Description
Type
SelfServiceAllAccountsListQueryPage_Input

Operation request.
String
ListOfSSAllAccount
SS_AllAccount_List_IO.
String
ListOfSSAllAccount /SSAllAccountList
Container element, which holds the

columns to be queried, and the criteria
to be used.
String
Empty.
String
/ModId
Set the Root Account Id as the view

criteria.
String
ListOfSSAllAccount /SSAllAccountList /
ParentPartyId
Empty.
String
21 5
Table 364. Request Message Description: SelfServiceAllAccountsListQueryPage

Node
Description
Type
RelationTypeCode
Empty
String
Level2ParentAccountName
Empty (Columns to be retrieved in the

response)
String
ExecutionMode
Empty
String
LOVLanguageMode
ForwardOnly
String
ViewMode
LDC
String
Level1AccountStatus
/Level1ApprovalStatus
Level1BusinessPhone
Level1EmailAddress
Level1FaxNumber
Level1ParentPartyId
Level1PartyLocation
Level1PartyName
Level1PriceListId
Level1PrimaryAddressId
Level1PrimaryBillToAddressId
Level1PrimaryContactId
Level1PrimaryShipToAddressId
Level1Type
Response Message Description: SelfServiceAllAccountsListQueryPage

Table 365. Response Message Description: SelfServiceAllAccountsListQueryPage
Node
Description
Type
SelfServiceAllAccountsListQueryPage_Input

Operation response.
String
ListOfSSAllAccount
SS_AllAccount_List_IO.
String
216
Table 365. Response Message Description: SelfServiceAllAccountsListQueryPage

Node
Description
Type
Container element, which holds the

columns to be queried, and the criteria to
be used.
String
ParentPartyId
Empty.
String
AccountId of the child account.
String
Whether the child is directly or indirectly

under this root account.
String
/ModId
/PartyId
RelationTypeCode
Can be SELF, DIRECT or INDIRECT.

Level1AccountStatus,
Retrieved details of the child account.
String
Level1ParentPartyId
Immediate Parent of this child account.

For accounts with RelationTypeCode as
DIRECT, it matches the root account Id
itelsef.
String
Level2ParentAccountName
AccountName of the Immediate Parent of

this child account.
String
Level1ApprovalStatus,
Level1BusinessPhone,
Level1EmailAddress,
Level1FaxNumber,
Level1PartyName,
Level1PartyLocation,
Level1PriceListId,
Level1PrimaryAddressId,
Level1PrimaryBillToAddressId,
Level1PrimaryContactId,
Level1PrimaryShipToAddressId,
Level1Type
21 7
SelfServiceAllAccountsList Application Interface

Technology Network.

Table 366. SelfServiceAllAccountsList Service Object
Name
Class
Business Service
CSSEAIUIDataService

Table 367. SelfServiceAllAccountsList Service Object
External Name
SS_AllAccount_List_IO
SS_AllAccount_List_IO
Example Package for SelfServiceAllAccountsList

Request
\SelfServiceAllAccountsList\SelfServiceAllAccountsList_request.xml
Response
\SelfServiceAllAccountsList\SelfServiceAllAccountsList_response.xml
Message Schema (WSDL) for SelfServiceAllAccountsList

\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
Table 368. SelfServiceContact Operations
Name
Description
SelfServiceContactExecute
SelfServiceContactQueryPage

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.
Request Message Description: SelfServiceContactExecute

Table 369. Request Message Description: SelfServiceContactExecute
Node
Description
Type
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.
Contact /Id
Id of the Contact. Set this if the mode on Contact

node is Update or SkipNode.
String
21 9
Table 369. Request Message Description: SelfServiceContactExecute

Node
Description
Contact /ListOfAccount
Container element for the assigned accounts of

this contact.
Type
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
Details of the assigned account.
String
Contact /
ListOfContactCommunicationAddress
/ContactCommunicationAddress /
AlternateEmailAddress
Alternate email address value to be edited or

created.
String
Contact /
CommunicationAddressId
Id of the alternate email address value to be

edited; blank for adding new alternate email
address.
String
Contact/
Response Message Description: SelfServiceContactExecute

Table 370. Response Message Description: SelfServiceContactExecute
Node
Description
SelfServiceContactExecute_Output
Container element for the Execute

Operation request.
ListOfSSContact
SS_Contacts_IO.
ListOfSSContact/Contact/Id, ModId
Id and ModId of Inserted/Updated

Contact Record.
String
ListOfSSContact/Contact/ListOfAccount/
Account/Id, Mod Id

Account Record.
String
ListOfSSContact/Contact/
ListOfCommunicationAddress/
CommunicationAddress/Id, Mod Id

CommunicationAddress Record.
String
220
Type
Request Message Description: SelfServiceContactQueryPage

Table 371. Request Message Description: SelfServiceContactQueryPage
Node
Description
Type
SelfServiceContactQueryPage_Input

Operation request.
Complex
Type
ListOfSSContact
SS_Contacts_IO.
(Refer
WSDL)
ListOfSSContact/Contact
Complex
Type
Contact/ Id
Set the Id of the Contact as a ViewCriteria.
(Refer
WSDL)
Contact/ ModId
Retrieve and pass back while updating, to

make sure that Contact record is not updated
in the interim.
Complex
Type
Contact/
Empty (Columns to be retrieved).
(Refer
WSDL)
Contact/
String
LoginName, ApprovalStatus,
ChallengeQuestion, ChallengeAnswer
These columns are related to the username

information.
Contact/
String
Container element for the

AlternateEmailAddress to be retrieved.
String
FirstName, MiddleName, LastName,

Status, EmailAddress, CellularPhone,
HomePhone, FaxPhone, WorkPhone,
TimeZoneId, EmailSRUpdatesFlag,
SendPromotions
PrimaryAccountName,
PrimaryAddressId,
PrimaryAddressName
PrimaryPersonalAddressId
Contact/
Contact can have similar sub-nodes for

querying PersonalAddress, Account and
AccountBusinessAddress.
Contact /
/ContactCommunicationAddress
String
22 1
Table 371. Request Message Description: SelfServiceContactQueryPage

Node
Description
Type
Contact /
String
Contact /
ExecutionMode
ForwardOnly.
(Refer
WSDL)
LOVLanguageMode
LDC.
String
ViewMode
All.
Complex
Type
Alternate Email Address of the contact.
Id of the Alternate Email Address of the

contact.
Complex
Type
Response Message Description: SelfServiceContactExecute

Node
Description
Type
SelfServiceContactQueryPage_Output

Operation response.
Complex
Type
ListOfSSContact
SS_Contacts_IO.
(Refer
WSDL)
ListOfSSContact/Contact
Complex
Type
Contact/ Id
Id of the Contact being queried.
(Refer
WSDL)
Contact/ ModId

Operation response.
Complex
Type
Contact/
Primitive details of the contact.

EmailSRUpdatesFlag and SendPromotions
contain the preferences shown in
SelfService 8.1 Registration screens.
(Refer
WSDL)
These nodes contain the values for the

username information.
String
FirstName, MiddleName, LastName,

Status, EmailAddress, CellularPhone,
HomePhone, FaxPhone, WorkPhone,
TimeZoneId, EmailSRUpdatesFlag,
SendPromotions
Contact/
LoginName, ApprovalStatus,
ChallengeQuestion, ChallengeAnswer
222

Node
Description
Type
Contact/
These nodes contain the values for the

PrimaryAccountName, Primary
BusinAddressId, Primary
BusinessAddressName and
PrimaryPersonalAddressId respectively.
String
Container element for the

AlternateEmailAddress retrieved.
String
PrimaryAccountName,
PrimaryAddressId,
PrimaryAddressName
PrimaryPersonalAddressId
Contact/
Contact /
ListOfContactCommunicationAddress /
ContactCommunicationAddress
String
Contact /
ContactCommunicationAddress /
Alternate Email Address of the contact.
String
Contact /
ContactCommunicationAddress /
Id of the Alternate Email Address of the

contact.
Complex
Type
ExecutionMode
ForwardOnly.
(Refer
WSDL)
LOVLanguageMode
LDC.
String
ViewMode
All.
Complex
Type
SelfServiceContact Application Interface

Technology Network.

Table 373. SelfServiceContact Service Object
Name
Class
SelfServiceContact
BusinessService
CSSEAIUIDataService
22 3

Table 374. SelfServiceContact Data Object
External Name
SS_Contacts_IO
SS_Contacts_IO
Example Package for SelfServiceContact

Request (SelfServiceContactQueryPage)
\SelfServiceContact\SelfServiceContactQueryPage_request.xml
Response (SelfServiceContactQueryPage)
\SelfServiceContact\SelfServiceContactQueryPage_request.xml
Request (SelfServiceContactExecute)
\SelfServiceContact\SelfServiceContactExecute_request.xml
Response (SelfServiceContactExecute)
\SelfServiceContact\SelfServiceContactExecute_request.xml
Message Schema (WSDL) for SelfServiceContact

\SelfServiceContact\SelfServiceContact.wsdl
224
Siebel 8.1 Primary Web Services 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
Table 375. SelfServicePaymentHistory Operations
Name
Description
SelfServicePaymentHistoryQueryPage
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
Description
Type
QueryPage_Input
The method arguments are Payment Integration

Object, Language Mode (value is LDC) and
viewMode (All).
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
Description
Type
SelfServicePaymentHistoryQueryPage_Output
Integration Object
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
Technology Network.
22 5
Siebel 8.1 Primary Web Services SelfServicePaymentHistory

Table 378. SelfServicePaymentHistory Service Object
Name
Class
Integration Object
CSSEAIUIDataService

Table 379. SelfServicePaymentHistory Data Object
External Name
SS_PaymentHistory_IO
Payments
Example Package for SelfServicePaymentHistory

Request
\SelfServicePaymentHistory\SelfServicePaymentHistory_request.xml
Response
\SelfServicePaymentHistory\SelfServicePaymentHistory_response.xml
Message Schema (WSDL) for SelfServicePaymentHistory

\SelfServicePaymentHistory\SelfServicePaymentHistory.wsdl
226
Siebel 8.1 Primary Web Services 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
Response
OnlyLoadResponsibilities
Returns only the responsibilities for the given user name.
SkipLoadResponsibilities
Returns only the contact details for the given user name.
LoadEverything
Returns both the contact details and responsibilities for the

given user name.
SelfServicePostLoginProcess Operations
Table 381. SelfServicePostLoginProcess Operations
Name
Description
LoadUserDetails
This operation triggers the SelfServicePostLoginProcess workflow.
Request Message Description: LoadUserDetails

Table 382. Request Message Description: LoadUserDetails
Node
Description
Type
P_Mode
See P_Mode Request Parameter table.
String
ListOfSSContact
An SS_Contact_IO instance, where in

ListOfSSContact/Contact/LoginName contains the
username of the user for whom the details need to
be retrived.
P_LoginName
Refer to the SelfServiceContact.doc for the details

on ListOfContact and its subnodes.
String
getUserResponsibilitiesResponse
Username of the user for whom the details need to

be retrived.
Complex
Type
getUserResponsibilitiesResponse /
listOfUserResponsibilities/
Container element for Responsibilities. Maps to an

instance of getUserResponsibilitiesResponse IO
(See
WSDL)
22 7
Response Message Description: LoadUserDetails

Table 383. Response Message Description: LoadUserDetails
Node
Description
Type
LoadUserDetails_Output
Container element for the LoadUserDetails

operation response.
Complex
Type
ListOfSSContact
An SS_Contact_IO instance, where in

ListOfSSContact/Contact/Id contains the
contactId of the user for whom the details are
retrieved.
(See
WSDL)
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.
Complex
Type
getUserResponsibilitiesResponse /
listOfUserResponsibilities/
userResponsibilities/
responsibilityValue
Will be blank when mode is

SkipLoadResponsibilities.
(See
WSDL)
Error_spcCode
Name of the Responsibility.
Complex
Type
Error_spcMessage
Error Code returned by the Workflow.
(See
WSDL)
SelfServicePostLoginProcess Application Interface

Technology Network.

Table 384. SelfServicePostLoginProcess Service Object
Name
Workflow
228

Table 385. SelfServicePostLoginProcess Data Object
External Name
SelfServiceContact
SelfServiceContact
Example Package for SelfServicePostLoginProcess

Request (LoadUserDetails_OnlyLoadResponsibilities)
\SelfServicePostLoginProcess\LoadUserDetails_OnlyLoadResponsibilities_request.xml
Response(LoadUserDetails_OnlyLoadResponsibilities)
\SelfServicePostLoginProcess\LoadUserDetails_OnlyLoadResponsibilities_response.xml
Request (LoadUserDetails_SkipLoadResponsibilities)
\SelfServicePostLoginProcess\LoadUserDetails_SkipLoadResponsibilities_request.xml
Response (LoadUserDetails_SkipLoadResponsibilities)
\SelfServicePostLoginProcess\LoadUserDetails_SkipLoadResponsibilities_response.xml
Message Schema (WSDL) for SelfServicePostLoginProcess

\SelfServicePostLoginProcess\SelfServicePostLoginProcess.wsdl
22 9
Siebel 8.1 Primary Web Services 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
Response
CreateContact
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
Table 387. SelfServiceRegistration Operations
Name
Description
Enroll
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
Begin Transaction
Business Service
Name
Business Service
Method
Begin Transaction
Description
This step is used to initiate a transaction. BeginTransaction will not take

any parameters as input.
23 1
SelfServiceContact Business Service

Table 389. Self ServiceContact Business Service
SelfServiceContact
Business Service
Step
Create, and update contact and account records
Business Service
Name
SelfServiceContact
Business Service
Method
Execute
Input Arguments
Argument Name
Type
Property Name
SiebelMessageIn
Process Property
P_ContactIO(SS_Contacts_IO)
ViewMode
Process Property
All
LanguageMode
Process Property
LDC
ExecutionMode
Process Property
BiDirectional
Output Arguments
Argument Name
Type
Property Name
SiebelMessageOut
Output Argument
Description
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

Table 390. PRM ANI Utility Service Business Service
PRM ANI Utility Service
Business Service
Step
Retrieve Contact Id
Business Service
Name
Business Service
Method
GetProperty
Input Arguments
Argument Name
Type
Property Name
Hierarchy Path:
Literal
Contact
Property Name
Literal
Id
SiebelMessage
Hierarchy
Output Arguments
Argument Name
Type
Property Name
Property Value
Output Argument
P_ContactId
Description
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.
Business Service
Step
Retrieve Account Id (called only when accountId Process Property is

null)
Business Service
Name
Business Service
Method
GetProperty
23 3

Input Arguments
Argument Name
Type
Property Name
Hierarchy Path:
Literal
Contact
Property Name
Literal
Account Id
SiebelMessage
Hierarchy
P_ContactIO (SS_Contacts_IO)
Output Arguments
Argument Name
Type
Property Name
Property Value
Output Argument
AccountId
Description
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

Table 392. SiebelWebRegistrationService Business Service
Business Service
Step
Create User
Business Service
Name
Business Service
Method
Promote
Input Arguments
Argument Name
Type
Property Name
Contactid
Process Property
P_ContactId
Type
Process Property
P_Usertype
Proxy User
Process Property
P_ProxyEmpLoginName
LoginName
Process Property
P_LoginName
Password
Process Property
P_NewPassword
securityQuestion
Process Property
P_ChallengeQuestion
234
Table 392. SiebelWebRegistrationService Business Service

securityAnswer
Process Property
P_ChallengeAnswer
Output Arguments
Argument Name
Type
Property Name
SuccessCode
Output Argument
P_CreateUserStatus
ErrorMessage
Output Argument
Error Message
Description
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

Table 393. Self Service User Business Service
Self Service User
Business Service
Step
Assign Responsibilities
Business Service
Name
SelfServiceUser
Business Service
Method
Execute
Input Arguments
Argument Name
Type
Property Name
SiebelMessageIn
Process Property
P_UserIO
ViewMode
Process Property
All
LanguageMode
Process Property
LDC
Output Arguments
Argument Name
Type
Property Name
SiebelMessageOut
Output Argument
P_UserIO
Description
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

Table 394. EAITransactionService Business Service
Business Service
Step
Commit Transaction
Business Service
Name
Business Service
Method
EndTransaction
Input Arguments
Argument Name
Type
Property Name
Is Abort
Literal
False
Description
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

Table 395. ISS Approval Bus Service Business Service
ISS Approval Bus Service
Business Service
Step
Trigger Approval
Business Service
Name
ISS Approval Bus Service
Business Service
Method
CreateNewApprovalTasks
Input Arguments
Argument Name
Type
Property Name
RequestingBusComp
Literal
Value = Contact
Approval Item ID
Process Property
P_ContactId
Approval Level Name
Process Property
P_UsertypeApprovalType
Inbox Type
Process Property
P_UsertypeInboxType
Approval Level Context
Process Property
P_AccountId
Description
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

Table 396. Outbound Communications Manager Business Service
Outbound Communications Manager
Business Service
Step
Trigger Notification
Business Service
Name
Outbound Communications Manager
Business Service
Method
CreateRequest
Input Arguments
Argument Name
Type
Property Name
RecipientBusComp
Literal
SourceIdList
Process Property
P_ContactId
PackageNameList
Process Property
P_NotificationTemplateName
RequestLanguageCode
Process Property
P_Language
RequestLocaleCode
Process Property
P_Locale
ProcessMode
Literal
RequestName
Literal
RecipientGroup
Process Property
Description
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.
238
SessionAccessService Business Service

Table 397. SessionAccessService Business Service
SessionAccessService
Business Service
Step
Set new password in Siebel session
Business Service
Name
Business Service
Method
SetProfileAttr
Input Arguments
Argument Name
Type
Property Name
Name
Literal
Value
Process Property
P_NewPassword
PackageNameList
Process Property
P_NotificationTemplateName
RequestLanguageCode
Process Property
P_Language
RequestLocaleCode
Process Property
P_Locale
ProcessMode
Literal
RequestName
Literal
RecipientGroup
Process Property
Description
This step is used to set the password in Siebel session.

For more information, see Siebel Self-Service Application
Developers Guide..
Response Message Description: CreateContact

Table 398. Response Message Description: CreateContact
Node
Description
Type
Process_spcInstance_spcId
Not of consequence in response.
String
Object_spcId
String
Siebel_spcOperation_spcObject_spcId
String
Error_spcCode
String
Error_spcMessage
String
23 9

Node
Description
Type
ListOfSSContact
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.
Integration
Object
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
String
P_AccountId
Derived Root Account Id
String
Refer to SelfService 8.1 Siebel BookShelf

for more details.
P_DefaultOrgId
String
P_Mode
String
P_Usertype
String
P_LoginName
Username created
String
P_DefaultProxyEmployee
String
P_LoginId
Value returned by SiebelWebRegistration

BusinessService.
String
P_CreateUserStatus
The status set on the newly created user.

Inactive, for pending users.
String
P_Password
String
P_NewPassword
String
P_ChallengeQuestion
String
P_ChallengeAnswer
String
240

Node
Description
Type
ListOfSSUser
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.
Integration
Object
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
String
P_UsertypeApprovalType
String
P_UsertypeInboxType
String
P_UsertypeNotifTemplateName
String
P_RecipientGroup
String
P_Language
String
P_Locale
String
Self Service Registration Application Interface

Technology Network.

Table 399. Self Service Registration Service Object
Name
Workflow
24 1

Table 400. Self Service Registration Data Object
External Name
SelfServiceContact
SelfServiceContact
Users
Users
Example Package for SelfServiceRegistration

Request and Response Samples are provided for the following scenarios:
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.
\SelfServiceRegistration\SelfServiceRegistration_1_request.xml
Response
Create a B2C contact and username and trigger notification.
Request
Items for approval.
242
Response
Items for approval.
\SelfServiceRegistration\SelfServiceRegistration_2_response.xml
Request
Update Personal Addresses of an existing contact.
Response
Update Personal Addresses of an existing contact.
\SelfServiceRegistration\SelfServiceRegistration_3\_response.xml
Request
Update Contact Details, Account Assignment, Responsibility Assignment, Password resetting for an
existing contact.
Response
Update Contact Details, Account Assignment, Responsibility Assignment, Password resetting for an
existing contact
\SelfServiceRegistration\SelfServiceRegistration_4_response.xml
Message Schema (WSDL) for SelfServiceRegistration

\SelfServiceRegistration\SelfServiceRegistration.wsdl
24 3
Siebel 8.1 Primary Web Services 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
Table 401. SelfServiceResponsibility Operations
Name
Description
SelfServiceResponsibilityQueryPage

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

Table 402. Request Message Description: SelfServiceResponsibilityQueryPage
Node
Description
SelfServiceResponsibilityQuery
Page_Input
Container element for SelfServiceResponsibility

WebService input for QueryPage operation.
ListOfSSResponsibility
Container element for the list of SS_Responsibility_IO.

Corresponds to an SS_Responsibility_IO IO.
ListOfSSResponsibility/
Responsibility
Corresponds to the primary IC Responsibility.
Responsibility/AccessType
Set to Yes, for retrieving only Web Enabled

Responsibilities.
Responsibility/Id
Empty; Placeholder for the Id of the responsibility to be

retrived.
Responsibility/Name
Empty; Placeholder for the name of the responsibility to

be retrived.
244
Siebel 8.1 Primary Web Services SelfServiceResponsibility
Response Message Description: SelfServiceResponsibilityQueryPage

Table 403. Response Message Description: SelfServiceResponsibilityQueryPage
Node
Description
SelfServiceResponsibilityQueryPage_Output
Container element for

SelfServiceResponsibility WebService
output for QueryPage operation.
ListOfSSResponsibility
Container element for the list of

SS_Responsibility_IO. Corresponds to an
SS_Responsibility_IO Integration Object.
ListOfSSResponsibility/Responsibility
Corresponds to the primary IC

Responsibility.
ListOfSSResponsibility/Responsibility/
AccessType
Yes for Web Enabled Responsibility.
ListOfSSResponsibility/Responsibility/Id
Retrived Id of the responsibility.
ListOfSSResponsibility/Responsibility/Name
Retrived name of the responsibility.
SelfServiceResponsibility Application Interface

Technology Network.

Table 404. SelfServiceResponsibility Service Object
Name
Class
BusinessService
CSSEAIUIDataService

Table 405. SelfServiceResponsibility Data Object
External Name
SS_Responsibility_IO
SS_Responsibility_IO
24 5
Siebel 8.1 Primary Web Services SelfServiceSmtpEmail
Example Package for SelfServiceResponsibility

Request
\SelfServiceResponsibility\SelfServiceResponsibility_request.xml
Response
\SelfServiceResponsibility\SelfServiceResponsibility_response.xml
Message Schema (WSDL) for SelfServiceResponsibility

\SelfServiceResponsibility\SelfServiceResponsibility.wsdl
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
Table 406. SelfServiceSmtpEmail Operations
Name
Description
SendSmtpEmail
Invokes SelfServiceSmtpEmail workflow.
246
Request Message Description: SendSmtpEmail

Table 407. Request Message Description: SendSmtpEmail
Node
Description
Type
FromAddress
Email address of the sender.
String
MessageToList
Semicolon-separated list of email addresses for the TO line.
String
MessageCCList
Semicolon-separated list of email addresses for th CC line.
String
MessageBCCList
Semicolon-separated list of email addresses for th BCC

line.
String
MessageSubject
Descriptive subject line for the message.
String
MessageBody
Message content in plain-text.
String
MessageHTMLBody
Message content in HTML. This parameter when specified

would override the parameter MessageBody.
String
Error Code
Error code, if any.
String
Error Message
String
Object Id
Object Id.
String
Process Instance Id
Id of process instance.
String
Siebel Operation Object Id
Id of Siebel operation.
String
Response Message Description: SendSmtpEmail

Table 408. Response Message Description: SendSmtpEmail
Node
Description
Type
FromAddress
String
MessageToList
String
MessageCCList
String
MessageBCCList
String
MessageSubject
String
MessageBody
String
MessageHTMLBody
String
Error Code
Error code, if any, for exceptions raised while submitting the

request. This is automatically set from the workflow.
String
Error Message
Error details, if any, for exceptions raised while submitting the

request. This is automatically set from the workflow.
String
24 7
Table 408. Response Message Description: SendSmtpEmail

Node
Description
Type
Object Id
Standard WF Output.
String
Process Instance Id
Standard WF Output.
String
Siebel Operation
Object Id
Standard WF Output.
String
SelfServiceSmtpEmail Application Interface

Technology Network.

Table 409. SelfServiceSmtpEmail Service Object
Name
Workflow Process
Example Package for SelfServiceSmtpEmail

Request
\SelfServiceSmtpEmail\SelfServiceSmtpEmail_request.xml
Response
\SelfServiceSmtpEmail\SelfServiceSmtpEmail_response.xml
Message Schema (WSDL) for SelfServiceSmtpEmail

248
Siebel 8.1 Primary Web Services SelfServiceTemplateEmail
\SelfServiceSmtpEmail\SelfServiceSmtpEmail.wsdl
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
Table 410. SelfServiceTemplateEmail Operations
Name
Description
SendTemplateEmail
Invokes SelfServiceTemplateEmail workflow.
Request Message Description: SendTemplateEmail

Table 411. Request Message Description: SendTemplateEmail
Node
Description
Type
TemplateName
The communication template name to be used in the

request.
String
SourceRecipientGroupName
The source recipient group name. Either the name of

Siebel-seeded recipient group or a custom one.
String
SourceObjectID
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.
String
TemplateLanguageCode
Language code the template. A template must exist

with the name and language combination specified.
Defaulting is not recommended.
String
TemplateLocaleCode
Locale code the template. A template must exist with

the name and locale combination specified.
Defaulting is not recommended.
String
RequestName
An optional string that would help trace the

outbound communication requests at the server
side.
String
RequestStatus
Status code for the outbound request placed.
String
Error Code
Blank.
String
Error Message
Blank.
String
24 9
Table 411. Request Message Description: SendTemplateEmail

Node
Description
Type
Object Id
Blank.
String
Process Instance Id
Blank.
String
Blank.
String
Response Message Description: SendTemplateEmail

Table 412. Response Message Description: SendTemplateEmail
Node
Description
Type
TemplateName
String
SourceRecipientGroupName
String
SourceObjectID
String
TemplateLanguageCode
String
TemplateLocaleCode
String
RequestName
String
RequestStatus
String
Error Code
Error code, if any, for exceptions raised while

submitting the request. This is automatically set from
the workflow.
String
Error Message
Error details, if any, for exceptions raised while

submitting the request. This is automatically set from
the workflow.
String
Object Id
Standard WF Output.
String
Process Instance Id
Standard WF Output.
String
Standard WF Output.
String
SelfServiceTemplateEmail Application Interface

Technology Network.
250

Table 413. SelfServiceTemplateEmail Service Object
Namep
Workflow Process

Table 414. SelfServiceTemplateEmail Data Object
External Name
Not applicable
Example Package for SelfServiceTemplateEmail

Request
\SelfServiceTemplateEmail\SelfServiceTemplateEmail_request.xml
Response
\SelfServiceTemplateEmail\SelfServiceTemplateEmail_response.xml
Message Schema (WSDL) for SelfServiceTemplateEmail

\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
Table 415. SelfServiceTimeZone Operations
Name
Description
SelfServiceTimeZoneQueryPage
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

Table 416. Request Message Description:SelfServiceTimeZoneQueryPage
Node
Description
Type
SelfServiceTimeZoneQueryPage_Input
The method arguments are TimeZone

Integration Object with query
parameters set, Language Mode as
LDC and viewMode (All).
Integration
Object
Response Message Description: SelfServiceTimeZoneQueryPage

Table 417. Response Message Description: SelfServiceTimeZoneQueryPage
Node
Description
Type
SelfServiceTimeZoneQueryPage_Output
The list of the timezone values which

are returned in the language that is set
in the search spec.
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

Table 418. SelfServiceTimeZone Service Object
Name
Class
SelfServiceTimeZone
Integration Object
CSSEAIUIDataService

Table 419. SelfServiceTimeZone Data Object
External Name
SS_TimeZone_IO
Time Zone
Example Package for SelfServiceTimeZone

Request
\SelfServiceTimeZone\SelfServiceTimeZone_request.xml
Response
\SelfServiceTimeZone\SelfServiceTimeZone\_response.xml
Message Schema (WSDL) for SelfServiceTimeZone

\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
Table 420. SelfServiceUser Operations
Name
Description
SelfServiceUserExecute
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

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

Table 421. Request Message Description:SelfServiceUserExecute
Node
Description
SelfServiceUserExecute_Input
Container element for SelfServiceUser WebService input for

Execute operation.
ListOfSSUser
Container element for the list of Users. Corresponds to a Users

Integration Object.
ListOfSSUser/User
Corresponds to the primary IC User. Set the mode as skipnode

for adding/removing responsibilities of the user.
ListOfSSUser/User/LoginName
Set the Username for which the associated responsibilities need

to be reset.
ListOfSSUser/User/
ListOfSSUserResponsibility
Container element for User_Responsibility IC.
254
Table 421. Request Message Description:SelfServiceUserExecute

Node
Description
ListOfSSUser/User/
ListOfSSUserResponsibility/
SSUserResponsibility
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.
ListOfSSUser/User/
SSUserResponsibility/Id
Set the Id of the responsibility to be assigned/retained to the user.
Response Message Description: SelfServiceUserExecute

Table 422. Response Message Description: SelfServiceUserExecute
Node
Description
SelfServiceUserExecute_Output
Container element for SelfServiceUser WebService output for

Execute operation.
ListOfSSUser
Container element for the list of Users. Corresponds to a

Users Integration Object.
ListOfSSUser/User
Corresponds to the primary IC User.
Username for which the assigned responsibilities are

updated.
ListOfSSUser/User/
ListOfSSUser/User/
Corresponds to the User_Responsibility IC. Each entry

represents a responsibility assigned to the user.
ListOfSSUser/User/
Id of the responsibility assigned to the user.
Request Message Description: SelfServiceUserQueryPage

Table 423. Request Message Description: SelfServiceUserQueryPage
Node
Description
SelfServiceUserQueryPage_Input
Container element for SelfServiceUser WebService input for

QueryPage operation.
ListOfSSUser

25 5
Table 423. Request Message Description: SelfServiceUserQueryPage

Node
Description
ListOfSSUser/User
Set the Username for which the associated responsibilities

needs to be loaded.
ListOfSSUser/User/
ListOfSSUser/User/
Corresponds to the User_Responsibility IC. Represents a

responsibility associated to the user.
ListOfSSUser/User/
Empty; to query the Id of the responsibility assigned to the

user.
ListOfSSUser/User/
SSUserResponsibility/Responsibility
Empty; to query the Name of the responsibility assigned to

the user.
Response Message Description: SelfServiceUserQueryPage

Table 424. Response Message Description: SelfServiceUserQueryPage
Node
Description
SelfServiceUserQueryPage_Output
Container element for SelfServiceUser WebService output

for QueryPage operation.
ListOfSSUser

ListOfSSUser/User
Username for which the assigned responsibilities are

retrived.
ListOfSSUser/User/
ListOfSSUser/User/
Corresponds to the User_Responsibility IC. Each entry

represents a responsibility assigned to the user.
ListOfSSUser/User/
Id of the responsibility assigned to the user.
ListOfSSUser/User/
SSUserResponsibility/Responsibility
Name of the responsibility assigned to the user.
256
SelfServiceUser Application Interface

Technology Network.

Table 425. SelfServiceUser Service Object
Name
Class
SelfServiceUser
BusinessService
CSSEAIUIDataService

Table 426. SelfServiceUser Data Object
External Name
Users
Users
Example Package for SelfServiceUser

Request
\SelfServiceUser\SelfServiceUser_request.xml
Response
\SelfServiceUser\SelfServiceUser_response.xml
Message Schema (WSDL) for SelfServiceUser

\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
Table 427. SelfServiceWebSite Operations
Name
Description
SelfServiceWebSiteExecute
Perform various operations like creating/updating/deleting of

sites with SelfServiceWebSite Integration Object as the input.
SelfServiceWebSiteQueryPage
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
Description
Type
SelfServiceWebSiteExecute_Input
The method arguments are Site Integration

viewMode (All).
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
Description
Type
SelfServiceWebSiteExecute_Output
The data retrieved based on the query set.
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
Table 430. Request Message Description:SelfServiceWebSiteQueryPage
Node
Description
Type
SelfServiceWebSiteQueryPage_Input
The method arguments are Site

Integration Object with query parameters
set, Language Mode as LDC and
viewMode (All).
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
Description
Type
SelfServiceTimeZoneQueryPage_Output
The list of the timezone values which

are returned in the language that is set
in the search spec.
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.

Table 432. SelfServiceWebSite Service Object
Name
Class
SelfServiceWebSite
Integration Object
CSSEAIUIDataService

Table 433. SelfServiceWebSite Data Object
External Name
SS_WebSite_IO
SS_WebSite_BO
25 9
Siebel 8.1 Primary Web Services ServiceRequest
Example Package for SelfServiceWebSite

Request (SelfServiceWebSiteExecute)
\SelfServiceWebSite\SelfServiceWebSiteExecute_request.xml
Response (SelfServiceWebSiteExecute)
\SelfServiceWebSite\SelfServiceWebSiteExecute_response.xml
Request (SelfServiceWebSiteQuery)
\SelfServiceWebSite\SelfServiceWebSiteQuery_request.xml
Response (SelfServiceWebSiteQuery)
\SelfServiceWebSite\SelfServiceWebSiteQuery_response.xml
Message Schema (WSDL) for SelfServiceWebSite

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
Table 434. ServiceRequest Operations
Name
Description
ServiceReqInsert_Input
Used to Create the Service Request.
ServiceReqUpdate_Input
Used to Update the Service Request.
ServiceReqExecute_Input
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.
ServiceReqQueryPage_Input
Used to Query the Service Request and the child objects like
Activities, Attachment, Solution, Service Request Agreement.
ServiceReqInit_Input
Used to get the default values for the Service Request.
ServiceReqDelete_Input
Used to delete the child objects like Activities, Attachment,

Solution, Service Request Agreement.
Request Message Description: ServiceReqInsert_Input

Table 435. Request Message Description: ServiceReqInsert_Input
Node
Description
Abstract
Abstract of the Service Request.
Response Message Description: ServiceReqInsert_Input

Table 436. Response Message Description: ServiceReqInsert_Input
Node
Description
Id
Returns the Row_Id of the Service Request.
Mod_Id
Returns the Mod_Id of the Service Request.
Request Message Description: ServiceReqUpdate_Input

Table 437. Request Message Description: ServiceReqUpdate_Input
Node
Description
Id
Row Id of the Service Request is required.
26 1
Response Message Description: ServiceReqUpdate_Input

Table 438. Response Message Description: ServiceReqUpdate_Input
Node
Description
Id
Returns the Row_Id of the Service Request.
Mod_Id
Returns the Mod_Id of the Service Request.
Request Message Description: ServiceReqExecute_Input Request

Table 439. Request Message Description: ServiceReqExecute_Input Request
Node
Description
Service Request
Id
Row Id of the Service Request.
Abstract
Abstract of the Service Request is required.
Activities
Id
Row Id of the Activity.
Type
Type is required.
Description2
Description of the Activity.
Attachment
Id
Row Id of the Attachment.
ActivityId
Activity Id of the Attachment. In this case its Service Request Id.
ActivityComments
Comments for the Attachment.
ActivityFileAutoUpdFlg
File Auto Flag for the Attachment.
ActivityFileDeferFlg
File Defer Flag for the Attachment.
ActivityFileDockReqFlg
File Dock Required Flag for the Attachment.
ActivityFileDockStatFlg
File Dock Status Flag for the Attachment.
ActivityFileSrcType
Type of the Attachment (FILE/ URL).
ActivityFileSrcPath
Location of the File or URL for the Attachment.
ActivityFileName
File Name for the Attachment, in case of attachment type FILE.
ActivityFileRev
File Revision for the Attachment, in case of attachment type FILE.
ActivityFileSize
File Size for the Attachment, in case of attachment type FILE.
ActivityFileExt
File extension for the Attachment, in case of attachment type FILE.
ActivityFileBuffer
Contents to be attached.
262
Table 439. Request Message Description: ServiceReqExecute_Input Request

Node
Description
ActivityFileBuffer
Contents to be attached.
Solution
Id
Row Id of the solution is required
Name
Name of the Solution.
Agreement
Id
Row Id of the agreement is required.
AgreementName
Response Message Description: ServiceReqExecute_Input Request

Table 440. Response Message Description: ServiceReqExecute_Input Request
Node
Description
Id
Returns the Row_Id of the Service Request. Also the child objects Row Id.
Mod_Id
Returns the Mod_Id of the Service Request. Also the child objects Mod Id.
Request Message Description: ServiceReqQueryPage_Input

Table 441. Request Message Description: ServiceReqQueryPage_Input
Node
Description
Id
Response Message Description: ServiceReqQueryPage_Input

Table 442. Response Message Description: ServiceReqQueryPage_Input
Node
Description
Service Request
Returns all the information of the Service Request.
Child Objects
Returns all the child information for that Service Request.
26 3
Request Message Description: ServiceReqInit_Input

Table 443. Request Message Description: ServiceReqInit_Input
Node
Description
Service Request
Pass the Service Request attributes.
Response Message Description: ServiceReqInit_Input

Table 444. Response Message Description: ServiceReqInit_Input
Node
Description
Service Request
Returns default information of the Service Request.
Request Message Description: ServiceReqDelete_Input

Table 445. Request Message Description: ServiceReqDelete_Input
Node
Description
Id
Id
Row Id of the Activity.
Id
Row Id of the Attachment.
Id
Row Id of the Solution.
Id
Row Id of the Service Request Agreement.
Response Message Description: ServiceReqDelete_Input

Table 446. Response Message Description: ServiceReqDelete_Input
Node
Description
Id
Returns the Row_Id of the Service Request. Also the child objects Row Id.
Mod_Id
Returns the Mod_Id of the Service Request. Also the child objects Mod Id.
ServiceRequest Application Interface

Technology Network.
264

Table 447. ServiceRequest Service Object
Name
Class
ServiceReq
Business Service
CSSEAIUIDataService

Table 448. ServiceRequest Data Object
External Name
ServiceReqIO
Service Request (SelfService)
Example Package for Service Request

Request
\ServiceRequest\ServiceRequest_request.xml
Response
\ServiceReqWS\ServiceRequest_response.xml
Message Schema (WSDL) for Service Request

\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
Table 449. SessionAccessWS Operations
Name
Description
sessionAccessPing
This is used for setting a message as an input .
Request Message Description:sessionAccessPing

Table 450. Request Message Description:sessionAccessPing
Node
Description
Type
SessionAccessPing_Input
Container Element.
Not applicable
SessionAccessPing_Input/msgIn
Set as Self Service Logout Request.
String
Response Message Description: sessionAccessPing

Table 451. Response Message Description: sessionAccessPing
Node
Description
Type
SessionAccessPing_Output
Container Element.
Not applicable
SessionAccessPing_Input/msgOut
Sent as 1 which indicates successful

termination of the session.
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

Table 452. SessionAccessWS Service Object
Name
Class
CSSUIFSessionAccessService
Example Package for SessionAccessWS

Request
\SessionAccessWS\SessionAccess_request.xml
Response
\SessionAccessWS\SessionAccess_response.xml
Message Schema (WSDL) for SessionAccessWS

\SessionAccessWS\SessionAccessWS.wsdl

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.
26 7
SWI Update Order Line Item Operations

Table 453. SWI Update Order Line Item Operations
Name
Description
UpdateLineItems
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

Table 454. Request Message Descripiton: UpdateLineItems
Node
Description
FieldName1
The name of the field in the order line item to update.
FieldValue1
The new value of the field in the order line item to update.
RootLineItemId
The row ID of the root order in the order line item hierarchy.
OrderLineItemId
The row ID of the nested product in the order line item hierarchy.
UpdateSingleLineItem
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

Technology Network.

Table 455. SWI Update Order Line Item Service Objects
Name
CMU Order Line Item Update (For

simple products)
Business Service
SIS OM UpdateOrderItem (For

complex products)
Workflow
Not applicable
SIS OM NSB Update Order Line

(For nested service bundles)
Workflow
Not applicable
268

Table 456. SWI Update Order Line Item Data Object
External Name
Order Entry Line Item Update
Order Entry Line Item Update
Methods
Table 457. SWI Update Order Line Item Methods
Operation
Method
UpdateLineItems
[BS: CMU Order Line Item Update].Update
Example Package for SWI Update Order Line Item

Request
...\SWIUpdateOrderLineItem\SWIUpdateOrderLineItem.xml
Response
...\SWIUpdateOrderLineItem\SWIUpdateOrderLineItem.xml
Message Schema (WSDL) for SWI Update Order Line Item

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

Table 458. Ulnbox Contact Item Operations
Name
Description
UlnboxContactItemQueryPage
QueryPage method to query data in the Siebel database one

page at a time.
Query Page
QueryPage method to query data in the Siebel database one

page at a time.
Init
Action is initialized.
Execute
Action is executed.
Request Message Description: UlnboxContactItemQueryPage

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

Table 460. Response Message Description: UlnboxContactItemQueryPage
Node
Description
Type
SiebelMessageOut
Output argument.
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

Technology Network.

Table 461. Ulnbox Contact Item Service Object
Name
Class
UInbox Contact Item
Not applicable
CSSEAIUIDataService

Table 462. Ulnbox Contact Item Data Object
External Name
UInboxContactItem
UInbox Items
Example Package for Ulnbox Contact Item

Request
\UlnboxContactItem\UlnboxContactItem_request.xml
Response
\UlnboxContactItem\Response.xml
Message Schema (WSDL) for Ulnbox Contact Item

\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

Table 463. Universal Inbox Operations
Name
Description
UniversalInboxCallAction
Executes the action registered for a specific Inbox Item type.
Request Message Description: UniversalInboxCallAction

Table 464. Request Message Description: UniversalInboxCallAction
Node
Description
Type
InboxItemId
InboxItemId
String
ActionLIC
ActionLIC
String
InboxTypeName
InboxTypeName
String
OwnerId
OwnerId
String
ObjectId
ObjectId
String
Response Message Description: UniversalInboxCallAction

Table 465. Response Message Description: UniversalInboxCallAction
Node
Description
Type
Status
Call status.
String
Error message
Error message returned, if any.
String
This operation will return following messages:
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
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

Technology Network.

Table 466. Universal Inbox Service Object
Node
Description
Type
Universal Inbox
Not applicable
CSSUInboxSvc

Since all Input and Output parameters are Strings, Integration Object is not required.
Example Package for Universal Inbox

Request
\UniversalInbox\UniversalInbox_request.xml
274
Siebel 8.1 Primary Web Services UpdateCustomerSiebelJMSProducer
Response
\UniversalInbox\Universal_Inbox_response.xml
Message Schema (WSDL) for Universal Inbox

\UniversalInbox\UniversalInbox.wsdl
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
Table 467. UpdateCustomerSiebelJMSProducer Operations
Operation Name
Description
UpdateCustomerParty
Synchronizes account detail between the Siebel CRM

application and the billing application.
UpdateCustomerPartyAddress
Synchronizes address detail for an account between the Siebel

CRM application and the billing application.
UpdateCustomerPartyContact
Synchronizes contact detail for an account between the Siebel

CRM application and the billing application.
UpdateCustomerPartyBillProfile
Synchronizes billing profile detail for an account between

Oracles Siebel CRM application and the billing application.
Request Message Description: UpdateCustomerParty

Table 468. Request Message Description: UpdateCustomerParty
Node
Description
Account
The details of the account.
27 5
Table 468. Request Message Description: UpdateCustomerParty

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

Table 469. Request Message Description: UpdateCustomerPartyAddress
Node
Description
Account
CutAddress
The details of the address for an account.
ComInvoiceProfile
The details of the billing profile for an account.
Request Message Description: UpdateCustomerPartyContact

Table 470. Request Message Description: UpdateCustomerPartyContact
Node
Description
Account
Contact
The details of the contact for an account.
ComInvoiceProfile
Request Message Description: UpdateCustomerPartyBillProfile

Table 471. Request Message Description: UpdateCustomerPartyBillProfile
Node
Description
BillingProfileCutAddress
The details of the address for a billing profile.
BillingProfileContact
The details of the contact for a billing profile.
ComInvoiceProfile
UpdateCustomerSiebelJMSProducer Application Interface

Technology Network.
276

Table 472. UpdateCustomerSiebelJMSProducer Service Object
Name
Business Service

Table 473. UpdateCustomerSiebelJMSProducer Data Object
External Name
CMU AccSync Account Io
CMU - Account
CMU AccSync Address Io
CMU - Address
CMU AccSync Contact Io
CMU - Contact
CMU AccSync Billing Profile Io
CMU - Com Invoice Profile
Methods
Table 474. UpdateCustomerSiebelJMSProducer Methods
Operation
Method
UpdateCustomerParty
[BS: UpdateCustomerSiebelJMSProducer].UpdateCustomerParty
UpdateCustomerParty
Address
[BS: UpdateCustomerSiebelJMSProducer].UpdateCustomerPartyAddress
UpdateCustomerParty
BillProfile
[BS: UpdateCustomerSiebelJMSProducer].UpdateCustomerPartyBillProfile
UpdateCustomerParty
Contact
[BS: UpdateCustomerSiebelJMSProducer].UpdateCustomerPartyContact
Example Package for UpdateCustomerSiebelJMSProducer

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

...\UpdateCustomerSiebelJMSProducer\UpdateCustomerSiebelJMSProducer.xml
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
Table 475. WC_PickList_Payment_Profile_BS Operations
Name
Description
WC_PickList_Payment_Profile_BSQueryPage
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.
WC_PickList_Payment_Profile_BSExceute
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.
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
Table 476. Request Message Description: WC_PickList_Payment_Profile_BSQueryPage
Node
Description
Type
WC_PickList_Payment_Profile_
BSQueryPage_Input
The container element for the QueryPage

Operation request.The method arguments are
Payment Integration Object, Language Mode
(value is LDC) and viewMode (All).
Integration
Object
Response Message Description: WC_PickList_Payment_Profile_BSQueryPage

Table 477. Response Message Description: WC_PickList_Payment_Profile_BSQueryPage
Node
Description
Type
BSQueryPage_Output

viewMode (All).
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.
Table 478. Request Message Description: WC_PickList_Payment_Profile_BSExecute
Node
Description
Type
BSExecute_Input

viewMode (All).
Integration
Object
Response Message Description: WC_PickList_Payment_Profile_BSExecute

Table 479. Response Message Description: WC_PickList_Payment_Profile_BSExecute
Node
Description
Type
BSExecute_Output
The retrieved data for the update operation

performed which could be creating/editing/deleting
of a payment wallet.
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.

Table 480. WC_PickList_Payment_Profile_BS Web service
Name
Class
Integration Object
CSSEAIUIDataService

Table 481. WC_PickList_Payment_Profile_BS Web service
External Name
WC_PickList_Payment_Profile_IO
Payment Profile
Example Package for WC_PickList_Payment_Profile_BS

Request
\WC_PickList_Payment_Profile_BS\WC_PickList_Payment_Profile_BS_request.xml
Response
\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:
Support and Testing Web Services on page 285

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
Web Service Name
Namespace
Type
CME
NetworkOrderEntry
http://siebel.com/
NetworkOrderEntry
Inbound
TroubleTicket
http://siebel.com/TroubleTicket
Inbound
INS Claims
http://siebel.com/claims
Inbound
External Auto Policy
http://siebel.com/claims/
Outbound
External Property Policy
http://siebel.com/claims/
Outbound
Warranty
http://siebel.com/Service/
AssetWarranty
Inbound
CopyActivity
http://siebel.com/Service/FS/
CopyActivity
Inbound
ServiceRequest
http://siebel.com/Service/FS/
ServiceRequests
Inbound
AssetManagement
http://www.siebel.com/Service/
FS/Assets
Inbound
VerifyEntitlement
http://www.siebel.com/Service/
FS/Entitlement
Inbound
GetHealthCareProfessionalCompl
ianceDetails
http://siebel.com/LS/
MarketingCompliance
Inbound
GetHealthCareProfessionalProfile
Information
MarketingCompliance
Inbound
FINS
FS
LS
28 3
Web Services for Siebel CRM 8.0 Primary Web Services for Siebel CRM 8.0

Area
Web Service Name
Namespace
Type
Mktg
MarketingCompliance
Inbound
MarketingCompliance
Inbound
WebMarketing
webmarketing
Inbound
EventManagement
http://www.siebel.com/
Marketing/EventData
Inbound
Event Registration
Marketing/EventRegistration
Inbound
ABOWebService
http://siebel.com/
OrderManagement/ABO
Inbound
AssetWebService
http://siebel.com/
OrderManagement/Asset
Inbound
CatalogWebService
http://siebel.com/
OrderManagement/Catalog
Inbound
ProductConfigurator
http://siebel.com/
OrderManagement/Configurator
Inbound
ContactWebService
http://siebel.com/
OrderManagement/Contact
Inbound
CalculatePriceWS
http://siebel.com/
OrderManagement/External/PSP
Inbound
OrderWebService
http://siebel.com/
OrderManagement/Order
Inbound
PromotionWebService
http://siebel.com/
OrderManagement/Promotion
Inbound
QuoteAddItemsWS
http://siebel.com/
OrderManagement/Quote
Inbound
QuoteWebService
http://siebel.com/
OrderManagement/Quote
Inbound
CalculatePriceWS
http://siebel.com/
OrderManagement/Quote/PSP
Inbound
http://siebel.com/
Inbound
http://siebel.com/
Inbound
OM
284
Web Services for Siebel CRM 8.0 Support and Testing Web Services

Area
Web Service Name
Namespace
Type
PRM
PartnerPrograms
http://siebel.com/PRM/
PartnerPrograms
Inbound
PartnerRegistration
http://siebel.com/PRM/
PartnerRegistration
Inbound
PS
Serialization Service
http://siebel.com/publicsector
Inbound
SFA
WC_Account_BS
Inbound
WC_Contacts_BS
Inbound
WC_Opportunity_BS
Inbound
Inbound
Forecast
http://siebel.com/Sales/SFA
Inbound
Integration_Object_Info_Service
Inbound
SFA_Activity_BS
Inbound
EAILOVWS
LOVService
Inbound
OrderManagement/
ContextService
Inbound
Utility
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
Web Service Name
Namespace
Type
DDKPOC
DedicatedBlockWS
Inbound
DDKPOC
WC_Asset_DB_BS
Inbound
DDKPOC
WC_MVG_Channel_Partner_BS
Inbound
DDKPOC
WC_MVG_Household_BS
Inbound
DDKPOC
WC_MVG_Industry_BS
Inbound
28 5

Area
Web Service Name
Namespace
Type
DDKPOC
WC_MVG_Internal_Division_BS
Inbound
DDKPOC
WC_MVG_Organization_BS
Inbound
DDKPOC
WC_MVG_Position_BS
Inbound
DDKPOC
WC_MVG_Source_BS
Inbound
DDKPOC
WC_MVG_Territory_BS
Inbound
DDKPOC
WC_Orders_BS
Inbound
DDKPOC
WC_PickList_Abs_Admin_Service_Region_BS
Inbound
DDKPOC
WC_PickList_Action_BS
Inbound
DDKPOC
WC_PickList_Agreement_Entitlement_BS
Inbound
DDKPOC
WC_PickList_Auction_Services_BS
Inbound
DDKPOC
WC_PickList_Business_Address_BS
Inbound
DDKPOC
WC_PickList_Campaign_BS
Inbound
DDKPOC
WC_PickList_Currency_BS
Inbound
DDKPOC
WC_PickList_Employee_BS
Inbound
DDKPOC
WC_PickList_FS_Shipping_BS
Inbound
DDKPOC
WC_PickList_Internal_Product_BS
Inbound
DDKPOC
WC_PickList_Order_Entry_BS
Inbound
DDKPOC
Inbound
286

Area
Web Service Name
Namespace
Type
DDKPOC
WC_PickList_Payment_Terms_BS
Inbound
DDKPOC
WC_PickList_Price_List_BS
Inbound
DDKPOC
WC_PickList_Sales_Assessment_BS
Inbound
DDKPOC
WC_PickList_Sales_Stage_BS
Inbound
DDKPOC
WC_PickList_Service_Agreement_BS
Inbound
DDKPOC
WC_PickList_Siebel_Instance_BS
Inbound
DDKPOC
WC_PickList_VORD_Network_Asset_BS
Inbound
EAI
Core
WC Cached State Managed Service
Inbound
EAI
Core
WC Cached Stateful Service
Inbound
EAI
Core
WC Cached Stateless Service
Inbound
EAI
Core
WC NonCached State Managed Service
Inbound
EAI
Core
WC NonCached Stateful Service
Inbound
EAI
Core
WC NonCached Stateless Service
Inbound
Misc
ActuateAPI
http://schemas.actuate.com/
actuate7/wsdl
Outbound
Misc
ActuateAPI
http://schemas.actuate.com/
actuate8/wsdl
Outbound
Misc
DecisionService
http://
www.sigmadynamics.com/
schema/services/
DecisionService
Outbound
Misc
ExternalChoiceService
http://
www.sigmadynamics.com/
schema/services/
ExternalChoice
Outbound
28 7

Area
Web Service Name
Namespace
Type
Misc
JobManagementService
com.siebel.analytics.web/
soap/v1
Outbound
Misc
SAWSessionService
soap/v1
Outbound
Misc
SendMailingService
urn:xml-send-mailing
Outbound
Misc
SiebelSharePointArchival
collab/
Outbound
Misc
SiebelSharePointIntegration
collab/
Outbound
Misc
WC_Quote_BS
Inbound
Misc
Web Collaboration Service
SharepointIntegration
Inbound
Misc
WebCatalogService
soap/v1
Outbound
Test
PSRUnitBenchmark
http://siebel.com/PSR/FS/
PSRUnitTest
Inbound
ASI
AccountWS
http://siebel.com/asi/
Inbound
ASI
ActivityWS
Inbound
ASI
ContactWS
Inbound
ASI
CRM Contact Management
Inbound
ASI
CRM Lead Management
Inbound
ASI
CRM Marketing Management
Inbound
ASI
CRM Party Management
Inbound
ASI
CRM Service Management
Inbound
ASI
External Account
Outbound
ASI
External ANI Claims Notice of Loss
Outbound
ASI
External ANI Claims Payment Info
Outbound
ASI
External ATP Check
Outbound
ASI
External Contact
Outbound
ASI
External Credit Check
Outbound
ASI
External CRM Lead Management
Outbound
ASI
External CRM Marketing Management
Outbound
ASI
External CRM Service Management
http://siebel.com/asi
Outbound
288

Area
Web Service Name
Namespace
Type
ASI
External Employee
Outbound
ASI
External Household
Outbound
ASI
External Opportunity Create
Outbound
ASI
External Opportunity Query
Outbound
ASI
External Opportunity Update
Outbound
ASI
External Opportunity Update Response
Outbound
ASI
External Order
Outbound
ASI
External Position
Outbound
ASI
External Quote
Outbound
ASI
External Request Add/Cancel Group Policy

Member
Outbound
ASI
External Request Add/Cancel Individual

Policy Member
Outbound
ASI
External Request Authorization
Outbound
ASI
External Request Benefit Detail
Outbound
ASI
External Request Eligibility Check
Outbound
ASI
External Request Preliminary Rating
Outbound
ASI
External Request Providers
Outbound
ASI
External Request Referral
Outbound
ASI
External Request Update of Member Details
Outbound
ASI
External Send Update Provider Details
Outbound
ASI
External Shipment Tracking
Outbound
ASI
External Shopping Cart Create
Outbound
ASI
External Simple Product
Outbound
ASI
Healthcare Group Policy Member

Management
Inbound
ASI
Healthcare Individual Policy Member

Management
Inbound
ASI
Healthcare Member Details Management
Inbound
ASI
Healthcare Request Authorization
Inbound
ASI
Healthcare Request Benefit Detail
Inbound
ASI
Healthcare Request Eligibility Check
Inbound
28 9

Area
Web Service Name
Namespace
Type
ASI
Healthcare Request Preliminary Rating
Inbound
ASI
Healthcare Request Providers
Inbound
ASI
Healthcare Request Referral
Inbound
ASI
Healthcare Send Update Provider Details
Inbound
ASI
Insurance Claims Notice of Loss
Inbound
ASI
Insurance Claims Payment Info Management
Inbound
ASI
Insurance Life Policy Management
Inbound
ASI
ModuleLicense
Inbound
ASI
OpportunityWS
Inbound
ASI
PIMDomainWS
Inbound
ASI
ProjectWS
Inbound
ASI
SearchExternalService
Inbound
ASI
SearchSecurityService
Inbound
ASI
ServiceRequestWS
Inbound
ASI
Siebel Account
Inbound
ASI
Siebel Case Information
Inbound
ASI
Siebel Contact
Inbound
ASI
Siebel Employee
Inbound
ASI
Siebel Household
Inbound
ASI
Siebel Invoice
Inbound
ASI
Siebel Opportunity Create
Inbound
ASI
Siebel Opportunity Query
Inbound
ASI
Siebel Opportunity Update
Inbound
ASI
Siebel Opportunity Update Response
Inbound
ASI
Siebel Order
Inbound
ASI
Siebel Position
Inbound
ASI
Siebel Quote
Inbound
ASI
Siebel Shopping Cart Create
Inbound
ASI
Siebel Simple Product
Inbound
ASI
Siebel TM Alignment
Inbound
ASI
Siebel TM Alignment Results
Inbound
290

Area
Web Service Name
Namespace
Type
ASI
Siebel TM Hierarchy
Inbound
ASI
Siebel TM Territory
Inbound
Utility
SessionAccessWS
SessionAccess
Inbound
Utility
Inbound
Utility
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
Description
AutoOrder
Converts a Quote to a Sales Order.
SubmitOrder
Submits an Order.
AutoAsset
Creates assets from the completed order line items or updates a

current asset.
ModifyAssetToQuote
Modifies an asset (Service Item), and generates a quote item to

update the selected asset.
ModifyAssetToOrder
Modifies an asset (Service Item), and generates an order item to

update the selected asset.
DisconnectAssetToQuote
Disconnects an asset (Service Item) to generate a quote item to

deactivate the selected asset.
DisconnectAssetToOrder
Disconnects an asset (Service Item), and generates an order item

to deactivate the selected asset.
SuspendAssetToQuote
Suspends an active asset (Service Item) to generate a quote item

to suspend the selected asset.
SuspendAssetToOrder
Suspends an asset (Service Item) and generates an order item to

suspend the selected asset.
ResumeAssetToQuote
Resumes a suspended asset (Service Item) to generate a quote

item to resume the selected asset.
ResumeAssetToOrder
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

Table 485. Request Message Description: AutoOrder
Node
Description
Object Id
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
Description
PDS Order
Instance of Integration object PDS Order.
Header
Order Header.
Line Item
Order Line Items.
XA
Order Line Item attributes.
Request Message Description: SubmitOrder

Table 487. Request Message Description: SubmitOrder
Node
Description
OrderId
Required. RowId of the order to be submitted.
Response Message Description: SubmitOrder

response message.
Request Message Description: AutoAsset

Table 488. Request Message Description: AutoAsset
Node
Description
Object Id
Required. RowId of the corresponding Order that contains the Order Line Item
to be converted or applied to an asset.
LineItemId
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
Description
PDS Asset
Header
Asset Header.
Line Item
Asset.
XA
Asset attributes.
Request Message Description: ModifyAssetToQuote

Table 490. Request Message Description: ModifyAssetToQuote
Node
Description
AssetIntegrationId

AssetIntegrationId or AssetNumber.
AssetNumber

ActiveDocumentId
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.
AccountId
Account Id of the account that owns the selected asset (Service Item).
ContactId
Contact Id of the contact who owns the selected asset (Service Item)
to be modified.
DueDate
PriceListId
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.
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
Description
PDS Quote
Header
Quote Header.
Line Item
Quote Line Item.
XA
Quote Line Item attributes.
Request Message Description: ModifyAssetToOrder

Table 492. Request Message Description: ModifyAssetToOrder
Node
Description
AssetIntegrationId

AssetNumber

ActiveDocumentId
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.
AccountId
Account Id of the account that owns the selected asset (Service

Item).
ContactId
Contact Id of the contact who owns the selected asset (Service

Item) to be modified.
DueDate
PriceListId
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.
Response Message Description: ModifyAssetToOrder

response message.
298
Request Message Description: SuspendAssetToQuote

Response Message Description: SuspendAssetToQuote

Request Message Description: SuspendAssetToOrder

Response Message Description: SuspendAssetToOrder

Request Message Description: ResumeAssetToQuote

Response Message Description: ResumeAssetToQuote

Request Message Description: ResumeAssetToOrder

Response Message Description: ResumeAssetToOrder

Request Message Description: DisconnectAssetToQuote

Response Message Description: DisconnectAssetToQuote

Request Message Description: DisconnectAssetToOrder

Response Message Description: DisconnectAssetToOrder

29 9
ABOWebService Application Interface

Technology Network.

Table 493. ABOWebService Service Object
Name
Boundary Object
Type
Class (if
Business Service)
SISOMAutoOrderWebService
Workflow
Not applicable
SISOMSubmitWebService
Workflow
Not applicable
SISOMAutoAssetWebService
Workflow
Not applicable
SISOMModifyWebService-Quote
Workflow
Not applicable
SISOMModifyWebService-Order
Workflow
Not applicable
SISOMSuspendWebService-Quote
Workflow
Not applicable
SISOMSuspendWebService-Order
Workflow
Not applicable
SISOMResumeWebService-Quote
Workflow
Not applicable
SISOMResumeWebService-Order
Workflow
Not applicable
SISOMDisconnectWebService-Quote
Workflow
Not applicable
SISOMDisconnectWebService-Order
Workflow
Not applicable

Table 494. ABOWebService Data Object
External Name
PDS Quote
PDS Quote
PDS Order
PDS Order
PDS Asset
PDS Asset
Example Package for ABOWebService

300
Primary Web Services for Siebel CRM 8.0 Asset Management
Request (AutoOrder)
\ABOWebService\AutoOrder_request.xml
Response (AutoOrder)
...\ABOWebService\AutoOrder_response.xml
Request (ModifyAssetToQuote)
...\ABOWebService\ModifyAssetToQuote_request.xml
Response (ModifyAssetToQuote)
...\ABOWebService\ModifyAssetToQuote_response.xml
Request (AutoAsset)
...\ABOWebService\AutoAsset_request.xml
Response (AutoAsset)
...\ABOWebService\AutoAsset_response.xml
Message Schema (WSDL) for ABOWebservice

...\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.
Table 495. Asset Mangement Operations
Name
Description
Asset_spcManagement_AssetManagementInsert
Creates an
Asset record.
Request: Asset_spcManagement_AssetManagementInsert_Input
Request: Asset_spcManagement_AssetManagementInsert_Output:
Asset_spcManagement_AssetManagementQueryPage
Request: Asset_spcManagement_AssetManagementQueryPage_Input
Queries for an
Asset record.
Response: Asset_spcManagement_AssetManagementQueryPage_Output
Asset_spcManagement_AssetManagementUpdate
Request: Asset_spcManagement_AssetManagementUpdate_Input
Updates an
Asset record.
Response: Asset_spcManagement_AssetManagementUpdate_Output
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

Technology Network.

Table 496. Asset Management Service Object
Name
Class (If BusService)
Asset Management
Business Service
CSSEAIUIDataService
302

Table 497. Asset Management Data Object
External Name
Asset Management
Asset Management
Methods
Table 498. Asset Management Methods
Operation
Method
Asset_spcManagement_AssetManagementInsert
[BS:Asset Management].[Insert]
Asset_spcManagement_AssetManagementQueryPage
[BS:Asset Management].[QueryPage]
Asset_spcManagement_AssetManagementUpdate
[BS:Asset Management].[Update]
Example Package for AssetManagement

Request
...\AssetManagement\AssetManagement_request.xml
Response
...\AssetManagement\AssetManagement_response.xml
Message Schema (WSDL) for AssetManagement

...\AssetManagement\AssetManagement.wsdl
30 3
Primary Web Services for Siebel CRM 8.0 AssetWebService
AssetWebService
CalculatePriceWS
Use this Web service to calculate the documents Quote price.
CalculatePriceWS Operations
Table 499. CalculatePriceWS Operations
Name
Description
CalculatePrice
Calculate price for the input Quote Document. The Web service
invokes the Web Channel Pricing Driver Workflow.
Request Message Description: CheckQuoteEligibilityCompatibility

Table 500. Request Message Description: CheckQuoteEligibilityCompatibility
Node
Description
QuoteIO
Required. An instance of the Integration Object PDS Quote.
Response Message Description: CheckQuoteEligibilityCompatibility

Table 501. Response Message Description: CheckQuoteEligibilityCompatibility
Node
Description
QuoteIO
An instance of the Integration Object PDS Quote.
CalculatePriceWS Application Interface

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
Business
Service
Method
Sub
process
Name
Type
Description
Transfer
Quote IO
to PS
Business
Service
EAI
Integration
Object to XML
Hierarchy
Converter
IntObjHierToPSHier
Not
applicable
Converts input to the

PDS Quote
integration object to
a property set
hierarchy.
Get
Context
Business
Service
Context
Service
GetRowSetData
Not
applicable
Creates Context Row

Set from the
Property Set
hierarchy.
Get
RowSet
Business
Service
Context
Service
GetRowSetData
Not
applicable
Creates Row Set

from Property Set
hierarchy.
Set
Pricing
Date
Business
Service
Row Set
Transformation
Toolkit
Conditional Action
Transform
Not
applicable
Sets the Pricing Date

to the current time
stamp or the date
provided by the Joint
Workspace Scenario
Builder.
Calculate
Price
Sub
Procedure
Dynamic
Pricing
Procedure
Calls the Dynamic

Pricing Procedure to
perform pricing.
Zero Out
Totals
Business
Service
Row Set
Transformation
Toolkit
Conditional Action
Transform
Not
applicable
Clears the price

totals on the Context
Row Set.
Totaling
Business
Service
Row Set
Transformation
Toolkit
Conditional Action
Transform
Not
applicable
Calculates the Totals

for the Non
Recurring Charge
and Monthly
Recurring Charge on
the Context Row Set.
Sync Row
Set to PS
Business
Service
Context
Service
SetRowSetData
Not
applicable
Writes the updated

Row Set back to the
Property Set
Hierarchy.
30 5
Primary Web Services for Siebel CRM 8.0 CalculatePriceWS
Table 502. PSP Driver Workflow Process

Name
Type
Business
Service
Sync
Context
to PS
Business
Service
Context
Service
SetRowSetData
Not
applicable
Writes the updated

Context back to the
Property Set
Hierarchy.
Transfer
from PS
to IO
Business
Service
EAI
Integration
Object to XML
Hierarchy
Converter
PSHierToIntObjHier
Not
applicable
Converts the
Property Hierarchy
to the Integration
Object Hierarchy.
Method
Sub
process
Description

Table 503. CalculatePriceWS Service Object
Name
Web Channel Pricing Driver Workflow
Workflow
Not applicable

Table 504. CalculatePriceWS Data Objects
External Name
PDS Quote
PDS Quote
Structure:
Header
|-----LineItem
|----- XA
Methods
Table 505. CalculatePriceWS Data Objects
Operation
Method
CalculatePrice
RunProcess
306
Primary Web Services for Siebel CRM 8.0 CatalogWebService
Example Package for CalculatePriceWS

Request
...\CalculatePriceWS\CalculatePriceWS_request.xml
Response
...\CalculatePriceWS\CalculatePriceWS_response.xml
Message Schema (WSDL) of CalculatePriceWS

...\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
Table 506. CatalogWebService Operations
Name
Description
Get Catalog
Retrieves a list of catalogs.
Get Catalog Categories
Retrieves a list of categories for a given catalog.
Get Category Products
Retrieves a list of products for a given catalog, category

and other contextual parameters.
Publish Catalog
Retrieves the full structure of a given Catalog including

category and products.
Get Product Details
Retrieves the basic product information along with the

attributes.
30 7
Table 506. CatalogWebService Operations

Name
Description
Get Product Children
Retrieves the details of the product specific child entities,

such as 'Product Literature', 'Features', and so on.
Get Product Attribute Domain
Retrieves all the possible values for a given product

attribute.
Get Related Promotions
Retrieves all the related Promotions for a given product.
Get Search Options
Retrieves the search options for a specific product family or

class. For example, enter 'Printer Speed', 'Color', and so on
for the 'Printer' Class.
Get Search Parameters
Retrieves a list of fields or attributes that are available for

a search option. For example, enter '100dpm', '200dpm'
for the 'Printer Speed' option.
Execute Search
Returns the search results based on the search options and

parameter values.
Request Message Description: GetCatalogs

Table 507. Request Message Description: GetCatalogs
Node
Description
PDS Catalog Interface
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
Table 508. Response Message Description: GetCatalogs
Node
Description

PDS Catalog Interface.
Request Message Description: GetCatalogCategory

Table 509. Request Message Description: GetCatalogCategory
Node
Description
PDS Catalog Category Interface
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
Description

Catalog Category Interface.
Request Message Description: GetCategoryProducts

Table 511. Request Message Description: GetCategoryProducts
Node
Description
PDS Category Product Interface
Required. An instance of Integration Object PDS

Category Product Interface.
PricingMode

value is Y.
EligibilityMode
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.
ContextMode
SiebelContext or ExternalConext. Optional. However,

provide ContextMode to run pricing and eligibility.
Context
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: GetCategoryProducts

Integration Object Message Format: PDS Category Product Interface. For a description of this
Table 512. Response Message Description: GetCategoryProducts
Node
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

Table 513. Request Message Description: PublishCatalog
Node
Description
PDS Publish Catalog Interface
Required. An instance of Integration Object PDS Category

Product Interface.
PricingMode
Y or N (calculates price or not). Optional. The default value

is Y.
EligibilityMode
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.
ContextMode
SiebelContext or ExternalContext. Optional. However, you

must provide ContextMode to run pricing and eligibility.
Context
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.
IncludePriceWaterfall
Y or N (includes price waterfall or does not).
Response Message Description: PublishCatalog

Integration Object Message Format: PDS Publish Catalog Interface. For a description of this response
Table 514. Response Message Description: PublishCatalog
Node
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

Table 515. Request Message Description: GetProductDetails
Node
Description
PDS Product Details

Interface
Required. An instance of Integration Object PDS Product Details Interface.
PricingMode
Y or N (calculates price or not). Optional. The default value is Y.
EligibilityMode
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
Description
ContextMode
SiebelContext or ExternalConext. Optional. However, provide ContextMode

to run pricing and eligibility.
Context
An instance of Integration Object PDS Catalog Context. It either contains

SiebelContext or ExternalContext. Optional only if ContextMode is not
Response Message Description: GetProductDetails

Integration Object Message Format: PDS Product Details Interface. For a description of this response
Table 516. Response Message Description: GetProductDetails
Node
Description
PDS Product Details

Interface
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

Table 517. Request Message Description: GetProductChildren
Node
Description
PDS Product Children

Interface
Required. An instance of Integration Object PDS Product Children

Interface.
PricingMode:
EligibilityMode
0, 1, 2 (eligibility display mode: 0 do not run; 1 run; 2 run but only return
eligible products). Optional. The default value 1.
ContextMode
SiebelContext or ExternalConext. Optional. However, provide

ContextMode to run pricing and eligibility.
Context

31 1
Response Message Description: GetProductChildren

Integration Object Message Format: PDS Product Children Interface. For a description of this
Table 518. Response Message Description: GetProductChildren
Node
Description
PDS Product Children Interface
An instance of Integration Object PDS Product Children

Interface.
Request Message Description: GetSearchOptions

Table 519. Request Message Description: GetSearchOptions
Node
Description
PDS Searchable Product Class

Interface
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
Table 520. Response Message Description: GetSearchOptions
Node
Description
PDS Searchable Product Class

Interface
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
Description
PDS Searchable Product

Class Interface
Required. An instance of Integration Object PDS Searchable Product

Class Interface.
FieldNameClassId
Property name for the class Id field. Optional. The default value is Class
Id. It is recommend that this field not be changed.
LookupFromCache
Y or N (lookup search parameters from cache). Optional. The default

value is N. (It will be made obsolete. Do not use this parameter.)
MaximumAttributes
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
Table 522. Response Message Description: GetSearchParameters
Node
Description
PDS Product Class Attributes

Interface

Product Class Attributes Interface.
Request Message Description: GetProductAttributeDomain

Retrieves all the Possible Values for a Given Product Attribute. For a description of this request
Table 523. Request Message Description: GetProductAttributeDomain
Node
Description
Attribute Id
Product attribute Id. This is a required input.
Product Configuration
Model Id
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
Description
PDS Product Attribute

Domain Interface
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
Description
SearchOption
Required. SearchByProduct or SearchByClass.
PDS Product Interface
An instance of Integration Object PDS Product Interface. This is a

required input for the SearchByProduct search option.
PricingMode
EligibilityMode
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
Description
ContextMode
SiebelContext or ExternalConext. Optional. However, provide

ContextMode to run pricing and eligibility.
Context

PriceSearchExpression
Price field search expression. For example, greater than > 100 and less
than < 1000. Optional.
ProductSearchSpec
Search specification for the product business component, for example,

[Name] like "IBM*". Optional.
ResultSize
Number of products returned. Optional. The default value is 100.
PDS Product Class

Attributes Interface
An instance of Integration Object PDS Product Class Attributes Interface.

This is a required input for the SearchByClass search option.
Response Message Description: ExecuteSearch

Integration Object Message Format: PDS Product Interface. For a description of this response
Table 526. Response Message Description: ExecuteSearch
Node
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

Technology Network.

Table 527. CatalogWebService Service Object
Name
PDS Product Data Service
BusService
CSSProdDataSvc
314

Table 528. CatalogWebService Data Objects
External Name
PDS Product Class Attributes Interface
PDS Product Class Attributes Interface
PDS Product Attribute Domain Interface
PDS Product Attribute Domain Interface
PDS Searchable Product Class Interface
PDS Searchable Product Class Interface
PDS Product Details Interface
PDS Product Details Interface
CatalogWebService Example Package

Request
...\CatalogWebService\CatalogWebService_request.xml
Response
...\CatalogWebService\CatalogWebService_response.xml
Message Schema (WSDL) of CatalogWebService

...\CatalogWebService\CatalogWebService.wsdl
31 5
Primary Web Services for Siebel CRM 8.0 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
Table 529. ContextServiceWrapperService Operations
Node
Description
ContextServiceWrapperService-QuoteHeader-Verify
Validates a Quote, including all of its items,

or validates the selected quote items under
a quote. The signal invoked is
QuotesAndOrdersValidate.
ContextServiceWrapperService-QuoteItem-Verify
Validates a Quote, including all of its items,

or validates the selected quote items under
a quote. The signal invoked is
ContextServiceWrapperService-OrderHeader-Verify
Validates an Order, including all of its items,

or validates the selected order items under
an order. The signal invoked is
ContextServiceWrapperService-OrderItem-Verify
Validates an Order, including all of its items,

or validates the selected order items under
an order. The signal invoked is
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
Table 530. Request Message Description: ContextServiceWrapperService-QuoteHeader-Verify
Node
Description
Header
Quote (Quote Ids, UIActive, UISelected required)
Line Item
Quote Item
XA
Quote Item attributes
316
Response Message Description: ContextServiceWrapperService-QuoteHeader-Verify

Table 531. Response Message Description: ContextServiceWrapperService-QuoteHeader-Verify
Node
Description
Return Message
Data Validation: returns a validation message for validating

a Quote or Order against the Data Validation Rule Set.
Return Message
Promotion: returns a validation message from the

promotion verify workflow.
Return Message
All: returns a validation message after validating all

Customizable Products (CP) under the Quotes or Orders.
Return Message
Data Validation: returns a validation message for validating

a Quote or Order against the Data Validation Rule Set.
Request Message Description: ContextServiceWrapperService-QuoteItem-Verify

Table 532. Request Message Description: ContextServiceWrapperService-QuoteItem-Verify
Node
Description
Header
Quote (Quote Id required)
Line Item
Quote Item (Quote Items Ids, UIActive, UISelected required)
XA
Quote Item attributes
Response Message Description: ContextServiceWrapperService-QuoteItem-Verify

Table 533. Response Message Description: ContextServiceWrapperService-QuoteItem-Verify
Node
Description
Return Message
Data Validation: returns a validation message for validating a Quote or

Order against the Data Validation Rule Set.
Return Message
Promotion: returns a validation message from the promotion verify

workflow.
Return Message
Validate CP All: returns a validation message after validating all

Customizable Products (CP) under the Quotes or Orders.
Return Message
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

Table 534. Request Message Description: ContextServiceWrapperService-OrderHeader-Verify
Node
Description
Header
Order Entry - Orders (Order Id required)
Line Item
Order Entry - Line Items (Order Items Ids, UIActive, UISelected required)
XA
Order Item attributes
Response Message Description: ContextServiceWrapperService-OrderHeader-Verify

Table 535. Response Message Description: ContextServiceWrapperService-OrderHeader-Verify
Node
Description
Return Message
Data Validation: returns a validation message for validating a Quote or Order

against the Data Validation Rule Set.
Return Message
Promotion: returns a validation message from the promotion verify workflow.
Return Message
Validate CP All: returns a validation message after validating all Customizable

Products (CP) under the Quotes or Orders.
Return Message

Request Message Description: ContextServiceWrapperService-OrderItem-Verify

Table 536. Request Message Description: ContextServiceWrapperService-OrderItem-Verify
Node
Description
Header
Order Entry - Orders (Order Id required)
Line Item
Order Entry - Line Items (Order Items Ids, UIActive, UISelected required)
XA
Order Item attributes
318
Response Message Description: ContextServiceWrapperService-OrderItem-Verify

Table 537. Response Message Description: ContextServiceWrapperService-OrderItem-Verify
Node
Description
Return Message

Return Message
Promotion: returns a validation message from the promotion verify workflow.
Return Message
Validate CP All: returns a validation message after validating all Customizable

Products (CP) under the Quotes or Orders.
Return Message

ContextServiceWrapperService Application Interface

Technology Network.

Table 538. ContextServiceWrapperService Service Objects
Name
Boundary Object
Type
ContextServiceWrapperService-QuoteHeader-Verify
Workflow
ContextServiceWrapperService-QuoteItem-Verify
Workflow
ContextServiceWrapperService-OrderHeader-Verify
Workflow
ContextServiceWrapperService-OrderItem-Verify
Workflow

Table 539. ContextServiceWrapperService Data Objects
External Name
WS Quote
WS Quote
WS Order
WS Order
31 9
Methods
Table 540. ContextServiceWrapperService Methods
Operation
Method
ValidateQuotes
RunProcess
ValidateQuoteItems
RunProcess
ValidateOrders
RunProcess
ValidateOrderItems
RunProcess
Example Packages for ContextServiceWrapperService

Request (ValidateQuotes)
...\ContextServiceWrapperService\ValidateQuote_request.xml
Response (ValidateQuotes)
...\ContextServiceWrapperService\ValidateQuotes_response.xml
Request (ValidateQuoteItems)
...\ContextServiceWrapperService\ValidateQuoteItems_request.xml
Response (ValidateQuoteItems)
...\ContextServiceWrapperService\ValidateQuoteItems_response.xml
Message Schema (WSDL) of ContextServiceWrapperService

...\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
Table 541. CopyActivity Operations
Name
Description
WSCopyServiceActivityRunProcess
Creates activity records.
Request Message Description: WSCopyServiceActivityRunProcess

Table 542. Request Message Description: WSCopyServiceActivityRunProcess
Node
Description
SRId
Row Id of service request.
TemplateId
Row Id of Activity Template.
ActPlanId
Row Id of Activity Plan.
Response Message Description: WSCopyServiceActivityRunProcess

There is response message for this operation.
CopyActivity Application Interface

Technology Network.

Table 543. CopyActivity Service Object
Name
WS Copy Service Activity
Workflow
32 1
Primary Web Services for Siebel CRM 8.0 EAILOVWS
Methods
Table 544. CopyActivity Methods
Operation
Method
WSCopyServiceActivityRunProcess
[WF: WS Copy Service Activity].[RunProcess]
Example Package for CopyActivity

Request (WSCopyServiceActivityRunProcess)
...\CopyActivity\CopyActivity_request.xml
Response (WSCopyServiceActivityRunProcess)
...\CopyActivity\CopyActivity_response.xml
Message Schema (WSDL) of CopyActivity

...\CopyActivity\CopyActivity.wsdl
EAILOVWS
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
Table 545. EligibilityCompatibility Operations
Name
Description
CheckQuoteEligibilityCompatibility
Checks the eligibility and compatibility

status for the input Quote Object.
Request Message Description: CheckQuoteEligibilityCompatibility

Table 546. Request Message Description: CheckQuoteEligibilityCompatibility
Node
Description
QuoteIO
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.
PSPMode
The default is External PDS Quote. This parameter will be parsed as Mode
used in the Variable Map.
PickMode
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.
ProjectedAssetIO
An instance of the Projected Asset Integration Object. It is used for a

compatibility check with the current quote.
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
How It Is Used in
Eligibility and
Compatibility
PDS Quote (Quote) Mapping XML

Name
Variable Name (Map to

Internal Variable Map)
AccountContractedProductsOnlyFlag
Account Contracted
Products Only Flag
Used in the workflow
AccountId
Account Id
Account (used in the

Eligibility Matrix)
AccountType
Account Type
Account Type (used in the

Eligibility Matrix)
ShippingCity
City
City (used in the Eligibility

Matrix)
ShippingCountry
Country
Country (used in the

Eligibility Matrix)
32 3
Table 547. Eligibility and Compatibility Used Fields

How It Is Used in
Eligibility and
Compatibility
PDS Quote (Quote) Mapping XML

Name

ShippingPostalCode
Postal Code
Postal Code (used in the

Eligibility Matrix)
PriceListId
Price List Id
Price List (checks in the

workflow if the product is
included in the price list)
ShippingState
State
State (used in the Eligibility

Matrix)
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
Variable Name
How It Is Used
AccountId
Account Id
Account (used in the Eligibility Matrix).
ClassId
Class Id
Product Class (used in the Compatibility Matrix).
EffectiveFrom
Effective From
Checks if the product is effective.
EffectiveTo
Effective To
Checks if the product is effective.
InclusiveEligibilityFlag
Inclusive Eligibility
Flag
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
Name
Name of the line item.
PrePickCD
Pre Pick
Defines if the line item will trigger the eligibility and

compatibility checking. It must be 'Y' to trigger the
eligibility and compatibility check.
PriceListId
Price List Id
Price List (checks if the product is included in the

price list).
ProductId
Product Id
Product (used in the Eligibility and Compatibility

Matrix).
ProductLineId
Product Line Id
Product Line (used in the Eligibility and

Compatibility Matrix).
324
Response Message Description: CheckQuoteEligiblityCompatibility

Table 549. Response Message Description: CheckQuoteEligiblityCompatibility
Node
Description
QuoteIO
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

Technology Network.

Table 550. EligibilityCompatibility Service Object
Boundary
Object Type
Name
Web Channel Product Eligibility &
Compatibility Driver Workflow
Class (if
BusService)
Workflow

Table 551. EligibilityCompatibility Data Objects
External Name
PDS Quote
Projected Asset
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

...\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
Table 552. EventManagement Operations
Name
Description
GetEvents
Retrieves a list of events based on Status or Date Search Specification.
GetEventDetails
Retrieves event details for an event preferably based on an Id Search

Specification.
GetSessions
Retrieves a list of sessions.
GetRegisteredEvents
Retrieves a list of events registered by a specified contact.
RegisterForEvent
Enroll a contact into a specified event which invokes the Event

Registration Service.
Request Message Description: GetEvents

Table 553. Request Message Description: GetEvents
Node
Description
Id
Row Id of Event
Name
Name of Event
Status
Event Status
Event Type
Event Format
326
Table 553. Request Message Description: GetEvents

Node
Description
Max Attendees
Maximum Number of Attendees than can enroll for the Event.
Start Date
Event Start Date.
End Date
Event End Date.
Description
Event Description.
Parent Event
Name
Event Plan.
Session Info
Id
Session Id.
Event Id
Parent Event Id.
Name
Session Name.
Description
Session Description.
Start Date
Session Start Date.
End Date
Session End Date.
Region
Session Region.
View Mode
All.
Response Message Description: GetEvents

This Response Message is the same as the Request Message. For more information, see Table 553.
Request Message Description: GetEventDetails

Table 554. Request Message Description: GetEventDetails
Node
Description
Id
Row Id of Event.
Name
Name of Event.
Status
Event Status.
Event Type
Event Format.
Max Attendees
Start Date
Event Start Date.
End Date
Event End Date.
Description
Event Description.
Participant Type
Event Participant Type.
32 7
Table 554. Request Message Description: GetEventDetails

Node
Description
Region
Region where the Event takes Place.
Parent Event Name
Event Plan.
Invitation Deadline
Event Invitation deadline.
Organization
Event Organization.
Lead Partner
Event Partner.
Primary venue Name
Name of the Venue where the Event happens.
URL
Web URL for Events.
Period Name
Event Period.
Budget Period
Event Budget Period.
Session Info
Id
Session Id.
Event Id
Parent Event Id.
Name
Session Name.
Description
Start Date
Session Start Date.
End Date
Session End Date.
Region
Session Region.
View Mode
All.
Response Message Description: GetEventDetails

Request Message Description: GetRegisteredEvents

Table 555. Request Message Description: GetRegisteredEvents
Node
Description
Id
Row Id of Event Attendee.
Event Id
Event for which the attendee is registering to.
Attendee Id
Contact Id.
Name
Event Name.
Status
Event Registration Status.
328
Table 555. Request Message Description: GetRegisteredEvents

Node
Description
Event Type
Event Format.
Max Attendees
Maximum Number of attendees allowed to enroll into the Event.
Start
Start Date of Event..
End
End Date of Event.
View Mode
All.
Response Message Description: GetRegisteredEvents

Request Message Description: GetSessions

Table 556. Request Message Description: GetSessions
Node
Description
Id
Row Id of Event.
Name
Name of Event.
Status
Event Status.
Event Type
Event Format.
Max Attendees
Start Date
Event Start Date.
End Date
Event End Date.
Description
Event Description.
Parent Event Name
Event Plan.
Session Info
Id
Session Id.
Event Id
Parent Event Id.
Name
Session Name.
Description
Start Date
Session Start Date.
End Date
Session End Date.
Region
Session Region.
View Mode
All.
32 9
Response Message Description: GetSessions

Request Message Description: RegisterForEvent

Table 557. Request Message Description: RegisterForEvent
Node
Description
Status
Registration status.
Registration date
Date when the registration

occurs.
Contact Id
Attendee Id of event.
Reg Id
Registration Id.
Event Id
Event being enrolled to.
User Type
Denotes type of Attendee.
Response Message Description: RegisterForEvent

Table 558. Response Message Description: RegisterForEvent
Node
Description
Output Type
Message to Indicate detailed status.
Return Val
Outcome Status.
Reg Id
Registration Id.
EventManagement Application Interface

Technology Network.

Table 559. EventManagement Service Object
Name
Class (if Bus Service)
Event Data Service
Business Service
CSSEAIUIDataService
Event Detail Service
Business Service
CSSEAIUIDataService
330
Table 559. EventManagement Service Object

Name
Class (if Bus Service)
Event Attendee Data Service
Business Service
CSSEAIUIDataService
Session Data Service
Business Service
CSSEAIUIDataService
Event Registration Service
Business Service
CSSEventRegistrationService

Table 560. EventManagement Data Objects
External Name
WC_Event_IO
Event
WC_EventSession_IO
Event Session
WC_ATT_IO
Event Attendee
Methods
Table 561. EventManagement Methods
Operation
Display Name
Method
QueryPage
GetEvents
[BS: Event Data Service].[QueryPage]
QueryPage
GetEventDetails
[BS: Event Detail Service].[QueryPage]
QueryPage
Session Data Service
[BS: Session Data Service].[QueryPage]
QueryPage
GetRegisteredEvents
[BS: Event Attendee Data Service].[QueryPage]
EnrollUser
RegisterForEvent
BS: Event Registration Service].[ EnrollUser]
Example Package for EventManagement

Request
...\EventManagement\EventManagement_request.xml
Response
33 1
Primary Web Services for Siebel CRM 8.0 Event Registration
...\EventManagement\EventManagement_response.xml
Message Schema (WSDL) for EventManagement

...\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
\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
Table 562. GetHealthCareProfessionalProfileInformation Operations
Name
Description
LSMCProfileQueryById
Read the profile of an HCP specified by his/her

Siebel Contact Row Id.
LSMCProfileQueryByExample
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
Description
<PrimaryRowId>
Required - represents the Siebel Row Id of the Contact Object.
33 3
Request Message Description: LSMCProfileQueryByExample

Table 564. Request Message Description: LSMCProfileQueryByExample
Node
Description
<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>
Required is a combination of attributes

to uniquely identify a Contact.
334

The column Node represents a respective Siebel field if not specified otherwise. For a description of
Table 565. Common Response Message Description
Node
Parent
<ListOfLSMCProfile>
Description
<Tag>
<Contact soapenc>
ListOfLSMCProfile
<Tag>
<Contact>
Contact soapenc
<Tag>
<AccountIntegrationId>
Contact
<CallClass>
Contact
<ContactId>
Contact
<CreatedByName>
Contact
<EmployeeNumber>
Contact
<FirstName>
Contact
<LastName>
Contact
<LeadContactType>
Contact
<MarketPotential>
Contact
<MiddleName>
Contact
<PartyTypeCode>
Contact
<PartyUId>
Contact
<PersonUId>
Contact
<PersonalContact>
Contact
<PositionStatus>
Contact
<PrimaryCity>
Contact
<PrimaryCountry>
Contact
<PrimaryEmployeeLoginOfPrimaryContact
Position>
Contact
Contact
Contact
Contact
Contact
Contact
Contact
33 5

Node
Parent
Description
<PrimaryPostalCode>
Contact
<PrimarySpecialty>
Contact
<PrimaryState>
Contact
Contact
Contact
<PrivacyCode>
Contact
<Type>
Contact
<UpdatedByName>
Contact
<WorkPhone>
Contact
<ListOfLsMcBudgetContact>
Contact
<Tag>
<LsMcBudgetContact soapenc>
ListOfLsMcBudgetContact
<Tag>
<LsMcBudgetContact>
LsMcBudgetContact soapenc
<Tag>
<BudgetAmount>
LsMcBudgetContact
<BudgetCurrency>
LsMcBudgetContact
<BudgetEndDate>
LsMcBudgetContact
<BudgetId>
LsMcBudgetContact
<BudgetName>
LsMcBudgetContact
<BudgetStartDate>
LsMcBudgetContact
<BudgetState>
LsMcBudgetContact
<ContactId>
LsMcBudgetContact
<ListOfLsMcBudgetContactSalesRep>
LsMcBudgetContact
<Tag>
<LsMcBudgetContactSalesRep soapenc>
ListOfLsMcBudgetContactSalesRep
<Tag>
<LsMcBudgetContactSalesRep>
LsMcBudgetContactSalesRep soapenc
<Tag>
<ContactBudgetId>
LsMcBudgetContactSalesRep
<Currency2>
<SalesRepBudget>
<PositionId>
<PositionName>
<ListOfLsMcContactExpenseItem>
Contact
<Tag>
ListOfLsMcContactExpenseItem
<Tag>
<LsMcContactExpenseItem soapenc>
336

Node
Parent
Description
<LsMcContactExpenseItem>
LsMcContactExpenseItem soapenc
<Tag>
<ComplianceFlag>
LsMcContactExpenseItem
<Currency>
<ExchangeRate>
<ExpenseId>
<ExpenseItemAmount>
<ExpenseItemCurrency>
<ExpenseItemId>
<ExpenseItemTypeId>
<ExpenseItemTypeName>
<ProcessStatus>
<TransactionState>
<ListOfLsMcContactExpenseItemAllocation>
<Tag>
<LsMcContactExpenseItemAllocation soapenc>
ListOfLsMcContactExpenseItemAlloca
tion
<Tag>
<LsMcContactExpenseItemAllocation>
LsMcContactExpenseItemAllocation
soapenc
<Tag>
<Currency2>
<Description>
<ExpenseId>
<AllocatedAmount>
<LoggedById>
<ProcessStatus>
<ReportingState>
<TransactionState>
<ListOfServiceRequest>
Contact
<Tag>
<ServiceRequest soapenc>
ListOfServiceRequest
<Tag>
<ServiceRequest>
ServiceRequest soapenc
<Tag>
<Abstract>
ServiceRequest
<AdditionalInformation>
ServiceRequest
<Area>
ServiceRequest
33 7

Node
Parent
<Comments>
ServiceRequest
<ComplaintDescription>
ServiceRequest
<ComplaintType>
ServiceRequest
<ConfirmationNeeded>
ServiceRequest
<ContactId2>
ServiceRequest
<CreatedByName>
ServiceRequest
<Currency>
ServiceRequest
<CustomerComments>
ServiceRequest
<Decision>
ServiceRequest
<Description2>
ServiceRequest
<EffectiveDate2>
ServiceRequest
<HealthCareComplaintType>
ServiceRequest
<HealthCareSubType>
ServiceRequest
<Outcome>
ServiceRequest
<Owner>
ServiceRequest
<Priority>
ServiceRequest
<ProviderId>
ServiceRequest
<ProviderLastName>
ServiceRequest
<SRNumber>
ServiceRequest
<SROpenDate>
ServiceRequest
<SRRootcause>
ServiceRequest
<SRStatusDate>
ServiceRequest
<SRSubType>
ServiceRequest
<SRType>
ServiceRequest
<SRUrgency>
ServiceRequest
<Severity>
ServiceRequest
<Status>
ServiceRequest
<SubType>
ServiceRequest
<Sub-Area>
ServiceRequest
<ListOfFinAlertContact>
338
Contact
Description
<Tag>

Node
Parent
Description
<FinAlertContact soapenc>
ListOfFinAlertContact
<Tag>
<FinAlertContact>
FinAlertContact soapenc
<Tag>
<Category>
FinAlertContact
<ContactId>
FinAlertContact
<Message>
FinAlertContact
<Priority>
FinAlertContact
<StartDate2>
FinAlertContact
GetHealthCareProfessionalProfileInformation Application Interface

Technology Network.

Table 566. GetHealthCareProfessionalProfileInformation Service Object
Name
LSMCProfile
Business Service

Table 567. GetHealthCareProfessionalProfileInformation Data Object
External Name
LSMCProfile
Contact
Methods
For a descripition of methods for this Web service, see Table 568.
Table 568. GetHealthCareProfessionalProfileInformation Methods
Operation
Method
LSMCProfileQueryById
QueryById
LSMCProfileQueryByExample
QueryByExample
33 9
Primary Web Services for Siebel CRM 8.0 GetHeathCareProfessionalComplianceDetails
Example Package for GetHeathcareProfessionalProfileInformation

Request
...\GetHeathcareProfessionalProfileInformation\Request.xml
Response
...\GetHeathcareProfessionalProfileInformation\Response.xml

GetHeathcareProfessionalProfileInformation
...\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
Description
LSMCDetailsQueryById
Reads the profile of the Health Care Provider specified

by his/her Siebel Contact Row Id.
LSMCDetailsQueryByExample
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
Description
<PrimaryRowId>
Required. Represents the Siebel Row Id of the Contact Object.
34 1
Request Message Description: LSMCDetailsQueryByExample

Table 571. Request Message Description: LSMCDetailsQueryByExample
Node
Description
<Contact>
<Created>
<Updated>
<CallClass>
<ContactId>
<CreatedByName>
<EmployeeNumber>
<FirstName>
<LastName>
<LeadContactType>
<MarketPotential>
<MiddleName>
<PartyTypeCode>
<PartyUId>
<PersonUId>
<PersonalContact>
<PositionStatus>
<PrimaryCity>
<PrimaryEmployeeLoginOfPrimaryContactPosition>
<PrimaryPostalCode>
<PrimarySpecialty>
<PrimaryState>
<PrivacyCode>
<Type>
<UpdatedByName>
<WorkPhone>
Required. A combination of attributes

to uniquely identify a Contact.
342

Node
Parent
<ListOfLSMCDetails><Tag>
Description
<Tag>
<Contact soapenc>
ListOfLSMCDetails
<Tag>
<Contact>
Contact soapenc
<Tag>
Contact
<CallClass>
Contact
<ContactId>
Contact
<CreatedByName>
Contact
<EmployeeNumber>
Contact
<FirstName>
Contact
<LastName>
Contact
<LeadContactType>
Contact
<MarketPotential>
Contact
<MiddleName>
Contact
<PartyTypeCode>
Contact
<PartyUId>
Contact
<PersonUId>
Contact
<PersonalContact>
Contact
<PositionStatus>
Contact
<PrimaryCity>
Contact
<PrimaryCountry>
Contact
<PrimaryEmployeeLoginOfPrimaryContact
Position>
Contact
Contact
Contact
Contact
34 3

Node
Parent
Description
Contact
Contact
Contact
<PrimaryPostalCode>
Contact
<PrimarySpecialty>
Contact
<PrimaryState>
Contact
Contact
Contact
<PrivacyCode>
Contact
<Type>
Contact
<UpdatedByName>
Contact
<WorkPhone>
Contact
<ListOfLsMcBudgetContact>
Contact
<Tag>
<LsMcBudgetContact soapenc>
ListOfLsMcBudgetContact
<Tag>
<LsMcBudgetContact>
LsMcBudgetContact soapenc
<Tag>
<BudgetAmount>
LsMcBudgetContact
<BudgetCurrency>
LsMcBudgetContact
<BudgetEndDate>
LsMcBudgetContact
<BudgetId>
LsMcBudgetContact
<BudgetName>
LsMcBudgetContact
<BudgetStartDate>
LsMcBudgetContact
<BudgetState>
LsMcBudgetContact
<ContactId>
LsMcBudgetContact
<ListOfLsMcBudgetContactSalesRep>
LsMcBudgetContact
<Tag>
<LsMcBudgetContactSalesRep soapenc>
ListOfLsMcBudgetContactSalesRep
<Tag>
<LsMcBudgetContactSalesRep>
LsMcBudgetContactSalesRep soapenc
<Tag>
<ContactBudgetId>
344

Node
Parent
<Currency2>
<SalesRepBudget>
<PositionId>
<PositionName>
Description
<ListOfLsMcContactExpenseItem>
Contact
<Tag>
<LsMcContactExpenseItem soapenc>
ListOfLsMcContactExpenseItem
<Tag>
<LsMcContactExpenseItem>
LsMcContactExpenseItem soapenc
<Tag>
<ComplianceFlag>
<Currency>
<ExchangeRate>
<ExpenseId>
<ExpenseItemAmount>
<ExpenseItemCurrency>
<ExpenseItemId>
<ExpenseItemTypeId>
<ExpenseItemTypeName>
<ProcessStatus>
<TransactionState>
<ListOfLsMcContactExpenseItemAllocation>
<Tag>
<LsMcContactExpenseItemAllocation
soapenc>
ListOfLsMcContactExpenseItemAllocation
<Tag>
<LsMcContactExpenseItemAllocation>
soapenc
<Tag>
<Currency2>
<Description>
<ExpenseId>
<AllocatedAmount>
34 5

Node
Parent
<LoggedById>
<ProcessStatus>
<ReportingState>
<TransactionState>
Description
GetHealthCareProfessionalComplianceDetails Application Interface

Technology Network.

Table 573. GetHealthCareProfessionalComplianceDetails Service Object
Name
LSMCDetails
Business Service

Table 574. GetHealthCareProfessionalComplianceDetails Data Object
External Name
LSMCDetails
Contact
Methods
Table 575. GetHealthCareProfessionalComplianceDetails Methods
Operation
Method
LSMCDetailsQueryById
QueryById
LSMCDetailsQueryByExample
QueryByExample
346
Primary Web Services for Siebel CRM 8.0 GetUnallocatedExpenseItem
Example Package for GetHeathcareProfessionalComplianceDetails

Request
...\GetHeathcareProfComplianceDetails\GetHeathcareProfessionalComplianceDetails_reques
t.xml
Response
...\GetHeathcareProfComplianceDetails\GetHeathcareProfessionalComplianceDetails_respon
se.xml

GetHeathcareProfessionalComplianceDetails
...\GetHeathcareProfessionalComplianceDetails\GetHeathcareProfessionalComplianceDetail
s.wsdl
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
Description
LSMCGetUnallocatedExpenseItemQueryById
Read the data of an expense item specified

by its Siebel Row Id.
LSMCGetUnallocatedExpenseItemQueryByExample
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
Description
<PrimaryRowId>
Required. Represents the Siebel Row Id of the Expense Item Object.
Request Message Description: LSMCGetUnallocatedExpenseItemQueryByExample

Table 578. Request Message Description: LSMCGetUnallocatedExpenseItemQueryByExample
Node
Description
<Contact>
<Id>
<LSMCAllocationDate>
<LSMCAllocationStatusCode>
<LSMCComplianceFlag>
<LSMCTransactionState>
<ExpenseItemType>
<Amount>
<ExchangeRate>
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.

Node
Parent
Description
<ListOfLSMCGetUnallocatedExpenseItem
xmlns><Tag>
N/A
<Tag>
<ExpenseItem soapenc ...>
ListOfLSMCGetUnallocatedExpenseItem
<Tag>
<ExpenseItem>
ExpenseItem soapenc
<Tag>
<Id>
ExpenseItem
ExpenseItem
348

Node
Description
Parent
ExpenseItem
ExpenseItem
<LSMCTransactionState>
ExpenseItem
<ExpenseItemType>
ExpenseItem
<Amount>
ExpenseItem
<ExchangeRate>
ExpenseItem
<ListOfLSMCContactExpenseItem>
ExpenseItem
<Tag>
<LSMCContactExpenseItem soapenc ...>
ListOfLSMCContactExpenseItem
<Tag>
<LSMCContactExpenseItem>
LSMCContactExpenseItem soapenc
<Tag>
<Id>
LSMCContactExpenseItem
<ListOfLSMCBudgetContact>
<Tag>
<LSMCBudgetContact soapenc ...>
ListOfLSMCBudgetContact
<Tag>
<LSMCBudgetContact>
LSMCBudgetContact soapenc
<Tag>
<Id>
LSMCBudgetContact
<BudgetState>
LSMCBudgetContact
<ListOfLSMCEmployeeExpenseItem>
ExpenseItem
<Tag>
<LSMCEmployeeExpenseItem soapenc >
ListOfLSMCEmployeeExpenseItem
<Tag>
<LSMCEmployeeExpenseItem>
LSMCEmployeeExpenseItem soapenc
<Tag>
<Id>
LSMCEmployeeExpenseItem
GetUnallocatedExpenseItem Application Interface

Technology Network.

Table 580. GetUnallocatedExpenseItem Service Object
Name
LSMCGetUnallocatedExpenseItem
Business Service
34 9
Primary Web Services for Siebel CRM 8.0 INSClaims

Table 581. GetUnallocatedExpenseItem Data Object
External Name
Methods
Table 582. GetUnallocatedExpenseItem Methods
Operation
Method
LSMCGetUnallocatedExpenseItemQueryById
QueryById
LSMCGetUnallocatedExpenseItemQueryByExample
QueryByExample
Example Package for GetUnallocatedExpenseItem

Request
...\GetUnallocatedExpenseItem\GetUnallocatedExpenseItem_request.xml
Response
...\GetUnallocatedExpenseItem\GetUnallocatedExpenseItem_response.xml
Message Schema (WSDL) for GetUnallocatedExpenseItem

...\GetUnallocatedExpenseItem\GetUnallocatedExpenseItem.wsdl
INSClaims
Use this Web service to query for, and update claims and claim elements.
350
INSClaimsOperations
Table 583. INSClaimsOperations
Name
Description
INSClaimsQueryByExample
Retrieves the claim record.
INSClaimsInsertOrUpdate
Updates the claim record.
ClaimElementQueryByExample
Retrieves a claim element.
ClaimElementInsertOrUpdate
Updates a claim element.
Request Message Description: INSClaimsQueryByExample

Table 584. Request Message Description: INSClaimsQueryByExample
Node
Description
SiebelMessage
Required. Based on integration object INS Claims.
Request Message Description: INSClaimsInsertOrUpdate

Table 585. Request Message Description: INSClaimsInsertOrUpdate
Node
Description
SiebelMessage
Required. Based on integration object INS Claims.
Request Message Description: ClaimElementQueryByExample

Table 586. Request Message Description: ClaimElementQueryByExample
Node
Description
SiebelMessage
Required. Based on integration object FINS Claim Elements.
Request Message Description: ClaimElementInsertOrUpdate

Table 587. Request Message Description: ClaimElementInsertOrUpdate
Node
Description
SiebelMessage
Required. Based on integration object FINS Claim Elements.
35 1

The response messages for these operations are the same as the request messages.
INSClaims Application Interface

Technology Network.

Table 588. INSClaims Service Object
Name
INS Claims
Business Service
FINS Claim Elements
Business Service

Table 589. INSClaims Data Object
External Name
INS Claims
INS Claims
FINS Claim Elements
FINS Claim Elements
Methods
Table 590. INSClaims Methods
Operation
Method
INSClaimsQueryByExample
INS Claims.QueryByExample
INSClaimsInsertOrUpdate
INS Claims.InsertOrUpdate
ClaimElementQueryByExample
FINS Claim Elements.QueryByExample
ClaimElementInsertOrUpdate
FINS Claim Elemetns.InsertOrUpdate
Example Package for INSClaims

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

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
Table 591. IntegrationObjectInfo Operations
Name
Description
GetIntegrationObjectInfo
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
Description
IntegrationObjectName
Integration Object name.
IntegrationCompName
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
Description
RepositoryIntegrationObject
Integration Object name.
RepositoryIntegrationComponent
Integration Component name.
ListOfRepositoryIntegrationComponentField
List of repository Integration Component field names.
IntegrationObjectInfo Application Interface

Technology Network.

Table 594. IntegrationObjectInfo Business Service
Name
Class
Integration ObjectInfo Service
Business Service
CSSIntObjectInfoService

Table 595. Integration Object Business Service
External Name
Siebel OM: Repository Integration Object
Repository Integration Object
Methods
Table 596. Methods Business Service
Operation
Method
35 5
Primary Web Services for Siebel CRM 8.0 NetworkOrderEntry
Example Package for IntegrationObjectInfo

Request
...\IntegrationObjectInfo\IntegrationObjectInfo_request.xml
Response
...\IntegrationObjectInfo\IntegrationObjectInfo_response.xml
Message Schema (WSDL) for IntegrationObjectInfo

...\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
Table 597. NetworkOrderEntry Operations
Name
Description
GetNetworkAssets
Return the network asset based on the asset Id.
GetNetworkAssetAttributes
Return the attribute of a network asset (regardless whether it

is network, network node, or network connection).
GetNetworkAssetAttachments
Return the file attachment for a network asset.
GetOpenNetworkOrders
Return the open order line items for a network asset.
ValidateNetworkOrder
Validate a network based on the product rules. If the network

is invalid, return the error messages.
QueryProjectedNetworkAsset
Return the projected asset for a network.
356
Primary Web Services for Siebel CRM 8.0 NetworkOrderEntry

The service has six operations. They do not share a common request message format.

The service has six operations. They do not share a common response message format.
NetworkOrderEntry Application Interface

Technology Network.

Table 598. NetworkOrderEntry Service Object
Name
VORD NOE Complex Data Service
Business Service
CSSVORDWebService
VORD NOE Simple Data Service
Business Service
CSSVORDWebService

Table 599. NetworkOrderEntry Data Object
External Name
Business Service
VORD NOE Network Assets
VORD NOE Asset Attributes
VORD NOE Simple Data

Service

Service
VORD NOE Network Attachments
VORD Network Asset

Service
VORD NOE Network Open Order Line

Items
VORD Network Asset

Service
VORD NOE Network Validation Rule
VORD Network Validation Rule
VORD NOE Complex Data

Service
VORD NOE Projected Asset
VORD NOE Projected Asset
VORD NOE Complex Data

Service
35 7
Primary Web Services for Siebel CRM 8.0 PartnerPrograms
Methods
Table 600. NetworkOrderEntry Methods
Operation
Business Service
Method
GetNetworkAssets
GetNetworkAssets
Example Package for NetworkOrderEntry

Request
...\NetworkOrderEntry\NetworkOrderEntry_request.xml
Response
...\NetworkOrderEntry\NetworkOrderEntry_response.xml
Message Schema (WSDL) for NetworkOrderEntry

...\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
Table 601. ProductConfigurator Operations
Name
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).
BeginConfiguration
Enables Customization of products stored in Siebel DB.

Initializes the configurator session with a Quote Instance and
product model.
UpdateConfiguration
Executes operations on the Quote instance initialized in

BeginConfiguration.
EndConfiguration
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.
35 9
Primary Web Services for Siebel CRM 8.0 ProductConfigurator

Table 602. Request Message Description: GetCfgObjectStructure
Node
Description
WebChannelObjStructure
Required. This structure identified the objects that will be

queries as well the data that will be returned about the objects.
Object
Name
Required. Name of Object (product / class). Either Name or Id

is required.
Id
Required. Id of Object (product / class). Either Name or Id is

required.
ObjectType
Required. Product OR Class.
ParentClassId
ClassId of the parent.
DisplayName
Display Name.
Description
Description.
Attribute
queried for).
Name
Name of Attribute. If empty, all attributes are returned.
LocalType
Local type.
InternalType
Internal type.
OrigId
Internal Id.
DisplayName
Display name.
Hidden
Hidden flag.
Required
Required flag.
ReadOnly
Read only flag.
ValidationSpec
Validation specification.
UnitOfMeasure
Unit of measure.
Description
Description.
AttributeDomain
Zero or more.
LocalValue
Local value.
InternalValue
Internal value.
AttributeDomainDecoration
Zero or more. Attribute domain specific properties name value

pairs.
Name
Name of object (product / class). Either Name or Id is required.
Value
Unique value.
360

Node
Description
AttributeDefaultValue
Default value of the attribute. Only one of the valuetypes will

DisplayValue
Display value.
String
String value.
Number
Number value.
Integer
Integer value.
Date
Date value.
Boolean
Boolean value.
AttributeRejectedValue
Rejected value of the attribute. Only one of the valuetypes will

DisplayValue
Display value.
String
String value.
Number
Number value.
Integer
Integer value.
Date
Date value.
Boolean
Boolean value.
AttributeDecoration
Zero or more. Attribute properties name value pairs.
Name
Name of Object (product / class). Either Name or Id is required.
Value
Unique value.
Relationship
queried for).
Name
Name of relationship. If Name and/or Id is specified, only that

Id
Id of relationship. If Name and/or Id is specified, only that

DisplayName
Display name.
ClassName
Class name.
ClassId
Class Id.
DefaultProductId
Default product Id.
DefaultCardinality
Default cardinality.
MinimumCardinality
Minimum cardinality.
36 1

Node
Description
MaximumCardinality
Maximum cardinality.
RelationshipDomain
Zero or more.
Name
Name of product. If Name and/or Id is specified, only that

Id
Id of product. If Name and/or Id is specified, only that

DisplayName
Display name.
OrigId
Orig Id.
Description
Description.
RelationshipDomainDecoration
Zero or more. Relationship domain specific properties name

value pairs.
Name
Value
Unique value.
Relationship Decoration
Zero or more. Relationship properties name value pairs.
Name
Value
Unique value.
LinkedItem
queried for).
Name
Id
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.
DisplayName
Display name.
VariableName
Variable Name.
SortSpec
Sort specification.
SearchSpec
Search specification.
NeedsExecution
Needs execution flag for BC based query.
Expression
Expression.
DefaultValue
Default Value.
BusinessObject
Business Object for BC based query.
BusinessComponent
Business Component for BC based query.
362

Node
Description
FieldName
Field name in Business Component.
Active
Active flag.
LinkedItemDecoration
Linked Item properties name value pairs.
Name
Value
Unique value.
Resource
queried for).
Name
Name of resource. If Name and/or Id is specified, only that

Id
Id of resource. If Name and/or Id is specified, only that

DisplayName
Display name.
ResourceDecoration
Resource properties name value pairs.
Name
Value
Unique value.
ObjectDecoration
Name
Value
Unique value.
Request Message Description: GetCfgObjectGroupItems/ GetCfgObjectDefaultGroupItems

Table 603. Request Message Description:GetCfgObjectGroupItems/GetCfgObjectDefaultGroupItems
Node
Description
WebChannelObjGroupItems
Required. This structure identified the objects that will be queries

as well the data that will be returned about the objects.
Object
Name
Required. Name of Object (product / class). Either Name or Id is

required.
Id
Required. Id of Object (product / class). Either Name or Id is

required.
ObjectType
Required. Product OR Class.
ParentClassId
ClassId of the parent.
36 3

Node
Description
DisplayName
Display Name.
Description
Description.
UIOption
Zero or more.
Name
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
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
Type.
DisplayName
Display Name.
Sequence
Sequence.
BaseTheme
Base Theme.
ProductTheme
Product Theme.
Responsibility
Zero or more.
Name
Name of responsibility. If Name and/or Id is specified, only that

Id
Id of responsibility. If Name and/or Id is specified, only that

Group
Zero or more.
Name
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
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.
DisplayName
Display Name.
Sequence
Sequence.
GroupTheme
Group Theme.
Description
Description.
GroupItem
Zero or more.
364

Node
Description
Id
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
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
Sequence.
GroupItemTheme
Group item theme.
Attribute
Refer to Attribute child object of GetCfgObjectStructure Request

Message.
Relationship
Refer to Relationship child object of GetCfgObjectStructure Request

Message.
LinkedItem
Refer to LinkedItem child object of GetCfgObjectStructure Request

Message.
Resource
Refer to Resource child object of GetCfgObjectStructure Request

Message.
GroupDecoration
Group properties name value pairs.
Name

Value
Unique value.
Object Decoration
Name

Value
Unique value.
Request Message Description: BeginConfiguration

Table 604. Request Message Description: BeginConfiguration
Node
Description
BeginConfiguration_Input
Required.
36 5

Node
Description
InitInstanceOperation
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
Required for InitInstanceOperation of LOAD / DEFAULT. Row Id of the

Header.
RootId
Required for InitInstanceOperation of LOAD / SET. Row Id for the root

line item.
ProductId
Required for InitInstanceOperation of DEFAULT / ADD. Product Id for

the root line item.
ListOfQuote
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.
ListOfData
List of products / attributes / relationships on which user requires

domain information (with exclusions) in CfgInteractData integration
object format.
ProductData
Item
IntegrationId
366
Integration Id of the line item. If IntegrationId specified, only this line

IntegrationId & ProductId are not specified, the root line item is looked
at.

Node
Description
ProductId
Product Id of the line item. If IntegrationId specified, only this line

IntegrationId & ProductId are not specified, the root line item is looked
at.
Name
Name of the product.
Quantity
Quantity.
RelationshipName
Relationship Name. For sub line items, RelationshipName can be

specified to limit the search to a particular Relationship.
RootIntegrationId
Integration Id of the Root line item.
PortId
Relationship Id.
ParentProductId
Parent Product Id.
ParentIntegrationId
Parent Integration Id.
CanDrilldown
Can Drilldown Flag. Used to indicate whether the line item is a

Customizable product.
ListPrice
List Price.
HasGenericsFlag
Has Generics Flag. Used to indicate whether the line item is

incomplete.
EligibilityStatus
Eligibility Status.
EligibilityReason
Eligibility Reason.
Explanation
ExplanationText
Relationship
Zero or more. List of Relationships on which information is required.
Name
Name of relationship to query for. If empty, all relationships are

returned.
Id
Id. Always returned whether specified in Request or not.
DomainItem
Zero or more. Domain Items of the relationship. Always returned

whether specified in Request or not.
Name
Name of domain item.
Id
Id of domain item.
Excluded
Excluded Flag indicates the whether this domain item is excluded by

a Constraint, Eligibility & Compatibility rule or Promotion.
Attribute
Zero or more. List of Attributes on which information is required.
Name
Name of attribute to query for. If empty, all attributes are returned.
36 7

Node
Description
ValueType
Type of Attribute. Always returned whether specified in Request or

not.
AttributeValue
Zero or more. List of Attribute values. Always returned whether

specified in Request or not.
DisplayValue
Display Value.
StringValue
IntegerValue
Value displayed as integer
NumberValue
Value displayed as number
BooleanValue
DateTimeValue
Selected
Selected Flag indicates whether this value is selected.
Excluded
Excluded Flag indicates whether this value is excluded by a Constraint,

Eligibility & Compatibility rule or Promotion.
Item
Zero or more. Same recursive structure as that defined in this topic.
ListOfLinkedItems
List of linked items.
LinkedItems
Linked items.
LinkedItemValue
One or more.
Name
Name of linked item.
ValueType
Type of Value.

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.
Table 605. Response Message Description: Begin Configuration
Node
Description
BeginConfiguration_Output
Required.
Error_spcCode
Error code if error occurred.
Error_spcMessage
Error message if error occurred.
RootId
Root Id of new item.
RootIntegrationId
Integration Id of new root item.
368
Table 605. Response Message Description: Begin Configuration

Node
Description
ListOfQuote
Quote instance if ReturnFullInstance input parameter was set to Y.

See BeginConfiguration Request Message for details.
ListOfData
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.
ListOfStatus

contains messages to be displayed.
Status
Required.
StatusCode
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.
StatusText
Details on the error if any.
ConflictResolution
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).
Messages
Zero or one. List of messages.
MessageType
Zero or more.
MessageSource
Source of the messages (Eligibility, Promotion, Cardinality, Proceed

Actions, and so on).
Message
Message text.

Table 606. Request Message Description: UpdateConfiguration
Node
Description
UpdateConfiguration_Input
Required.
ConflictAutoResolve
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.
FinishInstanceInFlag
If set Y, FinishIt is called.
SaveInstanceInFlag
If set Y, Instance is saved to db.
RepriceInstanceInFlag
If set Y, reprice is called.
VerifyInstanceInFlag
If set Y, verify instance is called.
36 9
Table 606. Request Message Description: UpdateConfiguration

Node
Description
ListOfData
Same as ListOfData in BeginConfiguration Request Message.
ListOfRequest
List of Requests that will be executed on the product instance.
Requests
Request
Zero or more.
Type
Type of request (AddItem, RemoveItem, SetItemQuantitty,

SetAttribute, ReplaceItem).
Item
Zero or more requests.
AddProductId
Add product Id for AddItem, ReplaceItem.
Quantity
Quantity.
RelationshipId
Relationship Id which contains the new product for AddItem,

ReplaceItem.
IntegrationId
Integration Id on which the operation will be performed.
Attribute
Zero or more SetAttribute request details.
Name
Name or attribute.
ValueType
Value type: string, integer or number.
AttributeValue
Zero or more.
DisplayValue
New display value of attribute.
String
Number
Integer
Date
Boolean

Table 607. Response Message Description: UpdateConfiguration
Node
Description
UpdateConfiguration_Output
Required.
Error_spcCode
Error_spcMessage
FinishConfigurationOutFlag
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
Description
RepriceOutFlag
Y / N. Indicates whether Reprice was done. It might not be

SaveInstanceOutFlag
Y / N. Indicates whether Save Instance was done. It might not be

performed if there were some conflicts.
VerifyOutFlag
Y / N. Indicates whether Verify was done. It might not be

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

contains messages to be displayed. See BeginConfiguration
Response Message.

Table 608. Request Message Description: EndConfiguration
Node
Description
EndConfiguration_Input
Required
SaveInstanceFlag
Save Instance flag

Table 609. Response Message Description: EndConfiguration
Node
Description
EndConfiguration_Output
Required.
Error_spcCode
Error_spcMessage
ListOfQuote
Quote instance. See BeginConfiguration

Request Message for details.
ProductConfigurator Application Interface

Technology Network.
37 1

Table 610. ProductConfigurator Service Object
Name
Cfg Object Broker
Business Service
CSSCfgObjBrokerService
ConfiguratorWebChannelBeginConfig
Workflow
Not applicable
ConfiguratorWebChannelUpdateConfig
Workflow
Not applicable
ConfiguratorWebChannelEndConfig
Workflow
Not applicable

Table 611. ProductConfigurator Data Object
External Name
CfgInteractData
ListOfData
CfgInteractRequest
ListOfRequest
CfgInteractStatus
ListOfStatus
CfgLinkedItems
ListOfLinkedItems
PDS Quote
ListOfQuote
Methods
Table 612. ProductConfigurator Methods
Operation
Method
GetObjStructure
GetObjGroupItems
GetObjDefaultGroupItems
Example Package for ProductConfigurator

Request (GetObjDefaultGroupItems)
372
Primary Web Services for Siebel CRM 8.0 ProductRecommendation
...\ProductConfigurator\GetObjDefaultGroupItems_request.xml
Response (GetObjDefaultGroupItems)
...\ProductConfigurator\GetObjDefaultGroupItems_response.xml
Request (GetObjGroupItems)
...\ProductConfigurator\GetObjGroupItems_request.xml
Response (GetObjGroupItems)
...\ProductConfigurator\GetObjGroupItems_response.xml
Request (GetObjStructure)
...\ProductConfigurator\GetObjStructure_request.xml
Response (GetObjStructure)
...\ProductConfigurator\GetObjStructure_response.xml
Message Schema (WSDL) for ProductConfigurator

...\ProductConfigurator\ProductConfigurator.wsdl
Use this Web service to generate the Recommended Products, based on the input Quote line items.
37 3
ProductRecommendation Operations
Table 613. ProductRecommendation Operations
Name
Description
GetRecommendedProductsForQuote
Generate Recommended Products
Request Message Description: GetRecommendedProductsForQuote

Table 614. Request Message Description: GetRecommendedProductsForQuote
Node
Description
QuoteIO

This is a required input.
PSP Mode
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

How It Is Used
AccountId
Account Id
Account (used in the Eligibility Check).
AccountType
Account Type
Account Type (used in the Eligibility Check
ShippingCity
City
City (used in the Eligibility Check)
ShippingCountry
Country
Country (used in the Eligibility Check)
ShippingPostalCode
Postal Code
Postal Code (used in the Eligibility Check)
PriceListId
Price List Id
Price List (used in the Eligibility Check and

pricing)
ShippingState
State
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
Variable Name
How It Is Used
ProductId
Product Id
Product (used as a key to find the

recommended products)
374
Response Message Description: GetRecommendedProductsForQuote

Table 617. Response Message Description: GetRecommendedProductsForQuote
Node
Description
RecommendedProductIO
An instance of the integration object Recommended Products. It

contains the product information, pricing, eligibility, and
recommended reason and score.
ProductRecommendation Application Interface

Technology Network.

Table 618. ProductRecommendation Service Object
Name
Class (If BusService)
Web Channel Product

Recommendation Driver Workflow
Workflow
Not applicable

Table 619. ProductRecommendation Data Objects
External Name
Recommended Products
Recommended Products
PDS Quote
Example Package for ProductRecommendation

Request
...\ProductRecommendation\ProductRecommendation_request.xml
37 5
Primary Web Services for Siebel CRM 8.0 PromotionWebService
Response
...\ProductRecommendation\ProductRecommendation_response.xml
Message Schema (WSDL) for ProductRecommendation

...\ProductRecommendation\ProductRecommendation.wsdl
PromotionWebService
Use this Web service to get product promotion information, apply product promotion.
PromotionWebService Operations
Table 620. PromotionWebService Operations
Name
Description
ISS_spcPromotion_spcWS_spc-_spcGetProductPromotionDetails
Get
Promotion
Details
information
Request: spcGetProductPromotionDetails_GetProductPromotionDefinition_Input
Response:spcGetProductPromotionDetails_GetProductPromotionDefinition_Output
ISS_spcPromotion_spcWS_spc-_spcApplyProductPromotion
Request: spcApplyProductPromotion_ApplyProductPromotion_Input
Response: spcApplyProductPromotion_ApplyProductPromotion_Output

Table 621. Request Message Description: GetProductPromotionDefinition
Node
Description
EligibilityMode
PricingMode
Optional, default value as 'Y'. Y/N.
LoadAllDomainFlag
Required, Y/N.
LoadDefaultDomainFlag
Required, Y/N.
LoadPromDefFlag
Required, Y/N.
ContextMode
Required, 'Siebel Context' or 'External Context'.
376
Apply
Product
Promotion
Table 621. Request Message Description: GetProductPromotionDefinition

Node
Description
Context
Required, in SiebelMessage format of IO 'PDS Catalog Context'.
ProdPromRuleType
Optional, 'Product' or 'Pricing'.
ProdPromId
ProdPromRuleId
ApplyProductPromotion
EligibilityMode
PricingMode
ProdPromId
Required.
ProdPromInstanceId
LineItemId
SiebelMessage
Required, in SiebelMessage format of IO 'PDS Quote'.

Table 622. Response Message Description: GetProductPromotionDefinition
Node
Description
ProdPromDefinition
In SiebelMessage format of IO 'ISS Promotion Definition for WS'.
PromDomainProduct
In SiebelMessage format of IO 'PDS Product Interface'. Could be

either default domain product details or all domain product details
depending on input arguments.
Err_spcCode
Err_spcMessage

Table 623. Request Message Description: ApplyProductPromotion
Node
Description
EligibilityMode
PricingMode
ProdPromId
Required.
ProdPromInstanceId
37 7
Table 623. Request Message Description: ApplyProductPromotion

Node
Description
LineItemId
SiebelMessage

Table 624. Response Message Description: ApplyProductPromotion
Node
Description
SiebelMessage
Err_spcCode
Err_spcMessage
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.

Table 625. PromotionWebService Service Object
Name
Boundary
Object Type
Class
ISS Promotion WS - GetProductPromotionDetails
Workflow
Not applicable
ISS Promotion WS - ApplyProductPromotion
Workflow
Not applicable
ISS Promotion WS - Add Missed Items Sub Process
Workflow
Not applicable

Table 626. PromotionWebService Data Object
External Name
ISS Promotion Definition for WS
ISS Promotion Definition for WS
PDS Catalog Context
PDS Catalog Context
PDS Quote
PDS Quote
378
Primary Web Services for Siebel CRM 8.0 QuoteWebService and OrderWebService
Example Package for PromotionWebService

Request
...\PromotionWebService\PromotionWebService_request.xml
Message Schema (WSDL) for PromotionWebService

...\PromotionWebService\PromotionWebService.wsdl
QuoteWebService and OrderWebService

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

Table 627. QuoteWebService and OrderWebService Operations
Name
Description
Update Order
Updates the order header information.
Update Order Item
Updates the line items for a specific order.
Update Quote
Updates the quote header information.
Update Quote Item
Updates the line items for a specific quote.
Delete Order
Deletes a given order.
Delete Order Item
Deletes the line items on a specific order.
Delete Quote
Deletes a given quote.
Delete Quote Item
Deletes the line items on a specific quote.
Insert Order
Inserts an order.
Insert Order Item
Adds the line items on a given order.
Insert Quote
Inserts a quote.
Insert Quote Item
Adds the line items on a given quote.
37 9
Table 627. QuoteWebService and OrderWebService Operations

Name
Description
Get Quote
Queries the quote.
Get Order
Queries an order.
Request Message Description: Query, Update, Delete Quote

Table 628. Request Message Description: Query, Update, Delete Quote
QueryByExample/QueryById/InsertQuote/DeleteQuote Request Message
Node
Description
QuoteIO
Response Message Description: Query, Update, Delete, Quote

Table 629. Response Message Description: Query, Update, Delete, Quote
QueryByExample/QueryById/InsertQuote/DeleteQuote Response Message
Node
Description
QuoteIO
Request Message Description: Query, Update, Delete Quote Item

Table 630. Request Message Description: Query, Update, Delete Quote Item
QueryByExample/UpdateQuoteItem/InsertQuoteItem/DeleteQuoteItem Request
Message
Node
Description
QuoteItemIO
Required. An instance of the Integration Object PDS Quote Item.
Response Message Description: Query, Update, Delete Quote Item

Table 631. Response Message Description: Query, Update, Delete Quote Item
QueryByExample/UpdateQuoteItem/InsertQuoteItem/DeleteQuoteItem
Response Message
Node
Description
QuoteItemIO
Required. An instance of the Integration Object PDS Quote Item.
380
Request Message Description: Query, Update, Delete Order

Table 632. Request Message Description: Query, Update, Delete Order
QueryByExample/QueryById/InsertOrder/DeleteOrder Request Message
Node
Description
OrderIO
Required. An instance of the Integration Object PDS Order.
Response Message Description: Query, Update, Delete Order

Table 633. Response Message Description: Query, Update, Delete Order
QueryByExample/QueryById/InsertOrder/DeleteOrder Response Message
Node
Description
OrderIO
Required. An instance of the Integration Object PDS Order.
Request Message Description: Query, Update, Delete Order Item

Table 634. Request Message Description: Query, Update, Delete Order Item
QueryByExample/UpdateOrderItem/InsertOrderItem/DeleteOrderItem Request
Message
Node
Description
OrderItemIO
Required. An instance of the Integration Object PDS Order Item.
Response Message Description: Query, Update, Delete Order Item

Table 635. Response Message Description: Query, Update, Delete Order Item
QueryByExample/UpdateOrderItem/InsertOrderItem/DeleteOrderItem Response
Message
Node
Description
OrderItemIO
Required. An instance of the Integration Object PDS Order Item.
QuoteWebService and OrderWebService Application Interface

Technology Network.
38 1

Table 636. QuoteWebService and OrderWebService Service Objects
Name
PDS Quote
BusService
PDS Quote Item
BusService
PDS Order
BusService
PDS Order Item
BusService

Table 637. QuoteWebService and OrderWebService Data Objects
External Name
PDS Quote
PDS Quote Item
PDS Order
PDS Order Item
Example Package for QuoteWebService

Request
...\Quote_and_Order\QuoteWebService_request.xml
Response
...\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
Table 638. QuoteAddItemsWS Operations
Name
Description
QuoteAddItems
Add quote line items.
Request Message Description: QuoteAdd Items

Table 639. Request Message Description: QuoteAdd Items
Node
Description
Instance
Required. An instance of Integration Object PDS Quote. This is a

required input.
GetProductDataRequest
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.
Item, ProductId
Required field for each item. The product that will be added to the
Instance.
Item, Quantity
Quantity of the product. Not a required field. The default value is 1.
GetPricing
Y or N. Turns on (Y) or off (N) Pricing.
CheckEligibility
Y or N. Turns on (Y) or off (N) Eligibility Check.
Response Message Description: QuoteAddItems

Table 640. Response Message Description: QuoteAddItems
Node
Description
Instance
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

Technology Network.

Table 641. QuoteAddItems Service Object
Name
Web Channel Quote Add Default Items
Workflow
Not applicable

Table 642. QuoteAddItems Data Objects
External Name
Added Products
None (XML)
PDS Quote
Example Package for QuoteAddItems

Request
...\QuoteAddItemsWS\QuoteAddItemsWS_request.xml
Response
...\QuoteAddItemsWS\QuoteAddItemsWS_response.xml
Message Schema (WSDL) for QuoteAddItems

...\QuoteAddItemsWS\http_siebel.com_OrderManagement_Quote_QuoteAddItemsWS.wsdl
384
Primary Web Services for Siebel CRM 8.0 SerializationService
SerializationService
...\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.
Table 643. ServiceRequest Operations
Name
Description
Service_spcRequest_ServiceRequestInsert
Creates a service request
Request: Service_spcRequest_ServiceRequestInsert_Input
Response: Service_spcRequest_ServiceRequestInsert_Output
Service_spcRequest_ServiceRequestQueryPage
Read service request
Request: Service_spcRequest_ServiceRequestQueryPage_Input
Response: Service_spcRequest_ServiceRequestQueryPage_Output
Service_spcRequest_ServiceRequestUpdate
Update service request
Request: Service_spcRequest_ServiceRequestUpdate_Input
Response: Service_spcRequest_ServiceRequestUpdate_Output
Service_spcRequest_ServiceRequestDelete
Delete service request
Request: Service_spcRequest_ServiceRequestDelete_Input
Response: Service_spcRequest_ServiceRequestDelete_Output

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

Same as Request Message format.
ServiceRequest Application Interface

Technology Network.

Table 644. ServiceRequest Service Object
Name
Class
Service Request
Business Service
CSSEAIUIDataService

Table 645. ServiceRequest Data Object
External Name
Service Request
Service Request
Methods
Table 646. ServiceRequest Methods
Operation
Method
Service_spcRequest_ServiceRequestInsert
[BS:Service Request].[Insert]
Service_spcRequest_ServiceRequestQueryPage
[BS:Service Request].[QueryPage]
Service_spcRequest_ServiceRequestUpdate
[BS:Service Request].[Update]
Service_spcRequest_ServiceRequestDelete
[BS:Service Request].[Delete]
Example Package for ServiceRequest

386
Primary Web Services for Siebel CRM 8.0 SessionAccessWS
Request
...\ServiceRequest\ServiceRequest_request.xml
Response
...\ServiceRequest\ServiceRequest_response.xml
Message Schema (WSDL) for ServiceRequest

...\ServiceRequest\ServiceRequest.wsdl
SessionAccessWS
...\SessionAccessWS\SessionAccessWS.wsdl
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.
Table 647. SetAllocatedExpenseItem Operations
Name
Description
LSMCSetAllocatedExpenseItemSynchronize
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
Parent Node
<ListOfLSMCSetAllocatedExpenseItem>
Description
<Tag>
<ExpenseItem ...>
ListOfLSMCSetAllocatedExpenseItem
<Tag>
<ExpenseItem>
ExpenseItem ...
<Tag>
<Id>
ExpenseItem
ExpenseItem
Optional
ExpenseItem
Optional
ExpenseItem
Optional
<ListOfLSMCContactExpenseItem>
ExpenseItem
<Tag>
<LSMCContactExpenseItem ...>
ListOfLSMCContactExpenseItem
<Tag>
<LSMCContactExpenseItem>
<Tag>
Required
<ListOfLSMCContactExpenseItemAllocation>
<Tag>
<LSMCContactExpenseItemAllocation ...>
ListOfLSMCContactExpenseItemAlloca
tion
<Tag>
<LSMCContactExpenseItemAllocation>
LSMCContactExpenseItemAllocation
<Tag>
<ExpenseItemContactId>
Required
<ReportingState>
Required
<Description>
Optional
<AllocatedAmount>
Required
<Id>
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

Technology Network.
388
Primary Web Services for Siebel CRM 8.0 SetAllocatedExpenseItem

Table 649. SetAllocatedExpenseItem Service Object
Name
LSMCSetAllocatedExpenseItem
Business Service

Table 650. SetAllocatedExpenseItem Data Object
External Name
Methods
Table 651. SetAllocatedExpenseItem Method
Operation
Method
LSMCSetAllocatedExpenseItemSynchronize
Synchronize
Example Package for SetAllocatedExpenseItem

Request
...\SetAllocatedExpenseItem\SetAllocatedExpenseItem_request.xml
Response
...\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
Description
SFAInsertActivity
Creates an activity record in the database and

associates a contact record to it.
Response Message Description: SFAInsertActivity

Table 653. Response Message Description: SFAInsertActivity
Node
Description
SFA_Activity_IO
Required
Response Message Description: SFAInsertActivity

Table 654. Response Message Description: SFAInsertActivity
Node
Description
SFA_Activity_IO
Required
SFA_Activity_BS Application Interface

Technology Network.
390
Primary Web Services for Siebel CRM 8.0 SFA_Activity_BS

Table 655. SFA_Activity_BS Service Object
Name
SFAActivity_BS
Business Service
CSSEAIUIDataService

Table 656. SFA_Activity_BS Data Object
External Name
SFA_Activity_IO
Siebel Business Object
Action
Methods
For a description of methods for for Web service, see Table 657.
Table 657. SFA_Activity_BS Method
Operation
Method
Insert
Insert
Example Package for SFA_Activity_BS

Request
...\SFA_Activity_BS\SFA_Activity_BS_request.xml
Response
...\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\SiebelUserProfileService.wsdl
...\SiebelWebRegistration\SiebelWebRegistration.wsdl
TroubleTicket
Use this Web service to create, update, retrieve and set status for trouble tickets.
TroubleTicket Operations
Table 658. TroubleTicket Operations
Name
Description
CreateTroubleTicket
Create a new network trouble ticket, including the resource(s)

and service(s) affected.
UpdateTroubleTicket
Update additional attributes on the trouble ticket.
GetTroubleTicket
Return the existing trouble tickets that meet criteria specified in

a search spec.
SetTroubleTicketStatus
Update the status of an existing network trouble ticket; typically

to cancel or close a network alarm.

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

This Web service has four operations. Each operation does not share a common response message
format.
TroubleTicket Application Interface

Technology Network.

Table 659. TroubleTicket Service Object
Name
Trouble Ticket
Business Service
Trouble Ticket Lightweight
Business Service

Table 660. TroubleTicket Data Object
External Name
Business Service
WS Trouble Ticket
Service Request
Trouble Ticket
WS Trouble Ticket Lightweight
FINS eBanking
Methods
Table 661. TroubleTicket Methods
Operation
Business Service
Method
CreateTroubleTicket
Trouble Ticket
Insert
UpdateTroubleTicket
Trouble Ticket
Update
GetTroubleTicket
Trouble Ticket
QueryByExample
SetTroubleTicketStatus
Update
39 3
Primary Web Services for Siebel CRM 8.0 VerifyEntitlement
Example Package for TroubleTicket

Request
...\TroubleTicket\TroubleTicket_request.xml
Response
...\TroubleTicket\TroubleTicket_response.xml
Message Schema (WSDL) for TroubleTicket

...\TroubleTicket\TroubleTicket.wsdl
VerifyEntitlement
Use this Web service to obtain the best response time for Service Requests based on customer
entitlements.
VerifyEntitlement Operations
Table 662. VerifyEntitlement Operations
Name
Description
FSVerifyEntitlementRunProcess
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

Table 663. Request Message Description: FSVerifyEntitlement
Node
Description
Contact_spcTime_spcZone
Time zone
Account_spcId
Accounts which entitlements cover
Product_spcId
Products which entitlements cover
Contact_spcId
Contacts which entitlements cover
Asset_spcId
Assets which entitlements cover
Owned_spcBy_spcId
Owner of the SR
Priority
Priority of the SR
Created_spcDate
Created date of the SR
Contact_spcAccount_spcId
Contact of the SR
Response Message Description: FSVerifyEntitlement

Table 664. Response Message Description: FSVerifyEntitlement
Node
Description
Commit_spcTime
Commit Time for the SR
Entitlement_spcId
Entitlement Id that was used
Entitlement_spcName
Entitlement name that was used
VerifyEntitlement Application Interface

Technology Network.

Table 665. VerifyEntitlement Service Object
Name
FS Verify Entitlement
Workflow
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
Method
FSVerifyEntitlementRunProcess
[WF: FS Verify Entitlement].[RunProcess]
Example Package for VerifyEntitlement

Request
...\VerifyEntitlement\VerifyEntitlement_request.xml
Response
...\VerifyEntitlement\VerifyEntitlement_response.xml
Message Schema (WSDL) for VerifyEntitlement

...\VerifyEntitlement\VerifyEntitlement.wsdl
Warranty
...\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
...\WC_Contacts_BS\WC_Contacts_BS.wsdl
WC_Opportunity_BS
...\WC_Opportunity_BS\WC_Opportunity_BS.wsdl
...\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
Table 667. WebMarketing Operations
Name
Description
CreateWebMarketingResponse
Create response records to track click events.
GetActiveLists
Retrieve a list of all active subscription lists.
39 7
Primary Web Services for Siebel CRM 8.0 WebMarketing
Table 667. WebMarketing Operations

Name
Description
GetListMembers
Retrieve a list of subscription lists that the contact/prospect is

subscribed to.
GetWebTreatment
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

Table 668. Request Message Description: CreateWebMarketingResponse
Node
Description
Response
Required.
ACCNT_ID
Row Id of Account.
Delivery Method
Required. Delivery Method.
Description
Required. Description of the response.
Destination Name
Hyperlink name of response URL.
Destination URL
Response URL.
Event Id
Row Id of Event.
Event Reg Id
Event Registration Id.
Id
Response Row Id.
PRSP_CON_ID
Row Id of Prospect. Either PRSP_CON_ID or

PR_CON_ID must be filled in.
PR_CON_ID
Row Id of Contact. Either PRSP_CON_ID or PR_CON_ID

must be filled in.
Response Method
Response Method.
Response Type
Required. Response Type.
SRC_ID
Row Id of Campaign.
S_CAMP_CON_ID
Row Id of Campaign Contact.
Status
Status Code.
Sub_DMail_Cd
Subscribe to Direct Mail Action Code.
Sub_Email_Cd
Subscribe to Email Action Code.
Sub_Fax_Cd
Subscribe to Fax Action Code.
Sub_Phone_Cd
Subscribe to Phone Action Code.
Subscription List Id
Row Id of Subscription List.
398
Table 668. Request Message Description: CreateWebMarketingResponse

Node
Description
Summary
Summary.
Treatment Id
Required. Row Id of Offer Treatment.
Response Message Description: CreateWebMarketingResponse

Table 669. Response Message Description: CreateWebMarketingResponse
Node
Description
Same as request message
Not applicable
Request Message Description: GetActiveLists

Table 670. Request Message Description: GetActiveLists
Node
Description
List
Required.
Description
Description of the response.
Id
Row Id of subscription list.
Name
Name of subscription list.
ViewMode
Visibility algorithm used to determine which records will be retrieved.
Response Message Description: GetActiveLists

Table 671. Response Message Description: GetActiveLists
Node
Description
Not applicable
Request Message Description: GetListMembers

Table 672. Request Message Description: GetListMembers
Node
Description
List Members
Required
Contact Id
Row Id of Contact
39 9
Table 672. Request Message Description: GetListMembers

Node
Description
List Id
Row Id of Subscription List
List Name
Name of Subscription List
Prospect Id
Row Id of Prospect
Response Message Description: GetListMembers

Table 673. Response Message Description: GetListMembers
Node
Description
Not applicable
Request Message Description: GetWebTreatment

Table 674. Request Message Description: GetWebTreatment
Node
Description
WebTreatment
Required.
Id
Required. Row Id of Web Treatment.
Context
ContactId
Row Id of Contact.
ProspectId
Row Id of Prospect.
CampConId
Row Id of Campaign Contact.
CampaignId
Row Id of Campaign.
WebServer
Web Server URL to be substituted in response forms.
Response Message Description: GetWebTreatment

Table 675. Response Message Description: GetWebTreatment
Node
Description
WebTreatment
Required.
Active For Inbound Flag
Flag to indicate if the Web treatment is inbound.
Description
Description of the response.
Id
Row Id of Web Treatment.
400
Table 675. Response Message Description: GetWebTreatment

Node
Description
Language Code
Language Code.
Locale Code
Locale Code.
Name
Name of Web Treatment.
PriceList Id
Row Id of PriceList Id.
Valid End Date
Valid End Date.
Valid Start Date
Valid Start Date.
Template
Template type.
Lit Id
Row Id of Treatment Template.
Personalized Content
Personalized Content of Web treatment.
Related Web Surveys
Web survey to associate.
Id
Row Id of Web Survey.
Name
Name of Web Survey.
Related Products
Related product to retrieve.
Product Id
Row Id of Product.
Product
Name of Product.
Related Events
Related events to retreive.
Id
Row Id of Event.
Name
Name of Event.
WebMarketing Application Interface

Technology Network.

Table 676. WebMarketing Service Object
Name
WebMarketingService
Business Service
CSSWebMarketingService
40 1

Table 677. WebMarketing Data Object
External Name
Response
Response
SubscriptionList
Subscription
SubscriptionListMember
Subscription
GetWebTreatment
GetWebTreatmentResponse
Offer
Methods
For a description of the methods for this Web services, see Table 678.
Table 678. WebMarketing Methods
Operation
Method
CreateWebMarketingResponse
[BS: WebMarketingService].[CreateResponse]
GetActiveLists
[BS: WebMarketingService].[GetActiveLists]
GetListMembers
[BS: WebMarketingService].[GetListMembers]
GetWebTreatment
[BS: WebMarketingService].[GetWebTreatment]
Example Package for WebMarketing

Request
...\WebMarketing\WebMarketing_request.xml
Response
...\WebMarketing\WebMarketing_response.xml
402
Message Schema (WSDL) for WebMarketing

...\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
example package, message schema 41
operations 37
8.1 primary web services 25
8.1 Product Configurator Web Service 41
operations 42
8.1 PromotionWebService, Web service 56
operations 57
8.1 WebMarketing, Web service 62
operations 62
A
ABOWebService, Web service 294
operations 294
Account, Web service 67
operations 67
Asset Management, Web service 301
operations 302
AssetManagementComplex, Web service 69
operations 69
AssetWebService, Web service 304
C
CalculatePriceWS, Web service 304

operations 304
CatalogWebService, Web service 307
operations 307
CMU Account Query, Web Service
CMU Account Query, Web service 73
CMU Account Update
message schema for 77
operation for 76
Contact, Web service 77
operations 78
ContextServiceWrapperService, Web
service 316
operations 316
CopyActivity, Web Service 321
operations 321
E
EAILOVWS, Web service 322
EligibilityCompatibility, Web service 322
operations 323
ESB_AccountBalanceSiebelReqABCS_Servic
e
example package for 82
EventManagement, Web service
EventRegistration, Web service 332
ExternalAutoPolicy, Web service 332
40 5
Index F
ExternalPropertyPolicy, Web service
332
F
Forecast, Web service
332
G
GetHealthCareProfessionalProfileInformatio
n, Web service 332
operations 332
GetHeathCareProfessionalComplianceDetail
s, Web service 340
operations 340
GetMktgWebSurvey, Web service 105
operations 106
GetUnallocatedExpenseItem, Web
service 347
operations 347
I
INSClaims, Web service 350
operations 351
L
LeadProcessingService, Web service 110
operations 110
LeadService, Web service 115
operations 115
List, Web service 120
operations 120
ListMgmtProspect, Web service 123
operations 123
LoyaltyAccrualService, Web service 125
operations 125
LoyaltyBatchEnrollment, Web service 129
406

operations 129
LoyaltyImportBusinessService, Web
service 134
operations 134
LoyaltyMemberService, Web service 135
operations 136
LoyaltyRedemptionService, Web
service 150
operations 150
LoyaltyVoucherService, Web service 164
operations 164
M
MktgDeduplicationService, Web service
operations 166
MktgImportService, Web service 171
application objects 172
operations 171
166
N
NetworkOrderEntry, Web service
operations 356
356
O
OrderDetailWebService, Web service 173
operations 173
OrderWebService, Web service 379
operations 379
P
PartnerPrograms, Web service 358
PartnerRegistration, Web service 359
PDSOrderHeader, Web service 175
operations 175
PriceListsWS, Web service 176
operations 176
Product Import
Index Q

ProductConfigurator, Web service 359
operations 359
ProductRecommendation, Web service 373
operations 374
ProductSearchService, Web service 186
operations 187
PromotionWebService, Web service 376
operations 376
Q
QuoteAddItemsWS, Web service 383
operations 383
QuoteCheckOutWebService, Web
service 189
operations 190
QuoteDetailWebService, Web service 191
operations 191
QuoteWebService, Web service 379
QuotingWebService, Web service 194
operations 194
R
Response, Web service 196
operations 196
RetrieveAttachmentService, Web
service 199
operations 199
S
searchSolution, Web service 201
operations 202
SelfServiceAccount, Web service 204

operations 205
SelfServiceAccountRootPath, Web
service 211
operations 211
SelfServiceAllAccountsList, Web
service 214
operations 215
SelfServiceContact, Web service 219
operations 219
SelfServicePaymentHistory, Web
service 225
operations 225
SelfServicePostLoginProcess, Web
service 227
operations 227
P_mode request parameter 227
SelfServiceRegistration, Web service 230
enroll operation, business services called
by 231
operations 231
P_mode request parameter 230
SelfServiceResponsibility, Web service 244
operations 244
SelfServiceSmtpEmail, Web service 246
operations 246
SelfServiceTemplateEmail, Web service 249
operations 249
SelfServiceTimeZone, Web service 252
operations 252
SelfServiceUser, Web service 254
operations 254
SelfServiceWebSite, Web service 258
40 7
Index T

operations 258
SerializationService, Web service 385
ServiceRequest, Web service 260, 385
example package, schema 265, 386
operations 261, 385
SessionAccessWS, Web service 266, 387
operations 266
SetAllocatedExpenseItem, Web service 387
operations 387
SFA_Activity_BS, Web service 390
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
T
TroubleTicket, Web service 392
operations 392
U
Ulnbox Contact Item, Web service 270
operations 270
parameters, specifying 271
Universal Inbox, Web service 273
operations 273
408
described 275
V
VerifyEntitlement, Web service 394
operations 394
W
Warranty, Web service 396
WC_Picklist_Payment_Profile_BS, Web
service 278
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
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
X
XML, XML Schema, about
13

Siebel CRM Web Services Reference PDF

Diunggah oleh

Informasi Dokumen

Deskripsi Asli:

Judul Asli

Hak Cipta

Format Tersedia

Bagikan dokumen Ini

Bagikan atau Tanam Dokumen

Opsi Berbagi

Apakah menurut Anda dokumen ini bermanfaat?

Apakah konten ini tidak pantas?

Hak Cipta:

Format Tersedia

Siebel CRM Web Services Reference PDF

Diunggah oleh

Hak Cipta:

Format Tersedia

Siebel CRM Web Services

Copyright 2005, 2008, Oracle. All rights reserved.

Siebel CRM Web Services Reference 1

Chapter 1: Whats New in This Release

Core Technologies for Web Services

Siebel Web Service Documentation

Siebel Web Services Architecture

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 Product Configurator Web Service

Message Schema (WSDL) for Account

Siebel CRM Web Services Reference Version 8.1

ISS Price List Item WS

Siebel CRM Web Services Reference Version 8.1

SWI Update Order Line Item

SWI Update Order Line Item Operations

Ulnbox Contact Item

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

QuoteWebService and OrderWebService

Siebel CRM Web Services Reference Version 8.1

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

Integration Objects on page 15

Added additional information on Internal Component field.

Determine Which Siebel Objects to

Enhanced topic. Added more information on business service

Process of Exposing a Siebel Web

New topic. Provides new information on exposing Siebel Web

Assemble the Services on page 18

Enhanced topic. Clarified the task steps.

About Siebel Web Service

New topic. Reorganized Web service modeling discussion.

Using the Web Services

New topic. Brief overview of Web services deployment wizards.

CMU Account Query on page 73

Added new Web service topic.

CMU Account Update on page 75

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.

FS Asset Warranty Service on

Added new Web service topic.

Siebel CRM Web Services Reference Version 8.1

Whats New in This Release

ISS Price List Item WS on

Added new Web service topic.

Added new Web service topic.

Product Import on page 180

Added new Web service topic.

SWI Update Order Line Item on

Added new Web service topic.

Added new Web service topic.

This guide has been updated to reflect product name changes.