CRMWeb

For Oracle internal distribution only
Siebel CRM Web Services

Reference
Version 8.1
March 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 error-free. 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
1 Whats New in this Release
2 About This Reference Guide
3 Siebel CRM Web Services Overview

How Siebel Applications are Web Service Enabled 23
About Web Services 23
Web Service as a Server-Side Service 24

Core Technologies for Web Services 24
About Web Services Description Language (WSDL) 24
About XML and XML Schema 25
About Simple Object Access Protocol (SOAP) 25

The Web Services Development Cycle 25
Siebel Web Service Documentation 26
Support for Siebel Web Services 27
Inbound and Outbound Web Services 27
Integration Objects 27
Business Services 28
Siebel Web Services Architecture 30
Process of Exposing a Siebel Web Service 30
Determine Which Siebel Objects to Expose 30
Assemble the Services 31

About Siebel Web Service Modeling 32
Exposing a Business Service as a Web Service 32
Exposing a Workflow as a Web Service 33

Using the Web Services Deployment Wizard 34
Special Note on Authentication and Performance 35
Siebel CRM Web Services Reference Version 8.1 3
Contents
4 Siebel 8.1 Primary Web Services

8.1 Primary Web Services 39
8.1 ABOWebService 41
8.1 ABOWebService Operations 41
Application Interface 46
Example Package for ABOWebService 47
Message Schema (WSDL) for ABOWebservice 48

8.1 CatalogWebService 49
8.1 CatalogWebService Operations 49
Application Objects 52
Example Package for Siebel 8.1 CatalogWebService 52
Message Schema (WSDL) for Siebel 8.1 CatalogWebService 53

8.1 Product Configurator Web Service 54
8.1 Product Configurator Web Service Operations 54
Example Package for ProductConfigurator 67
Message Schema (WSDL) for ProductConfigurator 68

8.1 PromotionWebService 69
8.1 PromotionWebService Operations 69
Example Package for 8.1 PromotionWebService 73
Message Schema (WSDL) for 8.1 PromotionWebService 74

8.1 WebMarketing 75
8.1 WebMarketing Operations 75
WebMarketing Application Objects 78
Example Package for WebMarketing 78
Message Schema (WSDL) for WebMarketing 80

Account 81
Account Operations 81
4 Siebel CRM Web Services Reference Version 8.1
Whats New in this Release How Siebel Applications are Web Service Enabled
Example Package for Account 82
Message Schema (WSDL) for Account 83

AssetManagementComplex 83
AssetManagementComplex Operations 83
Example Package for AssetManagementComplex 87
Message Schema (WSDL) for AssetManagementComplex 87

Contact 88
Contact Operations 88
Contact Application Objects 89
Example Package for Contact 89
Message Schema (WSDL) for Contact 90

GetMktgWebSurvey 91
GetMktgWebSurvey Operations 91
Example Package for GetMktgWebSurvey 92
Message Schema (WSDL) for GetMktgWebSurvey 92

LeadProcessingService 93
Lead Processing Service Operations 93
LeadProcessingService Application Objects 95
Example Package for Lead Processing Service 96
Message Schema (WSDL) for Lead Processing Service 97

LeadService 98
LeadService Operations 98
LeadService Application Objects 101
Example Package for LeadService 101
Message Schema (WSDL) for LeadService 103

List 104
Contents
List Operations 104
List Application Objects 105
Example Package for List 106
Message Schema (WSDL) for List 106

ListMgmtProspect 107
Operations 107
Example Package for ListMgmtProspect 108
Message Schema (WSDL) for ListMgmtProspect 108

LoyaltyAccrualService 109
LoyaltyAccrualService Operations 109
Example of Package for LoyaltyAccrualService 111
Message Schema (WSDL) for LoyaltyAccrualService 112

LoyaltyMemberService 114
LoyaltyMemberService Operations 114
Example Package for LoyaltyMemberServices 129
Message Schema (WSDL) for LoyaltyMemberServices 131

LoyaltyRedemptionService 132
LoyaltyRedemptionService Operations 132
Example Packages for LoyaltyRedemptionService 142
Message Schema (WSDL) for LoyaltyRedemptionService 146

LoyaltyVoucherService 147
LoyaltyVoucherService Operations 147
Example Package for LoyaltyVoucherService 148
Message Schema (WSDL) for LoyaltyVoucherService 148

MktgDeduplicationService 149
Mktg Deduplication Service Operations 149
MktgImportDeduplicationService Application Objects 152
Example Package for MktgDeduplicationService 153
Message Schema (WSDL) for Mktg Deduplication Service 154

MktgImportService 155
Mktg Import Service Operations 155
Mktg Import Service Application Objects 155
Example Package for MktgImportService 156
Message Schema (WSDL) for Mktg Import Service 156

OrderDetailWebService 157
OrderDetailWebService Operations 157
OrderDetailWebService Application Objects 158
Example Package for OrderDetailWebService 158
Message Schema (WSDL) for OrderDetailWebService 159

PDSOrderHeader 160
PDSOrderHeader Operations 160
Example Package for PDSOrderHeader 160
Message Schema (WSDL) for PDSOrderHeader 161

PriceListsWS 162
PriceListsWS Operations 162
Example Package for PriceListsWS 162
Message Schema (WSDL) for PriceListsWS 163

ProductSearchService 164
ProductSearchService Operations 164
ProductSearchService Application Objects 165
Example Package for ProductSearchService 166
Message Schema (WSDL) for ProductSearchService 166

QuoteCheckOutWebService 167
QuoteCheckOutWebService Operations 167
Example Package for QuoteCheckOutWebService 167
Message Schema (WSDL) for QuoteCheckOutWebService 168

QuoteDetailWebService 169
QuoteDetailWebService Operations 169

Contents
Example Package for QuoteDetailWebService 171
Message Schema (WSDL) for QuoteDetailWebService 171

QuotingWebService 172
QuotingWebService Operations 172
QuotingWebService Application Objects 173
Example Package for QuotingWebService 173
Message Schema (WSDL) for QuotingWebService 173

Response 174
Response Operations 174
Example Package for Response 175
Message Schema (WSDL) for Response 176

RetrieveAttachmentService 177
RetrieveAttachmentService Operations 177
RetrieveAttachmentService Application Objects 178
Example Package for RetrieveAttachmentService 179
Message Schema (WSDL) for RetrieveAttachmentService 179

searchSolution 180
searchSolution Operations 180
searchSolution Application Objects 181
Example Package for searchSolution 182
Message Schema (WSDL) for searchSolution 182

SelfServiceAccount 183
SelfServiceAccount Operations 183
SelfServiceAccount Application Objects 188
Example Package for SelfServiceAccount 188
Message Schema (WSDL) for SelfServiceAccount 189

SelfServiceAccountRootPath 190
SelfServiceAccountRootPath Operations 190
SelfServiceAccountRootPath Application Objects 191

Example Package for SelfServiceAccountRootPath 192
Message Schema (WSDL) for SelfServiceAccountRootPath 192

SelfServiceAllAccountsList 193
SelfServiceAllAccountsList Operations 193
SelfServiceAllAccountsList Application Objects 195
Example Package for SelfServiceAllAccountsList 196
Message Schema (WSDL) for SelfServiceAllAccountsList 196

SelfServiceContact 197
SelfServiceContact Operations 197
SelfServiceContact Application Objects 202
Example Package for SelfServiceContact 202
Message Schema (WSDL) for SelfServiceContact 203

SelfServicePaymentHistory 204
SelfServicePaymentHistory Operations 204
Example Package for SelfServicePaymentHistory 205
Message Schema (WSDL) for SelfServicePaymentHistory 205

SelfServicePostLoginProcess 206
P_Mode Request Parameter 206
SelfServicePostLoginProcess Operations 206
SelfServicePostLoginProcess Application Objects 207
Example Package for SelfServicePostLoginProcess 208
Message Schema (WSDL) for SelfServicePostLoginProcess 209

SelfServiceRegistration 210
P_Mode Request Parameter 210
SelfServiceRegistration Operations 211
Example Package for SelfServiceRegistration 221
Message Schema (WSDL) for SelfServiceRegistration 223

Contents
SelfServiceResponsibility 224
SelfServiceResponsibility Operations 224
SelfServiceResponsibility Application Objects 225
Example Package for SelfServiceResponsibility 225
Message Schema (WSDL) for SelfServiceResponsibility 226

SelfServiceSmtpEmail 227
SelfServiceSmtpEmail Operations 227
SelfServiceSmtpEmail Application Objects 228
Example Package for SelfServiceSmtpEmail 229
Message Schema (WSDL) for SelfServiceSmtpEmail 229

SelfServiceTemplateEmail 230
SelfServiceTemplateEmail Operations 230
SelfServiceTemplateEmail Application Objects 232
Example Package for SelfServiceTemplateEmail 232
Message Schema (WSDL) for SelfServiceTemplateEmail 232

SelfServiceTimeZone 233
SelfServiceTimeZone Operations 233
SelfServiceTimeZone Application Objects 233
Example Package for SelfServiceTimeZone 234
Message Schema (WSDL) for SelfServiceTimeZone 234

SelfServiceUser 235
SelfServiceUser Operations 235
SelfServiceUser Application Objects 238
Example Package for SelfServiceUser 238
Message Schema (WSDL) for SelfServiceUser 238

SelfServiceWebSite 239
SelfServiceWebSite Operations 239
SelfServiceWebSite Application Objects 240
Example Package for SelfServiceWebSite 241

Message Schema (WSDL) for SelfServiceWebSite 241

ServiceRequest 242
ServiceRequest Operations 242
Example Package for Service Request 246
Message Schema (WSDL) for Service Request 246

SessionAccessWS 247
SessionAccessWS Operations 247
SessionAccessWS Application Objects 247
Example Package for SessionAccessWS 248
Message Schema (WSDL) for SessionAccessWS 248

Ulnbox Contact Item 249
Ulnbox Contact Item Operations 249
To Specify Parameters While Invoking Ulnbox Contact Item 250
Ulnbox Contact Item Application Objects 251
Example Package for Ulnbox Contact Item 251
Message Schema (WSDL) for Ulnbox Contact Item 251

Universal Inbox 252
Universal Inbox Operations 252
Universal Inbox Application Objects 253
Example Package for Universal Inbox 253
Message Schema (WSDL) for Universal Inbox 254

WC_PickList_Payment_Profile_BS 255
WC_PickList_Payment_Profile_BS Operations 255
WC_PickList_Payment_Profile_BS Application Objects 256
Example Package for WC_PickList_Payment_Profile_BS 257
Message Schema (WSDL) for WC_PickList_Payment_Profile_BS 257
5 Siebel 8.0 Web Services

Contents
8.0 Primary Web Services 259

Support and Testing Web Services 261

Siebel 8.0 Primary Web Services 267
ABOWebService 268
ABOWebService Operations 268
ABOWebService Application Interface 274
Example Package for ABOWebService 275
Message Schema (WSDL) for ABOWebservice 276

Asset Management 277
Asset Mangement Operations 277
Asset Management Application Interface 278
Example Package for AssetManagement 278
Message Schema (WSDL) for AssetManagement 279

AssetWebService 280
CalculatePriceWS 281
CalculatePriceWS Operations 281
Application Interface for CalculatePriceWS 281
Example Package for CalculatePriceWS 283
Message Schema (WSDL) of CalculatePriceWS 283

CatalogWebService 284
CatalogWebService Operations 284
CatalogWebService Application Interface 290
Example Package for CatalogWebService 291
Message Schema (WSDL) of CatalogWebService 292

ContextServiceWrapperService 293
ContextServiceWrapperService Operations 293
ContextServiceWrapperService Application Interface 296

Example Packages for ContextServiceWrapperService 297
Message Schema (WSDL) of ContextServiceWrapperService 297

CopyActivity 298
CopyActivity Operations 298
CopyActivity Application Interface 298
Example Package for CopyActivity 299
Message Schema (WSDL) of CopyActivity 299

EAILOVWS 300
EligibilityCompatibility 301
EligibilityCompatibility Operations 301
EligibilityCompatibility Application Interface 303
Example Package for EligibilityCompatibility 304
Message Schema (WSDL) of EligibilityCompatibility 304

EventManagement 305
EventManagement Operations 305
EventManagement Application Interface 309
Example Package for EventManagement 310
Message Schema (WSDL) for EventManagement 310

Event Registration 311
ExternalAutoPolicy 311
ExternalPropertyPolicy 311
Forecast 311
GetHealthCareProfessionalProfileInformation 312
GetHealthCareProfessionalProfileInformation Operations 312
Example Package for GetHeathcareProfessionalProfileInformation 319
Message Schema (WSDL) for GetHeathcareProfessionalProfileInformation 319

GetHealthCareProfessionalComplianceDetails 320
GetHealthCareProfessionalComplianceDetails Operations 320

Contents
GetHealthCareProfessionalComplianceDetails Application Interface 325
Example Package for GetHeathcareProfessionalComplianceDetails 325
Message Schema (WSDL) for GetHeathcareProfessionalComplianceDetails 326

GetUnallocatedExpenseItem 327
GetUnallocatedExpenseItem Operations 327
GetUnallocatedExpenseItem Application Interface 329
Example Package for GetUnallocatedExpenseItem 329
Message Schema (WSDL) for GetUnallocatedExpenseItem 330

INSClaims 331
INSClaims Operations 331
INSClaims Application Interface 332
Example Package for INSClaims 332
Message Schema (WSDL) for INSClaims 334

IntegrationObjectInfo 335
IntegrationObjectInfo Operations 335
IntegrationObjectInfo Application Objects 336
Example Package for IntegrationObjectInfo 336
Message Schema (WSDL) for IntegrationObjectInfo 337

NetworkOrderEntry 338
NetworkOrderEntry Operations 338
NetworkOrderEntry Application Interface 338
Example Package for NetworkOrderEntry 339
Message Schema (WSDL) for NetworkOrderEntry 340

PartnerPrograms 341
PartnerRegistration 341
ProductConfigurator 342
ProductConfigurator Operations 342
ProductConfigurator Application Interface 354
Example Package for ProductConfigurator 355

Message Schema (WSDL) for ProductConfigurator 356

ProductRecommendation 357
ProductRecommendation Operations 357
Example Package for ProductRecommendation 358
Message Schema (WSDL) for ProductRecommendation 359

PromotionWebService 360
PromotionWebService Operations 360
Example Package for PromotionWebService 363
Message Schema (WSDL) for PromotionWebService 363

QuoteWebService and OrderWebService 364
QuoteWebService and OrderWebService Operations 364
QuoteWebService and OrderWebService Application Interface 366
Example Package for QuoteWebService 367
Message Schema (WSDL) for QuoteWebService 367

QuoteAddItemsWS 368
QuoteAddItemsWS Operations 368
QuoteAddItems Application Interface 368
Example Package for QuoteAddItems 369
Message Schema (WSDL) for QuoteAddItems 369

SerializationService 370
ServiceRequest 371
ServiceRequest Operations 371
ServiceRequest Application Objects 372
Example Package for ServiceRequest 372
Message Schema (WSDL) for ServiceRequest 373

SessionAccessWS 374
SetAllocatedExpenseItem 375

Contents
SetAllocatedExpenseItem Operations 375
SetAllocatedExpenseItem Application Interface 377
Example Package for SetAllocatedExpenseItem 377
Message Schema (WSDL) for SetAllocatedExpenseItem 378

SFA_Activity_BS 379
SFA_Activity_BS Operations 379
SFA_Activity_BS Application Interface 379
Example Package for SFA_Activity_BS 380
Message Schema (WSDL) for SFA_Activity_BS 380

SiebelUserProfileService 381
SiebelWebRegistration 381
TroubleTicket 382
TroubleTicket Operations 382
Example Package for TroubleTicket 383
Message Schema (WSDL) for TroubleTicket 383

VerifyEntitlement 384
VerifyEntitlement Operations 384
VerifyEntitlement Application Interface 385
Example Package for VerifyEntitlement 385
Message Schema (WSDL) for VerifyEntitlement 385

Warranty 386
WC_Account_BS 386
WC_Contacts_BS 386
WC_Opportunity_BS 386
WC_Service_Request_BS 386
WebMarketing 387
WebMarketing Operations 387
WebMarketing Application Interface 390

Example Package for WebMarketing 391
Message Schema (WSDL) for WebMarketing 391

Contents

1 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.
NOTE: All Web services from the Siebel 8.0 Primary Web Services chapter in this book are applicable
in Siebel CRM version 8.1 and version 8.0. Web Services appended with 81_, such as
81_WebServiceName, are available only to implementations of Siebel CRM version 8.1.
Table 1 New Product Features in Siebel CRM Web Services Reference, Version 8.1
Topic Description
Integration Objects Added additional information on Internal Component

field.
Determine Which Siebel Objects to Enhanced topic. Added more information on

Expose 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 New topic. Provides new information on exposing
Service 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 Enhanced topic. Clarified the task steps.
About Siebel Web Service Modeling 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 New topic. Brief overview of Web services
Deployment Wizard deployment wizards.
8.1 Primary Web Services New Chapter. Contains all new Web services
released with version 8.1 of Siebel CRM.

Contents

2 About This Reference Guide

This chapter contains a brief overview of the contents of this book, and a discussion of the uses of
Siebel Web services by release number.
This reference guide contains the following chapters:
Chapter 3: Siebel CRM Web Services Overview

Use this chapter for general and specific information related to Web services, and deploying them
within your Siebel CRM system. In addition to general information on Web services, this chapter
contains specific information on modeling and deploying Siebel Web services.
Chapter 4: Siebel 8.1 Primary Web Services

Use this chapter for information on Web services that are available only to implementations of Siebel
CRM, version 8.1.
In certain cases, a Web service will appear in the following format: 81_WebServiceName. This
differentiates a similar Web service offered to 8.0 implementations of Siebel CRM. Siebel 8.1 Web
services originating with the release of Siebel CRM, version 8.1 are not intended to run on Siebel CRM,
version 8.0.
Chapter 5: Siebel 8.0 Web Services

Use this chapter for a comprehensive listing of primary and support Web services offered with Siebel
CRM version 8.0 and available to Siebel CRM version 8.1 and beyond.
Chapter 6: About 8.0 Primary Web Services

Use this chapter for information on Web services that are available to implementations of Siebel CRM
from version 8.0 onwards. In other words, any Web service listed in this chapter may be used in an
implementation of Siebel CRM including 8.0 through version 8.1, and beyond.

Contents

3 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 Enabled
About Web Services
Core Technologies for Web Services
The Web Services Development Cycle
Siebel Web Service Documentation
Support for Siebel Web Services
Siebel Web Services Architecture
Process of Exposing a Siebel Web Service
About Siebel Web Service Modeling
Using the Web Services Deployment Wizard
Special Note on Authentication and Performance
How Siebel Applications are Web Service

Enabled
Siebel applications are Web service enabled 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.

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:

Siebel CRM Web Services Overview The Web Services Development Cycle
The operations provided by a Web service.
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 datatypes 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 datatypes in XML.
Conventions for a procedure call and, or response.
The Web Services Development 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 runtime 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.

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.

Siebel CRM Web Services Overview Support for Siebel Web Services
Support for Siebel Web Services

The following elements contribute to the deployment of Siebel Web services.
Inbound and Outbound Web Services
Integration Objects
Business Services
Inbound and Outbound Web Services

Siebel applications support both inbound and outbound Web services.
Inbound Web services allow external clients to access Siebel functionality. For example, a custom
UI that wants to view and modify Siebel Service Requests.
Outbound Web services allow Siebel applications to make requests of external applications. For
example, if the Siebel Server wanted to provide its clients the option of either searching internally
or searching the Internet, the Siebel Server would invoke an Outbound Web service operation
against a third-party search engine, incorporating the results in its own reply to the client.
Figure 1 displays Inbound and Outbound Web services.
Figure 1. Inbound and Outbound Web services
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 Services.
CRUD (Create, Read, Update, Delete) data services, of the type: UDS and ASI.
Functional Services (Custom Business Services and Workflow).
Figure 3 displays Business Services and their corresponding Web service entities.

Figure 3. 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 the 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.

Siebel CRM Web Services Overview Process of Exposing a Siebel Web Service
Business Services and Workflows

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
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
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 views allow the creation and
configuration of all Web services at runtime.
In Web service Administration 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.
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.
To assemble a Web service in the Web service Administration view
1 In the Siebel Mobile Web client, navigate to Site Map > Administration Web Services.
2 Select either Inbound Web Services or Outbound Web Services.
3 Click New to create a new Web service, or select a Web service in the Inbound or Outbound Web
Services list.
4 In the Service Ports list applet, select a Business Service or Workflow to act as Web service
invocation boundary object.

Siebel CRM Web Services Overview About Siebel Web Service Modeling
To combine the operations of several Business Services or Workflows into a single service, add
them to the Port for the Service.
5 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.
6 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
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

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 runtime for participation in a Stateful exchange.
Note that, at runtime, 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.

Siebel CRM Web Services Overview About Siebel Web Service Modeling
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 above.
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 Administration Web 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.
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:

Siebel CRM Web Services Overview Using the Web Services Deployment Wizard
In if used as an input argument.
Out if used as an output argument.
In/Out if used as both input and output.
NOTE: In, In/Out, Out arg types are included in the interface definition.
2 If any Process Property is a Property Set hierarchy, complete the following steps:
a Define the property set structure as an Integration Object in tools.
b Specify data type for this Process Property as Hierarchy and associate with Integration Object
defined above.
NOTE: This is important as you must expose a strongly-typed interface, including

arguments.
3 In the Administration Web Services view, do the following:
4 Create a new Service record or choose and existing Service in the Inbound Web Services applet.
The WSDL XML namespace should be entered here.
5 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.
6 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 above 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 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.
If youve 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, choose File->New Object->EAI->Data Access Service.
NOTE: This wizard does not create ASI-based Services.

Siebel CRM Web Services Overview Special Note on Authentication and Performance
Special Note on Authentication and

Performance
In implementations where scalability is critical, a lightweight context management facility for
authentication is available and its use is highly 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 is 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 WS-I
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.

Siebel CRM Web Services Overview Special Note on Authentication and Performance

This chapter includes detailed descriptions and information about Siebel 8.1 Web services. Web
services described include the following:
8.1 Primary Web Services
8.1 ABOWebService
8.1 CatalogWebService
8.1 Product Configurator Web Service
8.1 PromotionWebService
8.1 WebMarketing
Account
AssetManagementComplex
Contact
GetMktgWebSurvey
LeadProcessingService
LeadService
List
ListMgmtProspect
LoyaltyAccrualService
LoyaltyMemberService
LoyaltyVoucherService
MktgDeduplicationService
OrderDetailWebService
PDSOrderHeader
PriceListsWS
ProductSearchService
QuoteCheckOutWebService
QuoteDetailWebService
QuotingWebService
RetrieveAttachmentService
searchSolution

Siebel 8.1 Primary Web Services Special Note on Authentication and Performance
SelfServiceAccount
SelfServiceAccountRootPath
SelfServiceAllAccountsList
SelfServiceContact
SelfServicePaymentHistory
SelfServicePostLoginProcess
SelfServiceRegistration
SelfServiceResponsibility
SelfServiceSmtpEmail
SelfServiceTemplateEmail
SelfServiceTimeZone
SelfServiceUser
SelfServiceWebSite
ServiceRequest
SessionAccessWS
Ulnbox Contact Item
Universal Inbox
WC_PickList_Payment_Profile_BS

Siebel 8.1 Primary Web Services 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 ProductSearchService http://siebel.com/CustomUI Inbound

UI
RetrieveAttachmentService http://siebel.com/CustomUI Inbound
Search Solution http://siebel.com/CustomUI Inbound
MKTGDeduplicationService http://siebel.com/CustomUI Inbound
WC_Picklist_Payment_Profile_BS http://siebel.com/CustomUI Inbound
Universal Inbox http://siebel.com/CustomUI Inbound
SiebelWebPasswdMgmtService http://siebel.com/CustomUI Inbound
SiebelWebRegistrationService http://siebel.com/CustomUI Inbound
SiebelWebRespMgmt http://siebel.com/CustomUI Inbound
PDS Order Header http://siebel.com/CustomUI Inbound
Ulnbox Contact Item http://siebel.com/CustomUI Inbound
Self SelfServiceAccount http://siebel.com/SelfService/Common/Account Inbound

Service
SelfServiceAccountRootPath http://siebel.com/SelfService/Common/Account Inbound
SelfServiceAllAccountsList http://siebel.com/SelfService/Common/Account Inbound
SelfServiceContact http://siebel.com/SelfService/Common/Contact Inbound
SelfServicePaymentHistory http://siebel.com/SelfService/eCommerce/Payment Inbound
SelfServicePostLogin http://siebel.com/SelfService/Common/Login Inbound
SelfServiceRegistration http://siebel.com/SelfService/Common/Registration Inbound
SelfServiceSmtpEmail http://siebel.com/SelfService/Common/Utility Inbound
SelfService User http://siebel.com/SelfService/Common/User Inbound
SelfServiceTemplateEmail http://siebel.com/SelfService/Common/Utility Inbound
SelfServiceTimeZone http://siebel.com/SelfService/Common/Utility Inbound
SelfServiceWebSite http://siebel.com/SelfService/Common/Setup Inbound
Mktg Account http://siebel.com/marketing/account Inbound

Siebel 8.1 Primary Web Services 8.1 Primary Web Services
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 http://siebel.com/marketing/webmarketing Inbound
Response http://siebel.com/marketing/response Inbound
WebMarketing http://siebel.com/marketing/webmarketing Inbound
Loyalty LoyaltyAccrual http://siebel.com/loy Inbound
LoyaltyMemberServices http://siebel.com/Loyalty/LoyaltyMemberServices Inbound
LoyaltyRedemptionService http://siebel.com/Loyalty/LoyaltyRedemptionService Inbound
LoyaltyVoucherService http://siebel.com/Loyalty/LoyaltyVoucherService Inbound
Service Service Request http://siebel.com/Service/ServiceReqs Inbound
OM OrderDetailWebService http://siebel.com/OrderManagement/Order/Details Inbound
8.1 Catalog Web Service http://siebel.com/OrderManagement/Catalog Inbound
CalculatePriceWS http://siebel.com/OrderManagement/Quote/PSP Inbound
QuoteAddItems http://siebel.com/OrderManagement/Quote Inbound
PriceListsWS http://siebel.com/OrderManagement/PriceLists Inbound
QuoteCheckOutWebService http://siebel.com/OrderManagement/Quote/Quoting Inbound
QuoteDetailWebService http://siebel.com/OrderManagement/Quote/Details Inbound
QuotingWebService http://siebel.com/OrderManagement/Quote/Quoting Inbound
8.1 ABO Web Service http://siebel.com/OrderManagement/ABO Inbound
ProductConfigurator http://siebel.com/OrderManagement/Configurator Inbound
8.1 Promotion Web Service http://siebel.com/OrderManagement/Promotion Inbound
SessionAccessWS http://www.siebel.com/xml/SessionAccess Inbound
FS AssetManagementComplex http://www.siebel.com/Service/FS/Assets Inbound

Siebel 8.1 Primary Web Services 8.1 ABOWebService
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.
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.
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

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.
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.
Node Description
Object Id Required. RowId of the Quote to be converted to the Sale Order.
Skip Query Order User can specify if order document need to be required and returned. By
default the Order IO will be returned. Only ActiveOrderId will be returned if
Skip Query Order is set to Y.
Response Message Description: AutoOrder

Integration Object Message Format: PDS Order
Node Description
PDS Order Integration Object.
ActiveOrderId ID number.
Header Order Header
Line Item Order Line Items
XA Order Line Item attributes
Request Message Description: 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.
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.
Response Message Description: AutoAsset

Integration Object Message Format: PDS Asset.
Node Description
PDS Asset Integration Object.
Header Asset Header
Line Item Asset
XA Asset attributes
Request Message Description: ModifyAssetToQuote
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

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

Integration Object Message Format: PDS Quote
Node Description
PDS Quote Integration Object.
Header Quote Header.
Line Item Quote Line Item.
XA Quote Line Item attributes.
Request Message Description: ModifyAssetToOrder

Node Description

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

PriceListId Specifies a Price List Id associated with the quote if a new quote is
requested.
CompoundProductNumber 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

Request Message Description: ResumeAssetToOrder

Response Message Description: ResumeAssetToOrder

Request Message Description: DisconnectAssetToQuote

Response Message Description: DisconnectAssetToQuote

Request Message Description: DisconnectAssetToOrder

Response Message Description: DisconnectAssetToOrder

Application Interface
This section describes the application objects called by this Web service. For more information on
application implementation, refer to the application development documentation.
Service Object (Business Service or Workflow)

Name Boundary Class (if Business Service)
Object
Type
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

Data Object (Integration Object)

Siebel Repository Name External Name
PDS Quote PDS Quote
PDS Order PDS Order
PDS Asset PDS Asset
Example Package for ABOWebService

To view the sample code, see the following files in the WebServices ZIP download in the Siebel
Bookshelf documentation library on Oracle Technology Network:
Request (AutoOrder)
See the following file in the WebServices ZIP download in the Siebel Bookshelf documentation library
on Oracle Technology Network to view the sample code:
...\81_WSDL_XML\81_ABOWebService\AutoOrder_request.xml
Response (AutoOrder)
...\81_WSDL_XML\81_ABOWebService\AutoOrder_response.xml
Request (ModifyAssetToQuote)
...\81_WSDL_XML\81_ABOWebService\ModifyAssetToQuote_request.xml
Response (ModifyAssetToQuote)
...\81_WSDL_XML\81_ABOWebService\ModifyAssetToQuote_response.xml
Request (AutoAsset)
...\81_WSDL_XML\81_ABOWebService\AutoAsset_request.xml

Siebel 8.1 Primary Web Services
Response (AutoAsset)
...\81_WSDL_XML\81_ABOWebService\AutoAsset_response.xml
Message Schema (WSDL) for ABOWebservice

To view the message schema, see the following files in the WebServices ZIP download in the Siebel
...\81_WSDL_XML\81_ABOWebService\81_ABOWebService.wsdl

Siebel 8.1 Primary Web Services 8.1 CatalogWebService
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

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

Name Description Type
PDS Related Promotions Interface An instance of Integration Object "PDS Integration Object
Related Promotions Interface".
PricingMode Y or N (calculates price or not). String

Optional. The default value is "Y".
EligibilityMode 0, 1 ,2 (eligibility display mode: 0 do String

not run; 1 run; 2 run but only return
eligible products). Optional. The default
value is "1".
ContextMode SiebelContext or ExternalConext. String

Optional. However, provide
ContextMode to run pricing and
eligibility.
Context An instance of Integration Object "PDS Integration Object

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

PDS Related Promotions Interface "PDS Related Promotions Interface". Integration Object
After running Eligibility and Pricing, the
List Price, Net Price, "Eligibility
status" and "Eligibility Reason" fields
will be updated.
Request Message Description: GetRelatedProducts

PDS Related Products Interface An instance of Integration Object "PDS Integration Object
Related Products Interface".


value is "1".

eligibility.

is required.
Response Message Description: GetRelatedProducts

PDS Related Products Interface An instance of Integration Object "PDS Integration Object
Related Products Interface". After
running Eligibility and Pricing, the List
Price, Net Price, "Eligibility status"
and "Eligibility Reason" fields will be
updated.

Request Message Description: GetCategory

PDS Category Interface Integration An instance of Integration Object "PDS Integration Object
Object Category Interface".
Response Message Description: GetCategory

PDS Category Interface Integration An instance of Integration Object "PDS Integration Object
Object Category Interface"
Request Message Description: UDSPublishCatalog

SiebelMessageIn An instance of Integration Object "PDS Integration Object

UDS Publish Catalog Interface". This is
a required input.


value is "1".

eligibility.

is required.
LOVLanguageMode LIC or LDC. String
ViewMode Visibility algorithm used in addition to a String

search specification to determine which
records will be retrieved. Catalog or
Organization.
NamedSearchSpec Name of a predefined query. String

Response Message Description: UDSPublishCatalog

SiebelMessageOut An instance of Integration Object "PDS Integration Object

UDS Publish Catalog Interface"
Application Objects
This section describes the application objects called by the CatalogWebService. For more information
on application implementation, refer to application development documentation.

Name Boundary Object Type Class
PDS Product Data Service BusService CSSProdDataSvc

PDS Related Promotions Interface PDS Related Promotions Interface
PDS Related Products Interface PDS Related Products Interface
PDS Category Interface PDS Category Interface
PDS UDS Publish Catalog Interface PDS UDS Publish Catalog Interface
Example Package for Siebel 8.1 CatalogWebService

Request
...\81_WSDL_XML\81_CatalogWebService\81_CatalogWebService_request.xml

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

...\81_WSDL_XML\81_CatalogWebService\81_CatalogWebService.wsdl

Siebel 8.1 Primary Web Services 8.1 Product Configurator Web Service
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.
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.
GetCfgObjectDefaultGroupItems 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.
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

Node Description
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 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.
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 valuetypes will
be populated depending on the type of the value.
DisplayValue Display value
String String value

Node Description
Number Number value
Integer Integer value
Date Date value
Boolean Boolean value
AttributeRejectedValue Rejected value of the attribute. Only one of the valuetypes

will be populated depending on the type of the value.
String String value
Number Number value
Date Date value
AttributeDecoration Zero or more.
Name Attribute properties name.
Value Value pairs.
Relationship Zero or more (only those child objects that are specified will
be 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

Node Description
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.
Value Value pairs.
Relationship Decoration Zero or more.
Name Relationship properties name
Value Value pairs.
LinkedItem Zero or more (only those child objects that are specified will
be 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.
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
FieldName Field name in BC
Active Active flag
LinkedItemDecoration Linked Item properties.
Name Name value.

Node Description
Value Pairsl.
Resource Zero or more (only those child objects that are specified will
be 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

ResourceDecoration Resource properties.
Name Name value
Value Pairs
ObjectDecoration Object properties.
Name Name value
Value Pairs.
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
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.
ParentClassId ClassId of the parent
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

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

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 particular

responsibility will be returned. If both are empty, all responsibilities
will be returned.
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.
Sequence Sequence
GroupTheme Group Theme
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 /

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

Node Description
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 Name value.
Value Pairs.
Object Decoration Object properties name value pairs.
Name Name value.
Value Pairs.
Request Message Description: 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.

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

Node Description
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.
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
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
Excluded Excluded Flag indicates the whether this domain item is excluded by a

Node Description
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
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
Response Message Description: Begin Configuration

GetCfgObjectStructure has the same request and response message. See Above for details.
GetCfgObjectGroupItems and GetCfgObjectDefaultGroupItems have the same request and response

messages. See Above for details.
Node Description
BeginConfiguration_Output Required.
Error_spcCode Error Code if error occurred
Error_spcMessage Error Message if error occurred
RootId New Item Root Id

Node Description
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.
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 etc)
Message Message text
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.

Node Description
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)
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 Value displayed in a string.
Number Value displayed as number.
Integer Value displayed as integer.
Date Date
Boolean Value displayed in Boolean format.
Response Message Description: UpdateConfiguration

Node Description
UpdateConfiguration_Output Required.
FinishConfigurationOutFlag Y / N. Indicates whether Finish Configuration was performed. It might

not be performed if there were some errors.

RepriceOutFlag Y / N. Indicates whether Reprice was done. It might not be performed

if there were some errors.
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 performed if

there were some errors.

details.
messages to be displayed. See BeginConfiguration Response Message.
Request Message Description: EndConfiguration
Node Description
EndConfiguration_Input Required.
SaveInstanceFlag Save Instance flag
Response Message Description: EndConfiguration
Node Description
EndConfiguration_Output Required.
ListOfQuote Quote instance. See BeginConfiguration Request Message for details.

application implementation, refer to application development documentation.

Name Boundary Class (if BusService)
Object Type
Cfg Object Broker Business Service CSSCfgObjBrokerService
ConfiguratorWebChannelBeginConfig Workflow Not applicable
ConfiguratorWebChannelUpdateConfig Workflow Not applicable
ConfiguratorWebChannelEndConfig Workflow Not applicable

CfgInteractData ListOfData
CfgInteractRequest ListOfRequest
CfgInteractStatus ListOfStatus
CfgLinkedItems ListOfLinkedItems
PDS Quote ListOfQuote
Methods
Operation Method
GetCfgObjectStructure GetObjStructure
GetCfgObjectGroupItems GetObjGroupItems
GetCfgObjectDefaultGroupItems GetObjDefaultGroupItems
Example Package for ProductConfigurator


Request (GetObjDefaultGroupItems)
...\81_WSDL_XML\81_ProductConfigurator\GetObjDefaultGroupItems_request.xml
Response (GetObjDefaultGroupItems)
...\81_WSDL_XML\81_ProductConfigurator\GetObjDefaultGroupItems_response.xml
Request (GetObjGroupItems)
...\81_WSDL_XML\81_ProductConfigurator\GetObjGroupItems_request.xml
Response (GetObjGroupItems)
...\81_WSDL_XML\81_ProductConfigurator\GetObjGroupItems_response.xml
Request (GetObjStructure)
...\81_WSDL_XML\81_ProductConfigurator\GetObjStructure_request.xml
Response (GetObjStructure)
...\81_WSDL_XML\81_ProductConfigurator\GetObjStructure_response.xml
Message Schema (WSDL) for ProductConfigurator

...\81_WSDL_XML\81_ProductConfigurator\81_ProductConfigurator.wsdl

Siebel 8.1 Primary Web Services 8.1 PromotionWebService
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.
8.1 PromotionWebService Operations

Name Description
getProductPromotionDefinition Get 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/migrate a promotion instance to another

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

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

EligibilityMode Optional, default value as 2. Could be Not applicable

0, 1, 2
PricingMode Optional, default value as Y. Y/N Not applicable
LoadAllDomainFlag Required, Y/N Not applicable
LoadDefaultDomainFlag Required, Y/N Not applicable
LoadPromDefFlag Required, Y/N Not applicable
ContextMode Required, Siebel Context or External Not applicable

Context
Context Required, in SiebelMessage format of Not applicable

IO PDS Catalog Context
ProdPromRuleType Optional, Product or Pricing Not applicable

Response Message Description: GetProductPromotionDefinition
ProdPromDefinition In SiebelMessage format of IO ISS Not applicable

Promotion Definition for WS
PromDomainProduct In SiebelMessage format of IO PDS Not applicable

Product Interface. Could be either
default domain product details or all
domain product details depending on
input arguments
Err_spcCode Error Code if error occurred Not applicable
Err_spcMessage Error Message if error occurred Not applicable
Request Message Description: ApplyProductPromotion

EligibilityMode Optional, default value as 2. Could be Not applicable

0, 1, 2.
PricingMode Optional, default value as Y. Y/N. Not applicable
ProdPromId Required. Not applicable
ProdPromInstanceId Optional, depending on usage Not applicable

scenarios.
LineItemId Optional, depending on usage Not applicable

scenarios.
Quantity Optional. Default value is 1. Not applicable
SiebelMessage Required, in SiebelMessage format of Not applicable

Integration Object PDS Quote.

Response Message Description: ApplyProductPromotion

SiebelMessage Required. In SiebelMessage format of Not applicable

the Integration Object PDS Quote.
Err_spcCode Error Code if error occurred Not applicable
Err_spcMessage Error Message if error occurred Not applicable
Request Message Description: getPromotionCommitments

Asset Integration Id Required. Asset Integration Id of the String

Promotion Instance Asset
Response Message Description: getPromotionCommitments

PromotionCommitments An instance of IO ISS Promotion Integration Object

Commitments
Request Message Description: UpgradePromotionToQuote

NewPromotionId Required. RowId of new promotion String
AssetNumber Asset Number of the selected String

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

ActiveDocumentId Document in Order Management means String

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 String

selected promotion asset being
upgraded
OverridePenaltyAmount Penalty Amount for upgrading the String

promotion, if any
OverrideProratePlanId If there is a penalty for upgrading the String

promotion, also pass in the prorate plan
used to prorate this penalty, if any.
Response Message Description: UpgradePromotionToQuote

QuoteIO An instance of the integration object Integration Object

PDS Quote
Request Message Description: UpgradePromotionToOrder

NewPromotionId Required. RowId of new promotion String
AssetNumber Asset Number of the selected String

AssetIntegrationId Asset Integration Id of the selected String

ActiveDocumentId Document in Order Management means String

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

selected promotion asset being
upgraded

OverridePenaltyAmount Penalty Amount for upgrading the String

promotion, if any
OverrideProratePlanId If there is a penalty for upgrading the String

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

OrderIO An instance of the integration object Integration Object

PDS Order
Application Objects
This section describes the application objects called by the PromotionWebService. For more
information on application implementation, refer to application development documentation.

Name Boundary Object Type
ISS Promotion WS GetPromotionCommitments Workflow
ISS Promotion WS-Upgrade Promotion-Quote Workflow
ISS Promotion WS-Upgrade Promotion-Order Workflow

ISS Promotion Commitments ISS Promotion Commitments
PDS Quote PDS Quote
PDS Order PDS Order
Example Package for 8.1 PromotionWebService


Request
...\81_WSDL_XML\81PromotionWebService\81PromotionWebService_request.xml
Response
...\81_WSDL_XML\81PromotionWebService\81PromotionWebService_response.xml
Message Schema (WSDL) for 8.1 PromotionWebService

...\81_WSDL_XML\81_PromotionWebService\81_PromotionWebService.wsdl

Siebel 8.1 Primary Web Services 8.1 WebMarketing
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.
8.1 WebMarketing Operations

Name Description
EmailMarketingForwardToFriend To forward campaign details to a list of forwardees
EmailMarketingUpdateJobStatus 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
Node Description Type
Account Id Account Id of the forwarder of the email String
Campaign Id The campaign Id of the campaign for String

which the info is being forwarded
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
Forwarder Message Message that the forwarder sends across String

along with the mails
Forwarder Prospect Id The prospect Id of the forwarder String
Offer Id Id of the offer for which the email is String

being sent
Response Type The type of response String

Response Message Description: EmailMarketingForwardToFriend

Dummy Error code for the process (OK or String

NOTOK)
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.
BatchNumber Batch number of the job String
ErrorCode Error code (if any) that needs to be String

passed for the job
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

Dummy Error code for the process (OK or String

NOTOK)
Request Message Description: UpdateCampaignRecipient

Calls EAI Siebel Adapter service to update campaign recipients
CampaignRecipientMsgIn The campaign recipient info that needs to Integration

be updated. Object
LOVLanguageMode The language mode. String

Response Message Description: UpdateCampaignRecipient

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.
ModuleName The module name which needs to be String

checked
Response Message Description: CheckModuleLicense

IsModuleLicensed Y or N according as the module is String

licensed or not respectively

WebMarketing Application Objects

This section describes the application objects called by WebMarketing service. For more information on

Email Marketing Forward to Friend Workflow NA
Email Marketing Update Status Workflow NA
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

Marketing Email Forwardee Forwardee Collection
Marketing Campaign Recipient CampaignRecipientMsgIn
Marketing Campaign Recipient CampaignRecipientMsgOut
Example Package for WebMarketing

Request (EmailMarketingForwardToFriend)
...\81_WSDL_XML\81_WebMarketing\EmailMktgFwdToFriend_request.xml

Response (EmailMarketingForwardToFriend)
...\81_WSDL_XML\81_WebMarketing\EmailMktgFwdToFriend_response.xml
Request (EmailMarketingUpdateJobStatus)
...\81_WSDL_XML\81_WebMarketing\EmailMarketingUpdateJobStatus_request.xml
Response (EmailMarketingUpdateJobStatus)
...\81_WSDL_XML\81_WebMarketing\EmailMarketingUpdateJobStatus_request.xml
Request (UpdateCampaignRecipient)
...\81_WSDL_XML\81_WebMarketing\UpdateCampaignRecipient_request.xml
Response (UpdateCampaignRecipient)
...\81_WSDL_XML\81_WebMarketing\UpdateCampaignRecipient_response.xml
Request (CheckModuleLicense)
\81_WSDL_XML\81_WebMarketing\CheckModuleLicense_request.xml
Response (CheckModuleLicense)
\81_WSDL_XML\81_WebMarketing\CheckModuleLicense_response.xml

Message Schema (WSDL) for WebMarketing

\81_WSDL_XML\81_WebMarketing\81_WebMarketing.wsdl

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

Account IO Required. An instance of the Integration Object

integration object Account IO.
Account is the Parent header and
Account_BusinessAddress is the
child
Response Message Description: AccountCreateAccount

Account Id The new Account Id generated as a String

result of the new account creation
Error Message Error message if any String
Success Flag Flag to indicate success or failure of String

the operation

Siebel 8.1 Primary Web Services Account
Request Message Description: AccountUpdateAccount
Account IO Required. An instance of the Integration Object

integration object Account IO.
Account is the Parent header and
Account_BusinessAddress is the
child
Response Message Description: AccountUpdateAccount


the operation
Application Objects
This section describes the application objects called by Account Web service. For more information on

Account IO Account IO
Example Package for Account

Request (AccountCreate)
...\81_WSDL_XMLAccount\AccountCreate_request.xml

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

...\81_WSDL_XML\Account\Account.wsdl
AssetManagementComplex
To display the detail of a promotion, CP, or bundle asset, i.e., display the related products for a
promotion, the child items for a CP or bundle asset.
AssetManagementComplex Operations
The following operations are used for the AssetManagementComplex Web service.
Name Description
AssetManagementComplexQueryPage 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.
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

Name Asset Name String
ParentAssetId Parent Asset ID String
PriceType Price Type String
ProdPromId Product Prom ID String
ProductDefTypeCode Product Def Type Code 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
AssetDescription Asset Description String
AssetNumber Asset Number String
BillingAccount Billing Account String
BillingAccountId Billing Account ID String
OwnerContactId Owner contact ID String
ProductDescription Product Description String
ProdPromId Product Prom ID String

ProductDefTypeCode Product Code String
ProductPartNumber Product Part Number String
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
Application Objects
This section describes the application objects called by AssetManagementComplex. For more

Asset Management - Business Service CSSEAIUIDataService

Complex


SiebelMessage SiebelMessage
SiebelMessageIn SiebelMessage
SiebelMessageOut SiebelMessageOut
Example Package for AssetManagementComplex

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

...\81_WSDL_XML\AssetManagementComplex\AssetManagementComplex.wsdl

Siebel 8.1 Primary Web Services Contact
Contact
Use this Web service for the basic operations of Siebel Marketing such as to create and update
contacts.
Contact Operations
Name Description
ContactCreateContact Creates a contact
ContactUpdateContact Updates an existing contact
Request Message Description: ContactCreateContact

Contact IO Required. An instance of the Integration Object

integration object Contact IO.
Contact is the Parent header and
Contact_BusinessAddress is the
child
Response Message Description: ContactCreateContact

Contact Id The new Contact Id generated as a String

result of the new contact creation
Error Message Error Message if any String

the operation

Request Message Description: ContactUpdateContact
Contact IO Required. An instance of the Integration Object

integration object Contact IO.
Contact is the Parent header and
Contact_BusinessAddress is the
child
Response Message Description: ContactUpdateContact


the operation
Contact Application Objects

This section describes the application objects called by the Contact Web service. For more information

Contact IO Contact IO
Example Package for Contact

Request (ContactCreate)
...\81_WSDL_XML\Contact\ContactCreate_request.xml

Response (ContactCreate)
...\81_WSDL_XML\Contact\ContactCreate_response.xml
Request (ContactUpdate)
...\81_WSDL_XML\Contact\ContactUpdate_request.xml
Response (ContactUpdate)
...\81_WSDL_XML\Contact\ContactUpdate_response.xml
Message Schema (WSDL) for Contact

...\81_WSDL_XML\Contact\Contact.wsdl

Siebel 8.1 Primary Web Services GetMktgWebSurvey
GetMktgWebSurvey
Use this Web service to get Marketing Web Surveys.
GetMktgWebSurvey Operations
Name Description
GetMktgWebSurveyQueryPage This Operation is used to query up a Survey Page
Request Message Description: GetMktgWebSurveyQueryPage

ExecutionMode The mode in which the query is to be String

performed
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

Integration Object Object
ViewMode The View Mode set for the String

Object(Admin,Preserve etc.)
Response Message Description: GetMktgWebSurveyQueryPage

SiebelMessageOut An instance of the GetMktgWebSurvey Integration

Integration Object Object
Application Objects

Import Job Integration Object Import Job Integration Object

Siebel 8.1 Primary Web Services GetMktgWebSurvey
Example Package for GetMktgWebSurvey

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

...\81_WSDL_XML\GetMktgWebSurvey\GetMktgWebSurvey.wsdl

Siebel 8.1 Primary Web Services LeadProcessingService
LeadProcessingService
This service contains the basic operations for processing leads, including assigning, querying, scoring
and data cleansing.
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.
Request Message Description: LeadProcessingServiceAssignLeads

This method is used to assign leads. It accepts the input parameters in a property set.
Execution Order Required. Parameter to be passed to String

Business Rules Workflow
Search Specification Required. The input search criteria to String

search on Lead BC
Response Message Description: LeadProcessingServiceAssignLeads

Error Message OK or NOTOK based on errors. String
Process Instance Id This is the Business Rules Workflow String

process Id.
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.
Business Component Required. Business Component to be String

passed to Data cleansing service.
Business Object Required. Business Object from which String

the business component instance is
obtained
Search Specification Required. Search specification to querry String

the BC and get the values in activated
Fields.

LeadProcessingServiceDataCleansing
Error Message OK or NOTOK based on errors. String
Success Flag Yes OR No based on success. String
Request Message Description: LeadProcessingServiceGetLeads

This method is used to get leads based on the input criteria.
Search Specification Required. The input search criteria to String

search on Lead BC
Response Message Description: LeadProcessingServiceGetLeads

SiebelMessage Required. Has Lead Id and description of Integration

the leads. Object

Request Message Description: LeadProcessingServiceScoreLeads

This method is used to score leads. It accepts the input parameters in a property set.
Execution Order Required. Parameter to be passed to String

Business Rules Workflow
Response Message Description: LeadProcessingServiceScoreLeads

Error Message OK or NOTOK based on errors String
Process Instance Id This is the Business Rules Workflow String

process Id
Success Flag Yes OR No based on success String
LeadProcessingService Application Objects

This section describes the application objects called by Lead Processing Service. For more information

Business Rules Workflow WorkFlow
Data Cleansing Busiiness Service

Lead Integration Object Lead

Example Package for Lead Processing Service

Request (LeadProcessingServiceAssignLeads)
...\81_WSDL_XML\LeadProcessingService\LeadProcessingService_AssignLeads_request.xml
Response (LeadProcessingServiceAssignLeads)
...\81_WSDL_XML\LeadProcessingService\LeadProcessingService_AssignLeads_request.xml
Request (LeadProcessingServiceDataCleansing)
...\81_WSDL_XML\LeadProcessingService\LeadProcessingService_ScoreLeads_request.xml
Response (LeadProcessingServiceDataCleansing)
Request (LeadProcessingServiceGetLeads)
Response (LeadProcessingServiceGetLeads)

Request (LeadProcessingServiceScoreLeads)
Response (LeadProcessingServiceScoreLeads)
Message Schema (WSDL) for Lead Processing Service

...\81_WSDL_XML\LeadProcessingService\LeadProcessing.wsdl

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
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.
LeadId Required.The Id of the lead to be retired. String
ReasonCode Required The reason code for retiring the String

lead.
Comments Comments for retiring (if any). String
Response Message Description: LeadServiceRetireLead

ReturnVal Error code (OK or NOTOK). String
Request Message Description: LeadServiceCreateLead

Lead IO Required.An instance of the Integration Integration

Object Lead IO Object

Response Message Description: LeadServiceCreateLead

Error Message Error message (if any). String
Success Flag Y or N. String
Lead Id Id of the lead generated as a result of String

the lead creation.
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.
LeadId Required. The Id of the lead to be String

rejected.
OwnerId Optional. String
ReasonCode Reason code for rejecting the lead. String
Comments Comments (if any). String
Response Message Description: LeadServiceRejectLead

ReturnVal Error message(OK or NOTOK) String
Request Message Description: LeadServiceResponseToLead

Response Id Required.The Id of the response to be String

converted to lead.

Response Message Description: LeadServiceResponseToLead

Error Message Error message (if any). String
Lead Id The Id of the lead created from the String

response.
Request Message Description: LeadServiceConvertLeadToOpty

LeadId Required . The Id of the lead to be String

converted.
Contact Id The contact Id of the lead String
Account Id The account Id of the lead String
Response Message Description: LeadServiceConvertLeadToOpty

Error Message Error message (if any) 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.
Lead IO Required. An instance of the integration Integration

object Lead IO Object

Response Message Description: LeadServiceUpdateLead

LeadService Application Objects

This section describes the application objects called by the Lead Web service. For more information on

Response To Lead Conversion Workflow
Lead To Opty Conversion Workflow

Lead IO Lead
Example Package for LeadService

Request (LeadServiceRetireLead)
...\81_WSDL_XML\LeadService\LeadService_RetireLead_request.xml
Response (LeadServiceRetireLead)
...\81_WSDL_XML\LeadService\LeadService_RetireLead_response.xml
Request (LeadServiceCreateLead)
...\81_WSDL_XML\LeadService\LeadService_CreateLead_request.xml
Response (LeadServiceCreateLead)
...\81_WSDL_XML\LeadService\LeadService_CreateLead_response.xml
Request (LeadServiceRejectLead)
...\81_WSDL_XML\LeadService\LeadService_RejectLead_request.xml
Response (LeadServiceRejectLead)
...\81_WSDL_XML\LeadService\LeadService_RejectLead_response.xml
Request (LeadServiceResponseToLead)
...\81_WSDL_XML\LeadService\LeadService_ResponseToLead_request.xml
Response (LeadServiceResponseToLead)
...\81_WSDL_XML\LeadService\LeadService_ResponseToLead_response.xml
Request (LeadServiceConvertLeadToOpty)
...\81_WSDL_XML\LeadService\LeadService_ConvertToOpty_request.xml

Response (LeadServiceConvertLeadToOpty)
...\81_WSDL_XML\LeadService\LeadService_ConvertToOpty_response.xml
Request (LeadServiceUpdateLead)
...\81_WSDL_XML\LeadService\LeadService_UpdateLead_request.xml
Response (LeadServiceUpdateLead)
...\81_WSDL_XML\LeadService\LeadService_UpdateLead_response.xml
Message Schema (WSDL) for LeadService

...\81_WSDL_XML\LeadService\Lead.wsdl

Siebel 8.1 Primary Web Services List
List
Use this Web service for the basic operations for processing lists.
List Operations
Name Description
ListCreateList Creates a list
ListExportList Exports a list
Request Message Description: ListCreateList

This method is used to create a list. It accepts the input parameters as a property set.
List IO Required. An instance of the integration Integration

object List IO Object
Response Message Description: ListCreateList

List Id List Id of the list created String
Error Message Error message if any. String

Request Message Description: ListExportList

This method is used to export lists. It accepts the input parameters as a property set.
Business Component The business component whose records String

need to be exported.
Business Object The business object containing the bc. String
Export Format The format (xml or CSV) based on which String

the filename(s) are to be created.
Search Specification The search specification for the records String

on the bc (if the records satisfying a
condition are only to be picked).
Response Message Description: ListExportList

Not applicable.
List Application Objects

This section describes the application objects called by List. For more information on application
implementation, refer to application development documentation.

EAI XML Write to File Business Service

List IO List IO

Example Package for List

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

...\81_WSDL_XML\List\List.wsdl

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.
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.
Prospect IO Required input parameter. Integration

Object
Response Message Description: ListMgmtProspectCreateProspect

Prospect Id Unique Id of the prospect created. String
Error Message Error message, if any. String
Request Message Description: ListMgmtProspectUpdateProspect

This method updates a prospect.
Prospect IO Required input parameter. Integration

Object

Siebel 8.1 Primary Web Services ListMgmtProspect
Response Message Description: ListMgmtProspectUpdateProspect

Success Flag Y or N String
Example Package for ListMgmtProspect

Request (ListMgmtProspectCreate)
ListMgmtProspect\ListMgmtProspectCreate_request.xml
Response (ListMgmtProspectCreate)
ListMgmtProspect\ListMgmtProspectCreate_request.xml
Request (ListMgmtProspectUpdate)
ListMgmtProspect\ListMgmtProspectUpdate_request.xml
Response (ListMgmtProspectUpdate)
ListMgmtProspect\ListMgmtProspectUpdate_request.xml
Message Schema (WSDL) for ListMgmtProspect

...\81_WSDL_XML\ListMgmtProspect\ListMgmtProspect.wsdl

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

Order Number Number The number of transactions this order Number

number will be processed.
Response Message Description: ProcessExternalOrder

Total Points Total Number of Points for a given order. Number
Request Message Description: ImportExternalOrderTxn

File Name File name that contains the transactions. String.

Response Message Description: ImportExternalOrderTxn

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.
Order Number Order Number to be stamped to the Number

saved transactions.
Total Lines Total number of transactions in the Number

Input.
Request Mode Can be Process or Simulate String
LOY EAI Transactions Transactions in Integration Object Integration

Format. Object
Response Message Description: ProcessExternalOrderTxn

Total Points Number Total Number of Points for the given Number
order.
Return Value String Failure or Success. String
Siebel Message Siebel Message of Transactions. Hierarchy

Hierarchy
Request Message Description: ExportPromotions

Exports the promotion of given program.
Activity Date Date should be between the start and String

end date of the promotion.
Export Flag Export Flag can be Y or N. String
Program Name Program Name of which the user want to String

export the Promotions

Response Message Description: ExportPromtions

Siebel Message All the Promotions in LOY EAI Promotion Integration

Integration Object Format Object.
Example of Package for LoyaltyAccrualService

Request (ProcessExternalOrder)
...\81_WSDL_XML\LoyaltyAccrualService\ProcessExternalOrder_request.xml
Response (ProcessExternalOrder)
...\81_WSDL_XML\LoyaltyAccrualService\ProcessExternalOrder_response.xml
Request (ImportExternalOrderTxn)
...\81_WSDL_XML\LoyaltyAccrualService\ProcessExternalOrderTxn_request.xml
Response (ImportExternalOrderTxn)
...\81_WSDL_XML\LoyaltyAccrualService\ProcessExternalOrderTxn_response.xml
Request (ImportExternalOrderTxnif Request Mode is Simulate)

...\81_WSDL_XML\LoyaltyAccrualService\RequestMode_Simulate_request.xml

Response (ImportExternalOrderTxnif Request Mode is Simulate)

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

WSDL (ProcessExternalOrder)
...\81_WSDL_XML\LoyaltyAccrualService\ProcessExternalOrder.wsdl
WSDL (ImportExternalOrderTxn)
...\81_WSDL_XML\LoyaltyAccrualService\ImportExternalOrderTxn.wsdl

WSDL (ProcessExternalOrderTxn)
...\81_WSDL_XML\LoyaltyAccrualService\ProcessExternalOrderTxn.wsdl
WSDL (ExportPromotions)
...\81_WSDL_XML\LoyaltyAccrualService\ExportPromotions.wsdl

Siebel 8.1 Primary Web Services LoyaltyMemberService
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
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.
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

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 String

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

purchase is to be given. It is a
mandatory input
Billing Address Member billing address. It is required if String

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

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

payment involves monetary currency and
Credit Card details are mentioned.
Billing Country Member billing country. It is required if String

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

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

CVV Number CVV number from member credit card. It String

is required if the payment involves
Card Holder Name Credit card holder name. It is required if String

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

payment involves monetary currency.

Credit Card Type Credit card type, such as Visa, String

MasterCard, and so on. It is required if
Currency Currency type used by member. It is String

required as the payment involves
monetary currency.
Expiration Month Expiration month of member credit String

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

monetary currency.
Override Flag It is a mandatory input. Loyalty String

be given.
Override Pay It is a mandatory input. If the member String

wants to override the price details, input
would be Y, else it would be N.
Override Reason Member should mention Override Pay String

when Override flag given is Y. It is the
Monetary Amount overridden by the
member.
Override Reason Code Reason to override the pricelist is to be String

mentioned if the Override Flag is Y.

Response Message Description: PurchasePointsService

Error Message Error message if the transaction fails is String

given.
Order Id Order Id of the Point Purchase Service is String

given.
Quote Id Quote Id of the Point Purchase Service is String

given.
Siebel Response Code Response Code given by Siebel Order String

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

Transaction Number Transaction Number of the Point String

Purchase Service is given in the output
Request Message Description: TransferPointService

Point Type It is a mandatory input. Loyalty String

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

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

Number purchase is to be given. It is a
mandatory input
Billing Address Transferee Membership Number to whom String

the points are to be transferred
Billing Address2 Member billing address. It is required if String

Billing City Secondary member billing address. It is String


Billing Country Member billing city. It is required if the String

Billing State Member billing country. It is required if String

Billing ZipCode Member billing state. It is required if the String

CVV Number Member billing Zip code. It is required if String

Card Holder Name CVV number from member credit card. It String
Credit Card Number Credit card holder name. It is required if String

Credit Card Type Credit card number. It is required if the String

Currency Credit card type, such as Visa, String

Expiration Month Currency type used by member. It is String

monetary currency.
Expiration Year Expiration month of member credit String

Override Flag Expiration year of member credit card. It String

monetary currency

Override Reason Member should mention Override Pay String

member.


Response Message Description: TransferPointService


given.
Order Id Order Id of the Point Transfer Service is String

given.
Quote Id Quote Id of the Point Transfer Service is String

given.


Transaction Number Transaction Number of the Point Transfer String

Service is given in the output
Request Message Description: LoungePurchaseService

Lounge Period Type It is a mandatory input. Loyalty String

be given.
Lounge Period Duration Lounge period type as Months or Years String
Billing Address Lounge period duration for the number of String

months or years the member want to
renew his lounge.











monetary currency.


monetary currency

Override Points Member should mention Override Pay String

member.
Override Reason Member should mention Override Points String

when Override flag given is Y and the
payment mode selected is Points or
Points + Pay.

Override Reason Code, Reason to override the pricelist is to be String

Payment Mode Override Reason Code is to be mentioned String

if the Override Flag is Y.
Point Type Payment mode as Points or Points + Pay String

or Pay. It is a mandatory input.
Response Message Description: LoungePurchaseService


given.
Order Id Order Id of the Lounge Purchase Service String

is given.
Quote Id Quote Id of the Lounge Purchase Service String

is given.


Transaction Number Transaction Number of the Lounge String

Purchase Service is given in the output
Request Message Description: RenewMembershipService

Membership Scheme It is a mandatory input. Loyalty String

be given.
Billing Address Membership Scheme to which the String

member wants to be renewed is to be
given. It is a mandatory input.











monetary currency.


monetary currency

Override Points Member should mention Override Pay String

member.

Override Reason Member should mention Override Points String

when Override flag given is Y and the
payment mode selected is Points or
Points + Pay.

Payment Mode Override Reason Code is to be mentioned String

if the Override Flag is Y.
Point Type Payment mode as Points or Points + Pay String

or Pay. It is a mandatory input.
Response Message Description: RenewMembershipService


given.
Order Id Order Id of the Renew Membership String

Service is given.
Quote Id Quote Id of the Renew Membership String

Service is given.


Transaction Number Transaction Number of the Renew String

Membership Service is given in the
output
Request Message Description: MembershipCancellationService

Member Number Membership number of the member String

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

Refund Percentage Refund percentage is to be given if the String

selected fee refund basis is Percentage.
Cancellation Reason Reason for the membership cancellation String

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

to be given. It is a mandatory input.
Credit Card Number Credit card number is to be given as the String

same one mentioned in last enrolment or
renewal transaction (whichever is the
latest). This is required when the refund
basis is Percentage or Prorata. Fee will
be refunded to the card number given, if
it matches with the previous renewal or
enrolment transactions credit card
details.
Credit Card Type Credit card Type (Visa or Master Card String
etc) is to be given as the same one
mentioned in last enrolment or renewal
transaction (whichever is the latest). This
is required when the refund basis is
Percentage or Prorata. Fee will be
refunded to the card number given, if it
matches with the previous renewal or
enrolment transactions credit card
details.
Expiration Month Expiration Month is to be given as the String

basis is Percentage or Prorata.
Expiration Year Expiration Year is to be given as the String

basis is Percentage or Prorata.
Override Flag It is a mandatory input. If the member String

wants to override the Refund Price
details, input would be Y, else it would be
N.
Override Pay Member should mention Override Pay String

Refund Amount overridden by the
member.
Override Reason Reason for overriding price is mentioned String

here.

Override Reason Code Override Reason Code is to be given if String

the Override Flag is Y.
Response Message Description: MembershipCancellationService

Currency Currency in which the fee is refunded is String

given as output

given.
Order Id Refund Order Id of the Membership String

Cancellation Service is given.
Quote Id Refund amount is given in the output String
Refund Amount Response Code given by Siebel Order String

Siebel Response Code Response Message given by Siebel Order String

Siebel Response Message Transaction number of the Membership String

Cancellation is mentioned
Transaction Number Currency in which the fee is refunded is String

given as output

Request Message Description: GetMemberServicePrice

Member Number Membership Number of the member who String

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

member wants to get price lists in the
given currency only
Lounge Period Duration Lounge Period Duration is to be given if String

the Transaction Sub Type is Lounge
Purchase
Lounge Period Type Lounge Period Type (Months or Years String

etc) is to be given if the Transaction Sub
Type is Lounge Purchase
Point Type Point Type is to be given here if the String

member wants to see price lists of Points
or Points + Pay mode in the given point
type.
Points Qty Number of Points to be given if the String

Transaction Sub Type is Purchase Points
or Transfer Points.
Selected Membership Membership Scheme is to be mentioned String

Scheme in the input if the Transaction Sub Type
is Membership Renewal.
Transaction Sub Type Member Service Type (Points String

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

Integration Object of the List of Pirce Lines, after applying the Integration
Pircelists promotions on the base prices, are given Object
in the out put as XML file.

Request Message Description: MemberInquiry

Member Number Membership Number of the member String

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

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

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

Middle Name Middle Name of the member whose String

Telephone Number Telephone Number of the member whose String

Transaction Type Transaction Type is given to query on the String

given type of transactions done by the
member.
ZIP Code ZIP Code of the member whose details String

Response Message Description: GetMemberServicePrice

Siebel Message Member details are given in the IO and Integration

(Integration Object of the can be extracted as XML file. Object
LOY Member Inquiry)

Example Package for LoyaltyMemberServices

Request (PurchasePointsService)
...\81_WSDL_XML\LoyaltyMemberServices\PointPurchase_request.xml
Response (PurchasePointsService)
...\81_WSDL_XML\LoyaltyMemberServices\PointPurchase_response.xml
Request (TransferPointsService)
...\81_WSDL_XML\LoyaltyMemberServices\TransferPoints_request.xml
Response (TransferPointsService)
...\81_WSDL_XML\LoyaltyMemberServices\TransferPoints_response.xml
Request (LoungePurchaseService)
...\81_WSDL_XML\LoyaltyMemberServices\LoungePurchase_request.xml
Response (LoungePurchaseService)
...\81_WSDL_XML\LoyaltyMemberServices\LoungePurchase_response.xml

Request (MembershipCancellationService)
...\81_WSDL_XML\LoyaltyMemberServices\MembershipCancellationService_request.xml
Response (MembershipCancellationService)
...\81_WSDL_XML\LoyaltyMemberServices\MembershipCancellationService_response.xml
Request (RenewMembershipService)
...\81_WSDL_XML\LoyaltyMemberServices\RenewMembershipService_request.xml
Response (RenewMembershipService)
...\81_WSDL_XML\LoyaltyMemberServices\RenewMembershipService_response.xml
Request (GetMemberServicePrice)
...\81_WSDL_XML\LoyaltyMemberServices\GetServicePrice_request.xml
Response (GetMemberServicePrice)
...\81_WSDL_XML\LoyaltyMemberServices\GetServicePrice_response.xml
Request (MemberInquiry)
...\81_WSDL_XML\LoyaltyMemberServices\MemberInquiry_request.xml

Response (MemberInquiry)
...\81_WSDL_XML\LoyaltyMemberServices\MemberInquiry_response.xml
Message Schema (WSDL) for LoyaltyMemberServices

...\81_WSDL_XML\LoyaltyMemberService\LoyaltyMemberServices.wsdl

Siebel 8.1 Primary Web Services LoyaltyRedemptionService
LoyaltyRedemptionService
User this Web service with the Siebel Loyalty Application to perform all redemption related operations,
including Redemption Processing, Redemption Cancellation, Voucher Reissue and Order Management
Integration.
LoyaltyRedemptionService Operations
Name Description
Returns available price options for a set of

redemption activities. Also returns the point balance
GetPriceOptions of the member in all point types.

redemption activities. Also performs the credit check
and returns how much loan is required for each point
type. If loan is not possible it does the point to pay
conversion and returns the prorated pay and points
CheckPriceOptions for each transaction.
Performs the credit check for a given member and

point type. Checks whether loan is required and
returns how much loan is required to fulfill the
CheckCredit redemption transaction.

redemption activities. Also performs the credit check
and returns how much loan is required for each point
type. If loan is not possible it does the point to pay
conversion and returns the prorated pay and points
for each transaction.
Also creates a quote using the given redemption

activities (transactions), credit card details (optional)
GetQuote and shipping details (optional).
Takes Quote Id as input and converts the quote to

order and order to redemption transactions. Then
ProcessQuote processes those transactions.
Takes as input an Order Number and returns the

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

given redemption transaction, which need to be
GetRedemptionRefund cancelled.
Takes the redemption transaction ID which need to

CancelRedemptionTxn
be cancelled and the refund amount (either

unmodified / overridden refund amount got from the

GetRedemptionRefund method) and creates the
cancellation transaction and processes it.
Returns the different fee options for reissuing the

GetReissueFeeOptions given voucher.
Checks whether a given fee option for a voucher is

valid, and whether the member has enough points to
CheckReissueFeeOption pay in this fee option if the payment mode involves
Points.
Takes the chosen fee option details for a voucher,
credit card details (optional), shipping details
(optional), checks whether the fee option is valid,
does credit check if the payment mode involves
GetReissueQuote points, and creates a quote with the given data.
Takes as input Quote Id, creates Order for Quote,

and creates a Loyalty Voucher Reissue transaction
ProcessReissueQuote and processes it to reissue the voucher.
Takes Quote Id and shipping details and updates the

UpdateQuoteShippingAddress quote with the given shipping address.
Takes Quote Id, credit card details, billing address

AddCreditCardToQuote and updates the quote with the credit card details.
Request Message Description: GetPriceOptions

LOY Redemption Txn Contains the redemption activity details Integration

Object
(Required)
Response Message Description: GetPriceOptions


and the price options for each activity Object
(Required)
LOY Redemp Points Contains point balances of the member in Integration

Summary all point types Object
(Required)

Request Message Description: CheckPriceOptions

LOY Redemption Txn Contains the redemption activity details. Integration

Object
(Required)
Response Message Description: CheckPriceOptions


and one price option for each activity Object
LOY Redemp Points Point Summary for each point type Integration
Summary including points to be paid, point Object
balance, loan (if any) and Points to Pay
Conversion flag
Pay Total amount to be paid if monetary Number

payment is involved
Pay Currency Code Currency if monetary payment is String

involved
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.
MemberNumber Membership number. String
PointTypeId Id number for point type. String
PointsReq Number
LoanFlag Indicates whether loan limit should be String

considered.

Response Message Description: CheckCredit

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).
LOY Redemption Txn Contains the redemption activity details. Integration

Object
Billing Address Address of customer being billed. String
Billing Address2 Second address, if necessary of customer String

being billed.
Shipping Method Shipping Method, such as Ground, Air or String

carrier name.
Ship To Street Address Shipping street address. String
Ship To Street Address 2 Second shipping street address if String

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

address.
Billing Country Billing country, if different from shipping String

address.
Billing State Billing state, if different from shipping String

address.

Billing ZipCode Billing ZIP code, if different from shipping String

address.
CVV Number String
Card Holder Name Name of credit card holder. String
Credit Card Expiration Expiration date of credit card. String

Month
Credit Card Expiration Expiration year of credit card. String

Year
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 String
Express, and so on.
Recipient Name Name of person who will receive shipped String

goods.
Save Shipping Address Check to save shipping address for future String
Flag use.
Select Primary Shipping Flag to indicate primary address for String

Address Flag account.
Ship To Address Id String

Ship To City String
Response Message Description:GetQuote


and one price option for each activity Object
LOY Redmp Points Point Summary for each point type Integration
Summary including points to be paid, point Object
balance, loan (if any) and Points to Pay
Conversion flag
Currency Code Code to indicate which currency being String

used for transation.
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

Request Message Description: ProcessQuote

This operation converts a quote to an order and an order to redemption transactions. It then
processes these transactions.
Quote Id String Required.
Response Message Description: Process Quote

Status String
Order Id Required String
Request Message Description: GetTransactionDetails
Order Number Required String
Response Message Description: GetTransactionDetails

LOY Redemption Txn Contains details of the redemption Integration

transactions that have been created for Object.
this order along with transaction items
for each transaction in case of package
transaction.
Request Message Description: GetRedemptionRefund

This operation returns the refund amount for given redemption transaction, which is then cancelled.
Transaction Id String Required.

Response Message Description: GetRedemptionRefund

Pay String
Point Type Required. String
Points Required. String
Currency String
Payment Type 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.
Override Expiry Date String
Override Expiry Date Flag String
Override Pay String
Override Points String
Override Price Flag String
Transaction Id Required String
Override Reason Code String
Payment Mode Required String
Simulate Pay String
Override Reason String
Response Message Description:CancelRedemptionTxn

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.
Currency Code String
Voucher Id Required String
Point Type Id String
Payment Type Code Required String
Response Message Description:GetReissueFeeOptions

Product Point Id Required String
Fee Points Number
Fee Amount Number
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.
Voucher Id Required String
Payment Type Code Required String
Point Type Id String
Override Amount Number
Override Flag String
Override Points Number
Override Reason String
Override Reason Code 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
Credit Card Expiration String

Month
Credit Card Expiration String

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

Flag
Select Primary Shipping String

Address Flag
Ship To Address Id String
Ship To City String
Response Message Description: GetReissueQuote

Quote Id Required String

Fee Amount Number
Fee Points Number
Shipping Charge String
Tax Amount 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.
Response Message Description: ProcessReissueQuote

Transaction Number Required String
Order Number Required String
New Voucher Expiry Date Required Date
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.
Response Message Description: UpdateQuoteShippingAddress

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.
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
Response Message Description: GetReissueQuote

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

Request (GetPriceOptions)
...\81_WSDL_XML\LoyaltyRedemptionService\GetPriceOptions_request.xml
Response (GetPriceOptions)

...\81_WSDL_XML\LoyaltyRedemptionService\GetPriceOptions_response.xml
Request (CheckPriceOptions)
...\81_WSDL_XML\LoyaltyRedemptionService\CheckPriceOptions_request.xml
Response (CheckPriceOptions)
...\81_WSDL_XML\LoyaltyRedemptionService\CheckPriceOptions_response.xml
Request (CheckCredit)
...\81_WSDL_XML\LoyaltyRedemptionService\CheckCredit_request.xm
Response (CheckCredit)
...\81_WSDL_XML\LoyaltyRedemptionService\CheckCredit_response.xml
Request (GetQuote)
...\81_WSDL_XML\LoyaltyRedemptionService\GetQuote_request.xml
Response (GetQuote)
...\81_WSDL_XML\LoyaltyRedemptionService\GetQuote_response.xml
Request (ProcessQuote)
...\81_WSDL_XML\LoyaltyRedemptionService\ProcessQuote_request.xml

Response (ProcessQuote)
...\81_WSDL_XML\LoyaltyRedemptionService\ProcessQuote_response.xml
Request (GetTransactionDetails)
...\81_WSDL_XML\LoyaltyRedemptionService\GetTransactionDetails_request.xml
Response (GetTransactionDetails)
...\81_WSDL_XML\LoyaltyRedemptionService\GetTransactionDetails_response.xml
Request (GetRedemptionRefund)
...\81_WSDL_XML\LoyaltyRedemptionService\GetRedemptionRefund_request.xml
Response (GetRedemptionRefund)
...\81_WSDL_XML\LoyaltyRedemptionService\GetRedemptionRefund_response.xml
Request (CancelRedemptionTxn)
...\81_WSDL_XML\LoyaltyRedemptionService\CancelRedemptionTxn_request.xml
Response (CancelRedemptionTxn)
...\81_WSDL_XML\LoyaltyRedemptionService\CancelRedemptionTxn_response.xml
Request (GetReissueFeeOptions)

...\81_WSDL_XML\LoyaltyRedemptionService\GetReissueFeeOptions_request.xml
Response (GetReissueFeeOptions)
...\81_WSDL_XML\LoyaltyRedemptionService\GetReissueFeeOptions_response.xml
Request (GetReissueQuote)
...\81_WSDL_XML\LoyaltyRedemptionService\GetReissueQuote_request.xml
Response (GetReissueQuote)
...\81_WSDL_XML\LoyaltyRedemptionService\GetReissueQuote_response.xml
Request (ProcessReissueQuote)
...\81_WSDL_XML\LoyaltyRedemptionService\ProcessReissueQuote_request.xml
Response (ProcessReissueQuote)
...\81_WSDL_XML\LoyaltyRedemptionService\ProcessReissueQuote_response.xml
Request (UpdateQuoteShippingAddress)
...\81_WSDL_XML\LoyaltyRedemptionService\UpdateQuoteShippingAddress_request.xml
Response (UpdateQuoteShippingAddress)
...\81_WSDL_XML\LoyaltyRedemptionService\UpdateQuoteShippingAddress_response.xml

Request (AddCreditCardToQuote)
...\81_WSDL_XML\LoyaltyRedemptionService\AddCreditCardToQuote_request.xml
Response (AddCreditCardToQuote)
...\81_WSDL_XML\LoyaltyRedemptionService\AddCreditCardToQuote_response.xml
Message Schema (WSDL) for LoyaltyRedemptionService

...\81_WSDL_XML\LoyaltyRedemptionService\LoyaltyRedemptionService.wsdl

Siebel 8.1 Primary Web Services LoyaltyVoucherService
LoyaltyVoucherService
Use this Web service with the Siebel Loyalty Application to perform all Voucher related Web service
operations, including Voucher Validity Check and Status Change.
LoyaltyVoucherService Operations
Name Description
VoucherValidityCheck Takes in the membership number, Partner Id

voucher number and activity date, to validate the
voucher and return Success or Failure.
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.
Voucher Number Required String
Activity Date Required String
Member Number Required String
Partner Id Required String
Response Message Description: VoucherValidityCheck

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.

Siebel 8.1 Primary Web Services LoyaltyVoucherService
Voucher Number Optional String
Member Number Required String
Partner Name Required String
Activity Date Required String
Order Number Optional Number
Response Message Description: VoucherStatusChange

Voucher Number Optional String
Order Number Optional Number
Voucher Type Required String
Return Value Required String
Example Package for LoyaltyVoucherService

Request
...\81_WSDL_XML\LoyaltyVoucherService\LoyaltyVoucherService_request.xml
Response
...\81_WSDL_XML\LoyaltyVoucherService\LoyaltyVoucherService_request.xml
Message Schema (WSDL) for LoyaltyVoucherService

...\81_WSDL_XML\LoyaltyVoucherService\LoyaltyVoucherService.wsdl

Siebel 8.1 Primary Web Services MktgDeduplicationService
MktgDeduplicationService
Use this Web service to check if a duplicate record exists for an account, contact, opportunity or
prospect.
Mktg Deduplication Service Operations

Name 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
DUNS Number String
Name Account name. String
Primary Account City City name. String
Primary Account Country Country name String
Primary Account Postal City postal code. String

Code
Primary Account State State String
Primary Account Street Street address of primary account. String

Address


MktgDeduplicationServiceMatchAccount
HasMatch Output String as hasMatch or String

hasNoMatch
Match Info Score of the match and row id of the Integration

matchee. Object

MktgDeduplicationServiceMatchOpportunity
Account Id Opportunitys account Id. String
Business Unit Id Opportunitys business unit Id. String
Name Opportunitys name. String

MktgDeduplicationServiceMatchOpportunity

hasNoMatch

matchee. Object

MktgDeduplicationServiceMatchProspect
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

MktgDeduplicationServiceMatchProspect

hasNoMatch

matchee. Object

MktgDeduplicationServiceMatchContact
Account Account name of contact. String
Birth Date Contacts birth date. String
Phone Contacts phone number. String
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

MktgDeduplicationServiceMatchContact

hasNoMatch

matchee. Object
MktgImportDeduplicationService Application Objects

his section describes the application objects called by Mktg Import Service. For more information on

Not applicable.

Mktg Deduplication Mktg Deduplication

Example Package for MktgDeduplicationService

Request (MatchAccount)
...\81_WSDL_XML\MktgDeduplicationService\MatchAccount_request.xml
Response (MatchAccount)
...\81_WSDL_XML\MktgDeduplicationService\MatchAccount_response.xml
Request (MatchOpportunity)
...\81_WSDL_XML\MktgDeduplicationService\MatchOpportuntity_request.xml
Response (MatchOpportunity)
...\81_WSDL_XML\MktgDeduplicationService\MatchOpportuntity_response.xml
Request (MatchProspect)
...\81_WSDL_XML\MktgDeduplicationService\MatchProspect_request.xml
Response (MatchProspect)
...\81_WSDL_XML\MktgDeduplicationService\MatchProspect_response.xml

Request (MatchContact)
...\81_WSDL_XML\MktgDeduplicationService\MatchContact_request.xml
Response (MatchContact)
...\81_WSDL_XML\MktgDeduplicationService\MatchContact_response.xml
Message Schema (WSDL) for Mktg Deduplication Service

MktgDeduplicationService\MktgDedup.wsdl

Siebel 8.1 Primary Web Services MktgImportService
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

Name 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.
ImportJobParams Required. An instance of the integration Integration

object Import Job Integration Object Object
Response Message Description: MktgImportServiceInvokeImportJob

ErrorCode OK or NOTOK String
Mktg Import Service Application Objects

his section describes the application objects called by Mktg Import Service. For more information on

Mktg System Task Service Business Service CSSSystemTaskService

Siebel 8.1 Primary Web Services MktgImportService

Import Job Integration Object Import Job Integration Object
Example Package for MktgImportService

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

...\81_WSDL_XML\MktgImportService\MktgImportService.wsdl

Siebel 8.1 Primary Web Services OrderDetailWebService
OrderDetailWebService
Use this Web service to query orders based on search criteria, and retrieve details from a particular
order. Details include payments,approvals, shipping and billing ,to track the shipment details of an
order. Additionally, users can copy current order lines to a cart and/or cancel an order.
OrderDetailWebService Operations
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 .
OrderDetailQueryPage_Input The method arguments are Orders Integration

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

set on the view criteria and Object
searchspec.

Request Message Description: OrderDetailUpdate

OrderDetailUpdate_Input The method arguments are Orders IO Integration

with parameters set, Language Mode Object
(value is LDC) and viewMode (All).
Response Message Description: OrderDetailUpdate

OrderDetailUpdate_Output The retrieved data for the update Integration

operation performed. Object
OrderDetailWebService Application Objects

This section describes the application objects called by the OrderDetailWebService. This WebService
exposes the EAI UI Business Service PDS Order Detail, which provides update and query operations
on PDS Order Detail Integration Object.

PDS Order Detail Integration Object CSSEAIUIDataService

PDS Order Detail PDS Simplified Order
Example Package for OrderDetailWebService

Request

...\81_WSDL_XML\OrderDetailWebService\OrderDetailWebService_request.xml
Response
...\81_WSDL_XML\OrderDetailWebService\OrderDetailWebService_response.xml
Message Schema (WSDL) for OrderDetailWebService

...\81_WSDL_XML\OrderDetailWebService\OrderDetailWebService.wsdl

Siebel 8.1 Primary Web Services PDSOrderHeader
PDSOrderHeader
Use this Web service to get header information for specific open orders.
PDSOrderHeader Operations
Name Description
PDSOrderHeaderQueryPage Get the header information of open orders for a

specific asset.
Request Message Description: PDSOrderHeaderQueryPage

PDSOrderHeaderQueryPage_Input The request message includes ComplexType

the search criteria for order
status and asset integration Id
Response Message Description: PDSOrderHeaderQueryPage

PDSOrderHeaderQueryPage_Output The response message ComplexType

includes list of order headers
matching the search criteria.
Example Package for PDSOrderHeader

Request
...\81_WSDL_XML\PDSOrderHeader\PDSOrderHeader_request.xml

Siebel 8.1 Primary Web Services PDSOrderHeader
Response
...\81_WSDL_XML\PDSOrderHeader\PDSOrderHeader_response.xml
Message Schema (WSDL) for PDSOrderHeader

...\81_WSDL_XML\PDSOrderHeader\PDSOrderHeader.wsdl

Siebel 8.1 Primary Web Services PriceListsWS
PriceListsWS
Use this Web service to obtain price lists based on defined search specifications.
PriceListsWS Operations
Name Description
GetPriceLists Get all the price lists based on search spec
Request Message Description: GetPriceLists

GetPriceLists_Input Request message includes the search ComplexType

spec
Response Message Description: GetPriceLists

GetPriceLists_Output Response message includes the price ComplexType

lists matching the search spec.
Example Package for PriceListsWS

Request
...\81_WSDL_XML\PriceListsWS\PriceListsWS_request.xml
Response
...\81_WSDL_XML\PriceListsWS\PriceListsWS_response.xml

Siebel 8.1 Primary Web Services PriceListsWS
Message Schema (WSDL) for PriceListsWS

...\81_WSDL_XML\PriceListsWS\PriceListsWS.wsdl

Siebel 8.1 Primary Web Services ProductSearchService
ProductSearchService
Business Service (Search Product Service) for Searching Product Business Component and doing
eligibility check.
ProductSearchService Operations
Name Description Parameters
ExecuteSearch Retrieve Products based on Input:

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

EligibilityMode String
ABOFlag String
AccountContractedProduct String
sOnlyFlag
AccountId String
AccountType Type of Account String
ClassId 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
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

TotalRecords Total number of records retrieved. String
ProductId Product Id String
ProductSearchService Application Objects

This section describes the application objects called by the ProductSearchService. For more

SearchProductService Business Service CSSSrchProductSvc


Context PDS Catalog Context
SearchProductInputSiebelMessage SearchProductInputIO
SearchProductResponseSiebelMessage SearchProductResponseIO
Example Package for ProductSearchService

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

...\81_WSDL_XML\ProductSearchService\ProductSearchService.wsdl

Siebel 8.1 Primary Web Services QuoteCheckOutWebService
QuoteCheckOutWebService
Use this Web service to perform payment authorizations for quotes.
QuoteCheckOutWebService Operations
Name 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

QuoteCheckOut_Input The request message includes the Id of ComplexType

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.
Response Message Description: QuoteCheckOut

QuoteCheckOut_Output The response message includes the Id of ComplexType

the order converted from quote.
Example Package for QuoteCheckOutWebService

Request
...\81_WSDL_XML\QuoteCheckOutWebService\QuoteCheckOutWebService_request.xml

Siebel 8.1 Primary Web Services QuoteCheckOutWebService
Response
...\81_WSDL_XML\QuoteCheckOutWebService\QuoteCheckOutWebService_response.xml
Message Schema (WSDL) for QuoteCheckOutWebService

...\81_WSDL_XML\QuoteCheckOutWebService\QuoteCheckOutWebService.wsdl

Siebel 8.1 Primary Web Services QuoteDetailWebService
QuoteDetailWebService
Use this Web service to retrieve, update, insert, or delete details on a quote record.
QuoteDetailWebService Operations
Name 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

QuoteDetailGet_Input Quote object passed to the Web service. ComplexType

It includes the search criteria.
Response Message Description: QuoteDetailGet

QuoteDetailGet_Output Quote object returned. It includes the ComplexType

detail of the quote header and the
payment information
Request Message Description: QuoteDetailUpdate

QuoteDetailUpdate_Input Quote to be updated into database ComplexType

Response Message Description: QuoteDetailUpdate

QuoteDetailUpdate_Output Quote returned with updated ComplexType

information
Request Message Description: QuoteDetailInsert

QuoteDetailInsert_Input Quote to be inserted into database ComplexType
Response Message Description: QuoteDetailInsert

QuoteDetailDelete_Output Quote returned from Web service. ComplexType
Request Message Description: QuoteDetailDelete

QuoteDetailDelete_Input Quote to be deleted from database ComplexType
Response Message Description: QuoteDetailDelete

QuoteDetailDelete_Output Quote returned from Web service. ComplexType
Request Message Description: QuoteDetailInit

QuoteDetailInit_Input Quote to be initialized from database ComplexType

Response Message Description: QuoteDetailInit

QuoteDetailInit_Output Quote returned from Web service. ComplexType
Example Package for QuoteDetailWebService

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

...\81_WSDL_XML\QuoteDetailWebService\QuoteDetailWebService.wsdl

Siebel 8.1 Primary Web Services QuotingWebService
QuotingWebService
Use this Web service to process quotes and commit them to the database.
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

ExecuteQuoting_Input The request message includes the quote ComplexType

to be saved. It also includes the following
flags:
Flag to indicate whether to check the

eligibility
Flag to indicate whether to calculate

the price for the quote

the shipping cost

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
Response Message Description: ExecuteQuoting

ExecuteQuoting_Output The response message includes the ComplexType

quote returned from Web service.

Siebel 8.1 Primary Web Services QuotingWebService
QuotingWebService Application Objects

This section describes the application objects called by the QuotingWebService. For more information

Web Channel Quoting Workflow

PDS Quote PDS Simplified Quote
Example Package for QuotingWebService

Request
...\81_WSDL_XML\QuotingWebService\QuotingWebService_request.xml
Response
...\81_WSDL_XML\QuotingWebService\QuotingWebService_response.xml
Message Schema (WSDL) for QuotingWebService

...\81_WSDL_XML\QuotingWebService\QuotingWebService.wsdl

Siebel 8.1 Primary Web Services Response
Response
Use this Web service for the basic Marketing operations such as creating and updating responses.
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.
Response IO Required input parameter. Integration

Object
Response Message Description: ResponseCreateResponse

Response Id Row Id of the new response. String
Request Message Description: ResponseSourceCodeLookup

This method takes in Ids and Codes of Offer, Campaign and Treatment and returns the
S_CAMP_CON_ID
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

S_CAMP_CON_ID Row Id of the response. String
Request Message Description: ResponseUpdateResponse

This method updates an existing response.
Response IO Required input parameter. Integration

Object
Response Message Description: ResponseUpdateResponse

Example Package for Response

Request (ResponseCreateResponse)
...\81_WSDL_XML\Response\ResponseCreateResponse_request.xml

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

...\81_WSDL_XML\Response\Response.wsdl

Siebel 8.1 Primary Web Services RetrieveAttachmentService
RetrieveAttachmentService
This Web service has one standard QueryPage method to retrieve attachment documents.
RetrieveAttachmentService Operations
Provides search solution results. Business Service (Search Solution Service) for Searching Solution
Business Component.
Name Parameters Description
QueryPage Input: Attachment Id This retrieves the Attachment

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

This fetches the Attachment content for a given attachment Id.
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
ExecutionMode Execution Mode String
ViewMode Visibility Access Mode String
Response Message Description: RetrieveAttachmentService

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 Objects

This section describes the application objects called by the RetrieveAttachmentService. For more

RetrieveAttachmentService Business Service CSSEAIUIDataService


SiebelMessageIn AttachmentDocIO
SiebelMessageOut AttachmentDocIO
Example Package for RetrieveAttachmentService

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

...\81_WSDL_XML\RetrieveAttachmentService\RetrieveAttachmentService.wsdl

Siebel 8.1 Primary Web Services searchSolution
searchSolution
Use this Web service to search for solutions based on user inputs, and retrieve a solution as a search
result.
searchSolution Operations
Provides search solution results. Business Service (Search Solution Service) for Searching Solution
Business Component.
Name Parameters Description
searchSolution.searchSolution Input: SearchInputsIO Performs a search on a solution

(SearchText, SolutionType, To, based on specified input.
From)
Output: SearchResultsIO (Total

Records, Solution Id, Solution
Title, Last Update Date)
searchSolution.getSolution Input: SolutionId Retrieves solution from search

results.
Output: SolutionResultIO
(Solution Id, Solution Title,
Last Update Date, FAQ,
Resolution Text, Solution Type,
SolnAttachmentList
(Attachment Id, File Name,
Last Updated Date, Type) )
Request Message Description: searchSolution

Performs a search on a solution based on specified input.
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

TotalRecords Total number of records fetched String
From Index of the first record returned String
SolutionId Solution Id String
SolutionTitle Solution Title String
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.
SolutionId Solution Id String
Response Message Description: getSolution

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 Objects

This section describes the application objects called by the searchSolution. For more information on


Search Solution Service Business Service CSSSrchSolutionSvc

SolutionResultSiebelMessage SolutionResultIO
SearchInputsSiebelMessage SearchInputsIO
SearchResultsSiebelMessage SearchResultsIO
Example Package for searchSolution

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

...\81_WSDL_XML\searchSolution\searchSolution.wsdl

Siebel 8.1 Primary Web Services SelfServiceAccount
SelfServiceAccount
This WebService exposes the EAI UI Business Service SelfServiceAccount, which provides CRUD and
query operations on SS_Account_IO Integration Object.
This WebService exposes the Execute and Query Methods in the SelfServiceAccount Business
Service as Web service operations.
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

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 Business Address needs to be
added/updated, set operation ="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
ListOfAccountBusinessAddress
for the Account.
ListOfSSAccount/ Account / Used to create or update the Business

ListOfAccountBusinessAddress/ Address of the Account. Set operation

AccountBusinessAddress appropriately as insert or update and set
IsPrimaryMVG=Y, if this address needs to
be made the primary address on the
Account.
ListOfSSAccount/ Account / If the operation is update on

AccountBusinessAddress, set this field to the
ListOfAccountBusinessAddress/
specific address of the account.
AccountBusinessAddress/ Id
ListOfSSAccount/ Account / Set appropriate values for the details of this

address.
AccountBusinessAddress/ StreetAddress
(Similarly StreetAddress2, AddressLine3, State,

City, County, Country)
ListOfSSAccount/ Account / Set true if the address is the main address

for the account.
AccountBusinessAddress/ MainAddressFlag
ListOfSSAccount/ Account / Set true if the address is the Billable

Address for the account.
AccountBusinessAddress/ BillAddressFlag
ListOfSSAccount/ Account / Set true to fetch if the address is the

Shippable Address for the account.
AccountBusinessAddress/ ShipAddressFlag
ListOfSSAccount/ Account / Set to =true, if only active addresses of the

account need to be retrieved.
AccountBusinessAddress/ ActiveStatus
ListOfAccountBusinessAddress/ Set the ModId while updating, so as to

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

Node Description
SelfServiceAccountExecute_Output Container element for the Execute Operation

response.

ListOfSSAccount Corresponds to an instance of SS_Account_IO.
ListOfSSAccount/ Account
ListOfSSAccount/ Account /Id Id of the Account.
ListOfSSAccount/ Account / Mod Id Mod Id for the Account Record.
ListOfSSAccount/ Account / Container element for the list of created/updated

Business Address of the Account.
ListOfBusinessAddress
ListOfSSAccount/ Account / For each created/updated Business Address of the

Account.
ListOfBusinessAddress/ BusinessAddress
ListOfSSAccount/ Account / Id of the Address created/updated.
ListOfBusinessAddress/
BusinessAddress/ Id
ListOfSSAccount/ Account / ModId of the Address record created/updated.
ListOfBusinessAddress/
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.
Node Description
SelfServiceAccountQueryPage_Input Container element for the QueryPage

Operation request.

SS_Account_IO.
ListOfSSAccount/ Account /Id Set the Id of the Account as a ViewCriteria.
ListOfSSAccount/ Account / Empty; to fetch the Id of the Primary

PrimaryAddressId Address of the Account.
ListOfSSAccount/ Account / Empty; to fetch the Id of the Primary Bill To

PrimaryBillToAddressId Address of the Account.
ListOfSSAccount/ Account / Empty; to fetch the Id of the Primary Ship

PrimaryShipToAddressId To Address of the Account.

ListOfSSAccount/ Account / To fetch the Business Address of the

Account.
ListOfSSAccount/ Account / Empty
ListOfSSAccount/ Account / Empty (Set it to retrieve a specific address

of this account).
ListOfBusinessAddress/ BusinessAddress/
Id
ListOfSSAccount/ Account / Empty; Set appropriate View Criteria for

filtering addresses.
StreetAddress
(Similarly StreetAddress2, AddressLine3,

State, City, County, Country)
ListOfSSAccount/ Account / Empty; to fetch if the address is the main

MainAddressFlag
ListOfSSAccount/ Account / Empty; to fetch if the address is the Billable

BillAddressFlag
ListOfSSAccount/ Account / Empty; to fetch if the address is the

Shippable Address for the account.
ShipAddressFlag
ListOfSSAccount/ Account / Set to =true, if only active addresses of the

account need to be retrieved.
ActiveStatus
ListOfSSAccount/ Account / Empty
ListOfBusinessAddress/ BusinessAddress/ Empty; to fetch the ModId to be sent back

ModId while updating, so as to ensure that the
record is not updated in the interim.
ExecutionMode Refer to Siebel EAI
LOVLanguageMode Refer to Siebel EAI
ViewMode Refer to Siebel EAI

Response Message Description: SelfServiceAccountQueryPage

Node Description
SelfServiceAccountQueryPage_Output Container element for the QueryPage

Operation response.

SS_Account_IO
ListOfSSAccount/ Account /Id Id of the Account
ListOfSSAccount/ Account / Retrieved Id of the Primary Address of the

PrimaryAddressId Account.
ListOfSSAccount/ Account / Retrieved Id of the Primary Bill To Address

PrimaryBillToAddressId of the Account.
ListOfSSAccount/ Account / Retrieved Id of the Primary Ship To Address

PrimaryShipToAddressId of the Account.
ListOfSSAccount/ Account / Container element for the retrieved Business

Address of the Account
ListOfSSAccount/ Account / For each retrieved Business Address of the

Account
ListOfSSAccount/ Account / Id of the Address
Id
ListOfSSAccount/ Account / Details of the Business Address
StreetAddress
(Similarly StreetAddress2, AddressLine3,

State, City, County, Country)
ListOfSSAccount/ Account / True, if the address is the main Address for

the account.
MainAddressFlag
ListOfSSAccount/ Account / True, if the address is the Billable Address

for the account.
BillAddressFlag
ListOfSSAccount/ Account / True, if the address is the Shippable Address

for the account.
ShipAddressFlag

ListOfSSAccount/ Account / True, if the address is active
ActiveStatus
ListOfBusinessAddress/ BusinessAddress/ Empty; to fetch the ModId to be sent back

ModId while updating, so as to ensure that the
record is not updated in the interim.
SelfServiceAccount Application Objects

This WebService exposes the EAI UI Business Service SelfServiceAccount, which provides CRUD and
query operations on SS_Account_IO Integration Object.

SelfServiceAccount Business Service CSSEAIUIDataService

SS_Account_IO SS_Account_IO
Example Package for SelfServiceAccount

Request (SelfServiceAccountExecute)
...\81_WSDL_XML\SelfServiceAccount\SelfServiceAccountExecute_request.xml
Response (SelfServiceAccountExecute)
...\81_WSDL_XML\SelfServiceAccount\SelfServiceAccountExecute_response.xml

Request (SelfServiceAccountQueryPage)
...\81_WSDL_XML\SelfServiceAccount\SelfServiceAccountQueryPage_request.xml
Response (SelfServiceAccountQueryPage)
...\81_WSDL_XML\SelfServiceAccount\SelfServiceAccountQueryPage_response.xml
Message Schema (WSDL) for SelfServiceAccount

...\81_WSDL_XML\SelfServiceAccountQueryPage\SelfServiceAccount.wsdl

Siebel 8.1 Primary Web Services SelfServiceAccountRootPath
SelfServiceAccountRootPath
This WebService exposes the EAI UI Business Service SelfServiceAccountRootPath, which provides
query operations on SS_AccountRootPath_IO Integration Object.
This WebService 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
Name Description
SelfServiceAccountRootPathQueryPage Performs Query operation based on the viewCriteria

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.

SelfServiceAccountRootPathQueryPage
Node Description
SelfServiceAccountRootPathQueryPage_Input Container element for the QueryPage Operation

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.
ListOfSSAccountRootPath /SSAccountRootPath Empty

/ParPartyId

/PartyId

/PartyName

/PriceListId

/RelationTypeCode

ListOfSSAccountRootPath /SSAccountRootPath Id of the Account, from which the path to the root
/Level1PartyId Account needs to be identified.
ExecutionMode ForwardOnly
LOVLanguageMode LDC
ViewMode All

SelfServiceAccountRootPathQueryPage
The response contains the details based on the query set on the payment IO .
Node Description
SelfServiceAccountRootPathQueryPage_Output Container element for the QueryPage

Operation response.
ListOfSSAccountRootPath Corresponds to an instance of

SS_AccountRootPath_IO
ListOfSSAccountRootPath /SSAccountRootPath Container element, which corresponds to an

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

/ParPartyId deemed as the root account. Else, this account
is one of the accounts in the path.
ListOfSSAccountRootPath /SSAccountRootPath Id of the retrieved account

/PartyId
ListOfSSAccountRootPath /SSAccountRootPath Name of the retrieved account

/PartyName
ListOfSSAccountRootPath /SSAccountRootPath PriceListId of the retrieved account

/PriceListId
ListOfSSAccountRootPath /SSAccountRootPath SELF or DIRECT or INDIRECT

/RelationTypeCode
ListOfSSAccountRootPath /SSAccountRootPath DIRECT=> Account is the parent the

/Level1PartyId Level1PartyId
SelfServiceAccountRootPath Application Objects

This section describes the application objects called by the SelfServiceAccountRootPath. For more
information on application implementation, refer to application development documentation. Service
Object (Business Service or Workflow).


SelfServiceAccountRootPath Business Service CSSEAIUIDataService

SS_AccountRootPath_IO SS_AccountRootPath_IO
Example Package for SelfServiceAccountRootPath

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

...\81_WSDL_XML\SelfServiceAccountRootPath\SelfServiceAccountRootPath.wsdl

Siebel 8.1 Primary Web Services SelfServiceAllAccountsList
SelfServiceAllAccountsList
This WebService exposes the EAI UI Business Service SelfServiceAllAccountsList, which provides
query operations on SS_AllAccount_List_IO Integration Object.
This WebService 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.
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

SelfServiceAllAccountsListQueryPage_Input Container element for the String

QueryPage Operation
request.
ListOfSSAllAccount Corresponds to an instance String

of SS_AllAccount_List_IO
ListOfSSAllAccount /SSAllAccountList Container element, which String

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

the view criteria.

/ParentPartyId

/RelationTypeCode
ListOfSSAllAccount /SSAllAccountList
/Level1AccountStatus

/Level1ApprovalStatus
Level1BusinessPhone
Level1EmailAddress
Level1FaxNumber
Level1ParentPartyId
Level1PartyLocation
Level1PartyName
Level1PriceListId
Level1PrimaryAddressId
Level1PrimaryBillToAddressId
Level1PrimaryContactId
Level1PrimaryShipToAddressId
Level1Type
Level2ParentAccountName Empty (Columns to be String

retrieved in the response)
ExecutionMode Empty String
LOVLanguageMode ForwardOnly String
ViewMode LDC String

SelfServiceAllAccountsListQueryPage
SelfServiceAllAccountsListQueryPage_Input Container element for the String

QueryPage Operation
response.
ListOfSSAllAccount Corresponds to an instance String

of SS_AllAccount_List_IO
ListOfSSAllAccount /SSAllAccountList Container element, which String

/ModId holds the columns to be
queried, and the criteria to
be used.

/ParentPartyId
ListOfSSAllAccount /SSAllAccountList AccountId of the child String
/PartyId
account
ListOfSSAllAccount /SSAllAccountList Whether the child is directly String

/RelationTypeCode or indirectly under this root
account.
Can be SELF, DIRECT or

INDIRECT
ListOfSSAllAccount /SSAllAccountList Retrieved details of the child String

/Level1AccountStatus, account.
Level1ApprovalStatus,
Level1BusinessPhone,
Level1EmailAddress,
Level1FaxNumber,
Level1PartyName,
Level1PartyLocation,
Level1PriceListId,
Level1PrimaryAddressId,
Level1PrimaryBillToAddressId,
Level1PrimaryContactId,
Level1PrimaryShipToAddressId,
Level1Type
ListOfSSAllAccount /SSAllAccountList Immediate Parent of this String

/Level1ParentPartyId child account. For accounts
with RelationTypeCode as
DIRECT, it matches the root
account Id itelsef.
ListOfSSAllAccount /SSAllAccountList AccountName of the String

/Level2ParentAccountName Immediate Parent of this
child account.
String
SelfServiceAllAccountsList Application Objects

This section describes the application objects called by the SelfServiceAllAccountsList. For more
SelfServiceAllAccountsList Business Service CSSEAIUIDataService


SS_AllAccount_List_IO SS_AllAccount_List_IO
Example Package for SelfServiceAllAccountsList

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

...\81_WSDL_XML\SelfServiceAllAccountsList\SelfServiceAllAccountsList.wsdl

Siebel 8.1 Primary Web Services SelfServiceContact
SelfServiceContact
This WebService exposes the EAI UI Business Service SelfServiceContact, which provides CRUD and
query operations on SS_Contacts_IO Integration Object.
This WebService 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 WebService, Siebel SelfService 8.1 uses SelfServiceRegistration Webservice, which
also accepts an instance of SS_Contacts_IO Integration Object. SelfServiceRegistration webservice
calls the SelfServiceRegistration workflow, which delegates the IO to SelfServiceContact Business
Service, for performing all the contact and account management activities.
Hence in SelfService 8.1, SelfServiceContact WebService is mostly used for QueryPage operation.
SelfServiceContact Operations
Name Description
SelfServiceContactExecute
SelfServiceContactQueryPage Performs Query operation based on the viewCriteria

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

ListOfSSContact
Contact Corresponds to a record in

SS_Contacts_IO. Set operation
accordingly. If Contact details needs to
be updated, operation =update or if
child elements like, Personal Address,
needs to be added/updated, set
operation="skipnode"
Contact /Id Id of the Contact. Set this if the mode on String

Contact node is Update or SkipNode.
Contact /ListOfAccount Container element for the assigned

accounts of this contact.
If mode on Contact is insert, then,

accounts specified in this list are inserted

and assigned to the newly created
contact.
If mode on Contact is skipnode, then,

accounts specified in this list are made
as the only accounts assigned for this
contact. All other existing assigned
accounts are unassigned by default.
Contact /ListOfAccount/
Account
Contact /ListOfAccount/ Details of the assigned account. String

Account/ Name,
PrimaryContactId, Type
Contact/
ListOfContactCommunicati
onAddress
Contact Alternate email address value to be String

/ListOfContactCommunicati edited or created.
onAddress
/ContactCommunicationAd
dress /
AlternateEmailAddress
Contact Id of the alternate email address value String

/ListOfContactCommunicati to be edited; blank for adding new
onAddress alternate email address.
dress
/CommunicationAddressId

Response Message Description: SelfServiceContactExecute

SelfServiceContactExecute Container element for the Execute

_Output Operation request.
ListOfSSContact Corresponds to an instance of

SS_Contacts_IO
ListOfSSContact/Contact/I Id and ModId of Inserted/Updated String

d, ModId Contact Record
ListOfSSContact/Contact/Li Id and ModId of Inserted/Updated String

stOfAccount/Account/Id, Account Record
Mod Id
ListOfSSContact/Contact/Li Id and ModId of Inserted/Updated String

stOfCommunicationAddres CommunicationAddress Record
s/CommunicationAddress/I
d, Mod Id
Request Message Description: SelfServiceContactQueryPage

SelfServiceContactQueryPa Container element for the QueryPage Complex Type

ge_Input Operation request.
ListOfSSContact Corresponds to an instance of (Refer WSDL)

SS_Contacts_IO
ListOfSSContact/Contact Complex Type
Contact/ Id Set the Id of the Contact as a (Refer WSDL)

ViewCriteria.
Contact/ ModId Retrieve and pass back while updating, Complex Type
to ensure that Contact record is not
updated in the interim.
Contact/ Empty (Columns to be retrieved) (Refer WSDL)
FirstName, MiddleName,
LastName, Status,
EmailAddress,
CellularPhone,
HomePhone, FaxPhone,
WorkPhone, TimeZoneId,
EmailSRUpdatesFlag,
SendPromotions
Contact/ Empty (Columns to be retrieved) String

LoginName, These columns are related to the

ApprovalStatus, username information.
ChallengeQuestion,
ChallengeAnswer
Contact/ Empty (Columns to be retrieved) String
PrimaryAccountName,
PrimaryAddressId,
PrimaryAddressName
PrimaryPersonalAddressId
Contact/ Container element for the String

ListOfContactCommunicati AlternateEmailAddress to be retrieved.
onAddress
Contact can have similar sub-nodes for

querying PersonalAddress, Account and
AccountBusinessAddress
Contact String
/ListOfContactCommunicati
onAddress
dress
Contact Empty (Columns to be retrieved) String

Alternate Email Address of the contact
onAddress
dress
/AlternateEmailAddress
Contact Empty (Columns to be retrieved) Complex Type

Id of the Alternate Email Address of the
onAddress
contact
dress
ExecutionMode ForwardOnly (Refer WSDL)
LOVLanguageMode LDC String
ViewMode All Complex Type
Response Message Description: SelfServiceContactExecute

SelfServiceContactQueryPa Container element for the QueryPage Complex Type

ge_Output Operation response.

ListOfSSContact Corresponds to an instance of (Refer WSDL)

SS_Contacts_IO
ListOfSSContact/Contact Complex Type
Contact/ Id Id of the Contact being queried. (Refer WSDL)
Contact/ ModId Container element for the QueryPage Complex Type

Operation response.
Contact/ Primitive details of the contact. (Refer WSDL)

EmailSRUpdatesFlag and
FirstName, MiddleName,
SendPromotions contain the preferences
LastName, Status,
shown in SelfService 8.1 Registration
EmailAddress,
screens.
CellularPhone,
HomePhone, FaxPhone,
WorkPhone, TimeZoneId,
EmailSRUpdatesFlag,
SendPromotions
Contact/ These nodes contain the values for the String

username information.
LoginName,
ApprovalStatus,
ChallengeQuestion,
ChallengeAnswer
Contact/ These nodes contain the values for the String

PrimaryAccountName, Primary
PrimaryAccountName,
BusinAddressId, Primary
PrimaryAddressId,
BusinessAddressName and
PrimaryAddressName
PrimaryPersonalAddressId respectively.
PrimaryPersonalAddressId
Contact/ Container element for the String

ListOfContactCommunicati AlternateEmailAddress retrieved.
onAddress
Contact String
onAddress
dress
Contact Alternate Email Address of the contact String

onAddress
dress
/AlternateEmailAddress
Contact Id of the Alternate Email Address of the Complex Type

onAddress contact
dress
ExecutionMode ForwardOnly (Refer WSDL)
LOVLanguageMode LDC String
ViewMode All Complex Type
SelfServiceContact Application Objects

This section describes the application objects called by the SelfServiceContact. For more information

SelfServiceContact BusinessService CSSEAIUIDataService

SS_Contacts_IO SS_Contacts_IO
Example Package for SelfServiceContact

Request (SelfServiceContactQueryPage)
...\81_WSDL_XML\SelfServiceContact\SelfServiceContactQueryPage_request.xml
Response (SelfServiceContactQueryPage)
...\81_WSDL_XML\SelfServiceContact\SelfServiceContactQueryPage_request.xml

Request (SelfServiceContactExecute)
...\81_WSDL_XML\SelfServiceContact\SelfServiceContactExecute_request.xml
Response (SelfServiceContactExecute)
...\81_WSDL_XML\SelfServiceContact\SelfServiceContactExecute_request.xml
Message Schema (WSDL) for SelfServiceContact

...\81_WSDL_XML\SelfServiceContact\SelfServiceContact.wsdl

Siebel 8.1 Primary Web Services SelfServicePaymentHistory
SelfServicePaymentHistory
This Web service queries the Payment History details as specified by the search criteria for any contact
logged into the application. Payment details such as payment type, payment profile, transaction
amount, type and date for different orders against which the payment has been made by a contact
may be queried.
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 IO, payment related details such as the payment profile details,
transaction amount, type and date along with the order numbers may be queried.
SelfServicePaymentHistory The method arguments are Payment IO, Integration

QueryPage_Input Language Mode (value is LDC) and Object
viewMode (All)

SelfServicePaymentHistoryQueryPage
The response contains the details based on the query set on the payment IO.
SelfServicePaymentHistory Integration Object The retrieved

QueryPage_Output data for the
query
performed.
Application Objects
This WebService exposes the EAI UI Business Service SelfServicePaymentHistory, which provides
update and query operations on SS_PaymentHistory_IO Integration Object.

Siebel 8.1 Primary Web Services SelfServicePaymentHistory

SelfServicePaymentHistory Integration Object CSSEAIUIDataService

SS_PaymentHistory_IO Payments
Example Package for SelfServicePaymentHistory

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

...\81_WSDL_XML\SelfServicePaymentHistory\SelfServicePaymentHistory.wsdl

Siebel 8.1 Primary Web Services SelfServicePostLoginProcess
SelfServicePostLoginProcess
This Web service exposes the SelfServicePostLoginProcess workflow as LoadUserDetails operation.
The response of this Web service is determined by the P_Mode request parameter, as displayed in the
following table.
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
Name Description
LoadUserDetails This operation triggers the

SelfServicePostLoginProcess workflow
Request Message Description: LoadUserDetails

P_Mode See P_Mode 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 String

for the details on ListOfContact and
its subnodes.
getUserResponsibilitiesResponse Username of the user for whom the Complex

details need to be retrived. Type
getUserResponsibilitiesResponse Container element for (See WSDL)

/listOfUserResponsibilities/ Responsibilities. Maps to an instance

of getUserResponsibilitiesResponse
IO
Response Message Description: LoadUserDetails

LoadUserDetails_Output Container element for the Complex

LoadUserDetails operation response Type
ListOfSSContact An SS_Contact_IO instance, where in (See

ListOfSSContact/Contact/Id contains WSDL)
the contactId of the user for whom the
details are retrived.
getUserResponsibilitiesResponse Refer to the SelfServiceContact.doc for Complex

the other nodes in ListOfContact and Type
its complex subnodes, like Account
and PersonalAddrrss, which will have
the retrived accounts(assigned) and
PersonalAddress of the contact
respectively.
getUserResponsibilitiesResponse Will be blank when mode is (See

/listOfUserResponsibilities/ SkipLoadResponsibilities WSDL)
userResponsibilities/
responsibilityValue
Error_spcCode Name of the Responsibility Complex

Type
Error_spcMessage Error Code returned by the Workflow (See

WSDL)
SelfServicePostLoginProcess Application Objects

This section describes the application objects called by the SelfServicePostLogin. For more information

SelfServicePostLoginProcess Workflow


SelfServiceContact SelfServiceContact
getUserResponsibilitiesResponse getUserResponsibilitiesResponse
Example Package for SelfServicePostLoginProcess

Request (LoadUserDetails_OnlyLoadResponsibilities)
...\81_WSDL_XML\SelfServicePostLoginProcess\LoadUserDetails_OnlyLoadResponsibilities_request.xm
l
Response (LoadUserDetails_OnlyLoadResponsibilities)
...\81_WSDL_XML\SelfServicePostLoginProcess\LoadUserDetails_OnlyLoadResponsibilities_response.x
ml
Request (LoadUserDetails_SkipLoadResponsibilities)
...\81_WSDL_XML\SelfServicePostLoginProcess\LoadUserDetails_SkipLoadResponsibilities_request.xml
Response (LoadUserDetails_SkipLoadResponsibilities)
...\81_WSDL_XML\SelfServicePostLoginProcess\LoadUserDetails_SkipLoadResponsibilities_response.x
ml

Message Schema (WSDL) for SelfServicePostLoginProcess

...\81_WSDL_XML\SelfServicePostLoginProcess\SelfServicePostLoginProcess.wsdl

Siebel 8.1 Primary Web Services SelfServiceRegistration
SelfServiceRegistration
The Enroll operation of this Web service 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 Web service
operation.
P_Mode Request Parameter

P_Mode Response
CreateContact Used for creating a contact without a username.
Usage in Siebel SelfService 8.1 in Profile > Account > Contact

Administration contact creation.
UpdateContact Used for updating a contact without a username.

Administration update contact. Also used in Profile > Personal
Info updating.
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.
Usage in Siebel SelfService 8.1: For making a contact as a user

in Profile>Account>Contact Administration. Also used for all
self-service registrations
UpdateUser Used for updating a contact with a username and manage the
assigned accounts and responsibilities.

Administration update user.
ResetPasswordOnly Used for resetting the password of the currently logged in user
of the siebel session or in the anonymous session.
Usage in Siebel SelfService 8.1 in Profile > Personal > Reset

password (for a logged in Siebel Session).
Also used in Forgot Password Flow (for an anonymous session).

SelfServiceRegistration Operations
Name Description
Enroll Internally calls the business services listed below.
Business Services Called by Enroll Operation

EAITransactionService.BeginTransaction
EAITransactionService.EndTransaction
SelfServiceContact.Execute
PRM ANI Utility Service.GetProperty
PRM ANI Utility Service.SetProperty
SiebelWebRegistrationService.Promote
SelfServiceUser.Execute
ISS Approval Bus Service.CreateNewApprovalTasks
Outbound Communications Manager.CreateRequest
SessionAccessService.SetProfileAttr
EAITransactionService Business Service
Business Service Step Begin Transaction
Business Service Name EAITransactionService
Business Service Begin Transaction

Method
Input Arguments
Argument Name Type Property Name
Output Arguments
Description This Step is used to initiate a transaction. BeginTransaction

will not take any parameters as input.

SelfServiceContact Business Service
Business Service Step Create Update Contact And Account
Business Service Name SelfServiceContact
Business Service Execute

Method
Input Arguments
SiebelMessageIn Process Property P_ContactIO(SS_

Contacts_IO)
ViewMode Process Property All
LanguageMode Process Property LDC
ExecutionMode Process Property BiDirectional
Output Arguments
SiebelMessageOut Output Argument P_ContactIO(SS_

Contacts_IO)
Description This Step is used to create or update Contact, Account,

Contact Address, Contact_Account relationships and
Alternate Communication Address. Contact IO 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 IO and retruns a
ContactIO with the ids specified for each Step.
Sample SOAP request portions of SS_Contacts_IO are shown

below.
PRM ANI Utility Service Business Service
Business Service Step Retrieve Contact Id
Business Service Name PRM ANI Utility Service
Business Service GetProperty

Method
Input Arguments

Hierarchy Path: Literal Contact
Property Name Literal Id
SiebelMessage Hierarchy P_ContactIO(SS_

Contacts_IO)
Output Arguments
Property Value Output Argument P_ContactId
Description This Step is used to retrieve the contact Id , given the

contact IO.
PRM ANI Utility Service Business Service
Business Service Step Retrieve Account Id (Called only when accountId Process
Property is null)
Business Service Name PRM ANI Utility Service
Business Service GetProperty

Method
Input Arguments
Hierarchy Path: Literal Contact
Property Name Literal Account Id
SiebelMessage Hierarchy P_ContactIO(SS_

Contacts_IO)
Output Arguments
Property Value Output Argument AccountId
Description This Step is used to retrieve the account Id, given the
contact IO.
In Self Service8.1, this step is only applicable during the

Register your company flow to retrieve the Id of the newly
created corporate account, which needs to be sent to Trigger
Approval, as root account. Hence, the caller (Java API that
calls the proxy) shall ignore the errors reported by this step.

SiebelWebRegistrationService Business Service
Business Service Step Create User
Business Service Name SiebelWebRegistrationService
Business Service Promote

Method
Input Arguments
Contactid Process Property P_ContactId
Type Process Property P_Usertype
Proxy User Process Property P_ProxyEmpLogi

nName
LoginName Process Property P_LoginName
Password Process Property P_NewPassword
securityQuestion Process Property P_ChallengeQues

tion
securityAnswer Process Property P_ChallengeAns

wer
CreateInactive Process Property P_CreateUserSta

tus
Output Arguments
SuccessCode Output Argument P_CreateUserSta

tus
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
Business Service Step Assign Responsibilities
Business Service Name SelfServiceUser
Business Service Execute

Method
Input Arguments
SiebelMessageIn Process Property P_UserIO
ViewMode Process Property All
LanguageMode Process Property LDC
Output Arguments
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.
Business Service Step Commit Transaction
Business Service EndTransaction

Method
Input Arguments
Argument Name Type Value
Is Abort Literal False
Output Arguments
Description This step uses EAITransactionService. EndTransaction to

commit the transaction. Parameter Is Abort is set to
False, to commit the transaction.

Business Service Step Rollback Transaction
Business Service EndTransaction

Method
Input Arguments
Argument Name Type Value
Is Abort Literal True
Output Arguments
Description This step uses EAITransactionService. EndTransaction to

commit the transaction. Parameter Is Abort is set to
True," to roll back the transaction.

ISS Approval Bus Service Business Service
Business Service Step Trigger Approval
Business Service Name ISS Approval Bus Service
Business Service CreateNewApprovalTasks

Method
Input Arguments
Argument Name Type Property Name Value
RequestingBusComp Literal Value = Contact 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
Output Arguments
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 usertype, 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.
See the Siebel Self Service documentation Siebel Bookshelf

documentation library on Oracle Technology Network.

Outbound Communications Manager Business Service
Business Service Step Trigger Notification
Business Service Name Outbound Communications Manager
Business Service CreateRequest

Method
Input Arguments
RecipientBusComp Literal Contact
SourceIdList Process Property P_ContactId

PackageNameList Process Property P_NotificationTempla
teName
RequestLanguageCode Process Property P_Language
RequestLocaleCode Process Property P_Locale
ProcessMode Literal Remote
RequestName Literal SS Send

Contact
Email
RecipientGroup Process Property Contacts
Output Arguments
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.


SessionAccessService Business Service
Business Service Step Set New password in Siebel Session
Business Service Name SessionAccessService
Business Service SetProfileAttr

Method
Input Arguments
Name Literal Session Password
Value Process Property P_NewPassword
Output Arguments
Description This step is used to set the password in Siebel Session.

Response Message Description: CreateContact

Process_spcInstance_spcId String
Object_spcId String
Siebel_spcOperation_spcObject_spcId String
Error_spcCode String
Error_spcMessage String
ListOfSSContact Contains an instance of the Integration

output integration object Object
SS_Contacts_IO that holds the
Id and ModId of the contact /
account that is created/updated.
Refer to SelfServiceContact Web

service documention in this
guide for more information on

the Structure and subnodes of

ListOfSSContact.
Maps to the P_ContactIO process

property in the workflow.
P_ContactId Not of consequence in response. String
P_AccountId Derived Root Account Id String
Refer to SelfService 8.1 Siebel

BookShelf for more details.
P_DefaultOrgId Not of consequence in response. String
P_Mode Not of consequence in response. String
P_Usertype Not of consequence in response. String
P_LoginName Username created String
P_DefaultProxyEmployee Not of consequence in response. String
P_LoginId Value returned by String

SiebelWebRegistration
BusinessService.
P_CreateUserStatus The status set on the newly String

created user. Inactive, for
pending users.
P_Password Not of consequence in response. String
P_NewPassword Not of consequence in response. String
P_ChallengeQuestion Not of consequence in response. String
P_ChallengeAnswer Not of consequence in response. String
ListOfSSUser Contains an instance of the input Integration

Contains an instance of the Object
output integration object Users
that holds the Id and Mode Id of
the user-responsibility mapping
for the updated responsibility
assignments.
Refer to SelfServiceUser Web

service documentation in this
guide for more information on
the Structure and subnodes of
ListOfSSUser.
Maps to the P_UserIO process

property in the workflow.
P_UsertypeApprovalRequd Not of consequence in response. String

P_UsertypeApprovalType Not of consequence in response. String
P_UsertypeInboxType Not of consequence in response. String
P_UsertypeNotifTemplateName Not of consequence in response. String
P_RecipientGroup Not of consequence in response. String
P_Language Not of consequence in response. String
P_Locale Not of consequence in response. String
Application Objects
This section describes the application objects called by the SelfServiceRegistration. For more

SelfServiceRegistration Workflow

SelfServiceContact SelfServiceContact
Users Users
Example Package for SelfServiceRegistration

Request and Response Samples are provided for the following

scenarios:
1. Create a B2C contact and a username and trigger notification
2. Create a B2B contact as Inactive and create a username and trigger notification and create
Inbox Items for approval
3. Update Personal Addresses of an existing Contact

4. Update Contact Details, Account Assignment, Responsibility Assignment, Password resetting

for an existing contact.
Request
Create a B2C contact and username and trigger notification

...\81_WSDL_XML\SelfServiceRegistration\SelfServiceRegistration_1_request.xml
Response
Create a B2C contact and username and trigger notification

Request
Create a B2B contact as Inactive and create a username and trigger notification and create
Response
Create a B2B contact as Inactive and create a username and trigger notification and create
...\81_WSDL_XML\SelfServiceRegistration\SelfServiceRegistration_2_response.xml

Request
Update Personal Addresses of an existing Contact

Response
Update Personal Addresses of an existing Contact

...\81_WSDL_XML\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
...\81_WSDL_XML\SelfServiceRegistration\SelfServiceRegistration_4_response.xml
Message Schema (WSDL) for SelfServiceRegistration

...\81_WSDL_XML\SelfServiceRegistration\SelfServiceRegistration.wsdl

Siebel 8.1 Primary Web Services SelfServiceResponsibility
SelfServiceResponsibility
This Web service exposes the EAI UI Business Service SelfServiceResponsibility, which provides
query operation on SS_Responsibility_IO Integration Object. Additionally, this WebService exposes
the Query Method in the SelfServiceResponsibility Business service as Web service operation.
SelfServiceResponsibility Operations
Name Description
SelfServiceResponsibilityQueryPage Performs Query operation based on the viewCriteria

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

SelfServiceResponsibilityQ Container element for SelfServiceResponsibility

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

SS_Responsibility_IO. Corresponds to an
SS_Responsibility_IO IO.
ListOfSSResponsibility/Res Corresponds to the primary IC Responsibility.

ponsibility
ListOfSSResponsibility/Res Set to Yes, for retrieving only Web Enabled

ponsibility/AccessType Responsibilities.
ListOfSSResponsibility/Res Empty; Placeholder for the Id of the

ponsibility/Id responsibility to be retrived.
ListOfSSResponsibility/Res Empty; Placeholder for the name of the

ponsibility/Name responsibility to be retrived.

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 IO.
ListOfSSResponsibility/Responsibility Corresponds to the primary IC

Responsibility.
ListOfSSResponsibility/Responsibility/AccessTy Yes for Web Enabled Responsibility.

pe
ListOfSSResponsibility/Responsibility/Id Retrived Id of the responsibility.
ListOfSSResponsibility/Responsibility/Name Retrived name of the responsibility.
SelfServiceResponsibility Application Objects

This section describes the application objects called by the SelfServiceResponsibility. For more

SelfServiceResponsibility BusinessService CSSEAIUIDataService

SS_Responsibility_IO SS_Responsibility_IO
Example Package for SelfServiceResponsibility


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

...\81_WSDL_XML\SelfServiceResponsibility\SelfServiceResponsibility.wsdl

Siebel 8.1 Primary Web Services SelfServiceSmtpEmail
SelfServiceSmtpEmail
The SendSmtpEmail operation of this Web service invokes the SelfServiceSmtpEmail workflow,
which internally uses the Outbound Communications Manager Business Service for sending non-
template based SMTP Email.
SelfServiceSmtpEmail Operations
Name Description
SendSmtpEmail Invokes SelfServiceSmtpEmail workflow.
Request Message Description: SendSmtpEmail

FromAddress Email address of the sender String
MessageToList Semicolon-separated list of email String

addresses for the TO line.
MessageCCList Semicolon-separated list of email String

addresses for th CC line.
MessageBCCList Semicolon-separated list of email String

addresses for th BCC line.
MessageSubject Descriptive subject line for the message. String
MessageBody Message content in plain-text. String
MessageHTMLBody Message content in HTML. This String

parameter when specified would override
the parameter MessageBody
Error Code Error code, if any. 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

FromAddress Not of consequence in response String
MessageToList Not of consequence in response String
MessageCCList Not of consequence in response String
MessageBCCList Not of consequence in response String
MessageSubject Not of consequence in response String
MessageBody Not of consequence in response String
MessageHTMLBody Not of consequence in response Not of String

consequence in response
Error Code Error code, if any, for exceptions raised String

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

while submitting the request. This is
automatically set from the workflow.
Object Id Standard WF Output String
Process Instance Id Standard WF Output String
Siebel Operation Object Id Standard WF Output String
SelfServiceSmtpEmail Application Objects

This section describes the application objects called by the SelfServiceSmtpEmail. For more

SelfServiceSmtpEmail Workflow Process

Example Package for SelfServiceSmtpEmail

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

...\81_WSDL_XML\SelfServiceSmtpEmail\SelfServiceSmtpEmail.wsdl

Siebel 8.1 Primary Web Services SelfServiceTemplateEmail
SelfServiceTemplateEmail
The SendTemplateEmail operation of this webservice invokes the SelfServiceTemplateEmail
workflow, which internally uses the Outbound Communications Manager Business Service for
sending template based SMTP Email.
SelfServiceTemplateEmail Operations
Name Description
SendTemplateEmail Invokes SelfServiceTemplateEmail workflow.
Request Message Description: SendTemplateEmail

TemplateName The communication template name String

to be used in the request.
SourceRecipientGroupName The source recipient group name. String

Either the name of Siebel-seeded
recipient group or a custom one.
SourceObjectID ROW_ID of the source object String

component of the recipient group.
This would determine the data
retrieved for processing the template
and recipient address for the email.
TemplateLanguageCode Language code the template. A String

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

template must exist with the name
and locale combination specified.
Defaulting is not recommended.
RequestName An optional string that would help String

trace the outbound communication
requests at the server side.
RequestStatus Status code for the outbound String

request placed.
Error Code Blank String
Error Message Blank String

Object Id Blank String
Process Instance Id Blank String
Siebel Operation Object Id Blank String
Response Message Description: SendTemplateEmail

TemplateName Not of consequence in response String
SourceRecipientGroupName Not of consequence in response String
SourceObjectID Not of consequence in response String
TemplateLanguageCode Not of consequence in response String
TemplateLocaleCode Not of consequence in response String
RequestName Not of consequence in response String
RequestStatus Not of consequence in response String
Error Code Error code, if any, for exceptions String

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

raised while submitting the request.
This is automatically set from the
workflow.
Object Id Standard WF Output String
Process Instance Id Standard WF Output String
Siebel Operation Object Id Standard WF Output String

SelfServiceTemplateEmail Application Objects

This section describes the application objects called by the SelfServiceTemplateEmail. For more

SelfServiceTemplateEmail Workflow Process

Not applicable
Example Package for SelfServiceTemplateEmail

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

...\81_WSDL_XML\SelfServiceTemplateEmail\SelfServiceTemplateEmail.wsdl

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

SelfServiceTimeZoneQueryPage_Input The method arguments are Integration

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

SelfServiceTimeZoneQueryPage_Output The list of the timezone Integration

values which are returned Object
in the language that is set
in the search spec.
SelfServiceTimeZone Application Objects

This section describes the application objects called by the SelfServiceTimeZone. This WebService
exposes the Business Service SelfServiceTimeZone, which provides query operation on
SS_TimeZone_IO Integration Object.

Siebel 8.1 Primary Web Services SelfServiceTimeZone

SelfServiceTimeZone Integration Object CSSEAIUIDataService

SS_TimeZone_IO Time Zone
Example Package for SelfServiceTimeZone

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

...\81_WSDL_XML\SelfServiceTimeZone\SelfServiceTimeZone.wsdl

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 Users Integration Object. Additionally, this WebService exposes the Execute
and Query Methods in the SelfServiceUser Business service as Web service operations.
SelfServiceUser Operations
Name Description
SelfServiceUserExecute Performs CRUD operations on the instance of Users

IO provided as input.
Though Siebel Self Service 8.1 does not use this

WebService operation for managing responsibilities
of a user, the SelfServiceRegistration Workflow used
instead, leverages the same business service
(SelfServiceUser) internally.
SelfServiceUserQueryPage Performs Query operation based on the viewCriteria

and searchSpec set on the instance of Users IO
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

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 IO.
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/ Container element for User_Responsibility IC

ListOfSSUserResponsibility
ListOfSSUser/User/ Corresponds to the User_Responsibility IC.

ListOfSSUserResponsibility/ Represents a responsibility association, for each
responsibility to be added/retained with the user.
SSUserResponsibility Earlier assigned responsibilities that are not listed

here are deleted by default.
ListOfSSUser/User/ Set the Id of the responsibility to be

ListOfSSUserResponsibility/ assigned/retained to the user.
SSUserResponsibility/Id
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 IO.
ListOfSSUser/User Corresponds to the primary IC User.
ListOfSSUser/User/LoginName Username for which the assigned responsibilities

are updated.

ListOfSSUser/User/ Corresponds to the User_Responsibility IC. Each

ListOfSSUserResponsibility/ entry represents a responsibility assigned to the
SSUserResponsibility user.
ListOfSSUser/User/ Id of the responsibility assigned to the user.

ListOfSSUserResponsibility/
Request Message Description: SelfServiceUserQueryPage

Node Description
SelfServiceUserQueryPage_Input Container element for SelfServiceUser

WebService input for QueryPage operation.

ListOfSSUser/User/LoginName Set the Username for which the associated

responsibilities needs to be loaded.

ListOfSSUser/User/ Corresponds to the User_Responsibility IC.

ListOfSSUserResponsibility/ Represents a responsibility associated to the

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

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

ListOfSSUserResponsibility/ assigned to the user.
SSUserResponsibility/Responsibility
Response Message Description: SelfServiceUserQueryPage

Node Description
SelfServiceUserQueryPage_Output Container element for SelfServiceUser

WebService output for QueryPage
operation.

ListOfSSUser/User/LoginName Username for which the assigned

responsibilities are retrived.
ListOfSSUser/User/ Container element for

ListOfSSUserResponsibility User_Responsibility IC
ListOfSSUser/User/ Corresponds to the User_Responsibility

ListOfSSUserResponsibility/ IC. Each entry represents a
SSUserResponsibility responsibility assigned to the user.
ListOfSSUser/User/ Id of the responsibility assigned to the

ListOfSSUserResponsibility/ user.
ListOfSSUser/User/ Name of the responsibility assigned to

ListOfSSUserResponsibility/ the user.
SSUserResponsibility/Responsibility

SelfServiceUser Application Objects

This section describes the application objects called by the SelfServiceUser. For more information on

SelfServiceUser BusinessService CSSEAIUIDataService

Users Users
Example Package for SelfServiceUser

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

...\81_WSDL_XML\SelfServiceUser\SelfServiceUser.wsdl

Siebel 8.1 Primary Web Services SelfServiceWebSite
SelfServiceWebSite
This Web service is used for creating /retrieving /updating /deleting sites.
This Web service exposes two methods, Query and the Execute methods in its business service
SelfServiceWebSite as Web service operations.
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 IO 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.
SelfServiceWebSiteExecute_Input The method arguments are Integration

Site IO, Language Mode Object
(value is LDC) and
viewMode (All).
Response Message Description: SelfServiceWebSiteExecute

The response contains the details based on the query set on the site IO.
SelfServiceWebSiteExecute_Output The data retrieved based Integration

on the query set. Object

Request Message Description: SelfServiceWebSiteQueryPage

Based on the querycriteria set on the IO, site related details are queried
SelfServiceWebSiteQueryPage_Input The method arguments are Integration

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

The response contains the details based on the update query set on the site IO .
SelfServiceTimeZoneQueryPage_Output The list of the timezone Integration

values which are returned Object
in the language that is set
in the search spec.
SelfServiceWebSite Application Objects

This section describes the application objects called by the SelfServiceWebSite. This Web service
exposes the Business Service SelfServiceWebSite, which provides execute and query operations on
SS_WebSite_IO Integration Object.

SelfServiceWebSite Integration Object CSSEAIUIDataService

SS_WebSite_IO SS_WebSite_BO

Example Package for SelfServiceWebSite

Request (SelfServiceWebSiteExecute)
...\81_WSDL_XML\SelfServiceWebSite\SelfServiceWebSiteExecute_request.xml
Response (SelfServiceWebSiteExecute)
...\81_WSDL_XML\SelfServiceWebSite\SelfServiceWebSiteExecute_response.xml
Request (SelfServiceWebSiteQuery)
...\81_WSDL_XML\SelfServiceWebSite\SelfServiceWebSiteQuery_request.xml
Response (SelfServiceWebSiteQuery)
...\81_WSDL_XML\SelfServiceWebSite\SelfServiceWebSiteQuery_response.xml
Message Schema (WSDL) for SelfServiceWebSite

SelfServiceWebSiteQuery\SelfServiceWebSite.wsdl

Siebel 8.1 Primary Web Services ServiceRequest
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.
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

Node Description
Abstract Abstract of the Service Request
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

Node Description
Id Row Id of the Service Request is required
Response Message Description: ServiceReqUpdate_Input

Node Description

Request

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

Node Description

Request. Also the child objects Row Id

Request. Also the child objects Mod Id
Request Message Description: ServiceReqQueryPage_Input

Node Description

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

Node Description
Service Request Pass the Service Request attributes.
Response Message Description: ServiceReqInit_Input

Node Description
Service Request Returns default information of the

Service Request
Request Message Description: ServiceReqDelete_Input
Node Description
Id Row Id of the Service Request.
Id Row Id of the Activity
Id Row Id of the Attachment
Id Row Id of the Solution

Agreement
Response Message Description: ServiceReqDelete_Input

Node Description

Request. Also the child objects Row Id

Request. Also the child objects Mod Id

Application Objects
This section describes the application objects called by the Service Request.

ServiceReq Business Service CSSEAIUIDataService

ServiceReqIO Service Request (SelfService)
Example Package for Service Request

Request
...\81_WSDL_XML\ServiceRequest\ServiceRequest_request.xml
Response
...\81_WSDL_XML\ServiceReqWS\ServiceRequest_response.xml
Message Schema (WSDL) for Service Request

...\81_WSDL_XML\ServiceRequest\ServiceRequest.wsdl

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
Name Description
sessionAccessPing This is used for setting a message as an input .
Request Message Description:sessionAccessPing
SessionAccessPing_Input Container Element Not applicable
SessionAccessPing_Input/msgIn Set as Self Service Logout String

Request.
Response Message Description: sessionAccessPing
SessionAccessPing_Output Container Element Not applicable
SessionAccessPing_Input/msgOut Sent as 1 which indicates String

successful termination of
the session.
SessionAccessWS Application Objects

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

SessionAccessService CSSUIFSessionAccessService

Example Package for SessionAccessWS

Request
...\81_WSDL_XML\SessionAccessWS\SessionAccess_request.xml
Response
...\81_WSDL_XML\SessionAccessWS\SessionAccess_response.xml
Message Schema (WSDL) for SessionAccessWS

...\81_WSDL_XML\SessionAccessWS\SessionAccessWS.wsdl

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

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

ExecutionMode The mode in which the query is to be String

performed.
LOVLanguageMode LIC or LDC. String
NamedSearchSpec Search Specification of the query. String
PickListName Name of the picklist (if any). String
Response Message Description: UlnboxContactItemQueryPage

SiebelMessageOut Output argument. Integration

Object

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.
2. This creates a C# class that should be modified to construct Input Integration Objects.
3. For performance reasons, Page size can also be specified here.
4. 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);
5. 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.
Ulnbox Contact Item Application Objects

This section describes the application objects called by the Ulnbox Contact Item. For more information

UInbox Contact Item Not applicable CSSEAIUIDataService

UInboxContactItem UInbox Items
Example Package for Ulnbox Contact Item

Request
...\81_WSDL_XML\UlnboxContactItem\UlnboxContactItem_request.xml
Response
...\81_WSDL_XML\UlnboxContactItem\Response.xml
Message Schema (WSDL) for Ulnbox Contact Item

...\81_WSDL_XML\UlnboxContactItem\UlnboxContactItem.wsdl

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

Name Description
UniversalInboxCallAction Executes the action registered for a specific Inbox

Item type.
Request Message Description: UniversalInboxCallAction

InboxItemId InboxItemId String
ActionLIC ActionLIC String
InboxTypeName InboxTypeName String
OwnerId OwnerId String
ObjectId ObjectId String
Response Message Description: UniversalInboxCallAction

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.

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 Objects

This section describes the application objects called by the Universal Inbox. For more information on

Universal Inbox Not applicable CSSUInboxSvc

Since all Input and Output parameters are Strings, Integration Object is not required.
Example Package for Universal Inbox

Request
...\81_WSDL_XML\UniversalInbox\UniversalInbox_request.xml
Response
\81_WSDL_XML\UniversalInbox\Universal_Inbox_response.xml
Message Schema (WSDL) for Universal Inbox

\81_WSDL_XML\UniversalInbox\UniversalInbox.wsdl

Siebel 8.1 Primary Web Services WC_PickList_Payment_Profile_BS
WC_PickList_Payment_Profile_BS
This Web service is used for creating/updating/deleting/listing of payment wallet with payment
methods.
This Web service exposes the Query and Execute Methods in the WC_PickList_Payment_Profile_BS
Business service as Web service operations.
WC_PickList_Payment_Profile_BS Operations
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.

WC_PickList_Payment_Profile_BSQueryPage
Based on the querycriteria set on the IO,payment related details like the payment profile details
,account/contact information can be queried.
WC_PickList_Payment_Pro The container element for the QueryPage Integration

file_BSQueryPage_Input Operation request.The method Object
arguments are Payment IO, Language
Mode (value is LDC) and viewMode
(All).


WC_PickList_Payment_Profile_BSQueryPage
WC_PickList_Payment_Pro The method arguments are Payment IO, Integration

file_BSQueryPage_Output Language Mode (value is LDC) and Object
viewMode (All).
Request Message Description: Request Message Description:

WC_PickList_Payment_Profile_BSExecute
Based on the querycriteria set,creating/editing/deleting operations on a wallet can be perfomed.
WC_PickList_Payment_Pro The method arguments are Payment IO, Integration

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

WC_PickList_Payment_Profile_BSExecute
WC_PickList_Payment_Pro The retrieved data for the update Integration

file_BSExecute_Output operation performed which could be Object
creating/editing/deleting of a payment
wallet.
WC_PickList_Payment_Profile_BS Application Objects

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.

WC_PickList_Payment_Profile_BS Integration Object CSSEAIUIDataService


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

\WC_PickList_Payment_Profile_BS\WC_PickList_Payment_Profile_BS.wsdl


5 Siebel 8.0 Web Services

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:
NOTE: Web services originating with the release of Siebel CRM, version 8.0 may be run on all
subsequent releases of Siebel CRM software, including version 8.1.
Support and Testing Web Services

Table 2 lists the primary Web services available with Siebel 8.0. The Services are divided by functional
area.
Table 2. 8.0 Primary Web services
CME NetworkOrderEntry http://siebel.com/NetworkOrderEntry Inbound
TroubleTicket http://siebel.com/TroubleTicket
FINS INS Claims http://siebel.com/claims Inbound
External Auto Policy http://siebel.com/claims/ Outbound
External Property Policy http://siebel.com/claims/
FS Warranty http://siebel.com/Service/AssetWarranty Inbound
CopyActivity http://siebel.com/Service/FS/CopyActivity
ServiceRequest http://siebel.com/Service/FS/ServiceRequests
AssetManagement http://www.siebel.com/Service/FS/Assets
VerifyEntitlement http://www.siebel.com/Service/FS/Entitlement
LS GetHealthCareProfessionalCompl http://siebel.com/LS/MarketingCompliance Inbound

ianceDetails
GetHealthCareProfessionalProfile http://siebel.com/LS/MarketingCompliance Inbound

Information
Mktg GetUnallocatedExpenseItem http://siebel.com/LS/MarketingCompliance Inbound
SetAllocatedExpenseItem http://siebel.com/LS/MarketingCompliance Inbound
WebMarketing http://siebel.com/marketing/webmarketing Inbound

Siebel 8.0 Web Services 8.0 Primary Web Services
EventManagement http://www.siebel.com/Marketing/EventData Inbound
Event Registration http://www.siebel.com/Marketing/EventRegistration Inbound
OM 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
EligibilityCompatibility http://siebel.com/OrderManagement/Quote/PSP Inbound
ProductRecommendation http://siebel.com/OrderManagement/Quote/PSP Inbound
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 http://siebel.com/CustomUI Inbound
WC_Contacts_BS http://siebel.com/CustomUI Inbound
WC_Opportunity_BS http://siebel.com/CustomUI Inbound
WC_Service_Request_BS http://siebel.com/CustomUI Inbound
Forecast http://siebel.com/Sales/SFA Inbound
Integration_Object_Info_Service http://siebel.com/Sales/SFA Inbound
SFA_Activity_BS http://siebel.com/Sales/SFA Inbound
Utility EAILOVWS http://www.siebel.com/xml/LOVService Inbound
ContextServiceWrapperService http://www.siebel.com/OrderManagement/ContextS Inbound

ervice

Siebel 8.0 Web Services Support and Testing Web Services
Support and Testing Web Services

Table 3 lists the Siebel 8.0 Web services used for support or testing.
Table 3. Support and Testing Web services
DDK-
POC DedicatedBlockWS http://siebel.com/CustomUI Inbound
DDK-
POC WC_Asset_DB_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_MVG_Channel_Partner_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_MVG_Household_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_MVG_Industry_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_MVG_Internal_Division_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_MVG_Organization_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_MVG_Position_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_MVG_Source_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_MVG_Territory_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_Orders_BS http://siebel.com/CustomUI Inbound
DDK- WC_PickList_Abs_Admin_Service_Region_
POC BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_PickList_Action_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_PickList_Agreement_Entitlement_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_PickList_Auction_Services_BS http://siebel.com/CustomUI Inbound
WC_PickList_Business_Address_BS http://siebel.com/CustomUI Inbound

DDK-
POC
DDK-
POC WC_PickList_Campaign_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_PickList_Currency_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_PickList_Employee_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_PickList_FS_Shipping_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_PickList_Internal_Product_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_PickList_Order_Entry_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_PickList_Payment_Profile_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_PickList_Payment_Terms_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_PickList_Price_List_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_PickList_Sales_Assessment_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_PickList_Sales_Stage_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_PickList_Service_Agreement_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_PickList_Siebel_Instance_BS http://siebel.com/CustomUI Inbound
DDK-
POC WC_PickList_VORD_Network_Asset_BS http://siebel.com/CustomUI Inbound
EAI
Core WC Cached State Managed Service http://siebel.com/CustomUI Inbound
EAI
Core WC Cached Stateful Service http://siebel.com/CustomUI Inbound
EAI
Core WC Cached Stateless Service http://siebel.com/CustomUI Inbound
EAI
Core WC NonCached State Managed Service http://siebel.com/CustomUI Inbound

EAI
Core WC NonCached Stateful Service http://siebel.com/CustomUI Inbound
EAI
Core WC NonCached Stateless Service http://siebel.com/CustomUI Inbound
http://schemas.actuate.com/actuat
Misc ActuateAPI e7/wsdl Outbound
http://schemas.actuate.com/actuat
Misc ActuateAPI e8/wsdl Outbound
http://www.sigmadynamics.com/sc
Misc DecisionService hema/services/DecisionService Outbound
http://www.sigmadynamics.com/sc
Misc ExternalChoiceService hema/services/ExternalChoice Outbound
Misc JobManagementService com.siebel.analytics.web/soap/v1 Outbound
Misc SAWSessionService com.siebel.analytics.web/soap/v1 Outbound
Misc SendMailingService urn:xml-send-mailing Outbound
Misc SiebelSharePointArchival http://www.siebel.com/collab/ Outbound
Misc SiebelSharePointIntegration http://www.siebel.com/collab/ Outbound
Misc WC_Quote_BS http://siebel.com/CustomUI Inbound
http://www.siebel.com/SharepointI
Misc Web Collaboration Service ntegration Inbound
Misc WebCatalogService com.siebel.analytics.web/soap/v1 Outbound
http://siebel.com/PSR/FS/PSRUnitT
Test PSRUnitBenchmark est Inbound
ASI AccountWS http://siebel.com/asi/ Inbound
ASI ActivityWS http://siebel.com/asi/ Inbound
ASI ContactWS http://siebel.com/asi/ Inbound
ASI CRM Contact Management http://siebel.com/asi/ Inbound
ASI CRM Lead Management http://siebel.com/asi/ Inbound
ASI CRM Marketing Management http://siebel.com/asi/ Inbound
ASI CRM Party Management http://siebel.com/asi/ Inbound
ASI CRM Service Management http://siebel.com/asi/ Inbound
ASI External Account http://siebel.com/asi/ Outbound
ASI External ANI Claims Notice of Loss http://siebel.com/asi/ Outbound

ASI External ANI Claims Payment Info http://siebel.com/asi/ Outbound
ASI External ATP Check http://siebel.com/asi/ Outbound
ASI External Contact http://siebel.com/asi/ Outbound
ASI External Credit Check http://siebel.com/asi/ Outbound
ASI External CRM Lead Management http://siebel.com/asi/ Outbound
ASI External CRM Marketing Management http://siebel.com/asi/ Outbound
ASI External CRM Service Management http://siebel.com/asi Outbound
ASI External Employee http://siebel.com/asi/ Outbound
ASI External Household http://siebel.com/asi/ Outbound
ASI External Opportunity Create http://siebel.com/asi/ Outbound
ASI External Opportunity Query http://siebel.com/asi/ Outbound
ASI External Opportunity Update http://siebel.com/asi/ Outbound
ASI External Opportunity Update Response http://siebel.com/asi/ Outbound
ASI External Order http://siebel.com/asi/ Outbound
ASI External Position http://siebel.com/asi/ Outbound
ASI External Quote http://siebel.com/asi/ Outbound
External Request Add/Cancel Group Policy

ASI Member http://siebel.com/asi/ Outbound
External Request Add/Cancel Individual

ASI Policy Member http://siebel.com/asi/ Outbound
ASI External Request Authorization http://siebel.com/asi/ Outbound
ASI External Request Benefit Detail http://siebel.com/asi/ Outbound
ASI External Request Eligibility Check http://siebel.com/asi/ Outbound
ASI External Request Preliminary Rating http://siebel.com/asi/ Outbound
ASI External Request Providers http://siebel.com/asi/ Outbound
ASI External Request Referral http://siebel.com/asi/ Outbound
External Request Update of Member

ASI Details http://siebel.com/asi/ Outbound
ASI External Send Update Provider Details http://siebel.com/asi/ Outbound
ASI External Shipment Tracking http://siebel.com/asi/ Outbound
ASI External Shopping Cart Create http://siebel.com/asi/ Outbound

ASI External Simple Product http://siebel.com/asi/ Outbound
Healthcare Group Policy Member

ASI Management http://siebel.com/asi/ Inbound
Healthcare Individual Policy Member

ASI Healthcare Member Details Management http://siebel.com/asi/ Inbound
ASI Healthcare Request Authorization http://siebel.com/asi/ Inbound
ASI Healthcare Request Benefit Detail http://siebel.com/asi/ Inbound
ASI Healthcare Request Eligibility Check http://siebel.com/asi/ Inbound
ASI Healthcare Request Preliminary Rating http://siebel.com/asi/ Inbound
ASI Healthcare Request Providers http://siebel.com/asi/ Inbound
ASI Healthcare Request Referral http://siebel.com/asi/ Inbound
ASI Healthcare Send Update Provider Details http://siebel.com/asi/ Inbound
ASI Insurance Claims Notice of Loss http://siebel.com/asi/ Inbound
Insurance Claims Payment Info

ASI Insurance Life Policy Management http://siebel.com/asi/ Inbound
ASI ModuleLicense http://siebel.com/asi/ Inbound
ASI OpportunityWS http://siebel.com/asi/ Inbound
ASI PIMDomainWS http://siebel.com/asi/ Inbound
ASI ProjectWS http://siebel.com/asi/ Inbound
ASI SearchExternalService http://siebel.com/asi/ Inbound
ASI SearchSecurityService http://siebel.com/asi/ Inbound
ASI ServiceRequestWS http://siebel.com/asi/ Inbound
ASI Siebel Account http://siebel.com/asi/ Inbound
ASI Siebel Case Information http://siebel.com/asi/ Inbound
ASI Siebel Contact http://siebel.com/asi/ Inbound
ASI Siebel Employee http://siebel.com/asi/ Inbound
ASI Siebel Household http://siebel.com/asi/ Inbound
ASI Siebel Invoice http://siebel.com/asi/ Inbound
ASI Siebel Opportunity Create http://siebel.com/asi/ Inbound

ASI Siebel Opportunity Query http://siebel.com/asi/ Inbound
ASI Siebel Opportunity Update http://siebel.com/asi/ Inbound
ASI Siebel Opportunity Update Response http://siebel.com/asi/ Inbound
ASI Siebel Order http://siebel.com/asi/ Inbound
ASI Siebel Position http://siebel.com/asi/ Inbound
ASI Siebel Quote http://siebel.com/asi/ Inbound
ASI Siebel Shopping Cart Create http://siebel.com/asi/ Inbound
ASI Siebel Simple Product http://siebel.com/asi/ Inbound
ASI Siebel TM Alignment http://siebel.com/asi/ Inbound
ASI Siebel TM Alignment Results http://siebel.com/asi/ Inbound
ASI Siebel TM Hierarchy http://siebel.com/asi/ Inbound
ASI Siebel TM Territory http://siebel.com/asi/ Inbound
http://www.siebel.com/xml/Sessio
Utility SessionAccessWS nAccess Inbound
Utility SiebelUserProfileService http://siebel.com/CustomUI Inbound
Utility SiebelWebRegistration http://siebel.com/CustomUI Inbound


This chapter includes detailed descriptions and information about Version 8.0 of Siebel CRM Web
services.
NOTE: Web services originating with the release of Siebel CRM, version 8.0 may be run on all
subsequent releases of Siebel CRM software, including version 8.1.
Web services described include the following:
ABOWebService
Asset Management
AssetWebService
CalculatePriceWS
CatalogWebService
ContextServiceWrapperService
CopyActivity
EAILOVWS
EligibilityCompatibility
EventManagement
Event Registration
ExternalAutoPolicy
ExternalPropertyPolicy
Forecast
GetHealthCareProfessionalProfileInformation
GetHealthCareProfessionalComplianceDetails
GetUnallocatedExpenseItem
INSClaims
IntegrationObjectInfo
NetworkOrderEntry
PartnerPrograms
PartnerRegistration
ProductConfigurator

Siebel 8.0 Primary Web Services ABOWebService
PromotionWebService
QuoteWebService and OrderWebService
QuoteAddItemsWS
SerializationService
ServiceRequest
SessionAccessWS
SetAllocatedExpenseItem
SFA_Activity_BS
SiebelUserProfileService
TroubleTicket
VerifyEntitlement
Warranty
WC_Account_BS
WC_Contacts_BS
WC_Opportunity_BS
WC_Service_Request_BS
WebMarketing
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.

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

ModifyAssetToOrder Modifies an asset (Service Item), and generates an order item to

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

Node Description
OrderId Required. RowId of the order to be submitted.
Response Message Description: SubmitOrder

response message.

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.

Integration Object Message Format: PDS Asset.
Node Description
PDS Asset Required. Integration Object.
Header Asset Header
Line Item Asset
XA Asset attributes
Request Message Description: ModifyAssetToQuote
Node Description



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

Integration Object Message Format: PDS Quote
Node Description
PDS Quote Required. Integration Object.
Header Quote Header.
Line Item Quote Line Item.
XA Quote Line Item attributes.
Request Message Description: ModifyAssetToOrder

Node Description



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.
be modified.
PriceListId Specifies a Price List Id associated with the quote if a new quote is
requested.
CompoundProductNumber 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

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

ABOWebService Application Interface

application implementation, refer to the application development documentation.

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


PDS Quote PDS Quote
PDS Order PDS Order
PDS Asset PDS Asset
Example Package for ABOWebService

For sample code, see the files in the WebServices file folder in the Bookshelf area on Oracle
Technology Network.
Request (AutoOrder)
\ABOWebService\AutoOrder_request.xml
Response (AutoOrder)
...\80_WSDL_XML\ABOWebService\AutoOrder_response.xml
Request (ModifyAssetToQuote)
...\80_WSDL_XML\ABOWebService\ModifyAssetToQuote_request.xml
Response (ModifyAssetToQuote)
...\80_WSDL_XML\ABOWebService\ModifyAssetToQuote_response.xml
Request (AutoAsset)
...\80_WSDL_XML\ABOWebService\AutoAsse_request.xml

Response (AutoAsset)
...\80_WSDL_XML\ABOWebService\AutoAsset_response.xml
Message Schema (WSDL) for ABOWebservice

...\80_WSDL_XML\ABOWebService\ABOWebService.wsdl

Siebel 8.0 Primary Web Services Asset Management
Asset Management
Use this Web service to create, read, and update Asset records.
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.
Name Description
Asset_spcManagement_AssetManagementInsert Creates an Asset

record.
Request : Asset_spcManagement_AssetManagementInsert_Input
Request : Asset_spcManagement_AssetManagementInsert_Output
Asset_spcManagement_AssetManagementQueryPage Querys for an Asset

record.
Request: Asset_spcManagement_AssetManagementQueryPage_Input
Response: Asset_spcManagement_AssetManagementQueryPage_Output
Asset_spcManagement_AssetManagementUpdate Updates an Asset

record.
Request: Asset_spcManagement_AssetManagementUpdate_Input
Response: Asset_spcManagement_AssetManagementUpdate_Output
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.

Same as request message format.

Asset Management Application Interface

implementing the application, refer to application development documentation.

Name Boundary Object Class (If BusService)
Type
Asset Management Business Service CSSEAIUIDataService

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

For sample code, see the files in the WebServices file folder in the Bookshelf area on Oracle
Technology Network.
Request
...\80_WSDL_XML\AssetManagement\AssetManagement_request.xml
Response
...\80_WSDL_XML\AssetManagement\AssetManagement_response.xml

Message Schema (WSDL) for AssetManagement

...\80_WSDL_XML\AssetManagement\AssetManagement.wsdl

Siebel 8.0 Primary Web Services AssetWebService
AssetWebService

Siebel 8.0 Primary Web Services CalculatePriceWS
CalculatePriceWS
Use this Web service to calculate the documents Quote price.
CalculatePriceWS Operations
Name Description
CalculatePrice Calculate price for the input Quote Document. The Web service
invokes the Web Channel Pricing Driver Workflow Workflow.
Request Message Description: CheckQuoteEligibilityCompatibility

Node Description
QuoteIO Required. An instance of the Integration Object "PDS Quote".
Response Message Description: CheckQuoteEligibilityCompatibility
Node Description
QuoteIO An instance of the Integration Object "PDS Quote".
Application Interface for CalculatePriceWS

This section describes the application objects called by the Web service CalculatePriceWS. For more
information on application implementation, refer to the application development documentation.
This Web service invokes the Web Channel Pricing Driver Workflow Workflow. The input and output
are based on the PSP Common Integration Object.
This is the Web service version of the PSP Driver Workflow Process. The following table lists the
descriptions of the workflow steps:
Name Type Business Method Subprocess Description

Service
Transfer Business EAI Integration IntObjHierToPSHier Converts input PDS

Quote IO to Service Object to XML Quote integration
PS Hierarchy object to a property set
Converter hierarchy
Get Context Business Context Service GetRowSetData Creates Context Row

Service Set from the Property
Set hierarchy

Name Type Business Method Subprocess Description

Service
Get RowSet Business Context Service GetRowSetData Creates Row Set from
Service Property Set hierarchy
Set Pricing Business Row Set Conditional Action Sets the Pricing Date to
Date Service Transformation Transform the current time stamp
Toolkit or the date provided by
the Joint Workspace
Scenario Builder
Calculate Sub Dynamic Calls the Dynamic

Price Procedure Pricing Pricing Procedure to
Procedure perform pricing
Zero Out Business Row Set Conditional Action Clears the price totals on
Totals Service Transformation Transform the Context Row Set
Toolkit
Totaling Business Row Set Conditional Action Calculates the Totals for
Service Transformation Transform the Non Recurring
Toolkit Charge and Monthly
Recurring Charge on the
Context Row Set
Sync Row Business Context Service SetRowSetData Writes the updated Row
Set to PS Service Set back to the
Property Set Hierarchy
Sync Business Context Service SetRowSetData Writes the updated

Context to Service Context back to the
PS Property Set Hierarchy
Transfer Business EAI Integration PSHierToIntObjHier Converts the Property

from PS to Service Object to XML Hierarchy to the
IO Hierarchy Integration Object
Converter Hierarchy
Name Boundary Object Class (if BusService)

Type
Web Channel Pricing Workflow Not applicable

Driver Workflow


PDS Quote PDS Quote
Structure:
Header
|-----LineItem
|----- XA
Methods
Operation Method
CalculatePrice RunProcess
Example Package for CalculatePriceWS

The following is an example of a message package for CalculatePrice.
Request
...\80_WSDL_XML\CalculatePriceWS\CalculatePriceWS_request.xml
Response
...\80_WSDL_XML\CalculatePriceWS\CalculatePriceWS_response.xml
Message Schema (WSDL) of CalculatePriceWS

See the following file in the WebServices file folder in the Bookshelf area on Oracle Technology
Network to view the message schema:
...\80_WSDL_XML\CalculatePriceWS\http___siebel.com_OrderManagement_Quote_PSP_CalculatePrice
WS.wsdl

Siebel 8.0 Primary Web Services CatalogWebService
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
Name Description
Get Catalog Retrieves a list of catalogs.
Get Catalog Categories Retrieves a list of categories for a given catalog.
Retrieves a list of products for a given catalog, category and other

Get Category Products contextual parameters.
Retrieves the full structure of a given Catalog including category

Publish Catalog and products.
Get Product Details Retrieves the basic product information along with the attributes.
Retrieves the details of the product specific child entities, such as

Get Product Children 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.
Retrieves the search options for a specific product family or class.

For example, enter Printer Speed, Color, and so on for the
Get Search Options Printer Class.
Retrieves a list of fields or attributes that are available for a

search option. For example, enter 100dpm, 200dpm for the
Get Search Parameters Printer Speed option.
Returns the search results based on the search options and

Execute Search parameter values.

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.
Node Description
PDS Catalog Interface An instance of Integration Object "PDS Catalog Interface".
Request Message Description: GetCatalogCategory

Node Description
PDS Catalog Category Required. An instance of Integration Object "PDS Catalog Category
Interface Interface".
Response Message Description: GetCatalogCategory

Integration Object Message Format: PDS Catalog Category Interface.
Node Description
PDS Catalog Category An instance of Integration Object "PDS Catalog Category Interface".
Interface

Request Message Description: GetCategoryProducts

Node Description
PDS Category Required. An instance of Integration Object "PDS Category Product

Product Interface 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 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.
Node Description
PDS Category An instance of Integration Object "PDS Catalog Category Interface". After
Product Interface running Eligibility and Pricing, the List Price, Net Price, "Eligibility status"
and "Eligibility Reason" fields will be updated.
Request Message Description: PublishCatalog

Node Description
PDS Publish Catalog Required. An instance of Integration Object "PDS Category Product
eligible products ). Optional. The default value is "1".


IncludePriceWaterfall Y or N (includes price waterfall or does not).

Response Message Description: PublishCatalog

Integration Object Message Format: PDS Publish Catalog Interface.
Node Description
PDS Publish Catalog An instance of Integration Object "PDS Publish Catalog Interface". After
Interface running Eligibility and Pricing, the List Price, Net Price, "Eligibility status"
Request Message Description: GetProductDetails

Node Description
PDS Product Details Required. An instance of Integration Object "PDS Product Details Interface".
Interface
eligible products ). Optional. The default value "1".


Response Message Description: GetProductDetails

Integration Object Message Format: PDS Product Details Interface.
Node Description
PDS Product Details An instance of Integration Object "PDS Product Details Interface". After
Interface running Eligibility and Pricing, the List Price, Net Price, "Eligibility status"
Request Message Description: GetProductChildren
Node Description
PDS Product Children Required. An instance of Integration Object "PDS Product Children
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".



Integration Object Message Format: PDS Product Children Interface.
Node Description
PDS Product An instance of Integration Object "PDS Product Children Interface".

Children Interface
Request Message Description: GetSearchOptions

Node Description
PDS Searchable Required. An instance of Integration Object "PDS Searchable Product Class
Product Class Interface".
Interface
Response Message Description: GetSearchOptions

Integration Object Message Format: PDS Searchable Product Class Interface.
Node Description
PDS Searchable Product An instance of Integration Object "PDS Searchable Product Class
Class Interface 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
Node Description
PDS Searchable Product Required. An instance of Integration Object "PDS Searchable Product
Class Interface Class Interface".
FieldNameClassId Property name for the class Id field. Optional. The default value is
"Class Id". (Recommend not to change.)
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.
Response Message Description: GetSearchParameters

Integration Object Message Format: PDS Product Class Attributes Interface.
Node Description
PDS Product Class An instance of Integration Object "PDS Product Class Attributes Interface".
Attributes Interface
Request Message Description: GetProductAttributeDomain

Retrieves all the Possible Values for a Given Product Attribute
Node Description
Attribute Id Product attribute Id. This is a required input.
Product Product Configuration Model Id. This is a required input. This field value can
Configuration Model be looked up from the product integration object.
Id
Response Message Description: GetProductAttributeDomain

Integration Object Message Format: PDS Product Attribute Domain Interface.
Node Description
PDS Product An instance of Integration Object "PDS Product Attribute Domain Interface".
Attribute Domain
Interface

Request Message Description: ExecuteSearch

Performs an Attribute Search, Returns the Search Results Based on the Search Options and Parameter
Values
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.
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".


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 An instance of Integration Object "PDS Product Class Attributes Interface".
Attributes Interface This is a required input for the SearchByClass search option.
Response Message Description: ExecuteSearch

Integration Object Message Format: PDS Product Interface.
Node Description
PDS Product Interface 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

implementing the application, refer to the application development documentation.


Type
PDS Product Data Service BusService CSSProdDataSvc
PDS Catalog Interface PDS Catalog Interface
PDS Catalog Category Interface PDS Catalog Category Interface
PDS Category Product Interface PDS Category Product Interface
PDS Publish Catalog Interface PDS Publish Catalog Interface
PDS Product Interface PDS Product Interface
PDS Product Class Attributes Interface PDS Product Class Attributes Interface
PDS Product Attribute Domain PDS Product Attribute Domain Interface

Interface
PDS Searchable Product Class Interface PDS Searchable Product Class Interface
PDS Product Details Interface PDS Product Details Interface
PDS Product Children Interface PDS Product Children Interface
Example Package for CatalogWebService

Request
To view sample code, see the following file in the WebServices folder in the Bookshelf area on Oracle
Technology Network:
...\80_WSDL_XML\CatalogWebService\CatalogWebService_request.xml
Response
Technology Network:
...\80_WSDL_XML\CatalogWebService\CatalogWebService_response.xml

Message Schema (WSDL) of CatalogWebService

...\80_WSDL_XML\CatalogWebService\CatalogWebService.wsdl

Siebel 8.0 Primary Web Services ContextServiceWrapperService
ContextServiceWrapperService
These Web services invoke the QuotesAndOrdersValidate signal through the context service wrapper
service. They validate the quotes and orders, or selected line items in the whole document.
ContextServiceWrapperService Operations
Name 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.
Node Description
Header Quote (Quote Ids, UIActive, UISelected required)
Line Item Quote Item
XA Quote Item attributes

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

QuoteItem-Verify
Node Description
Header Quote (Quote Id required)
Line Item Quote Item (Quote Items Ids, UIActive, UISelected required)
XA Quote Item attributes

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 Validate CP All: returns a validation message after validating all Customizable
Products (CP) under the Quotes or Orders


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

OrderHeader-Verify
Node Description

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

OrderItem-Verify
Node Description

against the Data Validation Rule Set.
ContextServiceWrapperService Application Interface

This section describes the application objects called by the quotes and orders verification Web service.
For more information on application implementation, refer to the application development

documentation.

Name Boundary Class (if
Object Type BusService)
ContextServiceWrapperService-QuoteHeader-Verify Workflow
ContextServiceWrapperService-QuoteItem-Verify Workflow
ContextServiceWrapperService-OrderHeader-Verify Workflow
ContextServiceWrapperService-OrderItem-Verify Workflow
WS Quote WS Quote
WS Order WS Order
Methods
Operation Method
ValidateQuotes RunProcess
ValidateQuoteItems RunProcess
ValidateOrders RunProcess
ValidateOrderItems RunProcess

Example Packages for ContextServiceWrapperService

The following are examples of a message package for all these operations.
Request (ValidateQuotes)
Technology Network:
...\80_WSDL_XML\ContextServiceWrapperService\ValidateQuote_request.xml
Response (ValidateQuotes)
Technology Network:
...\80_WSDL_XML\ContextServiceWrapperService\ValidateQuotes_response.xml
Request (ValidateQuoteItems)
Technology Network:
...\80_WSDL_XML\ContextServiceWrapperService\ValidateQuoteItems_request.xml
Response (ValidateQuoteItems)
Technology Network:
...\80_WSDL_XML\ContextServiceWrapperService\ValidateQuoteItems_response.xml
Message Schema (WSDL) of ContextServiceWrapperService

To view message schema, see the following file in the WebServices folder in the Bookshelf area on
Oracle Technology Network:
ContextServiceWrapperService\ContextServiceWrapperService.wsdl

Siebel 8.0 Primary Web Services CopyActivity
CopyActivity
Use this Web service to instantiate activities from an activity template for a Service Request.
CopyActivity Operations
Name Description
WSCopyServiceActivityRunProcess Creates activity records.
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


Object Type
WS Copy Service Activity Workflow n/a

Siebel 8.0 Primary Web Services CopyActivity
Methods
Operation Method
WSCopyServiceActivityRunProcess [WF: WS Copy Service Activity].[RunProcess]
Example Package for CopyActivity

The following is an example of a message package for WSCopyServiceActivityRunProcess.
Request (WSCopyServiceActivityRunProcess)
Technology Network:
...\80_WSDL_XML\CopyActivity\CopyActivity_request.xml
Response (WSCopyServiceActivityRunProcess)
Technology Network:
...\80_WSDL_XML\CopyActivity\CopyActivity_response.xml
Message Schema (WSDL) of CopyActivity

...\80_WSDL_XML\CopyActivity\CopyActivity.wsdl

Siebel 8.0 Primary Web Services EAILOVWS
EAILOVWS
To view the message schema, see the WebServices ZIP download in the Siebel Bookshelf

Siebel 8.0 Primary Web Services EligibilityCompatibility
EligibilityCompatibility
Use this Web service to validate the documents (Quote) eligibility and compatibility status.
EligibilityCompatibility Operations
Name Description
CheckQuoteEligibilityCompatibility Checks the eligibility and compatibility status for the input
Quote Object
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 IO "Projected Asset". It is used for a compatibility check with the
current quote.

Eligibility and Compatibility Used Fields
Variable
Name (Map
to Internal
PDS Quote (Quote) Mapping XML Variable How It Is Used in Eligibility and
Name Map) Compatibility
Account Used in the workflow

Contracted
Products Only
AccountContractedProductsOnlyFlag Flag
AccountId Account Id Account (used in the Eligibility Matrix)
Account Type (used in the Eligibility

AccountType Account Type Matrix)
ShippingCity City City (used in the Eligibility Matrix)
ShippingCountry Country Country (used in the Eligibility Matrix)
Postal Code (used in the Eligibility

ShippingPostalCode Postal Code Matrix)
Price List (checks in the workflow if the

PriceListId Price List Id product is included in the price list)
ShippingState State State (used in the Eligibility Matrix)
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.
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
Inclusive Eligibility about defining product and promotion eligibility
InclusiveEligibilityFlag Flag rules.
Name Name Name of the line item.

Defines if the line item will trigger the eligibility

and compatibility checking . It must be Y to
PrePickCD Pre Pick trigger the eligibility and compatibility check.
Price List (checks if the product is included in the

PriceListId Price List Id price list).
Product (used in the Eligibility and Compatibility

ProductId Product Id Matrix).
Product Line (used in the Eligibility and

ProductLineId Product Line Id Compatibility Matrix).
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

Name Boundary Class (if

Object BusService)
Type
Web Channel Product Eligibility & Compatibility Driver Workflow Workflow

Projected Asset Projected Asset

Example Package for EligibilityCompatibility

The following is an example of a message package for EligibilityCompatibility.
Request
Go to the following directory in the SampleCode.zip file to view the sample code:
...\80_WSDL_XML\EligibilityCompatibility\EligibilityCompatibility_request.xml
Response
Go to the following directory in the SampleCode.zip file to view the sample code:
...\80_WSDL_XML\EligibilityCompatibility\EligibilityCompatibility_response.xml
Message Schema (WSDL) of EligibilityCompatibility

...\80_WSDL_XML\EligibilityCompatibility\EligibilityCompatibility.wsdl

Siebel 8.0 Primary Web Services EventManagement
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
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

Node Description
Id Row Id of Event.
Name Name of Event.
Status Event Status.
Event Type Event Format.
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.

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

Node Description
Id Row Id of Event.
Name Name of Event.
Participant Type Event Participant Type.
Region Region where the Event takes Place.
Invitation Deadline Event Invitation deadline.
Organization Event Organization.
Lead Partner Event Partner.
Primary venue Name of the Venue where the Event happens.

Name
URL Web URL for Events.
Period Name Event Period.

Node Description
Budget Period Event Budget Period.
Session Info
Id Session Id.
Name Session Name.
View Mode All.
Response Message Description: GetEventDetails

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

Node Description
Id Row Id of Event.
Name Name of Event.
Session Info
Id Session Id.
Name Session Name.
View Mode All.
Response Message Description: GetSessions

Request Message Description: RegisterForEvent

Node Description
Status Registration Status.
Registration date Date Registration happens.

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

Node Description
Output Type Message to Indicate detailed status.
Return Val Outcome Status.
Reg Id Registration Id.
EventManagement Application Interface


Name Boundary Object Type Class (if Bus Service)
Event Data Service Business Service CSSEAIUIDataService
Event Detail Service Business Service CSSEAIUIDataService
Event Attendee Data Business Service CSSEAIUIDataService

Service
Session Data Service Business Service CSSEAIUIDataService
Event Registration Service Business Service CSSEventRegistrationService

WC_Event_IO Event
WC_EventSession_IO Event Session
WC_ATT_IO Event Attendee

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
...\80_WSDL_XML\EventManagement\EventManagement_request.xml
Response
...\80_WSDL_XML\EventManagement\EventManagement_response.xml
Message Schema (WSDL) for EventManagement

...\80_WSDL_XML\EventManagement\EventManagement.wsdl

Siebel 8.0 Primary Web Services Event Registration
Event Registration
ExternalAutoPolicy
See INSClaims Web Service for a description of this Web service.
ExternalPropertyPolicy
See INSClaims Web Service for a description of this Web service.
Forecast
...\80_WSDL_XML\Forecast\Forecast.wsdl

Siebel 8.0 Primary Web Services GetHealthCareProfessionalProfileInformation
GetHealthCareProfessionalProfileInforma
tion
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.
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.
Node Description
<PrimaryRowId> Required - represents the Siebel Row Id of the Contact Object
Request Message Description: LSMCProfileQueryByExample
Node Description
<Contact> Required is a combination of attributes to

uniquely identify a Contact
<Created>
<Updated>
<AccountIntegrationId>
<CallClass>
<ContactId>
<CreatedByName>

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

Common Response Message Description

The column Node represents a respective Siebel field if not specified otherwise.
Node Parent Descrip-

tion
<ListOfLSMCProfile> <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
<PrimaryEmployeeLoginOfPrimaryContactPosition> Contact
<PrimaryLastCallDate> Contact
<PrimaryLicenseExpirationDate> Contact
<PrimaryLicenseNumber> Contact
<PrimaryLicenseState> Contact
<PrimaryLicenseStatus> Contact
<PrimaryOrganization> Contact
<PrimaryPostalCode> Contact
<PrimarySpecialty> Contact


tion
<PrimaryState> Contact
<PrimaryStateLicenseId> Contact
<PrimaryStreetAddress> 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> ListOfLsMcBudgetContactSalesR <Tag>

ep
<LsMcBudgetContactSalesRep> LsMcBudgetContactSalesRep <Tag>

soapenc
<ContactBudgetId> LsMcBudgetContactSalesRep
<Currency2> LsMcBudgetContactSalesRep
<SalesRepBudget> LsMcBudgetContactSalesRep
<PositionId> LsMcBudgetContactSalesRep
<PositionName> LsMcBudgetContactSalesRep
<ListOfLsMcContactExpenseItem> Contact <Tag>
<LsMcContactExpenseItem soapenc> ListOfLsMcContactExpenseItem <Tag>
<LsMcContactExpenseItem> LsMcContactExpenseItem <Tag>

soapenc


tion
<ComplianceFlag> LsMcContactExpenseItem
<Currency> LsMcContactExpenseItem
<ExchangeRate> LsMcContactExpenseItem
<ExpenseId> LsMcContactExpenseItem
<ExpenseItemAmount> LsMcContactExpenseItem
<ExpenseItemCurrency> LsMcContactExpenseItem
<ExpenseItemId> LsMcContactExpenseItem
<ExpenseItemTypeId> LsMcContactExpenseItem
<ExpenseItemTypeName> LsMcContactExpenseItem
<ProcessStatus> LsMcContactExpenseItem
<TransactionState> LsMcContactExpenseItem
<ListOfLsMcContactExpenseItemAllocation> LsMcContactExpenseItem <Tag>
<LsMcContactExpenseItemAllocation soapenc> ListOfLsMcContactExpenseItemA <Tag>

llocation
<LsMcContactExpenseItemAllocation> LsMcContactExpenseItemAllocati <Tag>

on soapenc
<Currency2> LsMcContactExpenseItemAllocati
on
<Description> LsMcContactExpenseItemAllocati
on
<ExpenseId> LsMcContactExpenseItemAllocati
on
<AllocatedAmount> LsMcContactExpenseItemAllocati
on
<LoggedById> LsMcContactExpenseItemAllocati
on
<ProcessStatus> LsMcContactExpenseItemAllocati
on
<ReportingState> LsMcContactExpenseItemAllocati
on
<TransactionState> LsMcContactExpenseItemAllocati
on
<ListOfServiceRequest> Contact <Tag>
<ServiceRequest soapenc> ListOfServiceRequest <Tag>


tion
<ServiceRequest> ServiceRequest soapenc <Tag>
<Abstract> ServiceRequest
<AdditionalInformation> ServiceRequest
<Area> ServiceRequest
<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


tion
<SubType> ServiceRequest
<Sub-Area> ServiceRequest
<ListOfFinAlertContact> Contact <Tag>
<FinAlertContact soapenc> ListOfFinAlertContact <Tag>
<FinAlertContact> FinAlertContact soapenc <Tag>
<Category> FinAlertContact
<ContactId> FinAlertContact
<Message> FinAlertContact
<Priority> FinAlertContact
<StartDate2> FinAlertContact

Type
LSMCProfile Business Service CSSEAIDataSyncService

LSMCProfile Contact
Methods
Operation Method
LSMCProfileQueryById QueryById
LSMCProfileQueryByExample QueryByExample

Example Package for

GetHeathcareProfessionalProfileInformation
Request
...\80_WSDL_XML\GetHeathcareProfessionalProfileInformation\Request.xml
Response
...\80_WSDL_XML\GetHeathcareProfessionalProfileInformation\Response.xml
Message Schema (WSDL) for

GetHeathcareProfessionalProfileInformation
...\80_WSDL_XML\GetHeathcareProfessionalProfileInformation\GetHeathcareProfessionalProfileInform
ation.wsdl

Siebel 8.0 Primary Web Services GetHealthCareProfessionalComplianceDetails
GetHealthCareProfessionalComplianceDe
tails
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.
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.
Request Message Description: LSMCDetailsQueryById

The operations in this Web service work with a common response message format but have a different
Node Description
<PrimaryRowId> Required. Represents the Siebel Row Id of the

Contact Object.
Request Message Description: LSMCDetailsQueryByExample

Node Description
<Contact> Required. A combination of attributes to

uniquely identify a Contact.
<Created>
<Updated>
<AccountIntegrationId>
<CallClass>
<ContactId>
<CreatedByName>

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


Node Parent Description
<ListOfLSMCDetails> <Tag>
<Contact soapenc> ListOfLSMCDetails <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
<PrimaryEmployeeLoginOfPrimaryContactPosition> Contact
<PrimaryLastCallDate> Contact
<PrimaryLicenseExpirationDate> Contact
<PrimaryLicenseNumber> Contact
<PrimaryLicenseState> Contact
<PrimaryLicenseStatus> Contact
<PrimaryOrganization> Contact
<PrimaryPostalCode> Contact

<PrimarySpecialty> Contact
<PrimaryState> Contact
<PrimaryStateLicenseId> Contact
<PrimaryStreetAddress> 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> ListOfLsMcBudgetContactSal <Tag>

esRep
<LsMcBudgetContactSalesRep> LsMcBudgetContactSalesRep <Tag>

soapenc
<ContactBudgetId> LsMcBudgetContactSalesRep
<Currency2> LsMcBudgetContactSalesRep
<SalesRepBudget> LsMcBudgetContactSalesRep
<PositionId> LsMcBudgetContactSalesRep
<PositionName> LsMcBudgetContactSalesRep
<ListOfLsMcContactExpenseItem> Contact <Tag>
<LsMcContactExpenseItem soapenc> ListOfLsMcContactExpenseIt <Tag>

em

<LsMcContactExpenseItem> LsMcContactExpenseItem <Tag>

soapenc
<ComplianceFlag> LsMcContactExpenseItem
<Currency> LsMcContactExpenseItem
<ExchangeRate> LsMcContactExpenseItem
<ExpenseId> LsMcContactExpenseItem
<ExpenseItemAmount> LsMcContactExpenseItem
<ExpenseItemCurrency> LsMcContactExpenseItem
<ExpenseItemId> LsMcContactExpenseItem
<ExpenseItemTypeId> LsMcContactExpenseItem
<ExpenseItemTypeName> LsMcContactExpenseItem
<ProcessStatus> LsMcContactExpenseItem
<TransactionState> LsMcContactExpenseItem
<ListOfLsMcContactExpenseItemAllocation> LsMcContactExpenseItem <Tag>
<LsMcContactExpenseItemAllocation soapenc> ListOfLsMcContactExpenseIt <Tag>

emAllocation
<LsMcContactExpenseItemAllocation> LsMcContactExpenseItemAll <Tag>

ocation soapenc
<Currency2> LsMcContactExpenseItemAll
ocation
<Description> LsMcContactExpenseItemAll
ocation
<ExpenseId> LsMcContactExpenseItemAll
ocation
<AllocatedAmount> LsMcContactExpenseItemAll
ocation
<LoggedById> LsMcContactExpenseItemAll
ocation
<ProcessStatus> LsMcContactExpenseItemAll
ocation
<ReportingState> LsMcContactExpenseItemAll
ocation
<TransactionState> LsMcContactExpenseItemAll
ocation

GetHealthCareProfessionalComplianceDetails Application
Interface

Name Boundary Object Type Class (if BusService)
LSMCDetails Business Service CSSEAIDataSyncService

LSMCDetails Contact
Methods
Operation Method
LSMCDetailsQueryById QueryById
LSMCDetailsQueryByExample QueryByExample
Example Package for

GetHeathcareProfessionalComplianceDetails
Request
GetHeathcareProfComplianceDetails\GetHeathcareProfessionalComplianceDetails_request.xml
Response
GetHeathcareProfComplianceDetails\GetHeathcareProfessionalComplianceDetails_response.xml

Message Schema (WSDL) for

GetHeathcareProfessionalComplianceDetails
...\80_WSDL_XML\GetHeathcareProfessionalComplianceDetails\GetHeathcareProfessionalComplianceD
etails.wsdl

Siebel 8.0 Primary Web Services GetUnallocatedExpenseItem
GetUnallocatedExpenseItem
Use this Web service to read the data of an expense item record for the purpose of allocating
expenses for Marketing Compliance in ePharma.
GetUnallocatedExpenseItem Operations
Because of the nature of the schema generation for the WSDL file, the message formats for each
operation have their own message names.
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. 1

LSMCGetUnallocatedExpenseItemQueryById
The operations in this Web service work with a common response message format but have different
Node Description
<PrimaryRowId> Required. Represents the Siebel Row Id of the Expense Item Object..

LSMCGetUnallocatedExpenseItemQueryByExample
Node Description
<Contact> Required. A combination of attributes to

uniquely identify an expense Item.
<Id>
<LSMCAllocationDate>
<LSMCAllocationStatusCode>
<LSMCComplianceFlag>
1
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. the recommended approach is to use the operation
"LSMCGetUnallocatedExpenseItemQueryById" and specifying the Siebel Id of the expense item.
Node Description
<LSMCTransactionState>
<ExpenseItemType>
<Amount>
<ExchangeRate>

<ListOfLSMCGetUnallocatedExpenseItem xmlns> <Tag>
<ExpenseItem soapenc ...> ListOfLSMCGetUnallocatedExpenseItem <Tag>
<ExpenseItem> ExpenseItem soapenc <Tag>
<Id> ExpenseItem
<LSMCAllocationDate> ExpenseItem
<LSMCAllocationStatusCode> ExpenseItem
<LSMCComplianceFlag> ExpenseItem
<LSMCTransactionState> ExpenseItem
<ExpenseItemType> ExpenseItem
<Amount> ExpenseItem
<ExchangeRate> ExpenseItem
<ListOfLSMCContactExpenseItem> ExpenseItem <Tag>
<LSMCContactExpenseItem soapenc ...> ListOfLSMCContactExpenseItem <Tag>
<LSMCContactExpenseItem> LSMCContactExpenseItem soapenc <Tag>
<Id> LSMCContactExpenseItem
<ListOfLSMCBudgetContact> LSMCContactExpenseItem <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


LSMCGetUnallocatedExpenseItem Business Service CSSEAIDataSyncService

LSMCGetUnallocatedExpenseItem LSMCGetUnallocatedExpenseItem
Methods
Operation Method
LSMCGetUnallocatedExpenseItemQueryById QueryById
LSMCGetUnallocatedExpenseItemQueryByExample QueryByExample
Example Package for GetUnallocatedExpenseItem

Request
...\80_WSDL_XML\GetUnallocatedExpenseItem\GetUnallocatedExpenseItem_request.xml
Response
...\80_WSDL_XML\GetUnallocatedExpenseItem\GetUnallocatedExpenseItem_response.xml

Message Schema (WSDL) for GetUnallocatedExpenseItem

...\80_WSDL_XML\GetUnallocatedExpenseItem\GetUnallocatedExpenseItem.wsdl

Siebel 8.0 Primary Web Services INSClaims
INSClaims
Use this Web service to query for, and update claims and claim elements.
INSClaims Operations
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

Node Description
SiebelMessage Required. Based on integration object INS Claims.
Request Message Description: INSClaimsInsertOrUpdate

Node Description
SiebelMessage Required. Based on integration object INS Claims.
Request Message Description: ClaimElementQueryByExample

Node Description
SiebelMessage Required. Based on integration object FINS Claim Elements.
Request Message Description: ClaimElementInsertOrUpdate

Node Description
SiebelMessage Required. Based on integration object FINS Claim Elements.


The response messages for these operations are the same as the request messages.
INSClaims Application Interface


INS Claims Business Service CSSEAIDataSyncService
FINS Claim Elements Business Service CSSWSOutboundDispatcher

INS Claims INS Claims
FINS Claim Elements FINS Claim Elements
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

Request (INSClaims)

...\80_WSDL_XML\INSClaims\INSClaims_request.xml
Response (INSClaims)
...\80_WSDL_XML\INSClaims\INSClaim_response.xml
Request (ClaimElementQueryByExample)
...\80_WSDL_XML\ClaimElementQueryByExample\ClaimElementQueryByExample_request.xml
Response (ClaimElementQueryByExample)
...\80_WSDL_XML\ClaimElementQueryByExample\ClaimElementQueryByExample_response.xml
Request (ClaimElementsInsertOrUpdate)
...\80_WSDL_XML\ClaimElementsInsertOrUpdate\ClaimElementsInsertOrUpdate_request.xml
Request (GetAutoPolicy)
...\80_WSDL_XML\GetAutoPolicy\GetAutoPolicy_request.xml
Response (GetAutoPolicy)
...\80_WSDL_XML\GetAutoPolicy\GetAutoPolicy_response.xml
Request (GetPropertyPolicy)
...\80_WSDL_XML\GetPropertyPolicy\GetPropertyPolicy_request.xml

Response (GetPropertyPolicy)
...\80_WSDL_XML\GetPropertyPolicy\GetPropertyPolicy_response.xml
Request (INSClaimsInsertOrUpdate)
...\80_WSDL_XML\INSClaimsInsertOrUpdate\INSClaimsInsertOrUpdate_request.xml
Message Schema (WSDL) for INSClaims

...\80_WSDL_XML\INSClaims\INSClaims.wsdl

Siebel 8.0 Primary Web Services IntegrationObjectInfo
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
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.
Node Description
IntegrationObjectName Integration Object name.
IntegrationCompName Integration Component name from which fields are retrieved.
Response Message Description: GetIntegrationObjectInfo

Response Message includes all the repository integration component field names.
Node Description
RepositoryIntegrationObject Integration Object name.
RepositoryIntegrationComponent Integration Component name..
ListOfRepositoryIntegrationComponentField List of repository Integration Component field names.

IntegrationObjectInfo Application Objects

Business Service
Integration ObjectInfo Service Business Service CSSIntObjectInfoService
Integration Object
Siebel OM: Repository Integration Object Repository Integration Object..
Methods
Operation Method
GetIntegrationObjectInfo GetIntegrationObjectInfo.
Example Package for IntegrationObjectInfo

Request
...\80_WSDL_XML\IntegrationObjectInfo\IntegrationObjectInfo_request.xml
Response
...\80_WSDL_XML\IntegrationObjectInfo\IntegrationObjectInfo_response.xml

Message Schema (WSDL) for IntegrationObjectInfo

...\80_WSDL_XML\IntegrationObjectInfo\IntegrationObjectInfo.wsdl

Siebel 8.0 Primary Web Services NetworkOrderEntry
NetworkOrderEntry
Use this Web service to access network assets, as well as related attributes, attached files, and open
orderes. Additionally, use this servicet to validate a network based on product rules, and, return
projected assests for a network.
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.
Common Request Message Description

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


VORD NOE Complex Data Service Business Service CSSVORDWebService
VORD NOE Simple Data Service Business Service CSSVORDWebService


Siebel Repository Name External Name Business Service
VORD NOE Network Assets VORD NOE Asset Attributes VORD NOE Simple Data
Service
VORD NOE Asset Attributes VORD NOE Asset Attributes VORD NOE Simple Data
Service
VORD NOE Network Attachments VORD Network Asset VORD NOE Simple Data
Service
VORD NOE Network Open Order Line VORD Network Asset VORD NOE Simple Data
Items Service
VORD NOE Network Validation Rule VORD Network Validation VORD NOE Complex Data
Rule Service
VORD NOE Projected Asset VORD NOE Projected Asset VORD NOE Complex Data
Service
Methods
Operation Business Service Method
GetNetworkAssets VORD NOE Simple Data Service GetNetworkAssets
GetNetworkAssetAttributes VORD NOE Simple Data Service GetNetworkAssetAttributes
GetNetworkAssetAttachments VORD NOE Simple Data Service GetNetworkAssetAttachments
GetOpenNetworkOrders VORD NOE Simple Data Service GetOpenNetworkOrders
ValidateNetworkOrder VORD NOE Complex Data Service ValidateNetworkOrder
QueryProjectedNetworkAsset VORD NOE Complex Data Service QueryProjectedNetworkAsset
Example Package for NetworkOrderEntry

Request
...\80_WSDL_XML\NetworkOrderEntry\NetworkOrderEntry_request.xml

Response
...\80_WSDL_XML\NetworkOrderEntry\NetworkOrderEntry_response.xml
Message Schema (WSDL) for NetworkOrderEntry

...\80_WSDL_XML\NetworkOrderEntry\NetworkOrderEntry.wsdl

Siebel 8.0 Primary Web Services PartnerPrograms
PartnerPrograms
PartnerRegistration

Siebel 8.0 Primary Web Services ProductConfigurator
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
Name Description
GetCfgObjectStructure Get Product Relationships, Attributes, Linked Items and

Resources.
GetCfgObjectGroupItems Get Product UI Definition, UI Group and Group Items.
GetCfgObjectDefaultGroupItems 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.
Node Description
WebChannelObjStructure Required. This structure identified the objects that will be

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

Id is required.

Node Description
Id Required. Id of Object (product / class). Either Name or Id is

required.
ParentClassId ClassId of the parent.
DisplayName Display Name.
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.
AttributeDomain Zero or more.
LocalValue Local value.
InternalValue Internal value.
AttributeDomainDecoration Zero or more. Attribute Domain specific properties name

value pairs.
Name
Value
AttributeDefaultValue Default value of the attribute. Only one of the valuetypes will
be populated depending on the type of the value.
String String value
Number Number value

Node Description
Date Date value
AttributeRejectedValue Rejected value of the attribute. Only one of the valuetypes

will be populated depending on the type of the value.
String String value
Number Number value
Date Date value
AttributeDecoration Zero or more. Attribute properties name value pairs.
Name
Value
Relationship Zero or more (only those child objects that are specified will
be 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

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

Id Id of product. If Name and/or Id is specified, only that


Node Description
OrigId Orig Id
RelationshipDomainDecoration Zero or more. Relationship domain specific properties name

value pairs.
Name
Value
Relationship Decoration Zero or more. Relationship properties name value pairs.
Name
Value
LinkedItem Zero or more (only those child objects that are specified will
be 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.
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
FieldName Field name in BC
Active Active flag
LinkedItemDecoration Linked Item properties name value pairs.
Name
Value
Resource Zero or more (only those child objects that are specified will

Node Description
be 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

ResourceDecoration Resource properties name value pairs.
Name
Value
ObjectDecoration Object properties name value pairs.
Name
Value
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
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.
ParentClassId ClassId of the parent
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

Node Description
option will be returned. If both are empty, all UI options will be

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

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 particular

responsibility will be returned. If both are empty, all responsibilities
will be returned.
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.
Sequence Sequence
GroupTheme Group Theme
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 /

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

Node Description
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
Object Decoration Object properties name value pairs.
Name
Value
Request Message Description: 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.

Node Description
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 Integration Id of the line item. If IntegrationId specified, only this line
looked at.
ProductId Product Id of the line item. If IntegrationId specified, only this line
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
HasGenericsFlag Has Generics Flag. Used to indicate whether the line item is
incomplete
EligibilityStatus Eligibility Status
EligibilityReason Eligibility Reason

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

Response Message Description: Begin Configuration

GetCfgObjectStructure has the same request and response message. See the preceeding table for
details.
GetCfgObjectGroupItems and GetCfgObjectDefaultGroupItems have the same request and response

messages. See Above for details.
Node Description
BeginConfiguration_Output Required.
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.

details.
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 etc)
Message Message text

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.
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
AttributeValue Zero or more.
DisplayValue New display value of attribute
String Value displayed in a string.
Number Value displayed as number.
Integer Value displayed as integer.
Date Date and time value.
Boolean Value displayed in Boolean format.

Response Message Description: UpdateConfiguration

Node Description
UpdateConfiguration_Output Required.
FinishConfigurationOutFlag Y / N. Indicates whether Finish Configuration was performed. It might

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

if there were some errors.
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 performed if

there were some errors.

details.
messages to be displayed. See BeginConfiguration Response Message.
Request Message Description: EndConfiguration

Node Description
EndConfiguration_Input Required.
SaveInstanceFlag Save Instance flag

Response Message Description: EndConfiguration

Node Description
EndConfiguration_Output Required.
ListOfQuote Quote instance. See BeginConfiguration Request Message for details.
ProductConfigurator Application Interface


Object Type
Cfg Object Broker Business Service CSSCfgObjBrokerService
ConfiguratorWebChannelBeginConfig Workflow Not applicable

ConfiguratorWebChannelUpdateConfig Workflow Not applicable
ConfiguratorWebChannelEndConfig Workflow Not applicable

CfgInteractData ListOfData
CfgInteractRequest ListOfRequest
CfgInteractStatus ListOfStatus
CfgLinkedItems ListOfLinkedItems
PDS Quote ListOfQuote

Methods
Operation Method
GetCfgObjectStructure GetObjStructure
GetCfgObjectGroupItems GetObjGroupItems
GetCfgObjectDefaultGroupItems GetObjDefaultGroupItems
Example Package for ProductConfigurator

Request (GetObjDefaultGroupItems)
...\80_WSDL_XML\ProductConfigurator\GetObjDefaultGroupItems_request.xml
Response (GetObjDefaultGroupItems)
...\80_WSDL_XML\ProductConfigurator\GetObjDefaultGroupItems_response.xml
Request (GetObjGroupItems)
...\80_WSDL_XML\ProductConfigurator\GetObjGroupItems_request.xml
Response (GetObjGroupItems)
...\80_WSDL_XML\ProductConfigurator\GetObjGroupItems_response.xml
Request (GetObjStructure)
...\80_WSDL_XML\ProductConfigurator\GetObjStructure_request.xml
Response (GetObjStructure)
...\80_WSDL_XML\ProductConfigurator\GetObjStructure_response.xml
Message Schema (WSDL) for ProductConfigurator

...\80_WSDL_XML\ProductConfigurator\ProductConfigurator.wsdl

Siebel 8.0 Primary Web Services ProductRecommendation
ProductRecommendation
Use this Web service to generate the Recommended Products, based on the input Quote line items.
ProductRecommendation Operations
Name Description
GetRecommendedProductsForQuote Generate Recommended Products
Request Message Description: GetRecommendedProductsForQuote

Node Description
QuoteIO Required. An instance of the Integration Object "PDS Quote". 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

PDS Quote Variable Name How It Is Used
(Quote) Mapping (Map to Internal
XML Name Variable Map)
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)
PDS Quote
(Quote Line
Item) XML Name Variable Name How It Is Used
Product (used as a key to find the recommended

ProductId Product Id products)

Response Message Description: GetRecommendedProductsForQuote

Node Description
RecommendedProductIO An instance of IO "Recommended Products". It contains the product

information, pricing, eligibility, and recommended reason and score.

Name Boundary Object Type Class (If BusService)
Web Channel Product Recommendation Workflow Not applicable

Driver Workflow

Recommended Products Recommended Products
Example Package for ProductRecommendation

Request
...\80_WSDL_XML\ProductRecommendation\ProductRecommendation_request.xml
Response
...\80_WSDL_XML\ProductRecommendation\ProductRecommendation_response.xml

Message Schema (WSDL) for ProductRecommendation

...\80_WSDL_XML\ProductRecommendation\ProductRecommendation.wsdl

Siebel 8.0 Primary Web Services PromotionWebService
PromotionWebService
Use this Web service to get product promotion information, apply product promotion.
PromotionWebService Operations
Name Description
ISS_spcPromotion_spcWS_spc-_spcGetProductPromotionDetails Get
Promotion
Details
Request: spcGetProductPromotionDetails_GetProductPromotionDefinition_Input information
Response:spcGetProductPromotionDetails_GetProductPromotionDefinition_Output
ISS_spcPromotion_spcWS_spc-_spcApplyProductPromotion Apply
Product
Promotion
Request: spcApplyProductPromotion_ApplyProductPromotion_Input
Response: spcApplyProductPromotion_ApplyProductPromotion_Output

Request Message Description: GetProductPromotionDefinition

Node Description
EligibilityMode Optional, default value as 2. Could be 0, 1, 2
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
Context Required, in SiebelMessage format of IO PDS Catalog Context
ProdPromRuleType Optional, Product or Pricing
ProdPromId Optional, depending on usage scenarios
ProdPromRuleId Optional, depending on usage scenarios
ApplyProductPromotion
ProdPromId Required
ProdPromInstanceId Optional, depending on usage scenarios
LineItemId Optional, depending on usage scenarios
SiebelMessage Required, in SiebelMessage format of IO PDS Quote
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 Error Code if error occurred
Err_spcMessage Error Message if error occurred.

Request Message Description: ApplyProductPromotion

Node Description
ProdPromId Required
ProdPromInstanceId Optional, depending on usage scenarios
LineItemId Optional, depending on usage scenarios
Response Message Description: ApplyProductPromotion

Node Description
Err_spcCode Error Code if error occurred.
Err_spcMessage Error Message if error occurred.
Application Objects
Workflow
ISS Promotion WS - GetProductPromotionDetails Workflow Not

applicabl
e
ISS Promotion WS - ApplyProductPromotion Workflow Not

applicabl
e
ISS Promotion WS - Add Missed Items Sub Process Workflow Not

applicabl
e

Integration Object
ISS Promotion Definition for WS ISS Promotion Definition for WS
PDS Catalog Context PDS Catalog Context
PDS Product Interface PDS Product Interface
PDS Quote PDS Quote
Example Package for PromotionWebService

Request
...\80_WSDL_XML\PromotionWebService\PromotionWebService_request.xml
Message Schema (WSDL) for PromotionWebService

...\80_WSDL_XML\PromotionWebService\PromotionWebService.wsdl

Siebel 8.0 Primary Web Services QuoteWebService and OrderWebService
QuoteWebService and OrderWebService

Use this set of Web services to manipulate the Quote or Order data.
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
Get Quote Queries the quote
Get Order Queries an order
Request Message Description: Query, Update, Delete Quote

QueryByExample/QueryById/InsertQuote/DeleteQuote Request Message
Node Description

Response Message Description: Query, Update, Delete, Quote

QueryByExample/QueryById/InsertQuote/DeleteQuote Response Message
Node Description
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

QueryByExample/UpdateQuoteItem/InsertQuoteItem/DeleteQuoteItem Response
Message
Node Description
QuoteItemIO Required. An instance of the Integration Object "PDS Quote Item".
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

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

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

QueryByExample/UpdateOrderItem/InsertOrderItem/DeleteOrderItem Response
Message
Node Description
OrderItemIO Required. An instance of the Integration Object "PDS Order Item".
QuoteWebService and OrderWebService Application Interface


PDS Quote BusService CSSEAIDataSyncService
PDS Quote Item BusService CSSEAIDataSyncService
PDS Order BusService CSSEAIDataSyncService
PDS Order Item BusService CSSEAIDataSyncService

PDS Quote Item PDS Simplified Quote
PDS Order PDS Simplified Order
PDS Order Item PDS Simplified Order

Example Package for QuoteWebService

Request
...\80_WSDL_XML\Quote_and_Order\QuoteWebService_request.xml
Response
...\80_WSDL_XML\Quote_and_Order\QuoteWebService_response.xml
Message Schema (WSDL) for QuoteWebService

...\80_WSDL_XML\Quote_and_Order\QuoteWebService.wsdl

Siebel 8.0 Primary Web Services QuoteAddItemsWS
QuoteAddItemsWS
Use this Web service to add the default instance (products) to the Quote Object.
QuoteAddItemsWS Operations
Name Description
QuoteAddItems Add quote line items.
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. It is not required. 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

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.
QuoteAddItems Application Interface


Siebel 8.0 Primary Web Services QuoteAddItemsWS

Object Type
Web Channel Quote Add Default Items Workflow Not applicable

Added Products None (XML)
Example Package for QuoteAddItems

Request
...\80_WSDL_XML\QuoteAddItemsWS\QuoteAddItemsWS_request.xml
Response
...\80_WSDL_XML\QuoteAddItemsWS\QuoteAddItemsWS_response.xml
Message Schema (WSDL) for QuoteAddItems

...\80_WSDL_XML\QuoteAddItemsWS\http___siebel.com_OrderManagement_Quote_QuoteAddItems
WS.wsdl

Siebel 8.0 Primary Web Services SerializationService
SerializationService
...\80_WSDL_XML\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.
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.

Same as Request Message format.
ServiceRequest Application Objects

This section describes the application objects called by the Service Request Web service. For more
Business Service
Service Request Business Service CSSEAIUIDataService
Integration Object
Service Request Service Request
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


Request
...\80_WSDL_XML\ServiceRequest\ServiceRequest_request.xml
Response
...\80_WSDL_XML\ServiceRequest\ServiceRequest_response.xml
Message Schema (WSDL) for ServiceRequest

...\80_WSDL_XML\ServiceRequest\ServiceRequest.wsdl

SessionAccessWS
...\80_WSDL_XML\SessionAccessWS\SessionAccessWS.wsdl

Siebel 8.0 Primary Web Services SetAllocatedExpenseItem
SetAllocatedExpenseItem
Use this Web service to set the allocation data for a specific expense item record. This functionality is
specific for allocating expenses for Marketing Compliance in ePharma.
SetAllocatedExpenseItem Operations
Because of the nature of the schema generation for the WSDL file, the message formats for each
operation have their own message names.
Name Description
LSMCSetAllocatedExpenseItemSynchronize Set the allocation data for an expense item.


LSMCSetAllocatedExpenseItemSynchronize
The Node column represents a respective Siebel field if not specified otherwise.
Node Parent Node Description
<ListOfLSMCSetAllocatedExpenseItem> <Tag>
<ExpenseItem ...> ListOfLSMCSetAllocatedExpenseItem <Tag>
<ExpenseItem> ExpenseItem ... <Tag>
<Id> ExpenseItem
<LSMCAllocationDate> ExpenseItem Optional
<LSMCAllocationStatusCode> ExpenseItem Optional
<LSMCComplianceFlag> ExpenseItem Optional
<ListOfLSMCContactExpenseItem> ExpenseItem <Tag>
<LSMCContactExpenseItem ...> ListOfLSMCContactExpenseItem <Tag>
<LSMCContactExpenseItem> LSMCContactExpenseItem <Tag>
<Id> LSMCContactExpenseItem Required
<ListOfLSMCContactExpenseItemAllocation> LSMCContactExpenseItem <Tag>
<LSMCContactExpenseItemAllocation ...> ListOfLSMCContactExpenseItemAllocation <Tag>
<LSMCContactExpenseItemAllocation> LSMCContactExpenseItemAllocation <Tag>
<ExpenseItemContactId> LSMCContactExpenseItemAllocation Required
<ReportingState> LSMCContactExpenseItemAllocation Required
<Description> LSMCContactExpenseItemAllocation Optional
<AllocatedAmount> LSMCContactExpenseItemAllocation Required

See example.

SetAllocatedExpenseItem Application Interface

This section describes the application objects called by this Web service.
For more information on application implementation, refer to application development documentation.

LSMCSetAllocatedExpenseItem Business Service CSSEAIDataSyncService

LSMCSetAllocatedExpenseItem LSMCSetAllocatedExpenseItem
Methods
Operation Method
LSMCSetAllocatedExpenseItemSynchronize Synchronize
Example Package for SetAllocatedExpenseItem

Request
...\80_WSDL_XML\SetAllocatedExpenseItem\SetAllocatedExpenseItem_request.xml
Response
...\80_WSDL_XML\SetAllocatedExpenseItem\SetAllocatedExpenseItem_response.xml

Message Schema (WSDL) for SetAllocatedExpenseItem

...\80_WSDL_XML\SetAllocatedExpenseItem\SetAllocatedExpenseItem.wsdl

Siebel 8.0 Primary Web Services SFA_Activity_BS
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.
Name Description
SFAInsertActivity Creates an activity record in the database and associates a contact record to it.
Response Message Description: SFAInsertActivity

Node Description
SFA_Activity_IO Required
Response Message Description: SFAInsertActivity

Node Description
SFA_Activity_IO Required
SFA_Activity_BS Application Interface


SFAActivity_BS Business Service CSSEAIUIDataService

Siebel 8.0 Primary Web Services SFA_Activity_BS

Siebel Repository Name Boundary Object Type External Name
SFA_Activity_IO Siebel Business Object Action
Methods
Operation Method
Insert Insert
Example Package for SFA_Activity_BS

Request
...\80_WSDL_XML\SFA_Activity_BS\SFA_Activity_BS_request.xml
Response
...\80_WSDL_XML\SFA_Activity_BS\SFA_Activity_BS_response.xml
Message Schema (WSDL) for SFA_Activity_BS

...\80_WSDL_XML\SFA_Activity_BS\SFA_Activity_BS.wsdl

Siebel 8.0 Primary Web Services SiebelUserProfileService
SiebelUserProfileService
...\80_WSDL_XML\SiebelUserProfileService\SiebelUserProfileService.wsdl
...\80_WSDL_XML\SiebelWebRegistration\SiebelWebRegistration.wsdl

Siebel 8.0 Primary Web Services TroubleTicket
TroubleTicket
Use this Web service to create, update, retrieve and set status for trouble tickets.
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.

This Web service has four operations. Each operation does not share a common response message
format.

Trouble Ticket Business Service CSSEAIDataSyncService
Trouble Ticket Lightweight Business Service CSSEAIDataSyncService

Siebel 8.0 Primary Web Services TroubleTicket

Siebel Repository Name External Name Business Service
WS Trouble Ticket Service Request Trouble Ticket
WS Trouble Ticket Lightweight FINS eBanking Trouble Ticket Lightweight
Methods
Operation Business Service Method
CreateTroubleTicket Trouble Ticket Insert
UpdateTroubleTicket Trouble Ticket Update
GetTroubleTicket Trouble Ticket QueryByExample
SetTroubleTicketStatus Trouble Ticket Lightweight Update
Example Package for TroubleTicket

Request
...\80_WSDL_XML\TroubleTicket\TroubleTicket_request.xml
Response
...\80_WSDL_XML\TroubleTicket\TroubleTicket_response.xml
Message Schema (WSDL) for TroubleTicket

...\80_WSDL_XML\TroubleTicket\TroubleTicket.wsdl

Siebel 8.0 Primary Web Services VerifyEntitlement
VerifyEntitlement
Use this Web service to obtain the best response time for Service Requests based on customer
entitlements.
VerifyEntitlement Operations
Name Description
Verifies customer entitlements at time of service

FSVerifyEntitlementRunProcess
request creation to ensure fastest response
time.
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

Node Description
Commit_spcTime Commit Time for the SR
Entitlement_spcId Entitlement Id that was used
Entitlement_spcName Entitlement name that was used

Siebel 8.0 Primary Web Services VerifyEntitlement
VerifyEntitlement Application Interface


FS Verify Entitlement Workflow Not applicable
Methods
Operation Method
FSVerifyEntitlementRunProcess [WF: FS Verify Entitlement].[RunProcess]
Example Package for VerifyEntitlement

Request
...\80_WSDL_XML\VerifyEntitlement\VerifyEntitlement_request.xml
Response
...\80_WSDL_XML\VerifyEntitlement\VerifyEntitlement_response.xml
Message Schema (WSDL) for VerifyEntitlement

...\80_WSDL_XML\VerifyEntitlement\VerifyEntitlement.wsdl

Siebel 8.0 Primary Web Services Warranty
Warranty
...\80_WSDL_XML\Warranty\CreateWarranty.wsdl
...\80_WSDL_XML\Warranty\CheckWarranty.wsdl
WC_Account_BS
...\80_WSDL_XML\WC_Account_BS\WC_Account_BS.wsdl
WC_Contacts_BS
...\80_WSDL_XML\WC_Contacts_BS\WC_Contacts_BS.wsdl
WC_Opportunity_BS
...\80_WSDL_XML\WC_Opportunity_BS\WC_Opportunity_BS.wsdl
WC_Service_Request_BS
...\80_WSDL_XML\WC_Service_Request_BS\WC_Service_Request_BS.wsdl

Siebel 8.0 Primary Web Services WebMarketing
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
Name Description
CreateWebMarketingResponse Create response records to track click events.
GetActiveLists Retrieve a list of all active subscription lists.
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

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

Node Description
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
Summary Summary
Treatment Id Required. Row Id of Offer Treatment
Response Message Description: CreateWebMarketingResponse

Node Description
Same as request message Not applicable
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

Node Description
Same as request Not applicable

message

Request Message Description: GetListMembers

Node Description
List Members Required.
Contact Id Row Id of Contact.
List Id Row Id of Subscription List
List Name Name of Subscription List
Prospect Id Row Id of Prospect
Response Message Description: GetListMembers

Node Description
Same as request message Not applicable
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

Node Description
WebTreatment Required.
Active For Inbound Flag Flag indicate if the Web treatment is inbound
Description Description of the response
Id Row Id of Web Treatment
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
Lit Id Row Id of Treatment Template
Personalized Content Personalized Content of Web treatment
Related Web Surveys
Id Row Id of Web Survey
Name Name of Web Survey
Related Products
Product Id Row Id of Product
Product Name of Product
Related Events
Id Row Id of Event
Name Name of Event
WebMarketing Application Interface


WebMarketingService Business Service CSSWebMarketingService

Response Response
SubscriptionList Subscription
SubscriptionListMember Subscription

GetWebTreatment
GetWebTreatmentResponse Offer
Methods
Operation Method
CreateWebMarketingResponse [BS: WebMarketingService].[CreateResponse]
GetActiveLists [BS: WebMarketingService].[GetActiveLists]
GetListMembers [BS: WebMarketingService].[GetListMembers]
GetWebTreatment [BS: WebMarketingService].[GetWebTreatment]
Example Package for WebMarketing

Request
...\80_WSDL_XML\WebMarketing\WebMarketing_request.xml
Response
...\80_WSDL_XML\WebMarketing\WebMarketing_response.xml
Message Schema (WSDL) for WebMarketing

...\80_WSDL_XML\WebMarketing\WebMarketing.wsdl

CRMWeb

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

CRMWeb

Enviado por

Direitos autorais:

Formatos disponíveis

For Oracle internal distribution only

Siebel CRM Web Services

Copyright 2005, 2008, Oracle. All rights reserved.

1 Whats New in this Release

2 About This Reference Guide

3 Siebel CRM Web Services Overview

Web Service as a Server-Side Service 24

About Web Services Description Language (WSDL) 24

About XML and XML Schema 25

About Simple Object Access Protocol (SOAP) 25

Inbound and Outbound Web Services 27

Determine Which Siebel Objects to Expose 30

Assemble the Services 31

Exposing a Business Service as a Web Service 32

Exposing a Workflow as a Web Service 33

4 Siebel 8.1 Primary Web Services

8.1 ABOWebService Operations 41

Example Package for ABOWebService 47

Message Schema (WSDL) for ABOWebservice 48

8.1 CatalogWebService Operations 49

Example Package for Siebel 8.1 CatalogWebService 52

Message Schema (WSDL) for Siebel 8.1 CatalogWebService 53

8.1 Product Configurator Web Service Operations 54

Example Package for ProductConfigurator 67

Message Schema (WSDL) for ProductConfigurator 68

8.1 PromotionWebService Operations 69

Example Package for 8.1 PromotionWebService 73

Message Schema (WSDL) for 8.1 PromotionWebService 74

8.1 WebMarketing Operations 75

WebMarketing Application Objects 78

Example Package for WebMarketing 78

Message Schema (WSDL) for WebMarketing 80

Example Package for Account 82

Message Schema (WSDL) for Account 83

Example Package for AssetManagementComplex 87

Message Schema (WSDL) for AssetManagementComplex 87

Contact Application Objects 89

Example Package for Contact 89

Message Schema (WSDL) for Contact 90

Example Package for GetMktgWebSurvey 92

Message Schema (WSDL) for GetMktgWebSurvey 92

Lead Processing Service Operations 93

LeadProcessingService Application Objects 95

Example Package for Lead Processing Service 96

Message Schema (WSDL) for Lead Processing Service 97

LeadService Application Objects 101

Example Package for LeadService 101

Message Schema (WSDL) for LeadService 103

List Operations 104

List Application Objects 105

Example Package for List 106

Message Schema (WSDL) for List 106

Example Package for ListMgmtProspect 108

Message Schema (WSDL) for ListMgmtProspect 108

LoyaltyAccrualService Operations 109

Example of Package for LoyaltyAccrualService 111

Message Schema (WSDL) for LoyaltyAccrualService 112

LoyaltyMemberService Operations 114

Example Package for LoyaltyMemberServices 129

Message Schema (WSDL) for LoyaltyMemberServices 131

LoyaltyRedemptionService Operations 132

Example Packages for LoyaltyRedemptionService 142

Message Schema (WSDL) for LoyaltyRedemptionService 146

LoyaltyVoucherService Operations 147