Siebel CRM Primary Web Services (A-L)

This chapter includes detailed descriptions and information about Siebel Web services.

Note: This guide describes Web services supported by Siebel CRM, version 8.1 and later. For information on Siebel Web Services earlier than version 8.1, see Siebel CRM Web Services Reference, version 8.0 on Oracle Technology Network.

Web services described in this chapter include the following:

ABOWebService

Note: This version of ABOWebService is available only for implementations of Siebel CRM from version 8.1 and later. To use ABOWebService with Siebel CRM version 8.0, see version 8.0 of Siebel CRM Web Services Reference.

Use this Web service to make available 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 the Web service operates on the account profile. If AccountId is not provided, then it operates on the contact profile.

Affixing ToQuote in the Web service name means: if an active quote is provided, then the Web service adds the quote item to the existing quote. If an active quote is not provided, then the Web service generates a new quote and adds the quote item to the new quote.

Affixing ToOrder in the Web service name means: if an active order is provided, then the Web service adds the order item to the existing order. If an active order is not provided, then the Web service generates a new order and adds the order item to the new order. For a list of operations associated with this Web service, see the following table.

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 a Service Item asset, and generates a quote item to update the selected asset.
ModifyAssetToOrder	Modifies a Service Item asset, and generates an order item to update the selected asset.
DisconnectAssetToQuote	Disconnects a Service Item asset to generate a quote item to deactivate the selected asset.
DisconnectAssetToOrder	Disconnects a Service Item asset, and generates an order item to deactivate the selected asset.
SuspendAssetToQuote	Suspends an active a Service Item asset to generate a quote item to suspend the selected asset.
SuspendAssetToOrder	Suspends a Service Item asset and generates an order item to suspend the selected asset.
ResumeAssetToQuote	Resumes a suspended a Service Item asset to generate a quote item to resume the selected asset.
ResumeAssetToOrder	Resumes a Service Item asset, and generates an order item to resume the selected asset.

Request Message Description: AutoOrder

The following Web service operations AutoOrder, SubmitOrder, ModifyAssetToOrder, SuspendAssetToOrder, ResumeAssetToOrder, and DisconnectAssetToOrder share a common output message format: PDS Order.

ModifyAssetToOrder, SuspendAssetToOrder, ResumeAssetToOrder, DisconnectAssetToOrder share a common request message format.

ModifyAssetToQuote, SuspendAssetToQuote, ResumeAssetToQuote and DisconnectAssetToQuote share a common request message format, and a common response message format, PDS Quote.

For a description of this request message, see the following table.

Node	Description
Object Id	Required. Row ID of the quote to be converted to the Sale Order.
Skip Query Order	Allows the calling application to skip querying the modified or new Order back to the calling Web service after the Auto Order operation is performed.

Response Message Description: AutoOrder

The integration object message format is PDS Order. For a description of this response message, see the following table.

Node	Description
PDS Order	Instance of the integration object PDS Order.
Header	Order Header.
Line Item	Order Line Items.
XA	Order Line Item attributes.

Request Message Description: SubmitOrder

For a description of this request message, see the following table.

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

For a description of this request message, see the following table.

Node	Description
Object Id	Required. RowId of the corresponding Order that contains the Order Line Item to be converted or applied to an asset.
LineItemId	Required. RowId of an Order Line Item to be converted or applied to an asset.

Response Message Description: AutoAsset

This integration object message format is PDS Asset. For a description of this response message, see the following table.

Node	Description
PDS Asset	Required. Integration object.
Header	Asset header.
Line Item	Asset
XA	Asset attributes

For a description of this request message, see the following table.

Node	Description
AssetIntegrationId	Asset integration ID of the selected asset. Provide either AssetIntegrationId or AssetNumber.
AssetNumber	Asset integration ID of the selected asset. Provide either AssetIntegrationId or AssetNumber.
ActiveDocumentId	A document in SiebelOrder Management which refers to either a quote or an order. Each Document can have multiple children, that is Quote Items, or Order Line Items. ActiveDocumentId refers to the current active Document that the current process is working on. In this Web service call, it is the Quote ID of the active Quote to which the generated quote item has to be added. This is an optional input.
AccountId	Account ID of the account that owns the selected Service Item asset.
ContactId	Contact ID of the contact who owns the selected Service Item asset 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.
PriceOnSync	Passed down to the sub-process SIS OM Edit Complex Asset Workflow to the step SIS OM PMT Service 'Synchronize' step to trigger a reprice if necessary.

The integration object message format is PDS Quote. For a description of this response message, see the following table.

Node	Description
PDS Quote	Required. Integration object.
Header	Quote header.
Line Item	Quote line item.
XA	Quote line item attributes.

For a description of this request message, see the following table.

Node	Description
AssetIntegrationId	Asset integration ID of the selected asset. Provide either AssetIntegrationId or AssetNumber.
AssetNumber	Asset integration ID of the selected asset. Provide either AssetIntegrationId or AssetNumber.
ActiveDocumentId	A document in Siebel Order Management which refers to either a quote or an order. Each Document can have multiple children, which are Quote Items or Order Line Items. ActiveDocumentId refers to the current active document that the current process is working on. In this Web service call, it is the Quote ID of the active Quote to which the generated quote item has to be added. This is an optional input.
AccountId	Account ID of the account that owns the selected Service Item asset.
ContactId	Contact ID of the contact who owns the selected Service Item asset to be modified.
DueDate	The due date of the generated line item.
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.

Integration object message format: PDS Order, which has the same format as the AutoOrder response message.

Request Message Description: SuspendAssetToQuote

This is the same request message as ModifyAssetToQuote.

Response Message Description: SuspendAssetToQuote

Integration object message format: PDS Quote.

Request Message Description: SuspendAssetToOrder

This is the same request message as ModifyAssetToOrder.

Response Message Description: SuspendAssetToOrder

Integration object message format: PDS Order.

Request Message Description: ResumeAssetToQuote

This is the same request message as ModifyAssetToQuote.

Response Message Description: ResumeAssetToQuote

Integration object message format: PDS Quote.

Request Message Description: ResumeAssetToOrder

This is the same request message as ModifyAssetToOrder.

Response Message Description: ResumeAssetToOrder

Integration object message format: PDS Order.

Request Message Description: DisconnectAssetToQuote

This is the same request message as ModifyAssetToQuote.

Integration object message format: PDS Quote.

This is the same request message as ModifyAssetToOrder.

Integration object message format: PDS Order.

ABOWebService Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

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

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
PDS Quote	PDS Quote
PDS Order	PDS Order
PDS Asset	PDS Asset

Example Package for ABOWebService

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

Request (Auto Order)

See the following file to view the sample code:

...\ABOWebService\AutoOrder_request.xml

Response (AutoOrder)

See the following file to view the sample code:

...\ABOWebService\AutoOrder_response.xml

Request (ModifyAssetToQuote)

See the following file to view the sample code:

...\ABOWebService\ModifyAssetToQuote_request.xml

Response (ModifyAssetToQuote)

See the following file to view the sample code:

...\ABOWebService\ModifyAssetToQuote_response.xml

Request (AutoAsset)

See the following file to view the sample code:

...\ABOWebService\AutoAsset_request.xml

Response (AutoAsset)

See the following file to view the sample code:

...\ABOWebService\AutoAsset_response.xml

Interface Description (WSDL) for ABOWebService

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

...\ABOWebService\ABOWebService.wsdl

Account

Use this Web service for the basic Siebel Marketing operations such as creating and updating accounts.

Account Operations

There are two operations associated with this Web service which allow you to create and update accounts in Marketing. For a list of operations associated with this Web service, see the following table.

Name	Description
AccountCreateAccount	Creates an account.
AccountUpdateAccount	Updates an existing account.

Request Message Description: AccountCreateAccount

For a description of this request message, see the following table.

Node	Description	Type
Account IO	Required. An instance of the integration object Account. Account is the Parent header and Account_BusinessAddress is the child.	Integration Object

Response Message Description: AccountCreateAccount

For a description of this response message, see the following table.

Node	Description	Type
Account Id	The new Account ID generated as a result of the new account creation.	String
Error Message	Error message if any.	String
Success Flag	Flag to indicate success or failure of the operation.	String

Request Message Description: AccountUpdateAccount

For a description of this request message, see the following table.

Node	Description	Type
Account IO	Required. An instance of the integration object Account. Account is the Parent header and Account_BusinessAddress is the child.	Integration Object

Response Message Description: AccountUpdateAccount

For a description of this response message, see the following table.

Node	Description	Type
Error Message	Error message if any.	String
Success Flag	Flag to indicate success or failure of the operation.	String

Account Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type
Account	Business Service

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
Account IO	Account IO

Example Package for Account

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

Request (AccountCreate)

See the following file to view the sample code:

...\Account\AccountCreate_request.xml

Response (AccountCreate)

See the following file to view the sample code:

...\Account\AccountCreate_response.xml

Request (AccountUpdate)

See the following file to view the sample code:

...\Account\AccountUpdate_request.xml

Response (AccountUpdate)

See the following file to view the sample code:

...\Account\AccountUpdate_response.xml

Interface Description (WSDL) for Account

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\Account\Account.wsdl

AccountBalanceSiebelCommsReqABCS

Use this outbound Web service to query for account balance details in Oracle Communications Bill and Revenue Management and display it in the Billing view in Siebel Communications.

AccountBalanceSiebelCommsReqABCS Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
QueryBalanceSummary	Queries the balance summary for the billing profile in the Billing view in Siebel Communications.
QueryBalanceGroupList	Queries the balance group list for the billing profile in the Billing view in Siebel Communications.
QueryBalanceDetails	Queries the balance details for the billing profile in the Billing view in Siebel Communications.
QueryBalanceGroupServices	Queries the balance group services for the billing profile in the Billing view in Siebel Communications.

Request Message Description: QueryBalanceSummary

For a description of this request message, see the following table.

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
QueryBalanceSummaryReqMsg:ListOfCmuRequestBillingProfileIo	Optional	Integration Object

Response Message Description: QueryBalanceSummary

For a description of this response message, see the following table.

Node	Description	Type
QueryBalanceSummaryRespMsg:ListOfCmuBalanceSummaryResponseIo	Optional	Integration Object
SiebelFaultMsg:Fault	Optional	Integration Object

Request Message Description: QueryBalanceGroupList

For a description of this request message, see the following table.

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
QueryBalanceGroupListReqMsg:ListOfCmuRequestBillingProfileIo	Optional	Integration Object

Response Message Description: QueryBalanceGroupList

For a description of this response message, see the following table.

Node	Description	Type
QueryBalanceGroupListRespMsg:ListOfSwiBalanceGroupIoRes	Optional	Integration Object
SiebelFaultMsg:Fault	Optional	Integration Object

Request Message Description: QueryBalanceDetails

For a description of this request message, see the following table.

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
QueryBalanceDetailsReqMsg:ListOfSwiBillingGroupDetailIoReq	Optional	Integration Object

For a description of this response message, see the following table.

Node	Description	Type
QueryBalanceDetailsRespMsg:ListOfSwiBillingGroupDetailIoRes	Optional	Integration Object
SiebelFaultMsg:Fault	Optional	Integration Object

For a description of this request message, see the following table.

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
QueryBalanceGroupServicesReqMsg:ListOfSwiBillingGroupDetailIoReq	Optional	Integration Object

For a description of this response message, see the following table.

Node	Description	Type
QueryBalanceGroupServicesRespMsg:ListOfSwiBalanceGroupServicesIoRes	Optional	Integration Object
SiebelFaultMsg:Fault	Optional	Integration Object

AccountBalanceSiebelCommsReqABCS Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
AccountBalanceSiebelCommsReqABCS	Business Service	CSSWSOutboundDispatcher

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
SWIBalanceGroupServicesIORes	Account
SWIBillingGroupDetailIOReq	Account
CMU Request Billing Profile IO	Account
CMU Balance Summary Response IO	Account
SWIBalanceGroupIORes	Account
SWIBillingGroupDetailIORes	Account
Fault	Fault

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
QueryBalanceSummary	QueryBalanceSummary
QueryBalanceGroupList	QueryBalanceGroupList
QueryBalanceDetails	QueryBalanceDetails
QueryBalanceGroupServices	QueryBalanceGroupServices

Example Package for AccountBalanceSiebelCommsReqABCS

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

Request

See the following file to view the sample code:

...\AccountBalanceSiebelCommsReqABCS\Request

Response

See the following file to view the sample code:

...\AccountBalanceSiebelCommsReqABCS\Response

Interface Description (WSDL) for AccountBalanceSiebelCommsReqABCS

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\AccountBalanceSiebelCommsReqABCS\WSDL

AdjustmentSiebelCommsReqABCS

Use this outbound Web service to query for adjustments made to a bill in the external Oracle Communications Billing and Revenue Management application that will be displayed in the Billing view in Siebel Communications.

AdjustmentSiebelCommsReqABCS Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
QueryAdjustment	Queries the adjustment details in the Billing view in Siebel Communications.
CreateAdjustment	Creates adjustments. (currently not used.)

Request Message Description: QueryAdjustment

For a description of this request message, see the following table.

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
QueryAdjustmentReqMsg:ListOfCmuRequestBilledUsageIo	Optional	Integration Object

Response Message Description: QueryAdjustment

For a description of this response message, see the following table.

Node	Description	Type
QueryAdjustmentRespMsg:ListOfCmuResponseBilledUsageArItemsIo	Optional	Integration Object
SiebelFaultMsg:Fault	Optional	Integration Object

Request Message Description: CreateAdjustment

For a description of this request message, see the following table.

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
CreateAdjustmentReqMsg:ListOfCmuRequestAdjustmentIo	Optional	Integration Object

Response Message Description: CreateAdjustment

For a description of this response message, see the following table.

Node	Description	Type
CreateAdjustmentRespMsg:ListOfCmuResponseAdjustmentIo	Optional	Integration Object
SiebelFaultMsg:Fault	Optional	Integration Object

AdjustmentSiebelCommsReqABCS Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
AdjustmentSiebelCommsReqABCS	Business Service	CSSWSOutboundDispatcher

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
CMU Request Billed Usage IO	Account
CMU Response Billed Usage AR Items IO	Account
Fault	Fault

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
QueryAdjustment	QueryAdjustment
CreateAdjustment	CreateAdjustment

Example Package for AdjustmentSiebelCommsReqABCS

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

Request

See the following file to view the sample code:

...\AdjustmentSiebelCommsReqABCS\QueryAdjustmentRequestMessage.xml

Response

See the following file to view the sample code:

...\AdjustmentSiebelCommsReqABCS\QueryAdjustmentResponseMessage.xml

Interface Description (WSDL) for AdjustmentSiebelCommsReqABCS

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\AdjustmentSiebelCommsReqABCS\AdjustmentSiebelCommsReqABCS.wsdl

AssetManagementComplex

To display the detail of a promotion, customizable product, or bundle asset, for example, to display the related products for a promotion, the child items for a customizable product, or bundle asset.

AssetManagementComplex Operations

The following operations are used for the AssetManagementComplex Web service.

For a list of operations associated with this Web service, see the following table.

Name	Description
AssetManagementComplexQueryPageQuoteAddItems	The Web service fetches the details of promotion, customizable product or bundle asset.

Request Message Description: AssetManagementComplexQueryPage

Asset ManagementComplex Web service is called to query for the details of a promotion, customizable product, or bundle asset. Displays the related products for promotion, child items for a customizable product, or bundle asset.

For a description of this request message, see the following table.

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

Response Message Description: AssetManagementComplexQueryPage

For a description of this response message, see the following table.

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

AssetManagementComplex Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
Asset Management - Complex	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
SiebelMessage	SiebelMessage
SiebelMessageIn	SiebelMessage
SiebelMessageOut	SiebelMessageOut

Example Package for AssetManagementComplex

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

Request

See the following file to view the sample code:

...\AssetManagementComplex\AssetManagementComplex_request.xml

Response

See the following file to view the sample code:

...\AssetManagementComplex\AssetManagementComplex_response.xml

Interface Description (WSDL) for AssetManagementComplex

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\AssetManagementComplex\AssetManagementComplex.wsdl

CalculateShippingChargeSalesOrderSiebelReqABCSImpl

Use this Web service to get information about the shipping costs of a sales order.

CalculateShippingChargeSalesOrderSiebelReqABCSImpl Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
CalculateShippingCharge	Retrieves shipping charge information for sales orders.

Request Message Description: CalculateShippingCharge

For a description of this request message, see the following table.

Node	Description	Type
CalculateShippingChargeSalesOrderReqMsg: ListOfSWIOrderIOReq	Optional	Hierarchy
CustomerHeaderContext	Optional	Hierarchy

Response Message Description: CalculateShippingCharge

For a description of this response message, see the following table.

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
CalculateShippingChargeSalesOrderRespMsg: ListOfSWIOrderIOResp	Optional	Hierarchy
XMLHierarchyOutput	Optional	Hierarchy
faultactor	Optional	String
faultcode	Optional	String
faultstring	Optional	String
SiebelFaultMsg:Fault	Optional	Integration Object

CalculateShippingChargeSalesOrderSiebelReqABCSImpl Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Siebel Repository Name	Boundary Object Type	Class
SWISendCalculateShippingCharge	Workflow	Not applicable

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
SWIOrderIO	SWIOrderIO
Fault	Fault

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
CalculateShippingCharge	CalculateShippingCharge

Interface Description (WSDL) for CalculateShippingChargeSalesOrderSiebelReqABCSImpl

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

...\CalculateShippingChargeSalesOrderSiebelReqABCSImpl\CalculateShippingChargeSalesOrderSiebelReqABCSImpl.wsdl

CatalogWebService

Note: This version of CatalogWebService is available only for implementations of Siebel CRM from version 8.1 and later. To use CatalogWebService with Siebel CRM version 8.0, see version 8.0 of Siebel CRM Web Services Reference.

Use this Web service to make available promotional offerings related to products, as well as related products and categories.

CatalogWebService Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
GetRelatedPromotions	Retrieves a list of related promotions.
GetRelatedProducts	Retrieves a list of related products.
GetCategory	Retrieves a flat, non-hierarchical list of categories.
UDSPublishCatalog	Publish a category and product catalog with support of pagination and visibility.

Request Message Description: GetRelatedPromotions

For a description of this request message, see the following table.

Name	Description	Type
PDS Related Promotions Interface	An instance of the integration object PDS Related Promotions Interface.	Integration Object
PricingMode	Y or N (calculates price or not). Optional. The default value is Y.	String
EligibilityMode	0, 1, 2 (eligibility display mode: 0 do not run; 1 run; 2 run but only return eligible products). Optional. The default value is 1.	String
ContextMode	SiebelContext or ExternalContext. Optional. However, you must provide ContextMode to run pricing and eligibility.	String
Context	An instance of the integration object PDS Catalog Context. It either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. If ContextMode is provided, then it is required.	Integration Object

Response Message Description: GetRelatedPromotions

For a description of this response message, see the following table.

Name	Description	Type
PDS Related Promotions Interface	PDS Related Promotions Interface. After running Eligibility and Pricing, the List Price, Net Price, Eligibility status and Eligibility Reason fields will be updated.	Integration Object

Request Message Description: GetRelatedProducts

For a description of this request message, see the following table.

Name	Description	Type
PDS Related Products Interface	An instance of the integration object PDS Related Products Interface.	Integration Object
PricingMode	Y or N (calculates price or not). Optional. The default value is Y.	String
EligibilityMode	0, 1, 2 (eligibility display mode: 0 do not run; 1 run; 2 run but only return eligible products). Optional. The default value is 1.	String
ContextMode	SiebelContext or ExternalContext. Optional. However, provide ContextMode to run pricing and eligibility.	String
Context	An instance of the integration object PDS Catalog Context. The instance either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. If ContextMode is provided, then it is required.	Integration Object

Response Message Description: GetRelatedProducts

For a description of this response message, see the following table.

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

Request Message Description: GetCategory

For a description of this request message, see the following table.

Name	Description	Type
PDS Category Interface Integration Object	An instance of the integration object PDS Category Interface.	Integration Object

For a description of this response message, see the following table.

Name	Description	Type
PDS Category Interface Integration Object	An instance of the integration object PDS Category Interface.	Integration Object

For a description of this request message, see the following table.

Name	Description	Type
SiebelMessageIn	An instance of the integration object PDS UDS Publish Catalog Interface. This is a required input.	Integration Object
PricingMode	Y or N (calculates price or not). Optional. The default value is Y.	String
EligibilityMode	0, 1, 2 (eligibility display mode: 0 do not run; 1 run; 2 run but only return eligible products). Optional. The default value is 1.	String
ContextMode	SiebelContext or ExternalContext. Optional. However, provide ContextMode to run pricing and eligibility.	String
Context	An instance of the integration object PDS Catalog Context. It either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. If ContextMode is provided, then it is required.	Integration Object
LOVLanguageMode	LIC, or LDC.	String
ViewMode	Visibility algorithm used in addition to a search specification to determine which records will be retrieved. Catalog or Organization.	String
NamedSearchSpec	Name of a predefined query.	String

For a description of this response message, see the following table.

Name	Description	Type
SiebelMessageOut	An instance of the integration object PDS UDS Publish Catalog Interface.	Integration Object

CatalogWebService Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
PDS Product Data Service	BusService	CSSProdDataSvc

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
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

Interface Description (WSDL) for Siebel Catalog Web Service

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\CatalogWebService\CatalogWebService.wsdl

CheckATPSalesOrderSiebelReqABCSImpl

Use this Web service to check the availability and location of a requested product.

CheckATPSalesOrderSiebelReqABCSImpl Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
CheckATP	Synchronizes the account.

Request Message Description: CheckATP

For a description of this request message, see the following table.

Node	Description	Type
CheckATPSalesOrderReqMsg:ATPCheck InterfaceRequestOrders	Optional	Hierarchy
CustomHeaderContext	Optional	Hierarchy

Response Message Description: CheckATP

For a description of this response message, see the following table.

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
CheckATPSalesOrderRespMsg:ATPCheck InterfaceResponseOrders	Optional	Hierarchy
XMLHierarchyOutput	Optional	Hierarchy
faultactor	Optional	String
faultcode	Optional	String
faultstring	Optional	String
SiebelFaultMsg:Fault	Optional	Integration Object

CheckATPSalesOrderSiebelReqABCSImpl Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Siebel Repository Name	Boundary Object Type	Class
SWISendATPCheck	Workflow	Not applicable
SWISendATPCheckLine	Workflow	Not applicable

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
SWIOrderIO	SWIOrderIO
Fault	Fault

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
CheckATP	CheckATP

Example Package for CheckATPSalesOrderSiebelReqABCSImpl

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

Interface Description (WSDL) for CheckATPSalesOrderSiebelReqABCSImpl

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

...\CheckATPSalesOrderSiebelReqABCSImpl\CheckATPSalesOrderSiebelReqABCSImpl.wsdl

ClinicalSubject

Use this Web service to perform the following:

Create a subject record in the Siebel database from details provided by an external application. The Screen and Enrollment template is applied to each new record with a default informed consent date, if a date is not provided by the external application. If a valid informed consent date is provided by the external application, then the Web service updates the default value with the valid informed consent date.
Create additional Siebel Life Science statuses for a subject apart from the statuses Screened and Enrolled.
Mark a subject visit as missed.
Override the subject visit completion or missed value.
Create subject statuses using Visit Type.
Delete the subject status.
Designate the latest subject status as Primary.
Designate any record at Primary.
Mark Visits/Activities as completed with the Completed Date details, and other information provided by the external application.
Generate an error when the IntegrationId is not sent in the Web service for Visit Completion.
Use new custom tags: ActCustom1 through ActCustom25 in the Action (No Owner Lock) and SubCustom1 through SubCustom23 on the Clinical Subject integration component.

Note: SubCustom24 and SubCustom25 are reserved for Delete Non Applicable Visits flag and SVT Effective Date.
Use special status values: Randomized Date, Early Terminated Date, Screen Failure Date and Screen Failure Reason.
Mark Visits/Activities as completed with the Completed Date details, and other information provided by the external application.

Note: This Web service assumes that the Visits/Activities Clinical Item is unique for the given Subject Visit Template.
Support Subject Transfer from one Study site to another.

This Web service returns the Integration ID when a subject creation is successful. The Integration ID is used for identifying the subject for any future operations. An error message is presented in the event of an error.

ClinicalSubject Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
Upsert	Creates a Subject record in the Siebel database with the minimum required details, along with performing relevant updates.

Request Message Description: Upsert

For a description of this request message, see the following table.

Node	Description	Type
ClinicalSubject.Comments	Optional.	Character data
ClinicalSubject.DateofBirth	Required.	Date
ClinicalSubject.EarlyTerminatedDate	Optional.	Date
ClinicalSubject.EarlyTerminatedReason	Optional.	Character data
ClinicalSubject.Comments	Optional.	Character data
ClinicalSubject.EligibleFlag	Optional.	Boolean flag
ClinicalSubject.EmailAddress	Optional.	Character data
ClinicalSubject.EnrollmentDate	Optional.	Date
ClinicalSubject.EnrollmentId	Optional.	Character data
ClinicalSubject.FaxNumber	Optional.	Character data
ClinicalSubject.IntegrationId	Optional.	Character data
ClinicalSubject.PhoneNumber	Optional.	Character data
ClinicalSubject.ProtocolDeviation	Optional.	Character data
ClinicalSubject.ProtocolNumber	Optional.	Character data
ClinicalSubject.ProtocolSiteId	Optional.	Character data
ClinicalSubject.ProtocolViolation	Optional.	Character data
ClinicalSubject.RandomizationId	Optional.	Character data
ClinicalSubject.RandomizedDate	Optional.	Date
ClinicalSubject.ReasonExcluded	Optional.	Character data
ClinicalSubject.SDVRequired	Optional.	Character data
ClinicalSubject.ScreenDate	Optional.	Date
ClinicalSubject.ScreenFailureDate	Optional.	Date
ClinicalSubject.SubCustom1 through SubCustom 23	Optional. New custom fields.	Character data
ClinicalSubject.SubCustom24	Optional. Flag to decide deletion of Non Applicable Visits.	Character data
ClinicalSubject.SubCustom25	Optional. SVT Effective Date.	Character data
ClinicalSubject.TransferComments	Optional.	Character data
ClinicalSubject.TransferReason	Optional.	Character data
ClinicalSubject.SubjectInitials	Required.	Character data
ClinicalSubject.WithdrawnDate	Optional.	Boolean
ClinicalSubject.WithdrawnReason	Optional.	Character data
ClinicalSubject_InformedConsent.InformedConsentSignedDate	Optional.	Date
VisitPlan.OverrideStatus	Optional.	Character data
VisitPlan.VisitMissed	Optional.	Boolean
ClinicalSubjectStatus.Comments2	Optional.	Character data
ClinicalSubjectStatus.DeleteFlag	Optional.	Boolean
ClinicalSubjectStatus.Status	Optional.	Character data
ClinicalSubjectStatus.StatusDate	Optional.	Date
ClinicalSubjectStatus.VisitType	Optional.	Character data
ActionNoOwnerLock.ActCustom1 through ActCustom25	Optional. New custom fields.	Character data
ActionNoOwnerLock.Done	Optional.	Date
ActionNoOwnerLock.VisitClinicalItem	Optional.	Character data
ActionNoOwnerLock.ActivityClinicalItem	Optional.	Character data

Response Message Description: Upsert

For a description of this response message, see the following table.

Node	Description	Type
ClinicalSubject.IntegrationId	Required. Returns the process instance ID if the subject creation is successful.	Character data

ClinicalSubject Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Siebel Repository Name	Boundary Object Type	Class
SWI LS Clinical Subject Inbound-Subject	Workflow	Not applicable

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
Clinical Subject External	Clinical Subject

Example Package for ClinicalSubject

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

Request

See the following file to view the sample code:

...\ClinicalSubject\ClinicalSubject_request.xml

Interface Description (WSDL) for ClinicalSubject

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

...\ClinicalSubject\ClinicalSubject_asi_ClinicalSubject.wsdl

CMU Account Query

Use this Web service to find an account detail in the Siebel CRM application. A business service is made available in the Siebel CRM application so that the middle layer can query for the account detail in the Siebel CRM application and synchronize this detail with the billing application.

The account detail that this Web service finds includes details about the contacts, addresses, and billing profiles that are associated with the account. This detail includes only those fields that the billing application needs to synchronize data.

The response message returns only an acknowledgement message and not data.

CMU Account Query Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
CMU Account Query Page	Finds the account detail based on the account ID and the billing profile ID.

Request Message Description: CMU Account Query Page

For a description of this request message, see the following table.

Node	Description
AccountId	The ID of the account for the billing profile.
BillingProfileId	The ID of the billing profile for the account.

CMU Account Query Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class (If Business Service)
CMU Account Query Service	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
CMU Query Account Io	CMU - Account

Methods

For a description of methods for this Web service, see the following table.

Operation	Method
CMU Account QueryPage	[BS: CMU Account Query Service].QueryPage

Example Package for CMU Account Query

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

Request

See the following file to view the sample code:

...\CMUAccountQuery\CMUAccountQuery.xml

Response

See the following file to view the sample code:

...\CMUAccountQuery\CMUAccountQuery.xml

Interface Description (WSDL) for CMU Account Query

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\CMUAccountQuery\CMUAccountQuery.wsdl

CMU Account Update

Use this Web service to update the status of an account in the Siebel CRM application when the status of the account changes in the external billing application. The external billing application makes this inbound Web service call to the Siebel CRM application to update the status of the account. A business service is made available in the Siebel CRM application to update the status field.

The response message returns only an acknowledgement message and not data.

CMU Account Update Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
CMU Account Update	Updates the status of an account in the Siebel CRM application when the status of the account changes in the billing application.

Request Message Description: CMU Account Update

For a description of this request message, see the following table.

Node	Description
AccountId	The ID of the account for the billing profile.
AccountStatus	The status of the account that was updated in the billing application.

CMU Account Update Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class (If Business Service)
CMU Account Update	Business Service	CSSEAIDataSyncService

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
CMU Update Account Io	Account

Methods

For a description of methods for this Web service, see the following table.

Operation	Method
CMU Account Update	[BS: CMU Account Update].Update

Example Package for CMU Account Update

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

Request

See the following file to view the sample code:

...\CMUAccountUpdate\CMUAccountUpdate.xml

Response

See the following file to view the sample code:

...\CMUAccountUpdate\CMUAccountUpdate.xml

Interface Description (WSDL) for Account Update

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\CMUAccountUpdate\CMUAccountUpdate.wsdl

ConfiguratorUserLangSiebelAdapter

This is an Oracle Application Integration Architecture Web service, which is made available by Oracle Application Integration Architecture. This Web service is called from Siebel CRM to get language and other details. Use this outbound Web service to launch Siebel Configurator.

ConfiguratorUserLangSiebelAdapter Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
process	Returns the User, Responsibility ID, and Language values from Oracle E-Business Suite. These values are needed to launch Siebel Configurator and customize a product.

Request Message Description: process

For a description of this request message, see the following table.

Node	Description	Type
ConfiguratorUserLangSiebelAdapterRequest Message:payload	Optional	Hierarchy
CustomHeaderContext	Optional	Hierarchy

Response Message Description: process

For a description of this response message, see the following table.

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
MConfiguratorUserLangSiebelAdapterResponse Message:payload	Optional	Hierarchy
XMLHierarchyOutput	Optional	Hierarchy
faultactor	Optional	String
faultcode	Optional	String
faultstring	Optional	String
MatchContactFaultMsg:payload	Optional	Integration Object

ConfiguratorUserLangSiebelAdapter Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Siebel Repository Name	Boundary Object Type	Class
Oracle Configurator Load	Workflow	Not applicable

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
ConfiguratorUserLangSiebelAdapterProcessRequest	ConfiguratorUserLangSiebelAdapterProcessRequest
ConfiguratorUserLangSiebelAdapterProcessResponse	ConfiguratorUserLangSiebelAdapterProcessResponse

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
process	process

Contact

Use this Web service for the basic operations of Siebel Marketing such as to create and update contacts.

Contact Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
ContactCreateContact	Creates a contact.
ContactUpdateContact	Updates an existing contact.

Request Message Description: ContactCreateContact

For a description of this request message, see the following table.

Node	Description	Type
Contact IO	Required. An instance of the integration object Contact IO. Contact is the Parent header and Contact_BusinessAddress is the child.	Integration Object

Response Message Description: ContactCreateContact

For a description of this response message, see the following table.

Node	Description	Type
Contact Id	The new Contact ID generated as a result of the new contact creation.	String
Error Message	Error Message if any.	String
Success Flag	Flag to indicate success or failure of the operation.	String

Request Message Description: ContactUpdateContact

For a description of this request message, see the following table.

Node	Description	Type
Contact IO	Required. An instance of the integration object Contact IO. Contact is the Parent header and Contact_BusinessAddress is the child.	Integration Object

Response Message Description: ContactUpdateContact

For a description of this response message, see the following table.

Node	Description	Type
Error Message	Error message if any.	String
Success Flag	Flag to indicate success or failure of the operation.	String

Contact Application Interface

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

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
Contact IO	Contact IO

Example Package for Contact

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

Request (ContactCreate)

See the following file to view the sample code:

...\Contact\ContactCreate_request.xml

Response (ContactCreate)

See the following file to view the sample code:

...\Contact\ContactCreate_response.xml

Request (ContactUpdate)

See the following file to view the sample code:

...\Contact\ContactUpdate_request.xml

Response (ContactUpdate)

See the following file to view the sample code:

...\Contact\ContactUpdate_response.xml

Interface Description (WSDL) for Contact

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\Contact\Contact.wsdl

CreateLeads Web Service

Use this Web service to create leads in the Siebel database. If the Web service returns a given contact’s details, and if those details match an existing contact in the Siebel database, then the Web service creates a lead based on the existing contact’s information. If the contact does not exist in the Siebel database, then the Web service creates a new contact record, and creates a new lead from the new contact.

The new lead can be associated with any existing campaign using the Source Code parameter. The Source Code parameter must be retrieved from the ID or Source ID field of the GetCampaigns Web service response. For more information, see GetCampaigns Web Service.

CreateLeads Web Service Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
CreateLeads	Creates a lead with provided details. It performs a deduplication operation on lead details, and if the lead does not match an existing lead, creates a new lead.

Request Message Description: CreateLeads

For a description of this request message, see the following table.

Node	Description	Type
Lead IO	Used to describe leads. Performs a deduplication operation based on information returned from the node. If required a new contact is created.	Integration Object
Mktg Social Data IO	Used to capture social posts data related to a lead. You can associate multiple social posts to the same lead..	Integration Object
Mktg SM Personal Address IO	Extracts a new lead address from social posts.	Integration Object

Response Message Description: CreateLeads

Supplies the success status for Lead creation. It issues an error message (if any) or a lead ID if the lead creation was successful. For a description of this response message, see the following table.

Node

Description

Type

Success Flag

Indicates the status of the CreateLead operation. Status is:

Yes if lead is created properly, then No if not.

String

Error Message

A descriptive error message of the particular issue that occurred during lead creation.

The Duplicate Lead message indicates the operation is attempting to create a leads that is already in the database.

String

Lead ID

The unique ID of the new lead.

String

CreateLeads Web Service Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class (If Business Service)
SocialMediaService	Business Service	CSSSocialService

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LeadIO	ListofLeadIO
MktgSocialDataIO	ListOfMktgSocialDataIO
MktgSMPersonalAddressIO	ListOfMktgSMPersonalAddressIo

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
CreateLeads	CreateLeads

Example Package for CreateLeads Web Service

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

Request

See the following file to view the sample code:

...\CreateLeadsWebService\CreateLeads_req.xml

Response

See the following file to view the sample code:

...\CreateLeadsWebService\CreateLeads_resp.xml

Interface Description (WSDL) for CreateLeads Web Service

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\CreateLeadsWebService\CreateLeads.wsdl

CreditCheckSalesOrderSiebelReqABCSImpl

Use this Web service to verify that the method of payment used in a purchase order is a valid payment type.

CreditCheckSalesOrderSiebelReqABCSImpl Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
CreditCheck	Checks for the method of payment.

Request Message Description: CreditCheck

For a description of this request message, see the following table.

Node	Description	Type
CreditCheckSalesOrderReqMsg:ListOfSWI OrderIOReq	Optional	Hierarchy
CustomHeaderContext	Optional	Hierarchy

Response Message Description: CreditCheck

For a description of this response message, see the following table.

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
CreditCheckSalesOrderRespMsg:ListOfSWI OrderIOResp	Optional	Hierarchy
XMLHierarchyOutput	Optional	Hierarchy
faultactor	Optional	String
faultcode	Optional	String
faultstring	Optional	String
SiebelFaultMsg:Fault	Optional	Integration Object

CreditCheckSalesOrderSiebelReqABCSImpl Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Siebel Repository Name	Boundary Object Type	Class
SWISendCreditCheck	Workflow	Not applicable

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
SWIOrderIO	SWIOrderIO
Fault	Fault

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
CreditCheck	CreditCheck

Example Package for CreditCheckSalesOrderSiebelReqABCSImpl

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

Interface Description (WSDL) for CreditCheckSalesOrderSiebelReqABCSImpl

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

...\CreditCheckSalesOrderSiebelReqABCSImpl\CreditCheckSalesOrderSiebelReqABCSImpl.wsdl

FetchAccountSiebelReqABCSImpl

Use this outbound Web service to synchronize account details with the participating application by fetching the account details from the Siebel database. This Web service is called when the fetch process is triggered in the Siebel application from the Account list, or form applets, and also from the Match Account pop-up applet.

FetchAccountSiebelReqABCSImpl Operations

The following operations are used for the FetchAccountSiebelReqABCSImpl Web service.

For a list of operations associated with this Web service, see the following table.

Name	Description
FetchAccount	This operation is used to import a new account from the participating application to Siebel database tables. It is called from the Match Account pop-up applet by clicking the Fetch button to fetch the queried account details from the participating application.
CustomerPartyIOFetchAccount	Synchronizes a preexisting account from the participating application and imports the record to the Siebel database. The operation is called from the Account list or form applet by clicking the Fetch menu item.
AsyncFetchCustomerPartyResponse	Not in use.

Request Message Description: FetchAccount

For a description of this request message, see the following table.

Node	Description	Type
FetchAccountReqMsg:ListofSwimatchaccountvbcio	Optional	Hierarchy
CustomHeaderContext	Optional	Hierarchy

Response Message Description: FetchAccount

For a description of this response message, see the following table.

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
FetchAccountRespMsg:ListofSwimatchaccountvbcio	Optional	Hierarchy
XMLHierarchyOutput	Optional	Hierarchy
faultactor	Optional	String
faultcode	Optional	String
faultstring	Optional	String
FetchAccountFaultMsg:Fault	Optional	Integration Object

Request Message Description: CustomerPartyIOFetchAccount

For a description of this request message, see the following table.

Node	Description	Type
FetchAccountReqMsg:ListOfSwimatchaccountvbcio	Optional	Hierarchy
CustomHeaderContext	Optional	Hierarchy

Response Message Description: CustomerPartyIOFetchAccount

For a description of this response message, see the following table.

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
CustomerPartyIOFetchAccountRespMsg:ListOfSwicustomerpartyio	Optional	Hierarchy
XMLHierarchyOutput	Optional	Hierarchy
faultactor	Optional	String
faultcode	Optional	String
faultstring	Optional	String
FetchAccountFaultMsg:Fault	Optional	Integration Object

Fetch Account SiebelReqABCSImpl Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Siebel Repository Name	Boundary Object Type	Class
SWI External Account Request Sync Process	Workflow	Not applicable

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
SWIMatchAccountVBCIO	Account
SWICustomerPartyIO	Account
Fault	Fault

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
FetchAccount	FetchAccount
CustomerPartyIOFetchAccount	CustomerPartyIOFetchAccount
AsyncFetchCustomerPartyResponse	AsyncFetchCustomerPartyResponse

Example Package for FetchAccountSiebelReqABCSImpl

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

Interface Description (WSDL) for FetchAccountSiebelReqABCSImpl

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

WSDL

...WSDL\FetchAccountSiebelReqABCSImpl.wsdl

FetchContactSiebelReqABCSImpl

Use this outbound Web service to synchronize contact details with the participating application and the Siebel database. This Web service is called from the Siebel application when the fetch process is called from Contact list or form applets, and also from the Match Contact pop-up applet.

FetchContactSiebelReqABCSImpl Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
FetchContact	Imports a new contact from the participating application to the Siebel database. This operation is called from the Match Contact pop-up applet when a user clicks the Fetch button to fetch the queried contact details from the participating application.
ContactIOFetchContact	Synchronizes a contact from the participating application and imports the record to the Siebel database. This operation is called from the Contact list or form applet by clicking on Fetch menu item to fetch contact details from the participating application.
AsyncFetchCustomerPartyResponse	Not in use.

Request Message Description: FetchContact

Sends queried contact details from the participating application through the Match Contact process to import and synchronize the contact record with Siebel data tables.

For a description of this request message, see the following table.

Node	Description	Type
BirthDate	Contact’s birth date.	String
CellularPhone	Contact’s mobile phone number.	String
ContactId	Row ID of the contact record in Siebel data tables.	String
EmailAddress	Contact’s email address.	String
ExternalContactId	Oracle Application Integration Architecture (AIA) Cross Reference ID for the contact.	String
FirstName	Contact’s first name.	String
HomePhone	Contact’s home phone number.	String
LastName	Contact’s last name.	String
MatchScore	Match score.	String
MiddleName	Contact’s middle name.	String
PrimaryAccountName	Contact’s primary address.	String
PrimaryCity	Contact’s primary city.	String
PrimaryCountry	Contact’s primary country.	String
PrimaryPostalCode	Contact’s primary postal code.	String
PrimaryState	Contact’s primary state.	String
PrimaryStreetAddress	Contact’s primary street address.	String
SocialSecurityNumber	Contact’s social security number.	String
WorkPhone	Contact’s work phone number.	String

Response Message Description: FetchContact

Contains the Siebel ID value of the contact record that is imported into the Siebel data tables. This record is used to refresh and display the imported contact details in the Siebel application.

For a description of this response message, see the following table.

Node	Description	Type
ContactId	Siebel Row ID of the contact record.	String

Request Message Description: ContactIOFetchContact

Sends contact details to the participating application to synchronize the contact with the Siebel database.

For a description of this request message, see the following table.

Node	Description	Type
Id	Contact ID.	String
RowId	Siebel Row ID of the contact record.	String

Response Message Description: ContactIOFetchContact

Contains the Siebel ID value of the contact record that is synchronized with the Siebel database. This record is used to refresh contact details in the Siebel application after synchronizing the contact with the participating application.

For a description of this response message, see the following table.

Node	Description	Type
Id	Contact ID.	String
RowId	Siebel Row ID of the contact record.	String

FetchContactSiebelReqABCSImpl Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Siebel Repository Name	Boundary Object Type	Class
FetchContactSiebelReqABCSImplService	Business Service	CSSWSOutboundDispatcher

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
SWIMatchContactVBCIO	Contact
SWICustomerPartyIO	SWI Contact
Fault	Fault

Interface Description (WSDL) for FetchContactSiebelReqABCSImpl

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

WSDL

...WSDL\FetchContactSiebelReqABCSImpl.wsdl

FS Asset Warranty Service

Use this Web service to create asset warranties and to retrieve asset warranty information.

FS Asset Warranty Service Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
CreateAssetWarranty	Adds the input warranty to the source asset.
GetAssetWarranty	Used to retrieve all the warranties for a specified asset's product and then add them to the asset if not already done so.

Request Message Description: CreateAssetWarranty

Adds a specific warranty to an asset. If that warranty has already been added to the asset record, then the service will update the service date. For a description of this request message, see the following table.

Node	Description	Type
Asset Id	Row ID of asset.	String
Warranty Id	Row ID of the warranty.	String
Serviced Date	Date from which warranty will start displayed in the following format: (mm/dd/yyyy).	Date

Response Message Description: CreateAssetWarranty

For a description of this response message, see the following table.

Node	Description	Type
StatusMsg	(Optional). Will give error message in the case of incompatibility of inputs. If there is no incompatibility, then there will be no message.	String

Request Message Description: GetAssetWarranty

This operation will add all the warranty information associated with an asset. The date depends on the start data type of each warranty. If some of the warranties are already attached to the asset, then the operation adds the other potential warranties, but leaves the existing warranties untouched.

Caution: This operation does not return an error message if the user provides the wrong value for Asset ID.

For a description of this request message, see the following table.

Node	Description	Type
Asset Id	Row ID of asset.	String

Response Message Description: GetAssetWarranty

This Web service has no response message.

FS Asset Warranty Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name

Boundary Object Type

Class

BS: FS Asset Warranty Service

Operation: CreateAssetWarranty

Business Service

CSSFSAssetWrntyService

BS: FS Asset Warranty Service

Operation: GetAssetWarranties

Business Service

CSSFSAssetWrntyService

Example Package for FS Asset Warranty Service

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

Request, Response (CreateAssetWarranty)

See the following file to view the sample code:

...\FSAssetWarranty\CreateAssetWarranty_Sample_IO.doc

Request, Response (GetAssetWarranties)

See the following file to view the sample code:

...\FSAssetWarranty\GetAssetWarranty_Sample_IO.doc

Interface Description (WSDL) for FS Asset Warranty Service

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\FSAssetWarranty\FSAssetWarranty.wsdl

GetCampaigns Web Service

Use this Web service to retrieve campaigns and associated details from Siebel CRM with input parameters. Campaigns are sorted by the following criteria: Type, Subtype, and the Last Name field.

The Source ID parameter in the response message for this Web service is used in conjunction with the Create Leads Web service to associate a newly created lead with an existing campaign. For more information, see CreateLeads Web Service.

GetCampaigns Web Service Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
GetCampaigns	Returns a list of campaigns based on provide input parameters.

Request Message Description: GetCampaigns

For a description of this request message, see the following table.

Node	Description	Type
Campaign Name	Optional. The campaign name. Restricts results by campaign name. For example, passing a value of 2002 will return all campaigns that have 2002 in the name.	String
Start Date	Optional. Returns a list of campaigns having a start date greater or equal to a given value.	String
End Date	Optional. Returns a list of campaigns having a start date less than or equal to a given value.	String
Page Number	Required. Determines the number of records retrieved by a response. It must be a value greater than zero.	String
Row Number	Optional. Retrieves the Page Number value of campaigns. It must be a value greater than zero.	String
Source Code	The row ID of the campaign you want to retrieve.	String

Response Message Description: GetCampaigns

For a description of this response message, see the following table.

Node	Description	Type
MKTG campaign IO	Determines what fields of campaign records are retrieved and added to a response.	Integration Object

GetCampaigns Web Service Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class (If Business Service)
SocialMedia Service	Business Service	CSSSocialService

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
MKTG Campaign IO	LeadofLeadIO

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
GetCampaigns	GetCampaigns

Example Package for GetCampaigns Web Service

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

Request

See the following file to view the sample code:

...\GetCampaigns\GetCampaigns_req.xml

Response

See the following file to view the sample code:

...\GetCampaigns\GetCampaigns_resp.xml

Interface Description (WSDL) for GetCampaigns Web Service

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\GetCampaigns\GetCampaigns.wsdl

GetMktgWebSurvey

Use this Web service to get Siebel Marketing Web surveys.

GetMktgWebSurvey Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
GetMktgWebSurveyQueryPage	This operation is used to query up a Survey Page.

Request Message Description: GetMktgWebSurveyQueryPage

For a description of this request message, see the following table.

Node	Description	Type
ExecutionMode	The mode in which the query is to be performed.	String
LOVLanguageMode	The language mode from the seeded list.	String
NamedSearchSpec	Search specification of the query.	String
PickListName	Name of the picklist (if any).	String
SiebelMessageIn	An instance of the GetMktgWebSurvey Integration Object.	Integration Object
ViewMode	The View Mode set for the Object (Admin, Preserve, and so on).	String

Response Message Description: GetMktgWebSurveyQueryPage

For a description of this response message, see the following table.

Node	Description	Type
SiebelMessageOut	An instance of the GetMktgWebSurvey Integration Object.	Integration Object

GetMktgWebSurvey Application Interface

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

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
Import Job Integration Object	Import Job Integration Object.

Example Package for GetMktgWebSurvey

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

Interface Description (WSDL) for GetMktgWebSurvey

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\GetMktgWebSurvey\GetMktgWebSurvey.wsdl

InvoiceSiebelCommsReqABCS

Use this Web service to retrieve bill, usage, event, and resource balance information for bills in a billing profile. This Web service retrieves the information from the billing application.

InvoiceSiebelCommsReqABCS Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
QueryInvoiceList	Queries the invoice list for the billing profile in the Billing view.
QueryInvoice	Queries the invoice details for the billing profile in the Billing view.
QueryResourceBalance	Queries the resource balance details for the billing profile in the Billing view.
SearchEventDetails	Searches the event details for the billing profile view in the Billing view.
QueryEventDetails	Queries the event details for the billing profile view in the Billing view.

Request Message Description: QueryInvoiceList

For a description of this request message, see the following table.

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
QueryInvoiceReqMsg:ListOfCmuRequestBilledUsageIo	Optional	Integration Object

Response Message Description: QueryInvoiceList

For a description of this response message, see the following table.

Node	Description	Type
QueryInvoiceRespMsg:ListOfCmuResponseBilledUsageDetailsIo	Optional	Integration Object
FaultMsg:Fault	Optional	Integration Object

Request Message Description: QueryInvoice

For a description of this request message, see the following table.

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
QueryInvoiceReqMsg:ListOfCmuRequestBilledUsageIo	Optional	Integration Object

Response Message Description: QueryInvoice

For a description of this response message, see the following table.

Node	Description	Type
QueryInvoiceRespMsg:ListOfCmuResponseBilledUsageDetailsIo	Optional	Integration Object
FaultMsg:Fault	Optional	Integration Object

Request Message Description: QueryResourceBalance

For a description of this request message, see the following table.

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
QueryResourceBalanceReqMsg:ListOfCmuRequestCdrBalanceDetailsIo	Optional	Integration Object

For a description of this response message, see the following table.

Node	Description	Type
QueryResourceBalanceRespMsg:ListOfCmuResponseCdrBalanceDetailsIo	Optional	Integration Object
FaultMsg:Fault	Optional	Integration Object

For a description of this request message, see the following table.

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
SearchEventDetailsReqMsg:ListOfCmuRequestCdrDetailsSearchIo	Optional	Integration Object

For a description of this response message, see the following table.

Node	Description	Type
SearchEventDetailsRespMsg:ListOfCmuResponseCdrDetailsIo	Optional	Integration Object
FaultMsg:Fault	Optional	Integration Object

For a description of this request message, see the following table.

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
QueryEventDetailsReqMsg:ListOfCmuRequestCdrDetailsIo	Optional	Integration Object

For a description of this response message, see the following table.

Node	Description	Type
QueryEventDetailsRespMsg:ListOfCmuResponseCdrDetailsIo	Optional	Integration Object
FaultMsg:Fault	Optional	Integration Object

InvoiceSiebelCommsReqABCS Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class (If Business Service)
InvoiceSiebelCommsReqABCS	Business Service	CSSWSOutboundDispatcher

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
CMU Response CDR Details IO	Account
CMU Request CDR Details IO	Account
CMU Request Billed Usage IO	Account
CMU Response Billed Usage Details IO	Account
CMU Request Billing Profile IO	Account
CMU Response Billing Invoice IO	Account
CMU Response CDR Balance Details IO	Account
CMU Request CDR Balance Details IO	Account
CMU Request CDR Details Search IO	Account
Fault	Fault

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
QueryInvoiceList	QueryInvoiceList
QueryInvoice	QueryInvoice
QueryResourceBalance	QueryResouceBalance
SearchEventDetails	SearchEventDetails
QueryEventDetails	QueryEventDetails

Example Package for InvoiceSiebelCommsReqABCS

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

Request

See the following file to view the sample code:

...\InvoiceSiebelCommsReqABCS\QueryInvoice_request.xml

Response

See the following file to view the sample code:

...\InvoiceSiebelCommsReqABCS\QueryInvoice_response.xml

Interface Description (WSDL) for InvoiceSiebelCommsReqABCS

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\InvoiceSiebelCommsReqABCS\InvoiceSiebelReqABCSService.wsdl

ISS Price List Item WS

Use this Web service to add, update, and delete items in a price list in the Siebel application. The response message returns only an acknowledgement message and not data.

ISS Price List Item WS Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
Price List Item InsertorUpdate	Adds an item to a price list that does not already contain that item, and updates an item in a price list that already contains that item.
Price List Item Insert	Adds an item to a price list.
Price List Item Update	Updates an item in a price list.
Price List Item Delete	Deletes an item from a price list.

Request Message Description: Price List Item InsertOrUpdate

For a description of this request message, see the following table.

Node	Description
Price List Id	The ID of the price list. This node is used only to insert.
Product Id	The ID of the product to add to the price list. This node is used only to insert.
Price List Item Id	The ID of the price list item to update to the price list. This node is used only to update.

Request Message Description: Price List Item Insert

For a description of this request message, see the following table.

Node	Description
Price List Id	The ID of the price list.
Product Id	The ID of the product to add to the price list.

Request Message Description: Price List Item Update

For a description of this request message, see the following table.

Node	Description
Price List Item Id	The ID of the price list item to update in the price list.

Request Message Description: Price List Item Delete

For a description of this request message, see the following table.

Node	Description
Price List Item Id	The ID of the price list item to delete from the price list.

ISS Price List Item WS Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class (If Business Service)
ISS Price List Item WS	Business Service	CSSEAIDataSyncService

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
ISS Price List Item Integration Object	Admin Price List

Methods

For a description of methods for this Web service, see the following table.

Operation	Method
Price List Item InsertOrUpdate	[BS: ISS Price List Item WS].InsertOrUpdate
Price List Item Insert	[BS: ISS Price List Item WS].Insert
Price List Item Update	[BS: ISS Price List Item WS].Update
Price List Item Delete	[BS: ISS Price List Item WS].Delete

Example Package for ISS Price List Item WS

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

Request

See the following file to view the sample code:

...\ISSPriceListItem\ISS Price List Item WS.xml

Response

See the following file to view the sample code:

...\ISSPriceListItemWS\ISS Price List Item WS.xml

Interface Description (WSDL) for ISS Price List Item WS

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\ISSPriceListItem\ISS Price List Item WS.wsdl

ISS Web Commerce Export Attributes

Use this Inbound Web service to query for attribute definitions and values that were created in Siebel Customer Order Management.

ISS Web Commerce Export Attributes Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
ISSWebCommerceAttributeQueryPage	Queries for an attribute definition.

Request Message Description: ISSWebCommerceAttributeQueryPage

For a description of this request message, see the following table.

Node	Description	Type
LOVLanguageMode	Required. Indicates whether the value chosen from the list of values must be translated before being sent to the object manager. Valid values are LIC or LDC.	String
NamedSearchSpec	The name of a predefined query. The predefined query is performed on the business object instance.	String
NewQuery	The default value is False. This Boolean option indicates whether a new query is executed. If set to True, then a new query is executed clearing the cache of the integration object.	String
SiebelMessageIn	An instance of the integration object for attribute definitions and values.	Integration Object
ViewMode	Used to set the View Mode property for all business components corresponding to the integration object. Valid values are Manager, Sales Rep, Personal, Organization, Sub-Organization, Group, Catalog, and All.	String

Response Message Description: ISSWebCommerceAttributeQueryPage

For a description of this response message, see the following table.

Node	Description	Type
SiebelMessageOut	An instance of the integration object ISS Web Commerce Export Attribute used for attribute definitions and values.	Integration Object

ISS Web Commerce Export Attributes Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
ISS Web Commerce Export Attributes	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
ISS Web Commerce Export Attribute Integration Object	ISS Web Commerce Export Attribute Integration Object

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
ISSWebCommerceAttributeQueryPage	QueryPage

Example Package for ISS Web Commerce Export Attributes

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

Request

See the following file to view the sample code:

...\ISSWebCommerceExportAttributes\AttributeQueryRequest.xml

Response

See the following file to view the sample code:

...\ISSWebCommerceExportAttributes\AttributeQueryResponse.xml

Interface Description (WSDL) for ISS Web Commerce Export Attributes

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

...\ISSWebCommerceExportAttributes\ISS_Web_Commerce_Export_Attributes.WSDL

ISS Web Commerce Export Class

Use this Inbound Web service to query for class definitions that were created in Siebel Customer Order Management.

ISS Web Commerce Export Class Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
ISSWebCommerceClassQueryPage	Queries for a class.

Request Message Description: ISSWebCommerceClassQueryPage

For a description of this request message, see the following table.

Node	Description	Type
LOVLanguageMode	Required. Indicates whether the value chosen from the list of values must be translated before being sent to the object manager. Valid values are LIC or LDC.	String
NamedSearchSpec	The name of a predefined query. The predefined query is performed on the business object instance.	String
NewQuery	The default value is False. This Boolean option indicates whether a new query needs to be executed. If set to True, then a new query is executed clearing the cache of that particular integration object.	String
SiebelMessageIn	An instance of the integration object for class definitions.	Integration Object
ViewMode	Used to set the View Mode property for all business components corresponding to the integration object. Valid values are Manager, Sales Rep, Personal, Organization, Sub-Organization, Group, Catalog, and All.	String

Response Message Description: ISSWebCommerceClassQueryPage

For a description of this response message, see the following table.

Node	Description	Type
SiebelMessageOut	An instance of the integration object for class definitions and values.	Integration Object

ISS Web Commerce Export Class Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
ISS Web Commerce Export Class	Business service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
ISS Web Commerce Export Class Integration Object	ISS Web Commerce Export Class Integration Object

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
ISSWebCommerceClassQueryPage	QueryPage

Example Package for ISS Web Commerce Export Class

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

Request

See the following file to view the sample code:

...\ISSWebCommerceExportClass\ClassQueryRequest.xml

Response

See the following file to view the sample code:

...\ISSWebCommerceExportClass\ClassQueryResponse.xml

Interface Description (WSDL) for ISS Web Commerce Export Class

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

...\ISSWebCommerceExportClass\ISS_Web_Commerce_Export_Class.WSDL

ISS Web Commerce Export Content

Use this Inbound Web service to query or update export content job header or line items that were created within Siebel Customer Order Management.

ISS Web Commerce Export Contents Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
ISSWebCommerceContentQueryPage	Queries for a content header or line item.
ISSWebCommerceContentUpdate	Updates a content header or line item.

Request Message Description: ISSWebCommerceContentQueryPage

For a description of this request message, see the following table.

Node	Description	Type
LOVLanguageMode	Required. Indicates whether the value chosen from the list of values must be translated before being sent to the object manager. Valid values are LIC or LDC.	String
NamedSearchSpec	The name of a predefined query. The predefined query is performed on the business object instance.	String
NewQuery	Default is False. This Boolean option indicates whether a new query needs to be executed. If set to True, then a new query is executed flushing the cache for that particular integration object.	String
SiebelMessageIn	An instance of the integration object for Content Header and Line Items.	Integration Object
ViewMode	The ViewMode method argument is used to set the View Mode property for all business components corresponding to the integration object. Valid values are Manager, Sales Rep, Personal, Organization, Sub-Organization, Group, Catalog, and All.	String

Response Message Description: ISSWebCommerceContentQueryPage

For a description of this response message, see the following table.

Node	Description	Type
SiebelMessageOut	An instance of the integration object for content header and line items.	Integration Object

Request Message Description: ISSWebCommerceContentUpdate

For a description of this request message, see the following table.

Node	Description	Type
SiebelMessageIn	An instance of the integration object for content header and line items.	Integration Object

Response Message Description: ISSWebCommerceContentUpdate

For a description of this response message, see the following table.

Node	Description	Type
SiebelMessageOut	An instance of the integration object for content header and line items.	Integration Object

ISS Web Commerce Export Contents Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
ISS Web Commerce Export Contents	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
ISS Web Commerce Export Contents Integration Object	ISS Web Commerce Export Contents Integration Object

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
ISSWebCommerceContentQueryPage	QueryPage
ISSWebCommerceContentUpdate	Update

Example Package for ISS Web Commerce Export Contents

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

Request

See the following file to view the sample code:

...\ISSWebCommerceExportContents\ContentQueryRequest.xml
...\ISSWebCommerceExportContents\ContentUpdateRequest.xml

Response

See the following file to view the sample code:

...\ISSWebCommerceExportContents\ContentQueryResponse.xml
...\ISSWebCommerceExportContents\ContentUpdateResponse.xml

Interface Description (WSDL) for ISS Web Commerce Export Contents

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

...\ISSWebCommerceExportContents\ISS_Web_Commerce_Export_Contents.WSDL

ISS Web Commerce Export Error

Use this Inbound Web service to query, update, or insert export content error messages for export job header or line items that were created within Siebel Customer Order Management.

ISS Web Commerce Export Error Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
ISSWebCommerceErrorQueryPage	Queries for an export content error message.
ISSWebCommerceErrorUpdate	Updates an export content error message.
ISSWebCommerceErrorInsert	Inserts an export content error message.

Request Message Description: ISSWebCommerceErrorQueryPage

For a description of this request message, see the following table.

Node	Description	Type
LOVLanguageMode	Required. Indicates whether the value chosen from the list of values must be translated before being sent to the object manager. Valid values are LIC or LDC.	String
NamedSearchSpec	The name of a predefined query. The predefined query is performed on the business object instance.	String
NewQuery	Default is False. Boolean indicating whether a new query needs to be executed. If set to True, then a new query is executed flushing the cache for that particular integration object.	String
SiebelMessageIn	An instance of the integration object for content error messages.	Integration Object
ViewMode	The ViewMode method argument is used to set the View Mode property for all business components corresponding to the integration object. Valid values are Manager, Sales Rep, Personal, Organization, Sub-Organization, Group, Catalog, and All.	String

Response Message Description: ISSWebCommerceErrorQueryPage

For a description of this response message, see the following table.

Node	Description	Type
SiebelMessageOut	An instance of the integration object for content error messages.	Integration Object

Request Message Description: ISSWebCommerceErrorUpdate

For a description of this request message, see the following table.

Node	Description	Type
SiebelMessageIn	An instance of the integration object for content error messages.	Integration Object

Response Message Description: ISSWebCommerceErrorUpdate

For a description of this response message, see the following table.

Node	Description	Type
SiebelMessageOut	An instance of the integration object for content error messages.	Integration Object

Request Message Description: ISSWebCommerceErrorInsert

For a description of this request message, see the following table.

Node	Description	Type
SiebelMessageIn	An instance of the integration object for content error messages.	Integration Object

For a description of this response message, see the following table.

Node	Description	Type
SiebelMessageOut	An instance of the integration object for content error messages.	Integration Object

ISS Web Commerce Export Error Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
ISS Web Commerce Export Error Messages	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
ISS Web Commerce Export Error Message Integration Object	ISS Web Commerce Export Error Message Integration Object

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
ISSWebCommerceErrorQueryPage	QueryPage
ISSWebCommerceErrorUpdate	Update
ISSWebCommerceErrorInsert	Insert

Example Package for ISS Web Commerce Export Error

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

Request

See the following file to view the sample code:

...\ISSWebCommerceExportError\ErrorInsertRequest.xml
...\ISSWebCommerceExportError\ErrorQueryRequest.xml
...\ISSWebCommerceExportError\ErrorUpdateRequest.xml

Response

See the following file to view the sample code:

...\ISSWebCommerceExportError\ErrorInsertResponse.xml
...\ISSWebCommerceExportError\ErrorQueryResponse.xml
...\ISSWebCommerceExportError\ErrorUpdateResponse.xml

Interface Description (WSDL) for ISS Web Commerce Export Error

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

...\ISSWebCommerceExportError\ISS_Web_Commerce_Export_Errors.WSDL

ISS Web Commerce Export Price Lists

Use this Inbound Web service to query for price lists that were created within Siebel Customer Order Management.

ISS Web Commerce Export Price Lists Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
ISSWebCommercePriceListQueryPage	Queries for a price list and price list item.

Request Message Description: ISSWebCommercePriceListQueryPage

For a description of this request message, see the following table.

Node	Description	Type
LOVLanguageMode	Required. Indicates whether the value chosen from the list of values must be translated before being sent to the object manager. Valid values are LIC or LDC.	String
NamedSearchSpec	The name of a predefined query. The predefined query is performed on the business object instance.	String
NewQuery	Default is False. Boolean indicating whether a new query needs to be executed. If set to True, then a new query is executed flushing the cache for that particular integration object.	String
SiebelMessageIn	An instance of the integration object for Price List and Price List Items.	Integration Object
ViewMode	The ViewMode method argument is used to set the View Mode property for all business components corresponding to the integration object. Valid values are Manager, Sales Rep, Personal, Organization, Sub-Organization, Group, Catalog, and All.	String

Response Message Description: ISSWebCommercePriceListQueryPage

For a description of this response message, see the following table.

Node	Description	Type
SiebelMessageOut	An instance of the integration object for price list and price list items.	Integration Object

ISS Web Commerce Export Price Lists Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
ISS Web Commerce Export Price Lists	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
ISS Web Commerce Export Price List Integration Object	ISS Web Commerce Export Price List Integration Object

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
ISSWebCommercePriceListQueryPage	QueryPage

Example Package for ISS Web Commerce Export Price Lists

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

Request

See the following file to view the sample code:

...\ISSWebCommerceExportPriceLists\PriceListQueryRequest.xml

Response

See the following file to view the sample code:

...\ISSWebCommerceExportPriceLists\PriceListQueryResponse.xml

Interface Description (WSDL) for ISS Web Commerce Export Price Lists

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

...\ISSWebCommerceExportPriceLists\ISS_Web_Commerce_Export_Price_Lists.WSDL

ISS Web Commerce Export Recommended Products

Use this Inbound Web service to query for recommended products that were created in Siebel Customer Order Management.

ISS Web Commerce Export Recommended Products Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
ISSWebCommerceRecommendedProductQueryPage	Queries for a recommended product.

Request Message Description: ISSWebCommerceRecommendedProductQueryPage

For a description of this request message, see the following table.

Node	Description	Type
LOVLanguageMode	Required. Indicates whether the value chosen from the list of values must be translated before being sent to the object manager. Valid values are LIC or LDC.	String
NamedSearchSpec	The name of a predefined query. The predefined query is performed on the business object instance.	String
NewQuery	Default is False. Boolean indicating whether a new query needs to be executed. If set to True, then a new query is executed flushing the cache for that particular integration object.	String
SiebelMessageIn	An instance of the integration object for Price List and Price List Items.	Integration Object
ViewMode	The ViewMode method argument is used to set the View Mode property for all business components corresponding to the integration object. Valid values are Manager, Sales Rep, Personal, Organization, Sub-Organization, Group, Catalog, and All.	String

Response Message Description: ISSWebCommerceRecommendedProductQueryPage

For a description of this response message, see the following table.

Node	Description	Type
SiebelMessageOut	An instance of the integration object for Recommended Product.	Integration Object

ISS Web Commerce Export Recommended Products Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
ISS Web Commerce Export Recommended Products	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
ISS Web Commerce Export Recommended Product Integration Object	ISS Web Commerce Export Recommended Product Integration Object

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
ISSWebCommerceRecommendedProductQueryPage	QueryPage

Example Package for ISS Web Commerce Export Recommended Products

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

Request

See the following file to view the sample code:

...\ISSWebCommerceExportRecommendedProducts\RecommendedProductsQueryRequest.xml

Response

See the following file to view the sample code:

...\ISSWebCommerceExportRecommendedProducts\RecommendedProductsQueryResponse.xml

Interface Description (WSDL) for ISS Web Commerce Export Recommended Products

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

...\ISSWebCommerceExportRecommendedProducts\ISS_Web_Commerce_Export_Recommended_Products.WSDL

ISS Web Commerce Export Volume Discounts

Use this Inbound Web service to query for volume discounts and volume discount items that were created within Siebel Customer Order Management.

ISS Web Commerce Export Volume Discounts Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
ISSWebCommerceVolumeDiscountQueryPage	Query for a volume discount or volume discount item

Request Message Description: ISSWebCommerceVolumeDiscountQueryPage

For a description of this request message, see the following table.

Node	Description	Type
LOVLanguageMode	Required. Indicates whether the value chosen from the list of values must be translated before being sent to the object manager. Valid values are LIC or LDC.	String
NamedSearchSpec	The name of a predefined query. The predefined query is performed on the business object instance.	String
NewQuery	Default is False. Boolean indicating whether a new query needs to be executed. If set to True, then a new query is executed flushing the cache for that particular integration object.	String
SiebelMessageIn	An instance of the integration object for Price List and Price List Items.	Integration Object
ViewMode	The ViewMode method argument is used to set the View Mode property for all business components corresponding to the integration object. Valid values are Manager, Sales Rep, Personal, Organization, Sub-Organization, Group, Catalog, and All.	String

Response Message Description: ISSWebCommerceVolumeDiscountQueryPage

For a description of this response message, see the following table.

Node	Description	Type
SiebelMessageOut	An instance of the integration object for Volume Discount and Volume Discount Item.	Integration Object

ISS Web Commerce Export Volume Discounts Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
ISS Web Commerce Export Volume Discounts	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
ISS Web Commerce Export Volume Discount Integration Object	ISS Web Commerce Export Volume Discount Integration Object

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
ISSWebCommerceVolumeDiscountQueryPage	QueryPage

Example Package for ISS Web Commerce Export Volume Discounts

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

Request

See the following file to view the sample code:

...\ISSWebCommerceExportVolumneDiscounts\VolumeDiscountQueryRequest.xml

Response

See the following file to view the sample code:

...\ISSWebCommerceExportVolumneDiscounts\VolumeDiscountQueryResponse.xml

Interface Description (WSDL) for ISS Web Commerce Export Volume Discounts

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

...\ISSWebCommerceExportVolumneDiscounts\ISS_Web_Commerce_Export_Volume_Discounts.WSDL

LeadProcessingService

This service contains the basic operations for processing leads, including assigning, querying, scoring and data cleansing.

LeadProcessingService Operations

For a list of operations associated with this Web service, see the following table.

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

Request Message Description: LeadProcessingServiceAssignLeads

This method is used to assign leads. It accepts the input parameters in a property set. For a description of this request message, see the following table.

Node	Description	Type
Execution Order	Required. Parameter to be passed to the Business Rules Workflow.	String
Search Specification	Required. The input search criteria to search on the Lead business component.	String

Response Message Description: LeadProcessingServiceAssignLeads

For a description of this response message, see the following table.

Node	Description	Type
Error Message	Error code values are OK or NOTOK.	String
Process Instance Id	This is the Business Rules Workflow process ID.	String
Success Flag	Values are Yes or No based on whether the lead assignment was successfully created.	String

Request Message Description: LeadProcessingServiceDataCleansing

This method calls the Data Cleansing business service to cleanup a property set. For a description of this request message, see the following table.

Node	Description	Type
Business Component	Required. Business component to be passed to data cleansing service.	String
Business Object	Required. Business object from which the business component instance is obtained.	String
Search Specification	Required. Search specification to query the business component and get the values in activated fields.	String

Response Message Description: LeadProcessingServiceDataCleansing

For a description of this request message, see the following table.

Node	Description	Type
Error Message	Error code values are OK or NOTOK.	String
Success Flag	Values are Yes or No based on whether the lead assignment was successfully created.	String

Request Message Description: LeadProcessingServiceGetLeads

This method is used to get leads based on the input criteria. For a description of this request message, see the following table.

Node	Description	Type
Search Specification	Required. The input search criteria to search on Lead business component.	String

For a description of this response message, see the following table.

Node	Description	Type
SiebelMessage	Required. Has Lead ID and description of the leads.	Integration Object

This method is used to score leads. It accepts the input parameters in a property set. For a description of this request message, see the following table.

Node	Description	Type
Execution Order	Required. Parameter to be passed to Business Rules workflow.	String

For a description of this response message, see the following table.

Node	Description	Type
Error Message	Error code values are OK or NOTOK.	String
Process Instance Id	This is the Business Rules workflow process ID.	String
Success Flag	Values are Yes or No based on whether the lead assignment was successfully created.	String

LeadProcessingService Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type
Business Rules Workflow	WorkFlow
Data Cleansing	Business Service

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
Lead Integration Object	Lead

Example Package for LeadProcessingService

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

Request (LeadProcessingServiceAssignLeads)

See the following file to view the sample code:

...\LeadProcessingService\LeadProcessingService_AssignLeads_request.xml

Response (LeadProcessingServiceAssignLeads)

See the following file to view the sample code:

...\LeadProcessingService\LeadProcessingService_AssignLeads_request.xml

Request (LeadProcessingServiceDataCleansing)

See the following file to view the sample code:

...\LeadProcessingService\LeadProcessingService_ScoreLeads_request.xml

Response(LeadProcessingServiceDataCleansing)

See the following file to view the sample code:

...\LeadProcessingService\LeadProcessingService_ScoreLeads_request.xml

Request (LeadProcessingServiceGetLeads)

See the following file to view the sample code:

...\LeadProcessingService\LeadProcessingService_ScoreLeads_request.xml

Response (LeadProcessingServiceGetLeads)

See the following file to view the sample code:

...\LeadProcessingService\LeadProcessingService_ScoreLeads_request.xml

Request (LeadProcessingServiceScoreLeads)

See the following file to view the sample code:

...\LeadProcessingService\LeadProcessingService_ScoreLeads_request.xml

Response (LeadProcessingServiceScoreLeads)

See the following file to view the sample code:

...\LeadProcessingService\LeadProcessingService_ScoreLeads_request.xml

Interface Description (WSDL) for LeadProcessingService

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\LeadProcessingService\LeadProcessing.wsdl

LeadService

Use this Web service to perform basic operations on the Lead entity, such create, update, convert, retire and reject leads.

LeadService Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
LeadServiceRetireLead	Retires a lead.
LeadServiceCreateLead	Creates a lead.
LeadServiceRejectLead	Rejects a lead.
LeadServiceResponseToLead	Converts response to leads.
LeadServiceConvertLeadToOpty	Converts lead to an opportunity.
LeadServiceUpdateLead	Updates a lead.

Request Message Description: LeadServiceRetireLead

This method is used to assign leads. It accepts the input parameters in a property set. For a description of this request message, see the following table.

Node	Description	Type
LeadId	Required. The ID of the lead to be retired.	String
ReasonCode	Required The reason code for retiring the lead.	String
Comments	Comments for retiring (if any).	String

Response Message Description: LeadServiceRetireLead

For a description of this response message, see the following table.

Node	Description	Type
ReturnVal	Error code values are OK or NOTOK.	String

Request Message Description: LeadServiceCreateLead

For a description of this request message, see the following table.

Node	Description	Type
Lead IO	Required. An instance of the integration object Lead IO.	Integration Object

Response Message Description: LeadServiceCreateLead

For a description of this response message, see the following table.

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

Request Message Description: LeadServiceRejectLead

This method is used to reject a lead. The lead ID is retained, along with a reject comments code, a reject reason code. Optionally an owner ID can be passed to whom the lead will be assigned. For a description of this request message, see the following table.

Node	Description	Type
LeadId	Required. The ID of the lead to be rejected.	String
OwnerId	Optional.	String
ReasonCode	Reason code for rejecting the lead.	String
Comments	Comments (if any).	String

For a description of this response message, see the following table.

Node	Description	Type
ReturnVal	Error code values are OK or NOTOK.	String

For a description of this request message, see the following table.

Node	Description	Type
Response Id	Required. The ID of the response to be converted to lead.	String

For a description of this response message, see the following table.

Node	Description	Type
Error Message	Error message (if any).	String
Success Flag	Y or N.	String
Lead Id	The ID of the lead created from the response.	String

For a description of this request message, see the following table.

Node	Description	Type
LeadId	Required. The ID of the lead to be converted.	String
Contact Id	The contact ID of the lead.	String
Account Id	The account ID of the lead.	String

For a description of this response message, see the following table.

Node	Description	Type
Error Message	Error message (if any).	String
Success Flag	Y or N.	String
Opty Id	The ID of the opportunity created.	String

This method is used to update leads. It accepts input parameters in a property set. For a description of this request message, see the following table.

Node	Description	Type
Lead IO	Required. An instance of the integration object Lead IO.	Integration Object

For a description of this response message, see the following table.

Node	Description	Type
Error Message	Error message (if any).	String
Success Flag	Y or N.	String

LeadService Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type
Response To Lead Conversion	Workflow
Lead To Opty Conversion	Workflow

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
Lead IO	Lead

Example Package for LeadService

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

Request (LeadServiceRetireLead)

See the following file to view the sample code:

...\LeadService\LeadService_RetireLead_request.xml

Response (LeadServiceRetireLead)

See the following file to view the sample code:

...\LeadService\LeadService_RetireLead_response.xml

Request (LeadServiceCreateLead)

See the following file to view the sample code:

...\LeadService\LeadService_CreateLead_request.xml

Response (LeadServiceCreateLead)

See the following file to view the sample code:

...\LeadService\LeadService_CreateLead_response.xml

Request (LeadServiceRejectLead)

See the following file to view the sample code:

...\LeadService\LeadService_RejectLead_request.xml

Response (LeadServiceRejectLead)

See the following file to view the sample code:

...\LeadService\LeadService_RejectLead_response.xml

Request (LeadServiceResponseToLead)

See the following file to view the sample code:

...\LeadService\LeadService_ResponseToLead_request.xml

Response (LeadServiceResponseToLead)

See the following file to view the sample code:

...\LeadService\LeadService_ResponseToLead_response.xml

Request (LeadServiceConvertLeadToOpty)

See the following file to view the sample code:

...\LeadService\LeadService_ConvertToOpty_request.xml

Response (LeadServiceConvertLeadToOpty)

See the following file to view the sample code:

...\LeadService\LeadService_ConvertToOpty_response.xml

Request (LeadServiceUpdateLead)

See the following file to view the sample code:

...\LeadService\LeadService_UpdateLead_request.xml

Response (LeadServiceUpdateLead)

See the following file to view the sample code:

...\LeadService\LeadService_UpdateLead_response.xml

Interface Description (WSDL) for LeadService

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\LeadService\Lead.wsdl

List

Use this Web service for the basic operations for processing lists.

List Operations

For a list of operations associated with this Web service, see the following table.

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. For a description of this request message, see the following table.

Node	Description	Type
List IO	Required. An instance of the integration object List IO.	Integration Object

Response Message Description: ListCreateList

For a description of this response message, see the following table.

Node	Description	Type
List Id	List ID of the list created.	String
Error Message	Error message if any.	String
Success Flag	Y or N.	String

Request Message Description: ListExportList

This method is used to export lists. It accepts the input parameters as a property set. For a description of this request message, see the following table.

Node	Description	Type
Business Component	The Business component whose records need to be exported.	String
Business Object	The business object containing the business component.	String
Export Format	The format (xml, or CSV) based on which the filename or filenames are to be created.	String
Search Specification	The search specification for the records on the business component (if the records satisfying a condition are only to be picked).	String

List Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type
EAI XML Write to File	Business Service

Data Object (Integration Object)

For a description of data objects for this Web service, see the following table.

Siebel Repository Name	External Name
List IO	List IO

Example Package for List

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

Request (ListCreateList)

See the following file to view the sample code:

...\List\ListCreate_request.xml

Response (ListCreateList)

See the following file to view the sample code:

...\List\ListCreate_response.xml

Request (ListExportList)

See the following file to view the sample code:

...\List\ListExport_request.xml

Interface Description (WSDL) for List

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\List\List.wsdl

ListMgmtProspect

Use this Web service for the basic operations in Siebel Marketing such as to create and update prospect.

ListMgmtProspect Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
ListMgmtProspectCreateProspect	Creates a Prospect.
ListMgmtProspectUpdateProspect	Updates a Prospect.

Request Message Description: ListMgmtProspectCreateProspect

This method takes in an integration object called Prospect IO and returns the Prospect ID and Success Flag. For a description of this request message, see the following table.

Node	Description	Type
Prospect IO	Required input parameter.	Integration Object

Response Message Description: ListMgmtProspectCreateProspect

For a description of this response message, see the following table.

Node	Description	Type
Prospect Id	Unique ID of the prospect created.	String
Error Message	Error message, if any.	String
Success Flag	Y or N.	String

Request Message Description: ListMgmtProspectUpdateProspect

This method updates a prospect. For a description of this request message, see the following table.

Node	Description	Type
Prospect IO	Required input parameter.	Integration Object

Response Message Description: ListMgmtProspectUpdateProspect

For a description of this response message, see the following table.

Node	Description	Type
Error Message	Error message, if any.	String
Success Flag	Y or N.	String

Example Package for ListMgmtProspect

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

Request (ListMgmtProspectCreate)

See the following file to view the sample code:

...\ListMgmtProspect\ListMgmtProspectCreate_request.xml

Response (ListMgmtProspectCreate)

See the following file to view the sample code:

...\ListMgmtProspect\ListMgmtProspectCreate_request.xml

Request (ListMgmtProspectUpdate)

See the following file to view the sample code:

...\ListMgmtProspect\ListMgmtProspectUpdate_request.xml

Response (ListMgmtProspectUpdate)

See the following file to view the sample code:

...\ListMgmtProspect\ListMgmtProspectUpdate_request.xml

Interface Description (WSDL) for ListMgmtProspect

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\ListMgmtProspect\ListMgmtProspect.wsdl

LoyaltyAccrualService

Use this Web service with Siebel Loyalty to perform operations on orders, including processing, importing from an external file, importing transactions, and exporting promotions.

LoyaltyAccrualService Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
ProcessExternalOrder	Process all the transactions with the given order number.
ImportExternalOrderTxn	Imports the transactions from an external file, assigns the given order number to the files, and processes all the transactions.
ProcessExternalOrderTxn	Imports the transactions from given input, stamps the transaction with an order number, and processes all the transactions. The request mode can be either Process, or Simulate.
ProcessSocialActionTxn	Captures customers' social actions (such as checkins, Tweets, shares and so on) and processes their rewards in Siebel Loyalty. This operation automatically creates a new transaction for a referral reward based on the referee's purchase transaction. Rewards are on a one-time and recurring basis.
ExportPromotions	Exports the promotion of given program.
CancelOrder	Cancels all the transactions in a given order.

Request Message Description: ProcessExternalOrder

For a description of this request message, see the following table.

Node	Description	Type
Order Number – Number	The number of transactions this order number will be processed.	Number

Response Message Description: ProcessExternalOrder

For a description of this response message, see the following table.

Node	Description	Type
Total Points	Total number of points for a given order.	Number

Request Message Description: ImportExternalOrderTxn

For a description of this request message, see the following table.

Node	Description	Type
File Name	File name that contains the transactions.	String.

Response Message Description: ImportExternalOrderTxn

For a description of this response message, see the following table.

Node	Description	Type
Total Points	Total number of points for a given order.	Number
Siebel Message	Siebel Message of transactions.	Hierarchy

Request Message Description: ProcessExternalOrderTxn

Imports the transactions from an external file, assigns the given order number to the files, and processes all the transactions. The Request Mode can be either Process or Simulate. For a description of this request message, see the following table.

Node	Description	Type
Order Number	Order Number to be stamped to the saved transactions.	Number
Total Lines	Total number of transactions in the Input.	Number
Request Mode	Possible modes are Process or Simulate.	String
LOY EAI Transactions	Transactions in integration object format.	Integration Object

For a description of this response message, see the following table.

Node	Description	Type
Total Points – Number	Total number of points for the given order.	Number
Return Value – String	Possible values are Failure, or Success.	String
Siebel Message – Hierarchy	Siebel message of transactions.	Hierarchy

For a description of this request message, see the following table.

Node	Description	Type
SiebelMessage	One or more transactions in integration object format.	Integration Object

For a description of this response message, see the following table.

Node	Description	Type
ErrorArgs	Error message of each transaction.	Hierarchy
Siebel Message – Hierarchy	Processing information of transactions in the LOY EAI Transaction integration object format.	Hierarchy

Exports the promotion of given program. For a description of this request message, see the following table.

Node	Description	Type
Activity Date	Date needs to be between the start and end date of the promotion.	String
Export Flag	Export flag can be Y or N.	String
Program Name	Program name to which the user must export the promotions.	String

For a description of this response message, see the following table.

Node	Description	Type
Siebel Message	All the promotions in LOY EAI Promotion integration object format.	Integration Object.

For a description of this request message, see the following table.

Node	Description	Type
LOY Cancel Order Transaction	An instance of the integration object LOY Cancel Order Transaction.	Integration Object
Order Number	The order number of the order to be cancelled.	Number.

For a description of this response message, see the following table.

Node	Description	Type
LOY Cancel Order Transaction	An instance of the integration object LOY Cancel Order Transaction.	Integration Object
Order Number	The order number of the order to be cancelled.	Number.

Example of Package for LoyaltyAccrualService

To view an example of messages for this Web service, navigate to the documentation library for Siebel Business Applications on the Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Then extract the files in the zip file.

Request

See the following file to view the sample code:

...\LoyaltyAccrualService\ProcessExternalOrder_request.xml
...\LoyaltyAccrualService\ProcessExternalOrderTxn_request.xml
...\LoyaltyAccrualService\RequestMode_Simulate_request.xml
...\LoyaltyAccrualService\ProcessExternalOrderTxn_request.xml
...\LoyaltyAccrualService\ExportPromotions_request.xml

Response

See the following file to view the sample code:

...\LoyaltyAccrualService\ProcessExternalOrder_response.xml
...\LoyaltyAccrualService\ProcessExternalOrderTxn_response.xml
...\LoyaltyAccrualService\RequestMode_Simulate_response.xml
...\LoyaltyAccrualService\ProcessExternalOrderTxn_response.xml
...\LoyaltyAccrualService\ExportPromotions_response.xml

Interface Description (WSDL) for LoyaltyAccrualService

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

WSDL (ProcessExternalOrder)

...\LoyaltyAccrualService\ProcessExternalOrder.wsdl

WSDL (ImportExternalOrderTxn)

...\LoyaltyAccrualService\ImportExternalOrderTxn.wsdl

WSDL (ProcessExternalOrderTxn)

...\LoyaltyAccrualService\ProcessExternalOrderTxn.wsdl

WSDL (ExportPromotions)

...\LoyaltyAccrualService\ExportPromotions.wsdl

LoyaltyMemberEnrolment

Use this Web service with the Siebel Loyalty Application to perform the following operations for a member:

Enrolling a member into the selected Loyalty Program
Updating member data
Enrollment Payment processing for the selected member
Generating specified number of pre-allotted memberships into the selected Loyalty Program.

LoyaltyMemberEnrolment Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
MemberEnrollment	Enrolls a member into the specified loyalty program and returns the generated Member number, along with the Simulated prices for enrollment, if any. In case of any error, it sends the member data along with the error message or messages. If the Enrollment entails a payment, then this Web service method enrolls the member into Payment Pending status. If there is no Payment required, then the member directly goes into the Active status.
MemberUpdate	Used to update member details. If there is payment involved with the membership scheme, and if the membership is designated as Pre-Allotted, then this Web service updates the member details and returns the list of simulated prices along with the list of error messages occurred during the member update.
EnrollmentPaymentProcessing	Used to process the enrollment payment for the selected member, who is in the Payment Pending status. If the payment processing is successful, then the member status becomes Active, otherwise the status will remain in Payment Pending. This Web service returns the list of error messages occurred during the payment processing.
GeneratePreallottedMemberships	Used to generate the specified number of membership numbers for the given Loyalty program. The status of all these memberships.
EnrolContactAsMember	Creates a Loyalty membership from an existing Siebel contact from social networks. You can also view membership details and contact details that were captured from the attributes of the social profile.

Request Message Description: MemberEnrollment

For a description of this request message, see the following table.

Node

Description

Type

Siebel Message

Hierarchy of the Member details. Uses the integration object LOY Member.

Required Input:

Action Type must be Enrollment.
Program Id.
Membership Scheme Id.
Member Type.
Contact Details.
Account, Household details based on the member type.

Hierarchy (Integration Object : LOY Member).

Response Message Description: MemberEnrollment

For a description of this response message, see the following table.

Node

Description

Type

Siebel Message

Hierarchy of the Member details. If there is any error in the processing of the member details, then the property set returns the entire member details along with the error messages.

If the member is created successfully and payment is involved for the membership scheme, then the property set contains the enrolment simulated price lists.

Hierarchy (Integration Object : LOY Member).

Request Message Description: MemberUpdate

For a description of this request message, see the following table.

Node

Description

Type

Siebel Message

Hierarchy of the Member details. Uses the integration object LOY Member.

Required Input:

Action type must be ‘Update’.
Member Number.

Hierarchy (Integration Object : LOY Member)

Response Message Description: MemberUpdate

For a description of this response message, see the following table.

Node

Description

Type

Siebel Message

Hierarchy of the Member details. If there is any error in the processing of the member details, then the property set returns the entire member details along with the error messages.

If the member has a status of Prealloted and the supplied membership scheme has payment, then the property set contains the enrolment simulated price lists.

Hierarchy

Request Message Description: EnrolmentPaymentProcessing

For a description of this request message, see the following table.

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

For a description of this response message, see the following table.

Node	Description	Type
MemberNumber	Member Number.	String
Status	Status of the Member.	String
Payment Errors	The list of error messages occurred during the enrolment payment processing.	Hierarchy (Integration Object: LOY ENR Payment Errors)

For a description of this request message, see the following table.

Node	Description	Type
Program Id	Program ID.	String
Number of Members	The total number of pre-allotted memberships to be generated.	Number

For a description of this response message, see the following table.

Node	Description	Type
MemberNumbers	The hierarchy of the list of membership numbers generated in Pre-allotted status.	Hierarchy (Integration Object: LOY Preallotted Member)

For a description of this request message, see the following table.

Node	Description	Type
Account Id	Optional. The ID of the account being enrolled.	String
Accrual Type	Optional. The accrual type.	String
Contact Id	Required. The primary contact ID of the member being enrolled.	String
Enrollment Channel	Optional. The enrollment channel. Valid values are drawn from the LOV LOY_TXN_CHNNL_CD table.	String
Household Id	Optional. The existing household ID.	String
Member Type	Optional. The member type.	String
Membership Scheme Id	Optional. Membership plan corresponding to the member type.	String
Name	Optional. The member name.	String
Program Id	Optional. The existing program to which the member should be enrolled.	String
Referred By Id	Optional. The existing Referred by Member ID.	String

For a description of this response message, see the following table.

Node	Description	Type
Siebel Message	Hierarchy of the Contact Member details. Uses the integration object LOY Member.	Integration Object

Example Package for LoyaltyMemberEnrolment

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

Request

See the following file to view the sample code:

...\LoyaltyMemberEnrolment\Request.xml

Response

See the following file to view the sample code:

...\LoyaltyMemberEnrolment\Response.xml

Interface Description (WSDL) for LoyaltyMemberEnrolment

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\LoyaltyMemberEnrolment\WSDL

LoyaltyImportBusinessService

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

Note: LOY Import Business Service needs to be deployed as a web service in Siebel Tools.

LoyaltyImportBusinessService Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
VoucherImport	Takes in the File Name, Service Name, Method Name, File Format and Integration Object Name as input, and processes the redemption transactions for those records sent in the File mentioned in the input. Generates the log file with the same file name appended with the current timestamp.

Request Message Description: VoucherImport

This operation takes in the File Name, Service Name, Method Name, File Format and Integration Object Name as input and processes the redemption transactions for those records sent in the File mentioned in the input. It generates the log file with the same file name appended with a current timestamp. For a description of this request message, see the following table.

Node	Description	Type
File Format	String	Required
File Name	String	Required
IO Name	String	Required
Method Name	String	Required
Service Name	String	Required

Response Message Description: VoucherImport

For a description of this response message, see the following table.

Node	Description	Type
ValidFlag	Required	String

Example Package for LoyaltyImportBusinessService

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

Interface Description (WSDL) for LoyaltyImportBusinessService

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\LoyaltyImportBusService\LoyaltyImportBusService.wsdl

LoyaltyMemberService

Use this Web service to do the following member service actions:

Inquire membership details
Process membership information for Renewal or Cancellation
Retrieve member service price details
Purchase or Transfer points

LoyaltyMemberService Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
PurchasePointsService	Used for purchasing points. The member provides a membership number, the point type he or she wants to purchase, and the number of points as input. Credit card details must also be given as the service might involve monetary payment. Once the service is complete, output is given as an XML file that shows the transaction number and the order number. Member point balances are updated accordingly and reflected in the Siebel Loyalty application.
TransferPointsService	Used for transferring points to another member. The member provides a membership number, the point type which he or she wants to purchase, and the number of points as input. The transferee member number must also be included as input. Credit card details must also be given as the service might involve monetary payment. Once the service is performed, output is given as an XML file that shows the transaction number and the order number. Members’ (transferor and transferee) point balances are updated accordingly and reflected in the Siebel Loyalty application.
LoungePurchaseService	Used to buy or renew Lounge. The member provides a membership number, lounge period type, and lounge period duration along with credit card details. The member must also provide payment mode (Pay, Points, or Points+Pay) along with currency, and point type details as the service might involve payment. After the service is performed, the Member’s Lounge details are updated and a transaction detail record is created.
MembershipCancellationService	Used to cancel a loyalty membership. The member provides a membership number and credit card information (using the same credit card used during membership enrollment, or renewal). The loyalty program fee is refunded to the member’s credit card, and membership is cancelled.
RenewMembershipService	Renews the loyalty membership for members who are not enrolled in lifetime membership plans. The member provides a membership number, and membership scheme along with payment details (payment mode, credit card details and point type details) as the input. Membership dates are updated along with the membership scheme after the service is performed successfully.
GetMemberServicePrice	The member provides a membership number, and member service name to obtain price lists in different payment modes. Output is an integration object that can be seen as an XML file.
MemberInquiry	Used to query for a member or members given the member names, member number, and so on. The output details include member loyalty information, contact addresses, phone numbers, and email addresses, and so on.
PromotionEnrolmentForSMS	Rewards members a referral bonus when their social networking friends enroll into promotions.

Request Message Description: PurchasePointsService

For a description of this request message, see the following table.

Node	Description	Type
Member Number	Required. The requesting member must provide the Siebel Loyalty membership number.	String
Point Type	Required. The purchasing member must specify the type of point that he or she wants to purchase.	String
Points	Required. The purchasing member must specify the number of points that he or she wants to purchase.	String
Billing Address	Member billing address. Required if monetary or credit card details are a part of the transaction.	String
Billing Address2	Members secondary billing address. Required if monetary or credit card details are a part of the transaction.	String
Billing City	Member billing city. Required if monetary or credit card details are a part of the transaction.	String
Billing Country	Member billing country. Required if monetary or credit card details are a part of the transaction.	String
Billing State	Member billing state. Required if monetary or credit card details are a part of the transaction.	String
Billing ZIP Code	Member billing ZIP code. Required if monetary or credit card details are a part of the transaction.	String
CVV Number	CVV number from member credit card. Required if monetary or credit card details are a part of the transaction.	String
Card Holder Name	Credit card holder’s name. Required if monetary or credit card details are a part of the transaction.	String
Credit Card Number	Credit card number. Required if monetary or credit card details are a part of the transaction.	String
Credit Card Type	Credit card type, such as Visa, MasterCard, and so on. Required if monetary or credit card details are a part of the transaction.	String
Currency	Currency type used by member. Required if monetary currency is part of the transaction.	String
Expiration Month	Expiration month of member credit cards. Required if monetary or credit card details are a part of the transaction.	String
Expiration Year	Expiration year of member credit card. Required if monetary or credit card details are a part of the transaction.	String
Override Flag	Override flag.	String
Override Pay	Required. If the member wants to override the price details, then the input is Y, if not, then the input is N.	String
Override Reason	The member must specify Override Pay when the Override flag is marked Y. It is the monetary amount overridden by the member.	String
Override Reason Code	A reason for the price list override is stated if this flag is set to Y.	String

Response Message Description: PurchasePointsService

For a description of this response message, see the following table.

Node	Description	Type
Error Message	Error message given if the transaction fails.	String
Order Id	Order ID of the point purchase service.	String
Quote Id	Quote ID of the point purchase service.	String
Siebel Response Code	Siebel Order Management response code following authorization of a credit card.	String
Siebel Response Message	Siebel Order Management response message following authorization of a credit card.	String
Transaction Number	The transaction number of the point purchase service.	String

Request Message Description: TransferPointService

For a description of this request message, see the following table.

Node	Description	Type
Member Number	Required. The requesting member must provide the Siebel Loyalty membership number.	String
Point Type	Required. The purchasing member must specify the type of point that he or she wants to purchase.	String
Points	Required. The purchasing member must specify the number of points that he or she wants to purchase.	String
Transferee Member Number	Required. Transferee membership number to whom the points are to be transferred.	String
Billing Address	Member billing address. Required if monetary or credit card details are a part of the transaction.	String
Billing Address2	Members secondary billing address. Required if monetary or credit card details are a part of the transaction.	String
Billing City	Member billing city. Required if monetary or credit card details are a part of the transaction.	String
Billing Country	Member billing country. Required if monetary or credit card details are a part of the transaction.	String
Billing State	Member billing state. Required if monetary or credit card details are a part of the transaction.	String
Billing ZIP Code	Member billing ZIP code. Required if monetary or credit card details are a part of the transaction.	String
CVV Number	CVV number from member credit card. Required if monetary or credit card details are a part of the transaction.	String
Card Holder Name	Credit card holder’s name. Required if monetary or credit card details are a part of the transaction.	String
Credit Card Number	Credit card number. Required if monetary or credit card details are a part of the transaction.	String
Credit Card Type	Credit card type, such as Visa, MasterCard, and so on. Required if monetary or credit card details are a part of the transaction.	String
Currency	Currency type used by member. Required if monetary currency is part of the transaction.	String
Expiration Month	Expiration month of member credit cards. Required if monetary or credit card details are a part of the transaction.	String
Expiration Year	Expiration year of member credit card. Required if monetary or credit card details are a part of the transaction.	String
Override Flag	Override flag.	String
Override Pay	Required. If the member wants to override the price details, then the input is Y, if not, then the input is N.	String
Override Reason	The member must specify Override Pay when the Override flag is marked Y. It is the monetary amount overridden by the member.	String
Override Reason Code	A reason for the price list override is stated if this flag is set to Y.	String

Response Message Description: TransferPointService

For a description of this response message, see the following table.

Node	Description	Type
Error Message	Error message given if the transaction fails.	String
Order Id	Order ID of the point purchase service.	String
Quote Id	Quote ID of the point purchase service.	String
Siebel Response Code	Siebel Order Management response code following authorization of a credit card.	String
Siebel Response Message	Siebel Order Management response message following authorization of a credit card.	String
Transaction Number	The transaction number of the point purchase service.	String

Request Message Description: LoungePurchaseService

For a description of this request message, see the following table.

Node	Description	Type
Member Number	Required. The requesting member must provide the Siebel Loyalty Membership Number.	String
Lounge Period Type	Required. Lounge period type as months or years.	String
Lounge Period Duration	Lounge period duration for renewal stated in months or years.	String
Billing Address	Member billing address. Required if monetary or credit card details are a part of the transaction.	String
Billing Address2	Members secondary billing address. Required if monetary or credit card details are a part of the transaction.	String
Billing City	Member billing city. Required if monetary or credit card details are a part of the transaction.	String
Billing Country	Member billing country. Required if monetary or credit card details are a part of the transaction.	String
Billing State	Member billing state. Required if monetary or credit card details are a part of the transaction.	String
Billing ZIP Code	Member billing ZIP code. Required if monetary or credit card details are a part of the transaction.	String
CVV Number	CVV number from member credit card. Required if monetary or credit card details are a part of the transaction.	String
Card Holder Name	Credit card holder’s name. Required if monetary or credit card details are a part of the transaction.	String
Credit Card Number	Credit card number. Required if monetary or credit card details are a part of the transaction.	String
Credit Card Type	Credit card type, such as Visa, MasterCard, and so on. Required if monetary or credit card details are a part of the transaction.	String
Currency	Currency type used by member. Required if monetary currency is part of the transaction.	String
Expiration Month	Expiration month of member credit cards. Required if monetary or credit card details are a part of the transaction.	String
Expiration Year	Expiration year of member credit card. Required if monetary or credit card details are a part of the transaction.	String
Override Flag	Override flag.	String
Override Pay	Required. If the member wants to override the price details, then the input is Y, if not, then the input is N.	String
Override Points	The member must specify Override Pay when the Override flag is marked Y. It is the monetary amount overridden by the member.	String
Override Reason	A reason for the price list override is stated if this flag is set to Y.	String
Override Reason Code,	A reason for the price list override is stated if this flag is set to Y.	String
Payment Mode	Required. Payment mode stated as Points or Points+Pay, or Pay.	String
Point Type	Point type.	String

For a description of this response message, see the following table.

Node	Description	Type
Error Message	Error message given if the transaction fails.	String
Order Id	Order ID of the point purchase service.	String
Quote Id	Quote ID of the point purchase service.	String
Siebel Response Code	Siebel Order Management response code following authorization of a credit card.	String
Siebel Response Message	Siebel Order Management response message following authorization of a credit card.	String
Transaction Number	The transaction number of the point purchase service.	String

For a description of this request message, see the following table.

Node	Description	Type
Member Number	Required. The requesting member must provide the Siebel Loyalty Membership Number.	String
Membership Scheme	Required. The membership scheme to be renewed.	String
Billing Address	Member billing address. Required if monetary or credit card details are a part of the transaction.	String
Billing Address2	Members’ secondary billing address. Required if monetary or credit card details are a part of the transaction.	String
Billing City	Member billing city. Required if monetary or credit card details are a part of the transaction.	String
Billing Country	Member billing country. Required if monetary or credit card details are a part of the transaction.	String
Billing State	Member billing state. Required if monetary or credit card details are a part of the transaction.	String
Billing ZIP Code	Member billing ZIP code. Required if monetary or credit card details are a part of the transaction.	String
CVV Number	CVV number from member credit card. Required if monetary or credit card details are a part of the transaction.	String
Card Holder Name	Credit card holder’s name. Required if monetary or credit card details are a part of the transaction.	String
Credit Card Number	Credit card number. Required if monetary or credit card details are a part of the transaction.	String
Credit Card Type	Credit card type, such as Visa, MasterCard, and so on. Required if monetary or credit card details are a part of the transaction.	String
Currency	Currency type used by member. Required if monetary currency is part of the transaction.	String
Expiration Month	Expiration month of member credit cards. Required if monetary or credit card details are a part of the transaction.	String
Expiration Year	Expiration year of member credit card. Required if monetary or credit card details are a part of the transaction.	String
Override Flag	Override flag.	String
Override Pay	Required. If the member wants to override the price details, then the input is Y, if not, then the input is N.	String
Override Points	The member must specify Override Pay when the Override flag is marked Y. It is the monetary amount overridden by the member.	String
Override Reason	A reason for the price list override is stated if this flag is set to Y.	String
Override Reason Code	A reason for the price list override is stated if this flag is set to Y.	String
Payment Mode	Required. Payment mode stated as Points or Points+Pay, or Pay.	String
Point Type	Point type.	String

For a description of this response message, see the following table.

Node	Description	Type
Error Message	Error message given if the transaction fails.	String
Order Id	Order ID of the point purchase service.	String
Quote Id	Quote ID of the point purchase service.	String
Siebel Response Code	Siebel Order Management response code following authorization of a credit card.	String
Siebel Response Message	Siebel Order Management response message following authorization of a credit card.	String
Transaction Number	The transaction number of the point purchase service.	String

For a description of this request message, see the following table.

Node	Description	Type
Member Number	Required. The requesting member must provide the Loyalty Membership Number.	String
Fee Refund Basis	Required. Fee refund basis. Values include Prorata or Percentage, or No Refund.	String
Refund Percentage	Refund percentage is to be given if the selected fee refund basis is calculated as a percentage.	String
Cancellation Reason	Reason for the membership cancellation.	String
Cancellation Reason Code	Required. Membership cancellation reason code.	String
Credit Card Number	Credit card number. Required when the refund basis is Percentage or Prorata. The fee is refunded to the credit card number provided that it matches the number previously retained.	String
Credit Card Type	Credit card type, such as Visa, MasterCard, and so on. Required when the refund basis is Percentage or Prorata. The fee is refunded to the credit card number provided that it matches the number previously on file.	String
Expiration Month	Expiration month must match the expiration month of the credit card on file. Required when the refund basis is Percentage or Prorata.	String
Expiration Year	Expiration year must match the expiration year of the credit card on file. Required when the refund basis is Percentage or Prorata.	String
Override Flag	Required. If the member wants to override the refund price details, then the input is Y, if not, then the input is N.	String
Override Pay	Required. If the member wants to override the price details then the input is Y, if not, then the input is N.	String
Override Reason	Reason for overriding price.	String
Override Reason Code	Override reason code provided if the Override Flag is Y.	String

For a description of this response message, see the following table.

Node	Description	Type
Currency	Currency in which the fee is refunded.	String
Error Message	Error message if the transaction fails.	String
Order Id	Refund Order ID of the membership cancellation service.	String
Quote Id	Quote ID of the membership cancellation service.	String
Refund Amount	Refund amount.	String
Siebel Response Code	Response code provided by Siebel Order Management after the credit card authorization is sent.	String
Siebel Response Message	Response message given by Siebel Order Management after credit card authorization.	String
Transaction Number	The transaction number of the membership cancellation.	String

For a description of this request message, see the following table.

Node	Description	Type
Member Number	The requesting member must provide the Siebel Loyalty Membership Number.	String
Currency Code	Currency code to return price lists in a given currency.	String
Lounge Period Duration	The Lounge period duration must be provided if the Transaction Sub Type is set to Lounge Purchase.	String
Lounge Period Type	Lounge Period type (Months or Years, and so on) must be provided if the Transaction Sub Type is set to Lounge Purchase.	String
Point Type	Point type must be provided if the member wants to see price lists of Points, or Points + Pay mode in the given point type.	String
Points Qty	Number of points to be given if the transaction sub type is set to Purchase Points or Transfer Points.	String
Selected Membership Scheme	Membership scheme included in the input if the Transaction Sub Type is Membership Renewal.	String
Transaction Sub Type	Required. Member Service type. Possible values are: Points Purchase, Transfer Points, Membership Renewal, or Lounge Purchase.	String

For a description of this response message, see the following table.

Node	Description	Type
LOY EAI Transaction	List of price lines, after applying the promotions on the base prices, are given in the output as XML file.	Integration Object

For a description of this request message, see the following table.

Node	Description	Type
Member Number	The requesting member must provide the Siebel Loyalty Membership Number.	String
Email Address	Email address of inquiring member.	String
First Name	Member’s first name.	String
Last Name	Member’s last name.	String
Middle Name	Member’s middle name.	String
Telephone Number	Member’s telephone number.	String
Transaction Type	Transaction type must be provided for queries.	String
ZIP Code	ZIP code of the member whose details are to be inquired is given.	String

For a description of this response message, see the following table.

Node	Description	Type
Siebel Message (An instance of the integration object LOY Member Inquiry)	Member details are given in the integration object and can be extracted as XML file.	Integration Object

For a description of this request message, see the following table.

Node	Description	Type
Member Number	Required. The member number of the enrollee.	String
Enrolled Promotion Id	Required. The enrolled promotion ID.	String
Incentive Choice	Optional. Incentive choice type.	String
Referred By Member Number	Optional. Member number of referee.	String

For a description of this response message, see the following table.

Node	Description	Type
Error Message	Error message.	String
Siebel Message	Transactions in integration object format.	Integration Object

Example Package for LoyaltyMemberService

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

Request

See the following file to view the sample code:

...\LoyaltyMemberServices\Request.xml

Response

See the following file to view the sample code:

...\LoyaltyMemberServices\Response.xml

Interface Description (WSDL) for LoyaltyMemberService

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\LoyaltyMemberService\WSDL

LoyaltyRedemptionService

Use this Web service with the Siebel Loyalty application to perform all redemption related operations, including redemption processing, redemption cancellation, voucher reissue, and Siebel Order Management integration.

LoyaltyRedemptionService Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
GetPriceOptions	Returns available price options for a set of redemption activities. Also returns the point balance of the member in all point types.
GetPriceOptions	Returns available price options with payment mode set as Points or Points+Pay for a set of redemption activities. Also returns the point balance of the member in all point types.
CheckPriceOptions	Returns available price options for a set of redemption activities. Also performs the credit check and returns how much of a loan is required for each point type. If a loan is not possible, then the Web service performs the point-to-pay conversion and returns the prorated pay and points for each transaction.
CheckCredit	Performs the credit check for a given member and point type. Checks whether a loan is required and returns how much of a loan is required to fulfill the redemption transaction.
GetQuote	Returns available price options for a set of redemption activities. Also performs the credit check and returns how much of a loan is required for each point type. If a loan is not possible, then the Web service does the point-to-pay conversion and returns the prorated pay and points for each transaction. This operation also creates a quote using the given redemption activities (transactions), credit card details (optional) and shipping details (optional).
ProcessQuote	Takes Quote ID as input and converts the quote to order and order to redemption transactions, then processes those transactions.
GetTransactionDetails	Takes as input an Order Number and returns the Transaction details (including activities and Transaction Items if any) for the same.
GetRedemptionRefund	Returns the refund in Points or Points plus Pay for a given redemption transaction, which need to be cancelled.
CancelRedemptionTxn	Takes the redemption transaction ID which need to be cancelled and the refund amount (either unmodified, or overridden refund amount got from the GetRedemptionRefund method) and creates the cancellation transaction and processes it.
GetReissueFeeOptions	Returns the different fee options for reissuing the given voucher.
CheckReissueFeeOption	Checks whether a given fee option for a voucher is valid, and whether the member has enough points to pay in this fee option if the payment mode involves Points.
GetReissueQuote	Takes the chosen fee option details for a voucher, credit card details (optional), shipping details (optional), checks whether the fee option is valid, does credit check if the payment mode involves points, and creates a quote with the given data.
ProcessReissueQuote	Takes as input Quote ID, creates Order for Quote, and creates a Loyalty Voucher Reissue transaction and processes it to reissue the voucher.
UpdateQuoteShippingAddress	Takes Quote ID and shipping details and updates the quote with the given shipping address.
AddCreditCardToQuote	Takes Quote ID, credit card details, billing address and updates the quote with the credit card details.
ProcessRealTimeRedemption	Takes as input the transaction data. It checks all pending redemption transactions and verifies the point balance to determine whether the request can be processed. The service also performs a credit check to determine whether a loan is needed for processing the transaction. If a loan is needed, the service creates and processes the loan transaction, and then creates the redemption transaction. It returns the transaction number as output.

Request Message Description: GetPriceOptions

For a description of this request message, see the following table.

Node	Description	Type
LOY Redemption Txn	Contains the redemption activity details.	Integration Object (Required)

Response Message Description: GetPriceOptions

For a description of this response message, see the following table.

Node	Description	Type
LOY Redemption Txn	Contains the redemption activity details and the price options for each activity.	Integration Object (Required)
LOY Redemp Points Summary	Contains point balances of the member in all point types.	Integration Object (Required)

Request Message Description: CheckPriceOptions

For a description of this request message, see the following table.

Node	Description	Type
LOY Redemption Txn	Contains the redemption activity details.	Integration Object (Required)

Response Message Description: CheckPriceOptions

For a description of this response message, see the following table.

Node	Description	Type
LOY Redemption Txn	Contains the redemption activity details and one price option for each activity.	Integration Object
LOY Redemp Points Summary	Point summary for each point type including points to be paid, point balance, loan (if any) and Points to Pay Conversion flag.	Integration Object
Pay	Total amount to be paid if monetary payment is involved.	Number
Pay Currency Code	Currency if monetary payment is involved.	String

Request Message Description: CheckCredit

This operation performs a credit check for a given member and point type. Checks whether loan is required and returns how much of a loan is required to fulfill the redemption transaction. For a description of this request message, see the following table.

Node	Description	Type
MemberNumber	Membership number.	String
PointTypeId	ID number for point type.	String
PointsReq	The required number of points.	Number
LoanFlag	Indicates whether loan limit must be considered.	String

For a description of this response message, see the following table.

Node	Description	Type
CCResult	Required	String
Available Balance	Required	String
EligLoan	Optional	Number
Error Message	Optional	String
LoanAllowed	Required	String
LoanFlag	Optional	String
PointsShortage	Optional	String

This operation creates a quote using the given redemption activities (transactions), credit card details (optional) and shipping details (optional). For a description of this request message, see the following table.

Node	Description	Type
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 being billed.	String
Shipping Method	Shipping method, such as Ground, Air or carrier name.	String
Ship To Street Address	Shipping street address.	String
Ship To Street Address 2	Second shipping street address if needed.	String
Ship To State	Shipping state.	String
Ship To Postal Code	Shipping postal code.	String
Ship To Country	Shipping country.	String
Billing City	Billing city, if different from shipping address.	String
Billing Country	Billing country, if different from shipping address.	String
Billing State	Billing state, if different from shipping address.	String
Billing ZIP Code	Billing ZIP code, if different from shipping address.	String
CVV Number	CVV number of the credit card.	String
Card Holder Name	Name of credit card holder.	String
Credit Card Expiration Month	Expiration date of credit card.	String
Credit Card Expiration Year	Expiration year of credit card.	String
Credit Card Line Number	Credit card line number.	String
Credit Card Number	Credit card number.	String
Credit Card Type	Credit cards type, such as Visa, American Express, and so on.	String
Recipient Name	Name of person who will receive shipped goods.	String
Save Shipping Address Flag	Check to save shipping address for future use.	String
Select Primary Shipping Address Flag	Flag to indicate primary address for account.	String
Ship To Address Id	ID for shipping address.	String
Ship To City	City that product is being shipped to.	String

For a description of this response message, see the following table.

Node	Description	Type
LOY Redemption Txn	Contains the redemption activity details and one price option for each activity.	Integration Object
LOY Redmp Points Summary	Point Summary for each point type including points to be paid, point balance, loan (if any) and Points to Pay Conversion flag.	Integration Object
Currency Code	Code to indicate which currency being used for translation.	String
Shipping Charge	Shipping charge for transaction.	String
Quote Id	ID of quote that is created.	String
Pay	Total amount of transaction.	Number
Tax	Total taxed charged on transaction.	Number

This operation converts a quote to an order and an order to redemption transactions. It then processes these transactions.

For a description of this request message, see the following table.

Node	Description	Type
Quote Id	String	Required

For a description of this response message, see the following table.

Node	Description	Type
Status	Optional	String
Order Id	Required	String

For a description of this request message, see the following table.

Node	Description	Type
Order Number	Required	String

For a description of this response message, see the following table.

Node	Description	Type
LOY Redemption Txn	Contains details of the redemption transactions that have been created for this order along with transaction items for each transaction in case of package transaction.	Integration Object.

This operation returns the refund amount for given redemption transaction, which is then cancelled. For a description of this request message, see the following table.

Node	Description	Type
Transaction Id	Required	String

For a description of this response message, see the following table.

Node	Description	Type
Pay	Optional	String
Point Type	Required	String
Points	Required	String
Currency	Optional	String
Payment Type	Required	String

This operation takes the redemption transaction ID which requires cancellation as well as the refund amount (either the unmodified or overridden refund amount gotten from the GetRedemptionRefund operation) and creates the cancellation transaction and processes it. For a description of this request message, see the following table.

Node	Description	Type
Override Expiry Date	Optional	String
Override Expiry Date Flag	Optional	String
Override Pay	Optional	String
Override Points	Optional	String
Override Price Flag	Optional	String
Transaction Id	Required	String
Override Reason Code	Optional	String
Payment Mode	Required	String
Simulate Pay	Optional	String
Override Reason	Optional	String

For a description of this response message, see the following table.

Node	Description	Type
New Txn Id	ID of the cancelled transaction.	String

This operation returns available fee options for reissue of a voucher with given ID. For a description of this request message, see the following table.

Node	Description	Type
Currency Code	Optional	String
Voucher Id	Required	String
Point Type Id	Optional	String
Payment Type Code	Required	String

For a description of this response message, see the following table.

Node	Description	Type
Product Point Id	Required	String
Fee Points	Optional	Number
Fee Amount	Optional	Number
Error Message	Optional	String

This operation takes the chosen fee option details for a voucher, credit card details (optional), shipping details (optional), checks whether the fee option is valid, does credit check if the payment mode involves points, and creates a quote with the given data. For a description of this request message, see the following table.

Node	Description	Type
Voucher Id	Required	String
Currency Code	Optional	String
Payment Type Code	Required	String
Point Type Id	Optional	String
Override Amount	Optional	Number
Override Flag	Optional	String
Override Points	Optional	Number
Override Reason	Optional	String
Override Reason Code	Optional	String
Billing Address	Optional	String
Billing Address2	Optional	String
Shipping Method	Optional	String
Ship To Street Address 2	Optional	String
Ship To Street Address	Optional	String
Ship To State	Optional	String
Ship To Postal Code	Optional	String
Ship To Country	Optional	String
Billing City	Optional	String
Billing Country	Optional	String
Billing State	Optional	String
Billing ZIP Code	Optional	String
CVV Number	Optional	String
Card Holder Name	Optional	String
Credit Card Expiration Month	Optional	String
Credit Card Expiration Year	Optional	String
Credit Card Number	Optional	String
Credit Card Type	Optional	String
Recipient Name	Optional	String
Save Shipping Address Flag	Optional	String
Select Primary Shipping Address Flag	Optional	String
Ship To Address Id	Optional	String
Ship To City	Optional	String

For a description of this response message, see the following table.

Node	Description	Type
Currency Code	Optional	String
Quote Id	Required	String
Error Message	Optional	String
Fee Amount	Optional	Number
Fee Points	Optional	Number
Shipping Charge	Optional	String
Tax Amount	Optional	String
Currency Code	Optional	String

This operation takes as input Quote ID, creates and Order for Quote, and creates a Loyalty Voucher Reissue transaction and processes it to reissue the voucher. For a description of this request message, see the following table.

Node	Description	Type
Quote Id	Required	String

For a description of this response message, see the following table.

Node	Description	Type
Transaction Number	Required	String
Order Number	Required	String
New Voucher Expiry Date	Required	Date
New Voucher Number	Required	String
New Voucher Status	Required	String

This operation takes the Quote ID and shipping details and updates the quote with the given shipping address. For a description of this request message, see the following table.

Node	Description	Type
Quote Id	Required	String

For a description of this response message, see the following table.

Node	Description	Type
Shipping Charge	Required	String

This operation takes the Quote ID, credit card details, billing address and updates the quote with the credit card details. For a description of this request message, see the following table.

Node	Description	Type
Billing Address	Required	String
Billing Address 2	Optional	String
Billing City	Optional	String
Billing Country	Required	String
Billing ZIP Code	Optional	String
CVV Number	Optional	Number
Card Holder Name	Optional	String
Credit Card Number	Optional	Number
Credit Card Type	Optional	String
Expiration Month	Optional	String
Expiration Year	Optional	String

There are no response messages for this operation.

Request Message Description: ProcessRealTimeRedemption

For a description of this request message, see the following table.

Node	Description	Type
LOY Redemption Txn	Contains the redemption activity details.	Integration Object

For a description of this response message, see the following table.

Node	Description	Type
LOY Redemption Txn	Contains the redemption activity details.	Integration Object
Transaction Number	Required.	String

Example Packages for LoyaltyRedemptionService

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

Request (GetPriceOptions)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetPriceOptions_request.xml

Response (GetPriceOptions)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetPriceOptions_response.xml

Request (CheckPriceOptions)

See the following file to view the sample code:

...\LoyaltyRedemptionService\CheckPriceOptions_request.xml

Response (CheckPriceOptions)

See the following file to view the sample code:

...\LoyaltyRedemptionService\CheckPriceOptions_response.xml

Request (CheckCredit)

See the following file to view the sample code:

...\LoyaltyRedemptionService\CheckCredit_request.xm

Response (CheckCredit)

See the following file to view the sample code:

...\LoyaltyRedemptionService\CheckCredit_response.xml

Request (GetQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetQuote_request.xml

Response (GetQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetQuote_response.xml

Request (ProcessQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\ProcessQuote_request.xml

Response (ProcessQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\ProcessQuote_response.xml

Request (GetTransactionDetails)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetTransactionDetails_request.xml

Response (GetTransactionDetails)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetTransactionDetails_response.xml

Request (GetRedemptionRefund)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetRedemptionRefund_request.xml

Response (GetRedemptionRefund)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetRedemptionRefund_response.xml

Request (CancelRedemptionTxn)

See the following file to view the sample code:

...\LoyaltyRedemptionService\CancelRedemptionTxn_request.xml

Response (CancelRedemptionTxn)

See the following file to view the sample code:

...\LoyaltyRedemptionService\CancelRedemptionTxn_response.xml

Request (GetReissueFeeOptions)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetReissueFeeOptions_request.xml

Response (GetReissueFeeOptions)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetReissueFeeOptions_response.xml

Request (GetReissueQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetReissueQuote_request.xml

Response (GetReissueQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetReissueQuote_response.xml

Request (ProcessReissueQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\ProcessReissueQuote_request.xml

Response (ProcessReissueQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\ProcessReissueQuote_response.xml

Request (UpdateQuoteShippingAddress)

See the following file to view the sample code:

...\LoyaltyRedemptionService\UpdateQuoteShippingAddress_request.xml

Response (UpdateQuoteShippingAddress)

See the following file to view the sample code:

...\LoyaltyRedemptionService\UpdateQuoteShippingAddress_response.xml

Request (AddCreditCardToQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\AddCreditCardToQuote_request.xml

Response (AddCreditCardToQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\AddCreditCardToQuote_response.xml

Request (ProcessRealTimeRedemption)

See the following file to view the sample code:

...\LoyaltyRedemptionService\ProcessRealTimeRedemption_request.xml

Response (ProcessRealTimeRedemption)

See the following file to view the sample code:

...\LoyaltyRedemptionService\ProcessRealTimeRedemption_response.xml

Interface Description (WSDL) for LoyaltyRedemptionService

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\LoyaltyRedemptionService\LoyaltyRedemptionService.wsdl

LoyaltyVoucherService

Use this Web service with the Siebel Loyalty Application to perform all Voucher related Web service operations, including Voucher Validity Check and Status Change.

LoyaltyVoucherService Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
VoucherStatusChange	Takes in the membership number, partner name, voucher number, activity date and change the status of the voucher to Used in real time.

Request Message Description: VoucherValidityCheck

This operation takes in the membership number, Partner ID voucher number and activity date, to validate the voucher and return Success, Failure. For a description of this request message, see the following table.

Node	Description	Type
Voucher Number	Required	String
Activity Date	Required	String
Member Number	Required	String
Partner Id	Required	String

Response Message Description: VoucherValidityCheck

For a description of this response message, see the following table.

Node	Description	Type
Valid Flag	Required	String

Request Message Description: VoucherStatusChange

This operation takes in the membership number, partner name, voucher number, activity date and change the status of the voucher to Used in real time. This involves creation of Availment transaction and processing it in real time. For a description of this request message, see the following table.

Node	Description	Type
Voucher Number	Optional	String
Member Number	Required	String
Partner Name	Required	String
Activity Date	Required	String
Order Number	Optional	Number

Response Message Description: VoucherStatusChange

For a description of this response message, see the following table.

Node	Description	Type
Voucher Number	Optional	String
Order Number	Optional	Number
Voucher Type	Required	String
Return Value	Required	String

Example Package for LoyaltyVoucherService

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

Request

See the following file to view the sample code:

...\LoyaltyVoucherService\Request.xml

Response

See the following file to view the sample code:

...\LoyaltyVoucherService\Request.xml

Interface Description (WSDL) for LoyaltyVoucherService

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link forSiebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\LoyaltyVoucherService\WSDL

LS Clinical CRF Tracking Interface Service

Use this generic ASI-based Web service to query for Case Report Forms (CRFs) for a given Protocol, Region or Protocol Site. An external application invokes this Web service with details such as Protocol Id, Protocol Title, Protocol Number, Protocol Site Id, Region, and so on. No error message is returned in case the Web service search criteria fails to return CRF records.

LS Clinical CRF Tracking Interface Service Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
QueryById	Returns all Case Report Forms for a specified Protocol Site Id in the "Id" tag.
QueryByExample	Used to query Case Report Form records based on given filter criteria.
QueryPage	Used to query Case Report Form details in pages based on given filter criteria.

Request Message Description: QueryById

For a description of this request message, see the following table.

Node	Description	Type
PrimaryRowId	Required. Specify the Protocol Site RowId value for which the CRF records should be returned.	String
UTCCanonical	This flag is N by default. If this flag is enabled (Y), then data from the Siebel application must be in UTC (Coordinated Universal Time) and canonical format. The data in UTC and canonical format is converted to Siebel Object Manager format as determined by the value of the UTCCanonical flag.	Boolean

Request Message Description: QueryById

For a description of this request message, see the following table.

Node	Description	Type
ClinicalProtocolSite.PlannedSubjects	Number of planned subjects for the site.	Number
ClinicalProtocolSite.AmountCurrencyCode	Current code of the site.	Currency
ClinicalProtocolSite.AmountExchangeDate	Exchange date for the amount at the site.	Date
ClinicalProtocolSite.FirstSubjectEnrolledDate	Date when the subject was first enrolled.	Date
ClinicalProtocolSite.SiteRowId	Protocol site row ID.	Character data
ClinicalProtocolSite.InitiationCompletedDate	Date when the site was initiated.	Date
ClinicalProtocolSite.InvestigatorFirstName	Principal investigator first name.	Character data
ClinicalProtocolSite.InvestigatorLastName	Principal investigator last name	Character data
ClinicalProtocolSite.LastSubjectOffStudyDate	Date when the last subject was terminated.	Date
ClinicalProtocolSite.PrimaryInvestigatorId	Primary investigator's row ID.	Character data
ClinicalProtocolSite.ProtocolId	Protocol row ID.	Character data
ClinicalProtocolSite.ProtocolNumber	Protocol number.	Character data
ClinicalProtocolSite.ProtocolSiteId	Protocol site row ID.	Character data
ClinicalProtocolSite.ProtocolStatus	Protocol status.	Character data
ClinicalProtocolSite.ProtocolTitle	Protocol title.	Character data
ClinicalProtocolSite.Region	Region name.	Character data
ClinicalProtocolSite.RegionPlannedSites	Number of planned sites for the region.	Number
ClinicalProtocolSite.RegionPlannedSubjects	Number of planned subjects for the region.	Number
ClinicalProtocolSite.RegionId	Region row ID.	Character data
ClinicalProtocolSite.RegionStatus	Region status.	Character data
ClinicalProtocolSite.SiteAccountRowId	Account row ID for the associated site.	Character data
ClinicalProtocolSite.SiteAccountName	Account name for the associated site.	Character data
ClinicalProtocolSite.SiteNumber	Site number.	Character data
ClinicalProtocolSite.Status	Protocol site status.	Character data
ClinicalProtocolSite.TerminatedDate	Site terminated date.	Date
ClinicalProtocolSite.TotalContractAmount	Total contract amount rolled up for the site.	Currency
LsCrfTrackingBc.NumberofPages	Total number of pages for the CRF record.	Number
LsCrfTrackingBc.ActivityType	Type of activity.	Character data
LsCrfTrackingBc.Category	Category.	Character data
LsCrfTrackingBc.ChartsReviewed	When was the charts reviewed.	UTC Date Time
LsCrfTrackingBc.Comments	Comments.	Character data
LsCrfTrackingBc.CRFRowIdId	CRF Row ID.	Character data
LsCrfTrackingBc.Name2	Name of the CRF.	Character data
LsCrfTrackingBc.PagesVerified	Number of pages verified.	Number
LsCrfTrackingBc.ProtocolRegionId	Region row ID.	Character data
LsCrfTrackingBc.ProtocolSiteId	Protocol site ID.	Character data
LsCrfTrackingBc.ReceivedbyDataManagement	Date when received by the data management.	UTC Date Time
LsCrfTrackingBc.Receivedinhouse	Date when the CRF was received by in-house.	UTC Date Time
LsCrfTrackingBc.Retrieved	Boolen flag indicating whether or not the CRF information was retrieved.	Boolean
LsCrfTrackingBc.RetrievedDate	When the CRF was retrieved.	UTC Date Time
LsCrfTrackingBc.SignedForms	Whether the CRF are signed.	Boolean
LsCrfTrackingBc.SourceVerfied	The CRF is source verified.	Boolean
LsCrfTrackingBc.SourceVerifiedDate	When the CRF was source verified.	UTC Date Time
LsCrfTrackingBc.SubjectId	Subject row ID.	Character data
LsCrfTrackingBc.SubjectNumber	Subject number.	Character data

Request Message Description: QueryPage

For a description of this request message, see the following table.

Node	Description	Type
UTCCanonical	This flag is N by default. If this flag is enabled (Y), then data from the Siebel application must be in UTC (Coordinated Universal Time) and canonical format. The data in UTC and canonical format is converted to Siebel Object Manager format as determined by the value of the UTCCanonical flag.	Boolean
SortSpec	Determines whether the sort order is ascending ordescending. Valid values are ASC or DEC.	Character Data
StartRowNum	Determines the starting point for record retrieval. The 0-based index of the record within the recordset.	Number
LastPage	Indicates whether the record being returned is the last record in the record set. Valid values are true or false.	Character Data
PageSize	The number of records to be returned for a component. The default page size is 10. Note: There is a server parameter that controls the maximum page size (MaximumPageSize). If the pagesize attribute is greater than the maximum pagesize defined in the server parameter, an error occurs.	Number
ClinicalProtocolSite.PlannedSubjects	Required. Number of planned subjects for the site. Can be either ‘*’ or a valid number.	Number
ClinicalProtocolSite.Searchspec	An optional search specification.	Character Data
ClinicalProtocolSite.AmountCurrencyCode	Required. Currency Code of the site. Can be either ‘*’ or a valid currency amount.	Currency
ClinicalProtocolSite.AmountExchangeDate	Required. Can be either ‘*’ or a valid exchange date for the amount at the site.	Date
ClinicalProtocolSite.FirstSubjectEnrolledDate	Required. Can be either ‘*’ or a valid date when the subject was first enrolled.	Date
ClinicalProtocolSite.SiteRowId	Required. Can be either ‘*’ or a valid protocol site row ID.	Character data
ClinicalProtocolSite.InitiationCompletedDate	Required. Can be either ‘*’ or a valid date when the site was initiated.	Date
ClinicalProtocolSite.InvestigatorFirstName	Required. Can be either ‘*’ or a valid principal investigator first name.	Character data
ClinicalProtocolSite.InvestigatorLastName	Required. Can be either ‘*’ or a valid principal investigator last name.	Character data
ClinicalProtocolSite.LastSubjectOffStudyDate	Required. Can be either ‘*’ or a valid date when the last subject was terminated.	Date
ClinicalProtocolSite.PrimaryInvestigatorId	Required. Can be either ‘*’ or a valid primary investigator’s row ID.	Character data
ClinicalProtocolSite.ProtocolId	Required. Can be either ‘*’ or a valid protocol row ID.	Character data
ClinicalProtocolSite.ProtocolNumber	Required. Can be either ‘*’ or a valid protocol number.	Character data
ClinicalProtocolSite.ProtocolSiteId	Required. Can be either ‘*’ or a valid protocol site row ID.	Character data
ClinicalProtocolSite.ProtocolStatus	Required. Can be either ‘*’ or a valid protocol status.	Character data
ClinicalProtocolSite.ProtocolTitle	Required. Can be either ‘*’ or a valid protocol title.	Character data
ClinicalProtocolSite.Region	Required. Can be either ‘*’ or a valid region name.	Character data
ClinicalProtocolSite.RegionPlannedSites	Required. Can be either ‘*’ or a valid number of planned sites for the region.	Number
ClinicalProtocolSite.RegionPlannedSubjects	Required. Can be either ‘*’ or a valid number of planned subjects for the region.	Number
ClinicalProtocolSite.RegionId	Required. Can be either ‘*’ or a valid region row ID.	Character data
ClinicalProtocolSite.RegionStatus	Required. Can be either ‘*’ or a valid region status.	Character data
ClinicalProtocolSite.SiteAccountRowId	Required. Can be either ‘*’ or a valid account row ID for the site associated.	Character data
ClinicalProtocolSite.SiteAccountName	Required. Can be either ‘*’ or a valid account name for the site associated.	Character data
ClinicalProtocolSite.SiteNumber	Required. Can be either ‘*’ or a valid site number.	Character data
ClinicalProtocolSite.Status	Required. Can be either ‘*’ or a valid protocol site status.	Character data
ClinicalProtocolSite.TerminatedDate	Required. Can be either ‘*’ or a valid site terminated date.	Date
ClinicalProtocolSite.TotalContractAmount	Required. Can be either ‘*’ or a valid total contract amount rolled up for the site.	Currency
LsCrfTrackingBc.NumberofPages	Required. Can be either ‘*’ or a valid total number of pages for the CRF record.	Number
LsCrfTrackingBc.ActivityType	Required. Can be either ‘*’ or a valid type of activity.	Character data
LsCrfTrackingBc.Category	Required. Can be either ‘*’ or a valid category.	Character data
LsCrfTrackingBc.ChartsReviewed	Required. Can be either ‘*’ or a valid charts reviewed date.	UTC Date Time
LsCrfTrackingBc.Comments	Required. Can be either ‘*’ or a valid comments.	Character data
LsCrfTrackingBc.CRFRowIdId	Required. Can be either ‘*’ or a valid CRF row ID.	Character data
LsCrfTrackingBc.Name2	Required. Can be either ‘*’ or a valid name of the CRF.	Character data
LsCrfTrackingBc.PagesVerified	Required. Can be either ‘*’ or a valid number of pages verified.	Number
LsCrfTrackingBc.ProtocolRegionId	Required. Can be either ‘*’ or a valid region row ID.	Character data
LsCrfTrackingBc.ProtocolSiteId	Required. Can be either ‘*’ or a valid protocol site ID.	Character data
LsCrfTrackingBc.ReceivedbyDataManagement	Required. Can be either ‘*’ or a valid Date when received by the data management.	UTC Date Time
LsCrfTrackingBc.Receivedinhouse	Required. Can be either ‘*’ or a valid Date when the CRF was received by the Inhouse.	UTC Date Time
LsCrfTrackingBc.Retrieved	Required. Can be either ‘*’ or a valid Boolen flag if the CRF information is retrieved or not..	Boolean
LsCrfTrackingBc.RetrievedDate	Required. Can be either ‘*’ or a valid CRF retrieved date.	UTC Date Time
LsCrfTrackingBc.SignedForms	Required. Can be either ‘*’ or a valid Boolean value indicating if the CRF is signed.	Boolean
LsCrfTrackingBc.SourceVerfied	Required. Can be either ‘*’ or a valid Boolean value indicating if the CRF is source verified.	Boolean
LsCrfTrackingBc.SourceVerifiedDate	Required. Can be either ‘*’ or a valid date when the CRF was source verified.	UTC Date Time
LsCrfTrackingBc.SubjectId	Required. Can be either ‘*’ or a valid subject row ID.	Character data
LsCrfTrackingBc.SubjectNumber	Required. Can be either ‘*’ or a valid subject number.	Character data

Response Message Description: All LS Clinical CRF Tracking Interface Service Operations

For a description of this response message, see the following table.

Node	Description	Type
ClinicalProtocolSite.PlannedSubjects	Number of planned subjects for the site.	Number
ClinicalProtocolSite.AmountCurrencyCode	Current code of the site.	Currency
ClinicalProtocolSite.AmountExchangeDate	Exchange date for the amount at the site.	Date
ClinicalProtocolSite.FirstSubjectEnrolledDate	Date when the subject was first enrolled.	Date
ClinicalProtocolSite.SiteRowId	Protocol site row ID.	Character data
ClinicalProtocolSite.InitiationCompletedDate	Date when the site was initiated.	Date
ClinicalProtocolSite.InvestigatorFirstName	Principal investigator first name.	Character data
ClinicalProtocolSite.InvestigatorLastName	Principal investigator last name.	Character data
ClinicalProtocolSite.LastSubjectOffStudyDate	Date when the last subject was terminated.	Date
ClinicalProtocolSite.PrimaryInvestigatorId	Primary investigator’s row ID.	Character data
ClinicalProtocolSite.ProtocolId	Protocol row ID.	Character data
ClinicalProtocolSite.ProtocolNumber	Protocol number.	Character data
ClinicalProtocolSite.ProtocolSiteId	Protocol site row ID.	Character data
ClinicalProtocolSite.ProtocolStatus	Protocol status.	Character data
ClinicalProtocolSite.ProtocolTitle	Protocol title.	Character data
ClinicalProtocolSite.Region	Region name.	Character data
ClinicalProtocolSite.RegionPlannedSites	Number of planned sites for the region.	Number
ClinicalProtocolSite.RegionPlannedSubjects	Number of planned subjects for the region.	Number
ClinicalProtocolSite.RegionId	Region row ID.	Character data
ClinicalProtocolSite.RegionStatus	Region status.	Character data
ClinicalProtocolSite.SiteAccountRowId	Account row ID for the site associated.	Character data
ClinicalProtocolSite.SiteAccountName	Account name for the site associated.	Character data
ClinicalProtocolSite.SiteNumber	Site number.	Character data
ClinicalProtocolSite.Status	Protocol site status.	Character data
ClinicalProtocolSite.TerminatedDate	Site terminated date.	Date
ClinicalProtocolSite.TotalContractAmount	Total contract amount rolledup for the site.	Currency
LsCrfTrackingBc.NumberofPages	Total number of pages for the CRF record.	Number
LsCrfTrackingBc.ActivityType	Type of activity.	Character data
LsCrfTrackingBc.Category	Category.	Character data
LsCrfTrackingBc.ChartsReviewed	When was the charts reviewed.	UTC Date Time
LsCrfTrackingBc.Comments	Comments.	Character data
LsCrfTrackingBc.CRFRowIdId	CRF row ID.	Character data
LsCrfTrackingBc.Name2	Name of the CRF.	Character data
LsCrfTrackingBc.PagesVerified	Number of pages verified.	Number
LsCrfTrackingBc.ProtocolRegionId	Region Row ID.	Character data
LsCrfTrackingBc.ProtocolSiteId	Protocol site ID.	Character data
LsCrfTrackingBc.ReceivedbyDataManagement	Date when received by the data management.	UTC Date Time
LsCrfTrackingBc.Receivedinhouse	Date when the CRF was received by the in-house.	UTC Date Time
LsCrfTrackingBc.Retrieved	Boolen flag if the CRF information is retrieved or not.	Boolean
LsCrfTrackingBc.RetrievedDate	When the CRF was retrieved.	UTC Date Time
LsCrfTrackingBc.SignedForms	Whether the CRF are signed.	Boolean
LsCrfTrackingBc.SourceVerfied	The CRF is source verified.	Boolean
LsCrfTrackingBc.SourceVerifiedDate	When the CRF was source verified.	UTC Date Time
LsCrfTrackingBc.SubjectId	Subject row ID.	Character data
LsCrfTrackingBc.SubjectNumber	Subject number.	Character data

LS Clinical CRF Tracking Interface Service Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LS Clinical CRF Tracking Interface Service	LS Clinical CRF Tracking Interface Service	CSSEAIUIDataSyncService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS Clinical CRF Tracking IO	Clinical Protocol Site

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
LSClinicalCRFTrackingInterfaceServiceQueryByExample	QueryByExample
LSClinicalCRFTrackingInterfaceServiceQueryById	QueryById
LSClinicalCRFTrackingInterfaceServiceQueryPage	QueryPage

Example Package for LS Clinical CRF Tracking Interface Service

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

Request

See the following file to view the sample code:

...\LSClinical_CRFTracking\LS Clinical CRF Tracking Interface Service-QueryByExample-
request.xml
...\LSClinical_CRFTracking\LS Clinical CRF Tracking Interface Service-QueryById-
request.xml
...\LSClinical_CRFTracking\LS Clinical CRF Tracking Interface Service-QueryPage-
request.xml

Response

See the following file to view the sample code:

…\LSClinical_CRFTracking\LS Clinical CRF Tracking Interface Service-response.xml

Interface Description (WSDL) for LS Clinical CRF Tracking Interface Service

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

...\LSClinical_CRFTracking\LS Clinical CRF Tracking Interface 
Service_QueryByExample.WSDL
...\LSClinical_CRFTracking\LS Clinical CRF Tracking Interface Service_QueryById.WSDL
...\LSClinical_CRFTracking\LS Clinical CRF Tracking Interface Service_QueryPage.WSDL

LS Clinical Protocol Site Interface Service

Use this generic ASI-based Web service to pull information from protocol sites using Protocol Site, Region, or Protocol.

LS Clinical Protocol Interface Service Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
QueryById	This operation returns Protocol Site Information for the specified Protocol Site Id in the "Id" tag.
QueryByExample	Used to query all the Sites information based on given filter criteria.
QueryPage	Used to query all the Sites details in pages based on given filter criteria.

Request Message Description: QueryById

For a description of this request message, see the following table.

Name	Description	Type
PrimaryRowId	Required. Specify the Protocol Site RowId value for which the Protocol Site information should be returned.	String
UTCCanonical	This flag is N by default. If this flag is enabled (Y), then data from the Siebel application must be in UTC (Coordinated Universal Time) and canonical format. The data in UTC and canonical format is converted to Siebel Object Manager format as determined by the value of the UTCCanonical flag.	Boolean

Request Message Description: QueryByExample

For a description of this request message, see the following table.

Node	Description	Type
ClinicalProtocolSite.Completed Count	Count of the subjects for which the status tracking visit is completed.	Number
ClinicalProtocolSite.EarlyTerminated Count	Count of the subjects that are early terminated.	Number
ClinicalProtocolSite.EnrolledCount	Count of the subjects that are successfully enrolled.	Number
ClinicalProtocolSite.PlannedSubjects	Number of planned subjects for the site.	Number
ClinicalProtocolSite.Re-ScreenedCount	Count of the subjects that are rescreened.	Number
ClinicalProtocolSite.ScreenFailures Count	Count of the subjects that are screen failed.	Number
ClinicalProtocolSite.ScreenedCount	Count of the subjects that are screened successfully failed.	Number
ClinicalProtocolSite.AccountId	Account row ID.	Character data
ClinicalProtocolSite.Activate SynchronizationFlag	A Boolean flag that indicates if the sites are activated for synchronization. Used for SC-OC integration.	Boolean
ClinicalProtocolSite.Primary SiteAddress	Primary site address associated for the site. This is used for SC-OC integration.	Character data
ClinicalProtocolSite.PrimarySite AddressRowId	Primary site address row ID associated for the site. This is used for SC-OC integration.	Character data
ClinicalProtocolSite.Site AddressType	Site address type.	Character data
ClinicalProtocolSite.Amount CurrencyCode	Currency code of the site	Character data
ClinicalProtocolSite.Amount EarnedToDate	Amount earned by the principal investigator.	Number
ClinicalProtocolSite.Amount ExchangeDate	Exchange date for the amount at the site.	Date
ClinicalProtocolSite.Amount PaidToDate	Amount paid by the principal investigator.	Number
ClinicalProtocolSite.CDMSSite	The integration name used for the protocol or study. This is used for SC-OC integration.	Character data
ClinicalProtocolSite.CDMSStudyId	The RowId of the Study/Protocol. This is used for SC-OC Integration.	Character data
ClinicalProtocolSite.City	City.	Character data
ClinicalProtocolSite.ClinicalProgram Id	Program row ID.	Character data
ClinicalProtocolSite.ClinicalProgram Name	Program name.	Character data
ClinicalProtocolSite.Country	Country.	Character data
ClinicalProtocolSite.Description	Description.	Character data
ClinicalProtocolSite.Email	Email address.	Character data
ClinicalProtocolSite.FaxNumber	Fax number.	Number
ClinicalProtocolSite.FirstSubject EnrolledDate	Date when the subject was first enrolled.	Date
ClinicalProtocolSite.SiteRowId	Site row ID.	Character data
ClinicalProtocolSite.Initiation CompletedDate	Date when the subject was first enrolled.	Date
ClinicalProtocolSite.Primary InvestigatorFirstName	Principal investigator first name.	Character data
ClinicalProtocolSite.Primary InvestigatorLastName	Principal investigator last name.	Character data
ClinicalProtocolSite.Last CompletedDateFlag	Boolean flag value indicates if the reschedule should happen on the last completed date.	Boolean
ClinicalProtocolSite.Last SubjectOffStudyDate	Date when the last subject was terminated.	Date
ClinicalProtocolSite.LocaleId	Locale row ID.	Character data
ClinicalProtocolSite.LocaleName	Locale name.	Character data
ClinicalProtocolSite.Max EnrollmentNumber	Maximum enrolled subjects.	Number
ClinicalProtocolSite.No SubjectInfoFlag	Boolean flag indicating if the site has no subjects.	Boolean
ClinicalProtocolSite.PhoneNumber	Phone number.	Character data
ClinicalProtocolSite.PrevCDMSSite	Previous CDMSSite. Used for SC-OC integration.	Character data
ClinicalProtocolSite.PrimaryAddress Id	Primary address row ID.	Character data
ClinicalProtocolSite.Primary InvestigatorId	Primary investigator row ID.	Character data
ClinicalProtocolSite.Primary PositionId	Primary position row ID.	Character data
ClinicalProtocolSite.PrimarySubject TemplateId	Primary Subject Template row ID.	Character data
ClinicalProtocolSite.ProtocolId	Protocol row ID.	Character data
ClinicalProtocolSite.ProtocolNumber	Protocol number.	Character data
ClinicalProtocolSite.ProtocolNumber SitesPlanned	Number of sites planned for the protocol.	Number
ClinicalProtocolSite.ProtocolNumber SubjectsPlanned	Number of subjects panned for the protocol.	Number
ClinicalProtocolSite.ProtocolProduct Name	Product name associated to the protocol.	Character data
ClinicalProtocolSite.ProtocolProgram Indication	Program indication associated to the protocol.	Character data
ClinicalProtocolSite.ProtocolSiteId	Protocol site row ID.	Character data
ClinicalProtocolSite.ProtocolStatus	Protocol status.	Character data
ClinicalProtocolSite.ProtocolTitle	Protocol title.	Character data
ClinicalProtocolSite.Region	Region name.	Character data
ClinicalProtocolSite.RegionPlanned Sites	Planned number of sites for the region.	Character data
ClinicalProtocolSite.RegionPlanned Subjects	Planned number of subjects for the region.	Character data
ClinicalProtocolSite.RegionId	Region row ID.	Character data
ClinicalProtocolSite.RegionNoSite InfoFlag	Boolean flag, indicates if the region has no sites.	Boolean
ClinicalProtocolSite.RegionStatus	Region status.	Character data
ClinicalProtocolSite.RegionsRequired Flag	Boolean flag, indicates if the regions are mandatory for the protocol.	Boolean
ClinicalProtocolSite.SiteBillTo AddressId	Site billed to assigned address row ID.	Character data
ClinicalProtocolSite.SiteBillTo ContactId	Site billed to assigned contact ID.	Character data
ClinicalProtocolSite.SiteAccount RowId	Account Row Id assigned to the Site	Character data
ClinicalProtocolSite.SiteAccount Name	Account name.	Character data
ClinicalProtocolSite.SiteNumber	Site number.	Character data
ClinicalProtocolSite.State	State.	Character data
ClinicalProtocolSite.Status	Status.	Character data
ClinicalProtocolSite.StreetAddress	Street address.	Character data
ClinicalProtocolSite.TerminatedDate	Terminated date.	Date
ClinicalProtocolSite.TimeZone	Time zone in which the site is operating.	Character data
ClinicalProtocolSite.TimeZoneId	Time zone row ID.	Character data
ClinicalProtocolSite.TotalContract Amount	Total contract amount rolled up for the site.	Number
ClinicalProtocolSite.TotalVATAmount	Total VAT amount rolled up to the site.	Number
ClinicalProtocolSite.Withholding Amount	Site withholding amount.	Number
ClinicalProtocolSite.Withholding Percentage	Site withholding amount percentrage.	Number
ClinicalProtocolSite.Zip	ZIP code.	Character data
ClinicalProtocolSite.Searchspec	Search specification.	Character data
ClinicalProtocolSite_Position.Division	Division.	Character data
ClinicalProtocolSite_ Position.DivisionBU	Division business unit.	Character data
ClinicalProtocolSite_ Position.DivisionLocation	Division location.	Character data
ClinicalProtocolSite_ Position.IsPrimaryMVG	Boolean flag indicating if the position is primary at the site.	Boolean
ClinicalProtocolSite_ Position.Name2	Name.	Character data
ClinicalProtocolSite_ Position.RowStatus	Position status.	Character data
ClinicalProtocolSite_ Position.SalesRep	Sales representative.	Character data
ClinicalProtocolSite_ Position.Searchspec	Search specification.	Character data
ClinicalProtocolSite_ SubjectTemplate.IRBApprovalDate	IRB approval date for the associated SVT.	Date
ClinicalProtocolSite_ SubjectTemplate.IsPrimaryMVG	Boolean flag indicating if the subject template is primary at the site.	Boolean
ClinicalProtocolSite_ SubjectTemplate.Version	Subject template version.	Character data
ClinicalProtocolSite_ SubjectTemplate.Searchspec	Subject template search specification.	Character data

Request Message Description: QueryPage

For a description of this request message, see the following table.

Name	Description	Type
UTCCanonical	This flag is N by default. If this flag is enabled (Y), then data from the Siebel application must be in UTC (Coordinated Universal Time) and canonical format. The data in UTC and canonical format is converted to Siebel Object Manager format as determined by the value of the UTCCanonical flag.	Boolean
SortSpec	Determines whether the sort order is ascending or descending. Valid values are ASC or DEC.	Character Data
StartRowNum	Determines the starting point for record retrieval. The 0-based index of the record within the recordset.	Number
LastPage	Indicates whether the record being returned is the last record in the record set. Valid values are true or false.	Character Data
PageSize	The number of records to be returned for a component. The default page size is 10. Note that there is a server parameter that controls the maximum page size (MaximumPageSize). If the pagesize attribute is greater than the maximum pagesize defined in the server parameter, an error occurs.	Number
ClinicalProtocolSite.CompletedCount	Required. Can be either ‘*’ or a valid number.	Number
ClinicalProtocolSite.EarlyTerminatedCount	An optional search specification.	Number
ClinicalProtocolSite.EnrolledCount	Required. Can be either ‘*’ or a valid number.	Number
ClinicalProtocolSite.PlannedSubjects	Required. Can be either ‘*’ or a valid number.	Number
ClinicalProtocolSite.Re-ScreenedCount	Required. Can be either ‘*’ or a valid number.	Number
ClinicalProtocolSite.ScreenFailuresCount	Required. Can be either ‘*’ or a valid number.	Number
ClinicalProtocolSite.ScreenedCount	Required. Can be either ‘*’ or a valid number.	Number
ClinicalProtocolSite.AccountId	Required. Can be either ‘*’ or a valid Row ID.	Character data
ClinicalProtocolSite.ActivateSynchronizationFlag	Required. Can be either ‘*’ or a valid Boolean value.	Boolean
ClinicalProtocolSite.PrimarySiteAddress	Required. Can be either ‘*’ or a valid address.	Character data
ClinicalProtocolSite.PrimarySiteAddressRowId	Required. Can be either ‘*’ or a valid Address Row ID.	Character data
ClinicalProtocolSite.SiteAddressType	Required. Can be either ‘*’ or a valid address type.	Character data
ClinicalProtocolSite.AmountCurrencyCode	Required. Can be either ‘*’ or a valid currency code.	Character data
ClinicalProtocolSite.AmountEarnedToDate	Required. Can be either ‘*’ or a valid number.	Number
ClinicalProtocolSite.AmountExchangeDate	Required. Can be either ‘*’ or a valid date.	Date
ClinicalProtocolSite.AmountPaidToDate	Required. Can be either ‘*’ or a valid date.	Number
ClinicalProtocolSite.CDMSSite	Required. Can be either ‘*’ or a valid study name associated. Used for SC-OC Integration.	Character data
ClinicalProtocolSite.CDMSStudyId	Required. Can be either ‘*’ or a valid study row ID.	Character data
ClinicalProtocolSite.City	Required. Can be either ‘*’ or a valid city name.	Character data
ClinicalProtocolSite.ClinicalProgramId	Required. Can be either ‘*’ or a valid row ID.	Character data
ClinicalProtocolSite.ClinicalProgramName	Required. Can be either ‘*’ or a valid program name.	Character data
ClinicalProtocolSite.Country	Required. Can be either ‘*’ or a valid country name.	Character data
ClinicalProtocolSite.Description	Required. Can be either ‘*’ or a valid description.	Character data
ClinicalProtocolSite.Email	Required. Can be either ‘*’ or a valid email address.	Character data
ClinicalProtocolSite.FaxNumber	Required. Can be either ‘*’ or a valid fax number.	Number
ClinicalProtocolSite.FirstSubjectEnrolledDate	Required. Can be either ‘*’ or a valid date.	Date
ClinicalProtocolSite.SiteRowId	Required. Can be either ‘*’ or a valid row ID.	Character data
ClinicalProtocolSite.InitiationCompletedDate	Required. Can be either ‘*’ or a valid date.	Date
ClinicalProtocolSite.PrimaryInvestigatorFirstName	Required. Can be either ‘*’ or a valid first name.	Character data
ClinicalProtocolSite.PrimaryInvestigatorLastName	Required. Can be either ‘*’ or a valid last name.	Character data
ClinicalProtocolSite.LastCompletedDateFlag	Required. Can be either ‘*’ or a valid Boolean value.	Boolean
ClinicalProtocolSite.LastSubjectOffStudyDate	Required. Can be either ‘*’ or a valid date.	Date
ClinicalProtocolSite.LocaleId	Required. Can be either ‘*’ or a valid row ID.	Character data
ClinicalProtocolSite.LocaleName	Required. Can be either ‘*’ or a valid locale.	Character data
ClinicalProtocolSite.MaxEnrollmentNumber	Required. Can be either ‘*’ or a valid number.	Number
ClinicalProtocolSite.NoSubjectInfoFlag	Required. Can be either ‘*’ or a valid Boolean value.	Boolean
ClinicalProtocolSite.PhoneNumber	Required. Can be either ‘*’ or a valid phone number.	Character data
ClinicalProtocolSite.PrevCDMSSite	Required. Can be either ‘*’ or a valid PrevCDMSSite value. This is used for SC-OC integration.	Character data
ClinicalProtocolSite.PrimaryAddressId	Required. Can be either ‘*’ or a valid row ID.	Character data
ClinicalProtocolSite.PrimaryInvestigatorId	Required. Can be either ‘*’ or a valid row ID.	Character data
ClinicalProtocolSite.PrimaryPositionId	Required. Can be either ‘*’ or a valid position Row Id.	Character data
ClinicalProtocolSite.PrimarySubjectTemplateId	Required. Can be either ‘*’ or a valid Subject template row ID.	Character data
ClinicalProtocolSite.ProtocolId	Required. Can be either ‘*’ or a valid protocol row ID.	Character data
ClinicalProtocolSite.ProtocolNumber	Required. Can be either ‘*’ or a valid protocol number.	Character data
ClinicalProtocolSite.ProtocolNumberSitesPlanned	Required. Can be either ‘*’ or a valid number.	Number
ClinicalProtocolSite.ProtocolNumber SubjectsPlanned	Required. Can be either ‘*’ or a valid number.	Number
ClinicalProtocolSite.ProtocolProductName	Required. Can be either ‘*’ or a valid number.	Character data
ClinicalProtocolSite.ProtocolProgramIndication	Required. Can be either ‘*’ or a valid program indication.	Character data
ClinicalProtocolSite.ProtocolSiteId	Required. Can be either ‘*’ or a valid protocol site row ID.	Character data
ClinicalProtocolSite.ProtocolStatus	Required. Can be either ‘*’ or a valid protocol status.	Character data
ClinicalProtocolSite.ProtocolTitle	Required. Can be either ‘*’ or a valid protocol title.	Character data
ClinicalProtocolSite.Region	Required. Can be either ‘*’ or a valid region.	Character data
ClinicalProtocolSite.RegionPlannedSites	Required. Can be either ‘*’ or a valid number of planned sites for the region.	Character data
ClinicalProtocolSite.RegionPlannedSubjects	Required. Can be either ‘*’ or a valid number of planned subjects for the region.	Character data
ClinicalProtocolSite.RegionId	Required. Can be either ‘*’ or a valid region ID.	Character data
ClinicalProtocolSite.RegionNoSiteInfoFlag	Required. Can be either ‘*’ or a valid Region No Site Info flag.	Boolean
ClinicalProtocolSite.RegionStatus	Required. Can be either ‘*’ or a valid region status.	Character data
ClinicalProtocolSite.RegionsRequiredFlag	Required. Can be either ‘*’ or a valid Regions Required flag.	Boolean
ClinicalProtocolSite.SiteBillToAddressId	Required. Can be either ‘*’ or a valid Site Bill To Address ID.	Character data
ClinicalProtocolSite.SiteBillToContactId	Required. Can be either ‘*’ or a valid Site Bill To Contact ID.	Character data
ClinicalProtocolSite.SiteAccountRowId	Required. Can be either ‘*’ or a valid Site ID.	Character data
ClinicalProtocolSite.SiteAccountName	Required. Can be either ‘*’ or a valid Site name.	Character data
ClinicalProtocolSite.SiteNumber	Required. Can be either ‘*’ or a valid site number.	Character data
ClinicalProtocolSite.State	Required. Can be either ‘*’ or a valid state.	Character data
ClinicalProtocolSite.Status	Required. Can be either ‘*’ or a valid status.	Character data
ClinicalProtocolSite.StreetAddress	Required. Can be either ‘*’ or a valid street address.	Character data
ClinicalProtocolSite.TerminatedDate	Required. Can be either ‘*’ or a valid terminated date.	Date
ClinicalProtocolSite.TimeZone	Required. Can be either ‘*’ or a valid time zone.	Character data
ClinicalProtocolSite.TimeZoneId	Required. Can be either ‘*’ or a valid time zone ID.	Character data
ClinicalProtocolSite.TotalContractAmount	Required. Can be either ‘*’ or a valid total contract amount.	Number
ClinicalProtocolSite.TotalVATAmount	Required. Can be either ‘*’ or a valid VAT amount.	Number
ClinicalProtocolSite.WithholdingAmount	Required. Can be either ‘*’ or a valid withholding amount.	Number
ClinicalProtocolSite.WithholdingPercentage	Required. Can be either ‘*’ or a valid withholding percentage.	Number
ClinicalProtocolSite.Zip	Required. Can be either ‘*’ or a valid ZIP code.	Character data
ClinicalProtocolSite.Searchspec	Required. Can be either ‘*’ or a valid search specification.	Character data
ClinicalProtocolSite_Position.Division	Required. Can be either ‘*’ or a valid division.	Character data
ClinicalProtocolSite_Position.DivisionBU	Required. Can be either ‘*’ or a valid division business unit.	Character data
ClinicalProtocolSite_Position.DivisionLocation	Required. Can be either ‘*’ or a valid division location.	Character data
ClinicalProtocolSite_Position.IsPrimaryMVG	Required. Can be either ‘*’ or a valid Boolean value.	Boolean
ClinicalProtocolSite_Position.Name2	Required. Can be either ‘*’ or a valid name.	Character data
ClinicalProtocolSite_Position.RowStatus	Required. Can be either ‘*’ or a valid row status.	Character data
ClinicalProtocolSite_Position.SalesRep	Required. Can be either ‘*’ or a valid sales representative.	Character data
ClinicalProtocolSite_Position.Searchspec	Required. Can be either ‘*’ or a valid search specification.	Character data
ClinicalProtocolSite_SubjectTemplate.IRBApproval Date	Required. Can be either ‘*’ or a valid IRB approval date.	Date
ClinicalProtocolSite_SubjectTemplate.IsPrimary MVG	Required. Can be either ‘*’ or a valid Boolean value.	Boolean
ClinicalProtocolSite_SubjectTemplate.Version	Required. Can be either ‘*’ or a valid version.	Character data
ClinicalProtocolSite_SubjectTemplate.Searchspec	Required. Can be either ‘*’ or a valid search specification.	Character data

Response Message Description: All LS Clinical Protocol Site Interface Service

For a description of this request message, see the following table.

Name	Description	Type
ClinicalProtocolSite.CompletedCount	Count of the subjects for which the status tracking visit is completed.	Number
ClinicalProtocolSite.EarlyTerminatedCount	Count of the subjects that are early terminated.	Number
ClinicalProtocolSite.EnrolledCount	Count of the subjects that are successfully enrolled.	Number
ClinicalProtocolSite.PlannedSubjects	Number of planned subjects for the site.	Number
ClinicalProtocolSite.Re-ScreenedCount	Count of the subjects that are rescreened.	Number
ClinicalProtocolSite.ScreenFailuresCount	Count of the subjects that are screen failed.	Number
ClinicalProtocolSite.ScreenedCount	Count of the subjects that are screened successfully failed.	Number
ClinicalProtocolSite.AccountId	Account row ID.	Character data
ClinicalProtocolSite.ActivateSynchronizationFlag	A Boolean flag which indicates if the sites are activated for synchronization. This is used for SC-OC Integration.	Boolean
ClinicalProtocolSite.PrimarySiteAddress	Primary site address associated for the site. This is used for SC-OC Integration.	Character data
ClinicalProtocolSite.PrimarySiteAddressRowId	Primary site address row ID associated for the site. This is used for SC-OC Integration.	Character data
ClinicalProtocolSite.SiteAddressType	Site address type.	Character data
ClinicalProtocolSite.AmountCurrencyCode	Currency code of the site.	Character data
ClinicalProtocolSite.AmountEarnedToDate	Amount Earned by the primary investigator.	Number
ClinicalProtocolSite.AmountExchangeDate	Exchange date for the amount at the site.	Date
ClinicalProtocolSite.AmountPaidToDate	Amount paid by the primary investigator.	Number
ClinicalProtocolSite.CDMSSite	The integration name used for the protocol or study. This is used for SC-OC Integration.	Character data
ClinicalProtocolSite.CDMSStudyId	The row ID of the study or protocol. This is used for SC-OC Integration.	Character data
ClinicalProtocolSite.City	City.	Character data
ClinicalProtocolSite.ClinicalProgramId	Program row ID.	Character data
ClinicalProtocolSite.ClinicalProgramName	Program name.	Character data
ClinicalProtocolSite.Country	Country.	Character data
ClinicalProtocolSite.Description	Description.	Character data
ClinicalProtocolSite.Email	Email address.	Character data
ClinicalProtocolSite.FaxNumber	Fax number.	Number
ClinicalProtocolSite.FirstSubjectEnrolledDate	Date when the subject was first enrolled.	Date
ClinicalProtocolSite.SiteRowId	Site row ID.	Character data
ClinicalProtocolSite.InitiationCompletedDate	Date when the subject was first enrolled.	Date
ClinicalProtocolSite.PrimaryInvestigatorFirstName	Principal investigator first name.	Character data
ClinicalProtocolSite.PrimaryInvestigatorLastName	Principal investigator last name.	Character data
ClinicalProtocolSite.LastCompletedDateFlag	Boolean flag value indicates if the reschedule should happen on the last completed date.	Boolean
ClinicalProtocolSite.LastSubjectOffStudyDate	Date when the last subject was terminated.	Date
ClinicalProtocolSite.LocaleId	Locale row ID.	Character data
ClinicalProtocolSite.LocaleName	Locale name.	Character data
ClinicalProtocolSite.MaxEnrollmentNumber	Maximum enrolled subjects.	Number
ClinicalProtocolSite.NoSubjectInfoFlag	Boolean flag indicating if the sites has no subjects.	Boolean
ClinicalProtocolSite.PhoneNumber	Phone number.	Character data
ClinicalProtocolSite.PrevCDMSSite	Previous CDMSSite. Used for SC-OC Integration.	Character data
ClinicalProtocolSite.PrimaryAddressId	Primary address row ID.	Character data
ClinicalProtocolSite.PrimaryInvestigatorId	Primary investigator row ID.	Character data
ClinicalProtocolSite.PrimaryPositionId	Primary position row ID.	Character data
ClinicalProtocolSite.PrimarySubjectTemplateId	Primary subject template row ID.	Character data
ClinicalProtocolSite.ProtocolId	Protocol row ID.	Character data
ClinicalProtocolSite.ProtocolNumber	Protocol number.	Character data
ClinicalProtocolSite.ProtocolNumberSitesPlanned	Number of sites planned for the protocol.	Number
ClinicalProtocolSite.ProtocolNumberSubjects Planned	Number of subjects planned for the protocol.	Number
ClinicalProtocolSite.ProtocolProductName	Product name associated to the protocol.	Character data
ClinicalProtocolSite.ProtocolProgramIndication	Program indication associated to the protocol.	Character data
ClinicalProtocolSite.ProtocolSiteId	Protocol site row ID.	Character data
ClinicalProtocolSite.ProtocolStatus	Protocol status.	Character data
ClinicalProtocolSite.ProtocolTitle	Protocol title.	Character data
ClinicalProtocolSite.Region	Region name.	Character data
ClinicalProtocolSite.RegionPlannedSites	Planned number of sites for the region.	Character data
ClinicalProtocolSite.RegionPlannedSubjects	Planned number of subjects for the region.	Character data
ClinicalProtocolSite.RegionId	Region row ID.	Character data
ClinicalProtocolSite.RegionNoSiteInfoFlag	Boolean flag. It indicates whether the region has no sites.	Boolean
ClinicalProtocolSite.RegionStatus	Region status.	Character data
ClinicalProtocolSite.RegionsRequiredFlag	Boolean flag, indicates if the regions are mandatory for the protocol	Boolean
ClinicalProtocolSite.SiteBillToAddressId	Site billed to assigned address row ID.	Character data
ClinicalProtocolSite.SiteBillToContactId	Site billed to assigned contact ID.	Character data
ClinicalProtocolSite.SiteAccountRowId	Account row ID assigned to the site.	Character data
ClinicalProtocolSite.SiteAccountName	Account Name.	Character data
ClinicalProtocolSite.SiteNumber	Site Number.	Character data
ClinicalProtocolSite.State	State.	Character data
ClinicalProtocolSite.Status	Status.	Character data
ClinicalProtocolSite.StreetAddress	Street address.	Character data
ClinicalProtocolSite.TerminatedDate	Terminated date.	Date
ClinicalProtocolSite.TimeZone	Time zone in which the site is operating.	Character data
ClinicalProtocolSite.TimeZoneId	Time zone row ID.	Character data
ClinicalProtocolSite.TotalContractAmount	Total contract amount rolled up for the site.	Number
ClinicalProtocolSite.TotalVATAmount	Total VAT amount rolled up to the site.	Number
ClinicalProtocolSite.WithholdingAmount	Site withholding amount.	Number
ClinicalProtocolSite.WithholdingPercentage	Site withholding amount percentage.	Number
ClinicalProtocolSite.Zip	ZIP code.	Character data
ClinicalProtocolSite.Searchspec	Search specification.	Character data
ClinicalProtocolSite_Position.Division	Division.	Character data
ClinicalProtocolSite_Position.DivisionBU	Division business unit.	Character data
ClinicalProtocolSite_Position.DivisionLocation	Division location.	Character data
ClinicalProtocolSite_Position.IsPrimaryMVG	Boolean flag indicating if the position is primary at the site.	Boolean
ClinicalProtocolSite_Position.Name2	Name.	Character data
ClinicalProtocolSite_Position.RowStatus	Position status.	Character data
ClinicalProtocolSite_Position.SalesRep	Sales representative.	Character data
ClinicalProtocolSite_Position.Searchspec	Search specification.	Character data
ClinicalProtocolSite_ SubjectTemplate.IRBApprovalDate	IRB approval date for the associated SVT.	Date
ClinicalProtocolSite_ SubjectTemplate.IsPrimaryMVG	Boolean flag indicating if the subject template is primary at the site.	Boolean
ClinicalProtocolSite_SubjectTemplate.Version	Subject template version.	Character data
ClinicalProtocolSite_SubjectTemplate.Searchspec	Subject template search specification.	Character data

LS Clinical Protocol Site Interface Service Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LS Clinical Protocol Site Interface Service	LS Clinical Protocol Site Interface Service	CSSEAIDataSyncService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS Clinical Protocol Site Information IO	Clinical Protocol Site

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
LSClinicalProtocolSiteInterfaceServiceQueryByExample	QueryByExample
LSClinicalProtocolSiteInterfaceServiceQueryById	QueryById
LSClinicalProtocolSiteInterfaceServiceQueryPage	QueryPage

Example Package for LS Clinical Protocol Site Interface Service

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

Request

See the following file to view the sample code:

...\LSClinical_ProtocolSite\LS_Clinical_Protocol_Site_Interface_Service-
QueryByExample-request.xml
...\LSClinical_ProtocolSite\LS_Clinical_Protocol_Site_Interface_Service-QueryById-
request.xml
...\LSClinical_ProtocolSite\LS_Clinical_Protocol_Site_Interface_Service-QueryPage-
request.xml

Response

See the following file to view the sample code:

…\LSClinical_ProtocolSite\LS_Clinical_Protocol_Site_Interface_Service-response.xml

Interface Description (WSDL) for LS Clinical Protocol Site Interface Service

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

...\LS Clinical_ProtocolSite\LS_Clinical_Protocol_Site_Interface_Service-
QueryByExample.WSDL
...\LS Clinical_ProtocolSite\LS_Clinical_Protocol_Site_Interface_Service-
QueryById.WSDL
...\LS Clinical_ProtocolSite\LS_Clinical_Protocol_Site_Interface_Service-
QueryPage.WSDL

LS Clinical Subject Information Interface Service

Use this generic ASI-based Web service to to pull all the subject statuses in a given date range for the protocol, region, or site. An external application invokes this Web service with details such as Protocol Id, Protocol Title, Protocol Number, Protocol Site Id, Region, and so on. No error message is returned in cases where the Web service search criteria fails to return the required subject information.

LS Clinical Subject Information Interface Service Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
QueryById	This operation returns the subjects with status information for the specified Protocol Site Id in the "Id" tag.
QueryByExample	Used to query status for Subjects based on given filter criteria.
QueryPage	Used to query all the Subject status information in pages based on given filter criteria.

Request Message Description: Query ById

For a description of this request message, see the following table.

Name	Description	Type
PrimaryRowId	Required. Specify the Protocol Site RowId value for which the Protocol Site information should be returned.	Character data
UTCCanonical	This flag is N by default. If this flag is enabled (Y), then data from the Siebel application must be in UTC (Coordinated Universal Time) and canonical format. The data in UTC and canonical format is converted to Siebel Object Manager format as determined by the value of the UTCCanonical flag.	Boolean

Request Message Description: QueryByExample

For a description of this request message, see the following table.

Node	Description	Type
ClinicalProtocolSite.PlannedSubjects	Count of the subjects for which the status tracking visit is completed.	Number
ClinicalProtocolSite.Amoung CurrencyCode	Amount currency code.	Character data
ClinicalProtocolSite.Amount Exchange	Amount exchange date.	Date
ClinicalProtocolSite.FirstSubject Enroll	First subject enrolled date.	Date
ClinicalProtocolSite.SiteRowId	Site row ID.	Character data
ClinicalProtocolSite.Initiation CompletedDate	Site initiation date.	Date
ClinicalProtocolSite.Investigator FirstName	Investigator’s first name.	Number
ClinicalProtocolSite.Investigator FirstName	Investigator last name.	Character data
ClinicalProtocolSite.LastSubject OffStudyDate	Last subject terminated date for the site.	Date
ClinicalProtocolSite.Primary InvestigatorId	ID of the primary investigator.	Character data
ClinicalProtocolSite.ProtocolId	Protocol ID.	Character data
ClinicalProtocolSite.ProtocolNumber	Protocol number.	Character data
ClinicalProtocolSite.ProtocolNumber SitesPlanned	Number of sites planned for the protocol.	Number
ClinicalProtocolSite.ProtocolNumber SubjectsPlanned	Number of subjects planned for the protocol.	Number
ClinicalProtocolSite.ProtocolSiteId	Protocol site ID.	Character data
ClinicalProtocolSite.ProtocolStatus	Protocol status.	Character data
ClinicalProtocolSite.ProtocolTitle	Protocol title.	Character data
ClinicalProtocolSite.Region	Region.	Character data
ClinicalProtocolSite.Region PlannedSites	Number of planned sites for the region.	Number
ClinicalProtocolSite.Region PlannedSubjects	Number of planned subjects for the region.	Number
ClinicalProtocolSite.RegionId	Region row ID.	Character data
ClinicalProtocolSite.RegionStatus	Region status.	Character data
ClinicalProtocolSite.Site AccountRowId	Site row ID.	Character data
ClinicalProtocolSite.Site AccountName	Site name.	Character data
ClinicalProtocolSite.SiteNumber	Site number.	Character data
ClinicalProtocolSite.Status	Status.	Character data
ClinicalProtocolSite.TerminatedDate	Site termination date.	Date
ClinicalProtocolSite.TotalContract Amount	Total contract amount.	Number
ClinicalSubject.Searchspec	Search specification.	Character data
ClinicalSubject.Comments	Comments.	Character data
ClinicalSubject.EncounterDate	Date of birth.	Date
ClinicalSubject.EarlyTerminatedDate	Early terminated date.	Date
ClinicalSubject.EligibleFlag	Eligible flag.	Boolean
ClinicalSubject.EnrollmentId	Enrollment ID.	Character data
ClinicalSubject.SubjectRowId	Row ID of the subject.	Character data
ClinicalSubject.PrimaryInformed ConsentDate	Primary informed consent date for the subject.	Date
ClinicalSubject.ProtocolDeviation	Protocol deviation.	Boolean
ClinicalSubject.ProtocolNumber	Protocol number.	Character data
ClinicalSubject.ProtocolViolation	Protocol violation.	Boolean
ClinicalSubject.RandomizationId	Randomization ID.	Character data
ClinicalSubject.RandomizedDate	Randomized date.	Character data
ClinicalSubject.ScreenFailure Reason	Reason excluded.	Character data
ClinicalSubject.ScreenFailureDate	Screen failure date.	Date
ClinicalSubject.SubjectId	Subject initials.	Character data
ClinicalSubject.SubjectNumber	Subject number.	Character data
ClinicalSubject.WithdrawnDate	Withdrawn date.	Date
ClinicalSubject.WithdrawnReason	Withdrawn reason.	Character data
ClinicalSubject.Searchspec	Search specification.	Character data
ClinicalSubject_ClinicalSubject Status.Status	Subject status.	Character data
ClinicalSubject_ClinicalSubject Status.StatusComments	Status comments.	Character data
ClinicalSubject_ClinicalSubject Status.StatusDate	Status date.	Date
ClinicalSubject_ClinicalSubject Status.VisitType	Visit type.	Character data
ClinicalSubject_ClinicalSubject Status.Searchspec	Search specficification.	Character data
ClinicalSubject_ClinicalSubject Status.StatusRegionId	Status Region ID.	Character data
ClinicalSubject_ClinicalSubject Status.StatusRegion	Status Region.	Character data
ClinicalSubject_ClinicalSubject Status.StatusSiteId	Status Site Id.	Character data
ClinicalSubject_ClinicalSubject Status.StatusSiteNumber	Status Site Number.	Character data

Request Message Description: QueryPage

For a description of this request message, see the following table.

Node	Description	Type
UTCCanonical	This flag is N by default. If this flag is Y, then data from the Siebel application must be in UTC (Coordinated Universal Time) and canonical format. The data in UTC and canonical format is converted to Siebel object manager format as determined by the value of the UTCCanonical flag.	Boolean
SortSpec	Determines whether the sort order is ascending or descending. Valid values are ASC or DEC.	Character Data
StartRowNum	Determines the starting point for record retrieval. The 0-based index of the record within the record set.	Number
PageSize	The number of records to be returned for a component. The default page size is 10. Note that there is a server parameter that controls the maximum page size (MaximumPageSize). If the pagesize attribute is greater than the maximum pagesize defined in the server parameter, an error occurs.	Number
ClinicalProtocolSite.PlannedSubjects	Count of the subjects for which the status tracking visit is completed.	Number
ClinicalProtocolSite.AmountCurrencyCode	Amount currency code.	Character data
ClinicalProtocolSite.AmountExchange	Amount exchange date.	Date
ClinicalProtocolSite.FirstSubjectEnrolledDate	First subject enrolled date.	Date
ClinicalProtocolSite.SiteRowId	Site row ID.	Character data
ClinicalProtocolSite.InitiationCompletedDate	Site initiation date.	Date
ClinicalProtocolSite.InvestigatorFirstName	Investigator's first name.	Number
ClinicalProtocolSite.InvestigatorFirstName	Investigator last name.	Character data
ClinicalProtocolSite.LastSubjectOffStudyDate	Last subject terminated date for the site.	Date
ClinicalProtocolSite.PrimaryInvestigatorId	ID of the primary investigator.	Character data
ClinicalProtocolSite.ProtocolId	Protocol ID.	Character data
ClinicalProtocolSite.ProtocolNumber	Protocol number.	Character data
ClinicalProtocolSite.ProtocolNumberSitesPlanned	Number of sites planned for the protocol.	Number
ClinicalProtocolSite.ProtocolNumberSubjects Planned	Number of subjects planned for the protocol.	Number
ClinicalProtocolSite.ProtocolSiteId	Protocol site ID.	Character data
ClinicalProtocolSite.ProtocolStatus	Protocol status.	Character data
ClinicalProtocolSite.ProtocolTitle	Protocol title.	Character data
ClinicalProtocolSite.Region	Region.	Character data
ClinicalProtocolSite.RegionPlannedSites	Number of planned sites for the region.	Number
ClinicalProtocolSite.RegionPlannedSubjects	Number of planned subjects for the region.	Number
ClinicalProtocolSite.RegionId	Region row ID.	Character data
ClinicalProtocolSite.RegionStatus	Region status.	Character data
ClinicalProtocolSite.SiteAccountRowId	Site row ID.	Character data
ClinicalProtocolSite.SiteAccountName	Site name.	Character data
ClinicalProtocolSite.SiteNumber	Site number.	Character data
ClinicalProtocolSite.Status	Status.	Character data
ClinicalProtocolSite.TerminatedDate	Site termination date.	Date
ClinicalProtocolSite.TotalContractAmount	Total contract amount.	Number
ClinicalSubject.Searchspec	Search specification.	Character data
ClinicalSubject.Comments	Comments.	Character data
ClinicalSubject.EncounterDate	Date of birth.	Date
ClinicalSubject.EarlyTerminatedDate	Early terminated date.	Date
ClinicalSubject.EligibleFlag	Eligible flag.	Boolean
ClinicalSubject.EnrollmentId	Enrollment ID.	Character data
ClinicalSubject.SubjectRowId	Row ID of the subject.	Character data
ClinicalSubject.PrimaryInformedConsentDate	Primary informed consent date for the subject.	Date
ClinicalSubject.ProtocolDeviation	Protocol deviation.	Boolean
ClinicalSubject.ProtocolNumber	Protocol number.	Character data
ClinicalSubject.ProtocolViolation	Protocol violation.	Boolean
ClinicalSubject.RandomizationId	Randomization ID.	Character data
ClinicalSubject.RandomizedDate	Randomized date.	Character data
ClinicalSubject.ScreenFailureReason	Reason excluded.	Character data
ClinicalSubject.ScreenFailureDate	Screen failure date.	Date
ClinicalSubject.SubjectId	Subject initials.	Character data
ClinicalSubject.SubjectNumber	Subject number.	Character data
ClinicalSubject.WithdrawnDate	Withdrawn date.	Date
ClinicalSubject.WithdrawnReason	Withdrawn reason.	Character data
ClinicalSubject.Searchspec	Search specification.	Character data
ClinicalSubject_ClinicalSubjectStatus.Status	Subject status.	Character data
ClinicalSubject_ClinicalSubjectStatus.Status Comments	Status comments.	Character data
ClinicalSubject_ClinicalSubjectStatus.StatusDate	Status date.	Date
ClinicalSubject_ClinicalSubjectStatus.VisitType	Visit type.	Character data
ClinicalSubject_ClinicalSubjectStatus.Searchspec	Search specficification.	Character data
ClinicalSubject_ClinicalSubject Status.StatusRegionId	Status Region Id.	Character data
ClinicalSubject_ClinicalSubject Status.StatusRegion	Status Region.	Character data
ClinicalSubject_ClinicalSubjectStatus.StatusSiteId	Status Site Id.	Character data
ClinicalSubject_ClinicalSubject Status.StatusSiteNumber	Status Site Number.	Character data

Response Message Description: All LS Clinical Subject Information Interface Service

For a description of this request message, see the following table.

Name	Description	Type
ClinicalProtocolSite.PlannedSubjects	Count of the subjects for which the status tracking visit is completed.	Number
ClinicalProtocolSite.AmountCurrencyCode	Amount currency code.	Character data
ClinicalProtocolSite.AmountExchange	Amount exchange date.	Date
ClinicalProtocolSite.FirstSubjectEnrolledDate	First subject enrolled date.	Date
ClinicalProtocolSite.InitiationCompletedDate	Site initiation date.	Date
ClinicalProtocolSite.InvestigatorFirstName	Investigator's first name.	Number
ClinicalProtocolSite.InvestigatorFirstName	Investigator last name.	Character data
ClinicalProtocolSite.LastSubjectOffStudyDate	Last subject terminated date for the site.	Date
ClinicalProtocolSite.PrimaryInvestigatorId	ID of the primary investigator.	Character data
ClinicalProtocolSite.ProtocolId	Protocol ID.	Character data
ClinicalProtocolSite.ProtocolNumber	Protocol number.	Character data
ClinicalProtocolSite.ProtocolSiteId	Protocol site ID.	Character data
ClinicalProtocolSite.ProtocolStatus	Protocol status.	Character data
ClinicalProtocolSite.ProtocolTitle	Protocol title.	Character data
ClinicalProtocolSite.Region	Region.	Character data
ClinicalProtocolSite.RegionPlannedSites	Number of planned sites for the region.	Number
ClinicalProtocolSite.RegionPlannedSubjects	Number of planned subjects for the region.	Number
ClinicalProtocolSite.RegionId	Region row ID.	Character data
ClinicalProtocolSite.RegionStatus	Region status.	Character data
ClinicalProtocolSite.SiteAccountRowId	Site row ID.	Character data
ClinicalProtocolSite.SiteAccountName	Site name.	Character data
ClinicalProtocolSite.SiteNumber	Site number.	Character data
ClinicalProtocolSite.Status	Status.	Character data
ClinicalProtocolSite.TerminatedDate	Site termination date.	Date
ClinicalProtocolSite.TotalContractAmount	Total contract amount.	Number
ClinicalSubject.Comments	Comments.	Character data
ClinicalSubject.EncounterDate	Date of birth.	Date
ClinicalSubject.EarlyTerminatedDate	Early terminated date.	Date
ClinicalSubject.EarlyTerminationReason	Early termination Reason	Character data
ClinicalSubject.EligibleFlag	Eligible flag.	Boolean
ClinicalSubject.EnrollmentId	Enrollment ID.	Character data
ClinicalSubject.PrimaryInformedConsentDate	Primary informed consent date for the subject.	Date
ClinicalSubject.ProtocolDeviation	Protocol deviation.	Boolean
ClinicalSubject.ProtocolNumber	Protocol number.	Character data
ClinicalSubject.ProtocolViolation	Protocol violation.	Boolean
ClinicalSubject.RandomizationId	Randomization ID.	Character data
ClinicalSubject.RandomizedDate	Randomized date.	Character data
ClinicalSubject.ScreenFailureReason	Reason excluded.	Character data
ClinicalSubject.ScreenFailureDate	Screen failure date.	Date
ClinicalSubject.SubjectId	Subject initials.	Character data
ClinicalSubject.SubjectNumber	Subject number.	Character data
ClinicalSubject.WithdrawnDate	Withdrawn date.	Date
ClinicalSubject.WithdrawnReason	Withdrawn reason.	Character data
ClinicalSubject_ClinicalSubjectStatus.Status	Subject status.	Character data
ClinicalSubject_ClinicalSubject Status.StatusComments	Status comments.	Character data
ClinicalSubject_ClinicalSubjectStatus.StatusDate	Status date.	Date
ClinicalSubject_ClinicalSubjectStatus.VisitType	Visit type.	Character data
ClinicalSubject_ClinicalSubject Status.StatusRegionId	Status Region Id.	Character data
ClinicalSubject_ClinicalSubjectStatus.StatusRegion	Status Region.	Character data
ClinicalSubject_ClinicalSubjectStatus.StatusSiteId	Status Site Id.	Character data
ClinicalSubject_ClinicalSubject Status.StatusSiteNumber	Status Site Number.	Character data

LS Clinical Subject Information Interface Service Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LS Clinical Subject Information Interface Service	LS Clinical Subject Information Interface Service	CSSEAIDataSyncService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS Clinical Subject Information Interface Service	Clinical Protocol Site

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
LSClinicalSubjectInformationInterfaceServiceQueryByExample	QueryByExample
LSClinicalSubjectInformationInterfaceServiceQueryById	QueryById
LSClinicalSubjectInformationInterfaceServiceQueryPage	QueryPage

Example Package for LS Clinical Subject Information Interface Service

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

Request

See the following file to view the sample code:

...\LSClinical_Subject_Information_Interface_Service\LS_Clinical_Subject_Information_I
nterface_Service-QueryByExample-request.xml
...\LSClinical_Subject_Information_Interface_Service\LS_Clinical_Subject_Information_I
nterface_Service-QueryById-request.xml
...\LSClinical_Subject_Information_Interface_Service\LS_Clinical_Subject_Information_I
nterface_Service-QueryPage-request.xml

Response

See the following file to view the sample code:

…\LSClinical_Subject_Information_Interface_Service\LS_Clinical_Protocol_Site_Interface
_Service-response.xml

Interface Description (WSDL) for LS Clinical Subject Information Interface Service

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

...\LSClinical_Subject_Information_Interface_Service\LS_Clinical_Subject_Information_I
nterface_Service-QueryByExample.WSDL

LS Clinical Trip Report File Transfer

Use this generic Web service to send and store a completed trip's approved BIP report in external systems such as ETMF. Once stored in ETMF, the URL of the report will be sent back to the CTMS system using this Web service. In this way, the external applications can query one or more trip reports for the approval report. The query operations will return trip reports along with approved BIP report. The upsert operation will update the ETMF URL back in the CTMS system.

LS Clinical Trip Report File Transfer Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
LSClinicalTripReportFileTransferQuery	This operation returns one or more trip reports along with approved BIP report attachments if any.
LSClinicalTripReportFileTransferQueryPage	This operation returns pages of trip reports along with approved BIP report attachments if any.
LSClinicalTripReportFileTransferUpsert	This operation is used to update the external system URL back to the CTMS system.

Request Message Description: LSClinicalTripReportFileTransferQuery and LSClinicalTripReportFileTransferUpsert.

Name	Description	Type
ClinicalTripReport.Searchspec	Custom search spec to query items such as approved trip reports and trip reports whose BIP reports are not yet uploaded to ETMF.	Character
ClinicalTripReport.TripReportID	Row Id of Trip report.	Character
ClinicalTripReport.VisitName	Name of Trip Report.	Character
ClinicalTripReport.VisitType	Trip Report Type.	Character
ClinicalTripReport.VisitStart	Trip Report Start Date.	Date
ClinicalTripReport.ProtocolId	Protocol Row Id.	Character
ClinicalTripReport.ProtocolNumber	Protocol Number.	Character
ClinicalTripReport.Region	Region Name.	Character
ClinicalTripReport.RegionId	Region Row Id.	Character
ClinicalTripReport.ProtocolSiteId	Site Row Id.	Character
ClinicalTripReport.SiteNumber	Protocol Site Number.	Character
ClinicalTripReport.PIFirstName	Principle Investigator First Name.	Character
ClinicalTripReport.PILastName	Principle Investigator Last Name.	Character
ClinicalTripReport.TripReportStatus	Trip Report Status.	Character
ClinicalTripReport.ApprovedDate	Approval date of trip report.	Date
ClinicalTripReport.EtmfReceivdDate	Date of receipt of ETMF file in the external system.	Date
ClinicalTripReport.EtmfUrl	URL of the approved BIP Report that is stored in the external ETMF system.	Character
ClinicalTripReport_ LSClinicalSiteVisitsAttachment.Id	Trip Report Attachment Row Id.	Character
ClinicalTripReport_ LSClinicalSiteVisitsAttachment. Searchspec	Trip Report Attachment Search specification.	Character
ClinicalTripReport_ LSClinicalSiteVisitsAttachment. Comment	Trip Report Attachment comments.	Character
ClinicalTripReport_ LSClinicalSiteVisitsAttachment. SiteVisitFileExt	Trip Report Attachment file extension type.	Character
ClinicalTripReport_ LSClinicalSiteVisitsAttachment. Name	Trip Report Attachment File Name.	Character
ClinicalTripReport_ LSClinicalSiteVisitsAttachment. AttachmentType	Trip Report Attachment File Type such as ETMF File or ETMF URL.	Character

Request Message Description: LSClinicalTripReportFileTransferQueryPage

Name	Description	Type
SortSpec	Determines whether the the sort order is ascending or descending. Valid values are ASC or DEC.	Character
StartRowNum	Determines the starting point for record retrieval. The 0-based index of the record within the record set.	Character
PageSize	The number of records to be returned for a component. The default page size is 10. Note that there is a server parameter that controls the maximum page size (MaximumPageSize). If the pagesize attribute is greater than the maximum pagesize defined in the server parameter, an error occurs.	Character
ClinicalTripReport.Searchspec	Custom search spec to query items such as approved trip reports and trip reports whose BIP reports are not yet uploaded to ETMF.	Character
ClinicalTripReport.TripReportID	Row Id of Trip report.	Character
ClinicalTripReport.VisitName	Name of Trip Report.	Character
ClinicalTripReport.VisitType	Trip Report Type.	Character
ClinicalTripReport.VisitStart	Trip Report Start Date.	Date
ClinicalTripReport.ProtocolId	Protocol Row Id.	Character
ClinicalTripReport.ProtocolNumber	Protocol Number.	Character
ClinicalTripReport.Region	Region Name.	Character
ClinicalTripReport.RegionId	Region Row Id.	Character
ClinicalTripReport.ProtocolSiteId	Site Row Id.	Character
ClinicalTripReport.SiteNumber	Protocol Site Number.	Character
ClinicalTripReport.PIFirstName	Principle Investigator First Name.	Character
ClinicalTripReport.PILastName	Principle Investigator Last Name.	Character
ClinicalTripReport.TripReportStatus	Trip Report Status.	Character
ClinicalTripReport.ApprovedDate	The date when trip report was approved.	Date
ClinicalTripReport.EtmfReceivdDate	The date when ETMF file was received by external system.	Date
ClinicalTripReport.EtmfUrl	URL of the approved BIP Report that is stored in the external ETMF system.	Character
ClinicalTripReport_ LSClinicalSiteVisitsAttachment.Id	Trip Report Attachment Row Id.	Character
ClinicalTripReport_ LSClinicalSiteVisitsAttachment. Searchspec	Trip Report Attachment Search specification.	Character
ClinicalTripReport_ LSClinicalSiteVisitsAttachment. Comment	Trip Report Attachment comments.	Character
ClinicalTripReport_ LSClinicalSiteVisitsAttachment. SiteVisitFileExt	Trip Report Attachment file extension type.	Character
ClinicalTripReport_ LSClinicalSiteVisitsAttachment. Name	Trip Report Attachment File Name.	Character
ClinicalTripReport_ LSClinicalSiteVisitsAttachment. AttachmentType	Trip Report Attachment File Type such as ETMF File or ETMF URL.	Character

Response Message Description: LSClinicalTripReportFileTransferQuery & LSClinicalTripReportFileTransferQueryPage

Name	Description	Type
ClinicalTripReport.TripReportID	Trip Report Row Id.	Character
ClinicalTripReport.VisitName	Trip Report Name.	Character
ClinicalTripReport.VisitType	Trip Report Type.	Character
ClinicalTripReport.VisitStart	Trip Report Start Date.	Date
ClinicalTripReport.ProtocolId	Protocol Row Id.	Character
ClinicalTripReport.ProtocolNumber	Protocol Row Number.	Character
ClinicalTripReport.Region	Region Name.	Character
ClinicalTripReport.RegionId	Region Row Id.	Character
ClinicalTripReport.ProtocolSiteId	Protocol Site Row Id.	Character
ClinicalTripReport.SiteNumber	Protocol Site Number.	Character
ClinicalTripReport.PIFirstName	Principle Investigator First name.	Character
ClinicalTripReport.PILastName	Principle Investigator Last name.	Character
ClinicalTripReport.TripReportStatus	Trip Report Status.	Character
ClinicalTripReport.ApprovedDate	Approval date of Trip Report.	Date
ClinicalTripReport.EtmfReceivdDate	Date of receipt of the BIP report in the external ETMF system.	Date
ClinicalTripReport.EtmfUrl	URL of BIP Report that is stored in the external ETMF system.	Character
ClinicalTripReport_ LSClinicalSiteVisitsAttachment.Comment	Attachment comments.	Character
ClinicalTripReport_ LSClinicalSiteVisitsAttachment.SiteVisitFileExt	File extension type such as PDF or DOC.	Character
ClinicalTripReport_ LSClinicalSiteVisitsAttachment.Name	Attachment name.	Character
ClinicalTripReport_ LSClinicalSiteVisitsAttachment.AttachmentType	Attachment type such as ETMF File or ETMF URL.	Character
ClinicalTripReport_ LSClinicalSiteVisitsAttachment.SiteVisitFileBuffer	File attachment in the form of base encode 64.	Character

Response Message Description: LSClinicalTripReportFileTransferUpsert

Name	Description	Type
ClinicalTripReport. PrimaryRowId	The updated Trip Report Row Id.	Character

LS Clinical Trip Report File Transfer Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LS Clinical Trip Report File Transfer	Business Service	CSSEAISiebelAdapterService

Data Object (Integration Object)

For a description of the service objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS Clinical Trip Report File Transfer	Clinical Trip Report

Methods

For a description of the methods for this Web service, see the following table.

Operation	Method
LSClinicalTripReportFileTransferQuery	Query
LSClinicalTripReportFileTransferQueryPage	Query Page
LSClinicalTripReportFileTransferUpsert	Upsert

Example Package for LS Clinical Trip Report File Transfer

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

Request

See the following file to view the sample code:

...\LSClinical_TripReport\LSClinicalTripReportFileTransferQuery_Request.xml
...\LSClinical_TripReport\LSClinicalTripReportFileTransferQueryPage_Request.xml
...\LSClinical_TripReport\LSClinicalTripReportFileTransferUpsert_Request.xml

Response

See the following file to view the sample code:

...\LSClinical_TripReport\LSClinicalTripReportFileTransferQuery_Response.xml
...\LSClinical_TripReport\LSClinicalTripReportFileTransferQueryPage_Response.xml
...\LSClinical_TripReport\LSClinicalTripReportFileTransferUpsert_Response.xml

Message Schema (WSDL) for LS Clinical Trip Report File Transfer

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

...\LSClinical_TripReport\LS Clinical Trip Report File Transfer.wsdl

LSSGOP_Account

Use this Web service to perform create, update, delete, and query records in the Account object.

LSSGOP_Account Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
AccountInsert	Creates an account.
AccountUpdate	Updates an existing account.
AccountDelete	Deletes an account.
AccountQueryPage	Queries for an account.

Request Message Description: AccountInsert

For a description of this request message, see the following table.

Name	Description	Type
AccountInsert	Creates an account.	String

Response Message Description: AccountInsert

For a description of this request message, see the following table.

Name	Description	Type
Id	ID of the newly created account.	String

Request Message Description: AccountUpdate

For a description of this request message, see the following table.

Name	Description	Type
Id	Account ID.	String
Name	Account name.	String
Type	Account type.	String

Response Message Description: AccountUpdate

For a description of this request message, see the following table.

Name	Description	Type
Id	ID of the updated account.	String

Request Message Description: AccountDelete

For a description of this request message, see the following table.

Name	Description	Type
Id	ID of the account to be deleted.	String

For a description of this request message, see the following table.

Name	Description	Type
Id	ID of the deleted account.	String

For a description of this request message, see the following table.

Name	Description	Type
Id	ID of the account to be queried upon.	String

For a description of this request message, see the following table.

Name	Description	Type
Id	ID of the account.	String

LSSGOP_Account Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_Account	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_Account	LS SGOP_Account

Interface Description (WSDL) for LSSGOP_Account

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

...\LSSGOP_Account\http_siebel.com_asi_LSSGOP_Account.WSDL

LSSGOP_AccountAddress

Use this Web service to create, update, delete, and query records in the AccountAddresses object.

LSSGOP_AccountAddress Operations

This Web service allows you to create, update, delete and query records in the AccountAddress object. For a list of operations, see the following table.

Name	Description
AccountAddressInsert	Creates an accountaddress record.
AccountAddressUpdate	Updates an existing accountaddress record.
AccountAddressDelete	Deletes an accountaddress record.
AccountAddressPage	Queries for an accountaddress record.

Request Message Description: AccountAddressInsert

For a description of this request message, see the following table.

Node	Description	Type
AddressId	ID of the address to be associated to an account.	String
AccountId	Account ID to which an address is associated.	String

Response Message Description: AccountAddressInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created accountaddress record.	String

Request Message Description: AccountAddressUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the accountaddress record.	String
AddressId	Name of the corresponding record.	String
AccountId	Type of the corresponding record.	String

Response Message Description: AccountAddressUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated accountaddress record.	String

Request Message Description: AccountAddressDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the accountaddress to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted accountaddress record.	.String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the accountaddress record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the accountaddress record.	String

LSSGOP_Account Address Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_AccountAddress	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_AccountAddress	LS SGOP_AccountAddress

Interface Description (WSDL) for LSSGOP_Account Address

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

...\LSSGOP_AccountAddress\http_siebel.com_asi_LSSGOP_AccountAddress.WSDL

LSSGOP_Activity

Use this Web service to create, update, delete and query the Activity object.

LSSGOP_Activity Operations

This Web service allows you to create, update, delete, and query the Activity object. For a list of operations, see the following table.

Name	Description
ActivityInsert	Creates an activity.
ActivityUpdate	Updates an existing activity.
ActivityDelete	Deletes an activity.
ActivityQueryPage	Queries for an activity.

Request Message Description: ActivityInsert

For Contact Call, pass only the Contact ID and for Account Call, pass only the Account ID. For a description of this request message, see the following table.

Node	Description	Type
ContactId	ID of the contact.	String
AccountId	ID of the account.	String

Response Message Description: ActivityInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created activity.	String

Request Message Description: ActivityUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the activity.	String
ContactId	Contact ID of the activity.	String
AccountId	Account ID of the activity.	String

Response Message Description: ActivityUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated activity.	String

Request Message Description: ActivityDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the activity to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted activity.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the activity to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the activity.	String

LSSGOP_Activity Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_Activity	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_Activity	LS SGOP_Activity

Interface Description (WSDL) for LSSGOP_Activity

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

...\LSSGOP_Activity\http_siebel.com_asi_LSSGOP_Activity.WSDL

LSSGOP_ActivityContact

Use this Web service to create, update, delete, and query records in the ActivityContacts object.

LSSGOP_ActivityContact Operations

This Web service allows you to create, update, delete, and query records in the ActivityContact object. For a list of operations, see the following table.

Name	Description
ActivityContactInsert	Creates an activitycontact record.
ActivityContactUpdate	Updates an existing activitycontact record.
ActivityContactDelete	Deletes an activitycontact record.
ActivityContactQueryPage	Queries for an activitycontact record.

Request Message Description: ActivityContactInsert

For a description of this request message, see the following table.

Node	Description	Type
ActivityId	Activity ID.	String
ContactId	Contact ID.	String

Response Message Description: ActivityContactInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created activitycontact record.	String

Request Message Description: ActivityContactUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the activitycontact record.	String
ActivityId	ActivityId of the activitycontact record.	String
ContactId	ContactId of the activitycontact record.	String

Response Message Description: ActivityContactUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated activitycontact record.	String

Request Message Description: ActivityContactDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the activitycontact record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the activitycontact record to be deleted.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the activitycontact record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the activitycontact record.	String

LSSGOP_ActivityContact Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_ActivityContact	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_ActivityContact	LS SGOP_ActivityContact

Interface Description (WSDL) for LSSGOP_ActivityContact

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

...\LSSGOP_ActivityContact\http_siebel.com_asi_LSSGOP_ActivityContact.WSDL

LSSGOP_CatalogCategory

Use this Web service to create, update, delete, and query records in the CatalogCategory object.

LSSGOP_CatalogCategory Operations

This Web service allows you to create, update, delete, and query records in the CatalogCategory object. For a list of operations, see the following table.

Name	Description
CatalogCategoryInsert	Creates a catalogcategory record.
CatalogCategoryUpdate	Updates an existing catalogcategory record.
CatalogCategoryDelete	Deletes a catalogcategory record.
CatalogCategoryQueryPage	Queries for a catalogcategory record.

Request Message Description: CatalogCategoryInsert

For a description of this request message, see the following table.

Node	Description	Type
Name	Name of the catalog to be inserted.	String

Response Message Description: CatalogCategoryInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created catalogcategory record.	String

Request Message Description: CatalogCategoryUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the catalogcategory record.	String
Name	Name of the catalogcategory record.	String

Response Message Description: CatalogCategoryUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated catalogcategory record.	String

Request Message Description: CatalogCategoryDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the catalogcategory record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted catalogcategory record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the catalogcategory record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the catalogcategory record.	String

LSSGOP_CatalogCategory Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_CatalogCategory	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_CatalogCategory	LS SGOP_CatalogCategory

Interface Description (WSDL) for LSSGOP_CatalogCategory

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

...\LSSGOP_CatalogCategory\http_siebel.com_asi_LSSGOP_CatalogCategory.WSDL

LSSGOP_Contact

Use this Web service to create, update, delete, and query records in the Contact object.

LSSGOP_Contact Operations

This Web service allows you to create, update, delete, and query records in the Contact object. For a list of operations, see the following table.

Name	Description
ContactInsert	Creates a contact.
ContactUpdate	Updates an existing contact.
ContactDelete	Deletes a contact.
ContactQueryPage	Queries for a contact.

Request Message Description: ContactInsert

For a description of this request message, see the following table.

Node	Description	Type
FirstName	First name of the new contact to be inserted.	String
LastName	Last name of the new contact to be inserted.	String
PersonUId	A unique person ID.	String

Response Message Description: ContactInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created contact.	String

Request Message Description: ContactUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the contact.	String
FirstName	First name of the contact.	String
LastName	Last name of the contact.	String
PersonUId	Person UId of the contact.	String

Response Message Description: ContactUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated contact.	String

Request Message Description: ContactDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the contact to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted contact.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the contact to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the contact.	String

LSSGOP_Contact Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_Contact	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_Contact	LS SGOP_Contact

Interface Description (WSDL) for LSSGOP_Contact

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

...\LSSGOP_Contact\http_siebel.com_asi_LSSGOP_Contact.WSDL

LSSGOP_ContactAccount

Use this Web service to create, update, delete, and query records in the Contact Account object.

LSSGOP_ContactAccount Operations

This Web service allows you to create, update, delete and query the ContactAccount object. For a list of operations, see the following table.

Name	Description
ContactAccountInsert	Creates a contactaccount record.
ContactAccountUpdate	Updates an existing contactaccount record.
ContactAccountDelete	Deletes a contactaccount record.
ContactAccountQueryPage	Queries for a contactaccount record.

Request Message Description: ContactAccountInsert

For a description of this request message, see the following table.

Node	Description	Type
ContactId	ID of a contact.	String
AccountId	ID of an account.	String

Response Message Description: ContactAccountInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created contactaccount record.	String

Request Message Description: ContactAccountUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the contactaccount record.	String
ContactId	ContactId of the corresponding record.	String
AccountId	AccountId of the corresponding record.	String

Response Message Description: ContactAccountUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated contactaccount.	String

Request Message Description: ContactAccountDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the contactaccount record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted contactaccount record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the contactaccount to be queried record.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the contactaccount record.	String

LSSGOP_ContactAccount Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_ContactAccount	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_ContactAccount	LS SGOP_ContactAccount

Interface Description (WSDL) for LSSGOP_ContactAccount

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

...LSSGOP_ContactAccount\http_siebel.com_asi_LSSGOP_ContactAccount.WSDL

LSSGOP_ContactAddress

Use this Web service to create, update, delete, and query records in the ContactAddress object.

LSSGOP_ContactAddress Operations

This Web service allows you to create, update, delete, and query records in the ContactAddress object. For a list of operations, see the following table.

Name	Description
ContactAddressInsert	Creates a new contactaddress record.
ContactAddressUpdate	Updates an existing contactaddress record.
ContactAddressDelete	Deletes a contactaddress record.
ContactAddressQueryPage	Queries for a contactaddress record.

Request Message Description: ContactAddressInsert

For a description of this request message, see the following table.

Node	Description	Type
ContactId	ID of the contact to be inserted.	String
AddressId	ID of the address to associate to the contact.	String

Response Message Description: ContactAddressInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created contactaddress record.	String

Request Message Description: ContactAddressUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the contactaddress record.	String
ContactId	Contact ID of the corresponding record.	String
AddressId	Address ID of the corresponding record.	String

Response Message Description: ContactAddressUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated contactaddress record.	String

Request Message Description: ContactAddressDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the contactaddress record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted contactaddress record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the contactaddress record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the contactaddress record.	String

LSSGOP_ContactAddress Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_ContactAddress	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_ContactAddress	LS SGOP_ContactAddress

Interface Description (WSDL) for LSSGOP_ContactAddress

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

...\LSSGOP_ContactAddress\http_siebel.com_asi_LSSGOP_ContactAddress.WSDL

LSSGOP_ContactBestTime

Use this Web service to create, update, delete, and query records in the ContactBestTime object.

LSSGOP_ContactBestTime Operations

This Web service allows you to create, update, delete, and query records in the ContactBestTime object. For a list of operations, see the following table.

Name	Description
ContactBestTimeInsert	Creates a contactbesttime record.
ContactBestTimeUpdate	Updates an existing contactbesttime record.
ContactBestTimeDelete	Deletes a contactbesttime record.
ContactBestTimeQueryPage	Queries for a contactbesttime record.

Request Message Description: ContactBestTimeInsert

For a description of this request message, see the following table.

Node	Description	Type
ContactId	ID of the contact to be inserted.	String
ContactAddressId	ID of the contactaddress to be inserted.	String
StartDay	Start day.	String
StartTime	Start time.	String

Response Message Description: ContactBestTimeInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created contactbesttime record.	String

Request Message Description: ContactBestTimeUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the contactbesttime record.	String
ContactId	Contact ID of the corresponding record.	String
ContactAddressId	Contact address ID of the corresponding record.	String
StartDay	Start day of the corresponding record.	String

Response Message Description: ContactBestTimeUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated contactbesttime record.	String

Request Message Description: ContactBestTimeDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the contactbesttime record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted contactbesttime record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the contactbesttime record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the contactbesttime record.	String

LSSGOP_ContactBestTime Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_ContactBestTime	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_ContactBestTime	LS SGOP_ContactBestTime

Interface Description (WSDL) for LSSGOP_ContactBestTime

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

...\LSSGOP_ContactBestTime\http_siebel.com_asi_LSSGOP_ContactBestTime.WSDL

LSSGOP_ContactLicense

Use this Web service to create, update, delete, and query records in the ContactLicence object.

LSSGOP_ContactLicense Operations

This Web service allows you to create, update, delete, and query records in the ContactLicense object. For a list of operations, see the following table.

Name	Description
ContactLicenseInsert	Creates a contactlicense record.
ContactLicenseUpdate	Updates an existing contactlicense record.
ContactLicenseDelete	Deletes a contactlicense record.
ContactLicenseQueryPage	Queries for a contactlicense record.

Request Message Description: ContactLicenseInsert

For a description of this request message, see the following table.

Node	Description	Type
ProfessionalId	ID of the contact.	String
State	State of the contact.	String
LicenseExpiryDate	Expiration date of the license.	String
LicenseNumber	License number.	String

Response Message Description: ContactLicenseInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created account record.	String

Request Message Description: ContactLicenseUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the contactlicense record.	String
ProfessionalId	Professional ID of the corresponding record.	String
State	State of the corresponding record.	String

Response Message Description: ContactLicenseUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated contactlicense	String

Request Message Description: ContactLicenseDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the contactlicense record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted contactlicense record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the contactlicense record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the contactlicense record.	String

LSSGOP_ContactLicense Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_ContactLicense	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_ContactLicense	LS SGOP_ContactLicense

Interface Description (WSDL) for LSSGOP_ContactLicense

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

...\LSSGOP_ContactLicense\http_siebel.com_asi_LSSGOP_ContactLicense.WSDL

LSSGOP_CurrentUser

Use this Web service to query records in the Current user object.

LSSGOP_CurrentUser Operations

This Web service allows you to query the CurrentUser object. For a list of operations, see the following table.

Name	Description
CurrentUserQueryPage	Queries for the currentuser record.

Request Message Description: CurrentUserQueryPage

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the current user to be queried.	String

Response Message Description: CurrentUserQueryPage

For a description of this response message, see the following table.

Node	Description	Type
Id	ID the current user.	String

LSSGOP_CurrentUser Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_CurrentUser	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_CurrentUser	LS SGOP_CurrentUser

Interface Description (WSDL) for LSSGOP_CurrentUser

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

...\LSSGOP_CurrentUser\http_siebel.com_asi_LSSGOP_CurrentUser.WSDL

LSSGOP_LanguageLOV

Use this Web service to query for records in the LanguageLOV object.

LSSGOP_LanguageLOV Operations

Use this Web service to query for records in the LanguageLOV object. For a list of operations, see the following table.

Name	Description
LanguageLOVQueryPage	Queries for the list of values.

Request Message Description: LanguageLOVQueryPage

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the LOV queried.	String

Response Message Description: LanguageLOVQueryPage

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the LOV.	String

LSSGOP_LanguageLOV Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_LanguageLOV	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_LanguageLOV	LS SGOP_LanguageLOV

Interface Description (WSDL) for LSSGOP_LanguageLOV

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

...\LSSGOP_LanguageLOV\http_siebel.com_asi_LSSGOP_LanguageLOV.WSDL

LSSGOP_Literature

Use this Web service to create, update, delete, and query records in the Literature object.

LSSGOP_Literature Operations

This Web service allows you to create, update, delete and query records in the Literature object using Sales Rep visibility. For a list of operations, see the following table.

Name	Description
LiteratureInsert	Creates a literature.
LiteratureUpdate	Update an existing literature.
LiteratureDelete	Delete a literature.
LiteratureQueryPage	Query for a literature.

Request Message Description: LiteratureInsert

For a description of this request message, see the following table.

Node	Description	Type
Name	Name of the literature record.	String
FileName	The file name of the literature record.	String
RelationshipType	Relationship type for the literature record.	String

Response Message Description: LiteratureInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created literature record.	String

Request Message Description: LiteratureUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the literature record.	String
Name	Name of the corresponding record.	String
FileName	File name of the corresponding record.	String
RelationshipType	Relationship type of the corresponding record.	String

Response Message Description: LiteratureUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated literature record.	String

Request Message Description: LiteratureDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the literature record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted literature record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the literature record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the literature record.	String

LSSGOP_Literature Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_Literature	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_Literature	LS SGOP_Literature

Interface Description (WSDL) for LSSGOP_Literature

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

...\LSSGOP_Literature\http_siebel.com_asi_LSSGOP_Literature.WSDL

LSSGOP_Literature_ALL

Use this Web service to create, update, delete, and query records in the Literature_ALL object.

LSSGOP_Literature_ALL Operations

This Web service allows you to create, update, delete, and query records in the Literature_ALL object using Administrator visibility. For a list of operations, see the following table.

Name	Description
Literature_ALLInsert	Creates a literature.
Literature_ALLUpdate	Update an existing literature.
Literature_ALLDelete	Delete a literature.
Literature_ALLQueryPage	Query for a literature.

Request Message Description: Literature_ALLInsert

For a description of this request message, see the following table.

Node	Description	Type
Name	Name of the literature record to be inserted.	String
FileName	File name of the literature record.	String
RelationshipType	Relationship type.	String

Response Message Description: Literature_ALLInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created Literature All record.	String

Request Message Description: Literature_ALLUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the literature record.	String
Name	Name of the corresponding record.	String
FileName	File name of the corresponding record.	String
RelationshipType	Relationship type of the corresponding record.	String

Response Message Description: Literature_ALLUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated literature record.	String

Request Message Description: Literature_ALLDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the literature record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted literature record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the literature record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the literature record.	String

LSSGOP_Literature_ALL Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_Literature_ALL	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_Literature_ALL	LS SGOP_Literature_ALL

Interface Description (WSDL) for LSSGOP_Literature_ALL

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

...\LSSGOP_Literature_ALL\http_siebel.com_asi_LSSGOP_Literature_ALL.WSDL

LSSGOP_LiteratureCatalog

Use this Web service to create, update, delete, and query records in the LiteratureCatalog object.

LSSGOP_LiteratureCatalog Operations

This Web service allows you to create, update, delete, and query records in the LiteratureCatalog object. For a list of operations, see the following table.

Name	Description
LiteratureCatalogInsert	Creates a literaturecatalog record.
LiteratureCatalogUpdate	Updates an existing literaturecatalog record.
LiteratureCatalogDelete	Deletes a literaturecatalog record.
LiteratureCatalogQueryPage	Queries for a literaturecatalog record.

Request Message Description: LiteratureCatalogInsert

For a description of this request message, see the following table.

Node	Description	Type
CtlgCatId	ID of the catalog category to which the literature is to be associated.	String
LitId	ID of the literature record.	String
LitName	Name of the literature record.	String

Response Message Description: LiteratureCatalogInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created literaturecatalog record.	String

Request Message Description: LiteratureCatalogUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the literaturecatalog record.	String
CtlgCatId	CtigCatId of the corresponding record.	String
LitId	Literature ID of the corresponding record.	String
LitName	Literature Name of the corresponding record.	String

Response Message Description: LiteratureCatalogUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated literaturecatalog record.	String

Request Message Description: LiteratureCatalogDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the literaturecatalog record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted literaturecatalog record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the literaturecatalog record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the literaturecatalog record.	String

LSSGOP_LiteratureCatalog Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_LiteratureCatalog	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_LiteratureCatalog	LS SGOP_LiteratureCatalog

Interface Description (WSDL) for LSSGOP_LiteratureCatalog

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

...\LSSGOP_LiteratureCatalog\http_siebel.com_asi_LSSGOP_LiteratureCatalog.WSDL

LSSGOP_MessagePlan

Use this Web service to create, update, delete, and query records in the MessagePlan object.

LSSGOP_MessagePlan Operations

This Web service allows you to create, update, delete and query records in the MessagePlan object using Sales Rep visibility. For a list of operations, see the following table.

Name	Description
MessagePlanInsert	Creates a messageplan record.
MessagePlanUpdate	Updates an existing messageplan record.
MessagePlanDelete	Deletes a messageplan record.
MessagePlanQueryPage	Queries for the messageplan record.

Request Message Description: MessagePlanInsert

For a description of this request message, see the following table.

Node	Description	Type
Name	Name of the corresponding record.	String
MessagePlanType	Message plan type of the corresponding record.	String
Owner	Owner of the corresponding record.	String
Position	Position of the corresponding record.	String
Product	Product of the corresponding record.	String
Status	Status of the corresponding record.	String
Version	Version of the corresponding record.	String

Response Message Description: MessagePlanInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created messageplan record.	String

Request Message Description: MessagePlanUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the messageplan.	String
Name	Name of the corresponding record.	String
MessagePlanType	Message plan type of the corresponding record.	String
Owner	Owner of the corresponding record.	String
Position	Position of the corresponding record.	String
Product	Product of the corresponding record.	String
Status	Status of the corresponding record.	String
Version	Version of the corresponding record.	String

Response Message Description: MessagePlanUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	Id of the updated messageplan record.	String

Request Message Description: MessagePlanDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the messageplan record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted messageplan record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the messageplan to be queried	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the messageplan	String

LSSGOP_MessagePlan Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_MessagePlan	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_MessagePlan	LS SGOP_MessagePlan

Interface Description (WSDL) for LSSGOP_MessagePlan

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

...\LSSGOP_MessagePlan\http_siebel.com_asi_LSSGOP_MessagePlan.WSDL

LSSGOP_Message Plan_ALL

Use this Web service to create, update, delete, and query records in the MessagePlan_ALL object.

LSSGOP_Message Plan_ALL Operations

This Web service allows you to create, update, delete, and query records in the MessagePlan_ALL object using Administrator visibility. For a list of operations, see the following table.

Name	Description
MessagePlan_ALLInsert	Creates a messageplan record.
MessagePlan_ALLUpdate	Updates an existing messageplan record.
MessagePlan_ALLDelete	Deletes a messageplan record.
MessagePlan_ALLQueryPage	Queries for a messageplan record.

Request Message Description: MessagePlan_ALLInsert

For a description of this request message, see the following table.

Node	Description	Type
Name	Name the message plan to be inserted.	String
MessagePlanType	Type of message plan.	String
Owner	The message plan owner.	String
Position	The position of the message plan owner.	String
Product	The message plan product.	String
Status	Status of the message plan.	String
Version	The version of the message plan.	String

Response Message Description: MessagePlan_ALLInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of an newly created account.	String

Request Message Description: MessagePlan_ALLUpdate and MessagePlanUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the messageplan record.	String
Name	Name of the corresponding record.	String
MessagePlanType	MessagePlanType of the corresponding record.	String
Owner	Owner of the corresponding record.	String
Position	Position of the corresponding record.	String
Product	Product of the corresponding record.	String
Status	Status of the corresponding record.	String
Version	Version of the corresponding record.	String

Response Message Description: MessagePlan_ALLUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of an updated messageplan record.	String

Request Message Description: MessagePlan_ALLDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the messageplan record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted messageplan record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the messageplan record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the messageplan record.	String

LSSGOP_Message Plan_ALL Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_MessagePlan_ALL	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_MessagePlan_ALL	LS SGOP_MessagePlan_ALL

Interface Description (WSDL) for LSSGOP_Message Plan_ALL

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

...\LSSGOP_MessagePlan_ALL\http_siebel.com_asi_LSSGOP_MessagePlan_ALL.WSDL

LSSGOP_MessagePlanCatalog

Use this Web service to create, update, delete, and query records in the MessagePlanCatalog object.

LSSGOP_MessagePlanCatalog Operations

This Web service features four operations which allow you to create, update, delete, and query records in the MessagePlan Catalog object. For a list of operations, see the following table.

Name	Description
MessagePlanCatalogInsert	Creates a messageplancatalog record.
MessagePlanCatalogUpdate	Updates an existing messageplancatalog record.
MessagePlanCatalogDelete	Deletes a messageplancatalog record.
MessagePlanCatalogQueryPage	Queries for a messageplancatalog record.

Request Message Description: MessagePlanCatalogInsert

For a description of this request message, see the following table.

Node	Description	Type
CtlgCatId	ID of the catalog category to be associated with the message plan.	String
MsgPlanId	ID of the message plan.	String

Response Message Description: MessagePlanCatalogInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created messageplancatalog record.	String

Request Message Description: MessagePlanCatalogUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the messageplancatalog record.	String
CtlgCatId	CtlgCatId of the corresponding record.	String
MsgPlanId	Message plan ID of the corresponding record.	String

Response Message Description: MessagePlanCatalogUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of an updated messageplancatalog record.	String

Request Message Description: MessagePlanCatalogDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the messageplancatalog record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted messageplancatalog record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the messageplancatalog record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the messageplancatalog record.	String

LSSGOP_MessagePlanCatalog Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_MessagePlanCatalog	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_MessagePlanCatalog	LS SGOP_MessagePlanCatalog

Interface Description (WSDL) for LSSGOP_MessagePlanCatalog

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

...\LSSGOP_MessagePlanCatalog\http_siebel.com_asi_LSSGOP_MessagePlanCatalog.WSDL

LSSGOP_MessageResponse

Use this Web service to create, update, delete, and query records in the MessageResponse object.

LSSGOP_MessageResponse Operations

This Web service allows you to create, update, delete, and query records in the MessageResponse object. For a list of operations, see the following table.

Name	Description
MessageResponseInsert	Creates a messageresponse record.
MessageResponseUpdate	Updates an existing messageresponse record.
MessageResponseDelete	Deletes a messageresponse record.
MessageResponseQueryPage	Queries for a messageresponse record.

Request Message Description: MessageResponseInsert

For a description of this request message, see the following table.

Node	Description	Type
MessagePlan	Name of the message plan.	String
MessagePlanId	ID of the message plan.	String
MessageStartTime	Start time of the message plan.	String
MessageEndTime	End time of the message plan.	String
Response	Response of the corresponding record.	String

Response Message Description: MessageResponseInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created messageresponse record.	String

Request Message Description: MessageResponseUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the messageresponse record.	String
MessagePlan	Message plan of the corresponding record.	String
MessagePlanId	Message plan ID of the corresponding record.	String
MessageStartTime	Message start time of the corresponding record.	String
MessageEndTime	Message end time of the corresponding record.	String
Response	Response of the corresponding record.	String

Response Message Description: MessageResponseUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated messageresponse record.	String

Request Message Description: MessageResponseDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the messageresponse record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted messageresponse record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the messageresponse record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the messageresponse record.	String

LSSGOP_MessageResponse Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_ MessageResponse	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_MessageResponse	LS SGOP_MessageResponse

Interface Description (WSDL) for LSSGOP_MessageResponse

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

...\LSSGOP_MessageResponse\http_siebel.com_asi_LSSGOP_MessageResponse.WSDL

LSSGOP_ MsgPlanItem

Use this Web service to create, update, delete, and query records in the MsgPlanItem object.

LSSGOP_ MsgPlanItem Operations

This Web service allows you to create, update, delete, and query records in the MsgPlanItem object using Sales Rep visibility. For a list of operations, see the following table.

Name	Description
MsgPlanItemInsert	Creates a msgplanitem record.
MsgPlanItemUpdate	Updates an existing msgplanitem record.
MsgPlanItemDelete	Deletes a msgplanitem record.
MsgPlanItemQueryPage	Queries for a msgplanitem record.

Request Message Description: MsgPlanItemInsert

For a description of this request message, see the following table.

Node	Description	Type
Name	Name of the message plan item.	String
SequenceNumber	Sequence number of the message plan.	String
Type	Type of message plan.	String
ParentMPId	ID of the parent message plan.	String

Response Message Description: MsgPlanItemInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created msgplanitem record.	String

Request Message Description: MsgPlanItemUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the msgplanitem record.	String
Name	Name of the corresponding record.	String
SequenceNumber	Sequence number of the corresponding record.	String
Type	Type of the corresponding record.	String
ParentMPId	Parent message plan ID of the corresponding record.	String

Response Message Description: MsgPlanItemUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated msgplanitem record.	String

Request Message Description: MsgPlanItemDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the msgplanitem record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted msgplanitem record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the msgplanitem record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the msgplanitem record.	String

LSSGOP_ MsgPlanItem Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_MsgPlanItem	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_MsgPlanItem	LS SGOP_MsgPlanItem

Interface Description (WSDL) for LSSGOP_ MsgPlanItem

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

...\LSSGOP_MsgPlanItem\http_siebel.com_asi_LSSGOP_MsgPlanItem.WSDL

LSSGOP_MsgPlanItem_ALL

Use this Web service to create, update, delete, and query records in the MsgPlanItem_ALL object.

LSSGOP_MsgPlanItem_ALL Operations

This Web service allows you to create, update, delete, and query records in the MsgPlanItems object using Administrator visibility. For a list of operations, see the following table.

Name	Description
MsgPlanItem_ALLInsert	Creates a msgplanitem record.
MsgPlanItem_ALLUpdate	Updates an existing msgplanitem record.
MsgPlanItem_ALLDelete	Deletes a msgplanitem record.
MsgPlanItem_ALLQueryPage	Queries for a msgplanitem record.

Request Message Description: MsgPlanItem_ALLInsert

For a description of this request message, see the following table.

Node	Description	Type
Name	Name of the message plan item.	String
SequenceNumber	Sequence number of the message plan item.	String
Type	Message plan item type.	String
ParentMPId	ID of the parent message plan.	String

Response Message Description: MsgPlanItem_ALLInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created msgplanitem	String

Request Message Description: MsgPlanItem_ALLUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the msgplanitem record.	String
Name	Name.	String
SequenceNumber	Sequence number of the corresponding record.	Number
Type	Type of the corresponding record.	String
ParentMPId	ParentMP ID of the corresponding record.	String

Response Message Description: MsgPlanItem_ALLUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated msgplanitem record.	String

Request Message Description: MsgPlanItem_ALLDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the msgplanitem record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted msgplanitem record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the msgplanitem record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the msgplanitem record.	String

LSSGOP_MsgPlanItem_ALL Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_MsgPlanItem_ALL	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_Account	LS SGOP_Account

Interface Description (WSDL) for LSSGOP_MsgPlanItem_ALL

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

...\LSSGOP_MsgPlanItem_ALL\http_siebel.com_asi_LSSGOP_MsgPlanItem_ALL.WSDL

LSSGOP_MsgPlanItemRelation

Use this Web service to create, update, delete, and query records in the MsgPlanItemRelation object.

LSSGOP_MsgPlanItemRelation Operations

This Web service allows you to create, update, delete, and query records in the MsgPlanItemRelation object using Sales Rep visibility. For a list of operations, see the following table.

Name	Description
MsgPlanItemRelationInsert	Creates a msgplanitemrelation record.
MsgPlanItemRelationUpdate	Updates an existing msgplanitemrelation record.
MsgPlanItemRelationDelete	Deletes a msgplanitemrelation record.
MsgPlanItemRelationQueryPage	Queries for a msgplanitemrelation record.

Request Message Description: MsgPlanItemRelationInsert

For a description of this request message, see the following table.

Node	Description	Type
SequenceNumber	Sequence number of the msgplanitemrelation record.	String

Response Message Description: MsgPlanItemRelationInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	Id of the newly created msgplanitemrelation record.	String

Request Message Description: MsgPlanItemRelationUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the msgplanitemrelation record.	String
SequenceNumber	Sequence number of the corresponding record.	String

Response Message Description: MsgPlanItemRelationUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated msgplanitemrelation record.	String

Request Message Description: MsgPlanItemRelationDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the msgplanitemrelation record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted msgplanitemrelation record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the msgplanitemrelation record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the msgplanitemrelation record.	String

LSSGOP_MsgPlanItemRelation Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_MsgPlanItemRelation	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_MsgPlanItemRelation	LS SGOP_MsgPlanItemRelation

Interface Description (WSDL) for LSSGOP_MsgPlanItemRelation

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

...\LSSGOP_MsgPlanItemRelation\http_siebel.com_asi_LSSGOP_MsgPlanItemRelation.WSDL

LSSGOP_MsgPlanItemRelation_ALL

Use this Web service to create, update, delete, and query records in the MsgPlanItemRelation_ALL objects.

LSSGOP_MsgPlanItemRelation_ALL Operations

This Web service allows you to create, update, delete, and query records in the MsgPlanItemRelation object using Administrator visibility. For a list of operations, see the following table.

Name	Description
MsgPlanItemRelation_ALLInsert	Creates a msgplanitemrelation record.
MsgPlanItemRelation_ALLUpdate	Updates an existing msgplanitemrelation record.
MsgPlanItemRelation_ALLDelete	Deletes a msgplanitemrelation record.
MsgPlanItemRelation_ALLQueryPage	Queries for a msgplanitemrelation record.

Request Message Description: MsgPlanItemRelation_ALLInsert

For a description of this request message, see the following table.

Node	Description	Type
SequenceNumber	Sequence number.	String

Response Message Description: MsgPlanItemRelation_ALLInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of an newly created account record.	String

Request Message Description: MsgPlanItemRelation_ALLUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the msgplanitemrelation record.	String
SequenceNumber	Sequence number of the corresponding record.	String

Response Message Description: MsgPlanItemRelation_ALLUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated msgplanitemrelation record.	String

Request Message Description: MsgPlanItemRelation_ALLDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the msgplanitemrelation record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted msgplanitemrelation record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the msgplanitemrelation record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the msgplanitemrelation record.	String

LSSGOP_MsgPlanItemRelation_ALL Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_ MsgPlanItemRelation_ALL	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_MsgPlanItemRelation_ALL	LS SGOP_MsgPlanItemRelation_ALL

Interface Description (WSDL) for LSSGOP_MsgPlanItemRelation_ALL

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

...\LSSGOP_MsgPlanItemRelation_ALL\http_siebel.com_asi_LSSGOP_MsgPlanItemRelation_ALL.WSDL

LSSGOP_PersonalList

Use this Web service to create, update, delete, and query records in the PersonalList object.

LSSGOP_PersonalList Operations

This Web service allows you to create, update, delete, and query records in the PersonalList object. For a list of operation, see the following table.

Name	Description
PersonalListInsert	Creates a personallist record.
PersonalListUpdate	Updates an existing personallist record.
PersonalListDelete	Deletes a personallist record.
PersonalListQueryPage	Queries for a personallist record.

Request Message Description: PersonalListInsert

For a description of this request message, see the following table.

Node	Description	Type
Sample	Name of the sample to be inserted.	String

Response Message Description: PersonalListInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	Id of the newly created personallist record.	String

Request Message Description: PersonalListUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	Id of a personallist record.	String
Sample	Sample of the corresponding record.	String

Response Message Description: PersonalListUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated personallist record.	String

Request Message Description: PersonalListDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the personallist record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted personallist record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the personallist record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of a personallist record.	String

LSSGOP_PersonalList Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_PersonalList	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_PersonalList	LS SGOP_PersonalList

Interface Description (WSDL) for LSSGOP_PersonalList

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

...\LSSGOP_PersonalList\http_siebel.com_asi_LSSGOP_PersonalList.WSDL

LSSGOP_PositionContactAddress

Use this Web service to create, update, delete, and query records in the PositionContactAddress object.

LSSGOP_PositionContactAddress Operations

This Web service allows you to create, update, delete, and query records in the PositioncontactAddress object. For a list of operations, see the following table.

Name	Description
PositionContactAddressInsert	Creates a positioncontactaddress record.
PositionContactAddressUpdate	Updates an existing positioncontactaddress record.
PositionContactAddressDelete	Deletes a positioncontactaddress record.
PositionContactAddressQueryPage	Queries for a positioncontactaddress record.

Request Message Description: PositionContactAddressInsert

For a description of this request message, see the following table.

Node	Description	Type
AddressId	Address Id.	String
ContactAddressId	Contact address Id.	String
ContactId	Contact Id.	String
PositionId	Position Id.	String

Response Message Description: PositionContactAddressInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	Id of the newly created positioncontactaddress record.	String

Request Message Description: PositionContactAddressUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the positioncontactaddress record.	String
AddressId	AddressId of the corresponding record.	String
ContactAddressId	ContactAddressId of the corresponding record.	String
ContactId	ContactId of the corresponding record.	String
PositionId	PositionId of the corresponding record.	String
Type	Type of the corresponding record.	String

Response Message Description: PositionContactAddressUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated positioncontactaddress record.	String

Request Message Description: PositionContactAddressDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of a positioncontactaddress record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted positioncontactaddress record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the positioncontactaddress record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the positioncontactaddress record.	String

LSSGOP_PositionContactAddress Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_PositionContactAddress	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_PositionContactAddress	LS SGOP_PositionContactAddress

Interface Description (WSDL) for LSSGOP_PositionContactAddress

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

...\LSSGOP_PositionContactAddress\http_siebel.com_asi_LSSGOP_PositionContactAddress.WSDL

LSSGOP_Product

Use this Web service to query records in the Product object.

LSSGOP_Product Operations

This Web service allows you to query records in the Product object. For a list of operations, see the following table.

Name	Description
ProductQueryPage	Queries for a product.

Request Message Description: ProductQueryPage

For a description of this request message, see the following table.

Node	Description	Type
Id	Id of the product record to be queried.	String

Response Message Description: ProductQueryPage

For a description of this response message, see the following table.

Node	Description	Type
Id	Id of the product record.	String

LSSGOP_Product Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_Product	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_Product	LS SGOP_Product

Interface Description (WSDL) for LSSGOP_Product

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

...\LSSGOP_Product\http_siebel.com_asi_LSSGOP_Product.WSDL

LSSGOP_ProductIndication

Use this Web service to query records in the ProductIndication object.

LSSGOP_ProductIndication Operations

This Web service allows you to query records in the ProductIndication object. For a list of operations, see the following table.

Name	Description
ProductIndicationQueryPage	Queries for a productindication record.

Request Message Description: ProductIndicationQueryPage

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of a productindication record to be queried.	String

Response Message Description: ProductIndicationQueryPage

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of a productindication record.	String

LSSGOP_ProductIndication Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_ProductIndication	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_ProductIndication	LS SGOP_ProductIndication

Interface Description (WSDL) for LSSGOP_ProductIndication

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

...\LSSGOP_ProductIndication\http_siebel.com_asi_LSSGOP_ProductIndication.WSDL

LSSGOP_ProductsDetailed

Use this Web service to create, update, delete, and query records in the ProductDetailed object.

LSSGOP_ProductsDetailed Operations

This Web service allows you to create, update, delete, and query records in the ProductDetailed object. For a list of operations, see the following table.

Name	Description
ProductsDetailedInsert	Creates a productdetailed record.
ProductsDetailedUpdate	Updates an existing productdetailed record.
ProductsDetailedDelete	Deletes a productdetailed record.
ProductsDetailedQueryPage	Queries for a productdetailed record.

Request Message Description: ProductsDetailedInsert

For a description of this request message, see the following table.

Node	Description	Type
Name	Name of the record.	String
Indication	Indication of the corresponding record.	String
Priority	Priority of the corresponding record.	String
ProductAllocationId	Product allocation Id of the corresponding record.	String
ProductId	Product Id of the corresponding record.	String

Response Message Description: ProductsDetailedInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created productdetailed record.	String

Request Message Description: ProductsDetailedUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the productdetailed record.	String
Name	Name of the corresponding record.	String
Indication	Indication of the corresponding record.	String
Priority	Priority of the corresponding record.	String
ProductAllocationId	Product allocation ID of the corresponding record.	String
ProductId	Product ID of the corresponding record.	String

Response Message Description: ProductsDetailedUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated productdetailed record.	String

Request Message Description: ProductsDetailedDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the productdetailed record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted productdetailed record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the productdetailed record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the productdetailed record.	String

LSSGOP_ProductsDetailed Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_ProductsDetailed	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_ProductsDetailed	LS SGOP_ProductsDetailed

Interface Description (WSDL) for LSSGOP_ProductsDetailed

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

...\LSSGOP_ProductsDetailed\http_siebel.com_asi_LSSGOP_ProductsDetailed.WSDL

LSSGOP_PromotionalItemsDropped

Use this Web service to create, update, delete, and query records in the PromotionalItemsDropped object.

LSSGOP_PromotionalItemsDropped Operations

This Web service allows you to create, update, delete, and query records in the PromotionalItemsDropped object. For a list of operations, see the following table.

Name	Description
PromotionalItemsDroppedInsert	Creates a promotionalitemsdropped record.
PromotionalItemsDroppedUpdate	Updates an existing promotionalitemsdropped record.
PromotionalItemsDroppedDelete	Deletes a promotionalitemsdropped record.
PromotionalItemsDroppedQueryPage	Queries for a promotionalitemsdropped record.

Request Message Description: PromotionalItemsDroppedInsert

For a description of this request message, see the following table.

Node	Description	Type
ProductId	Product ID of the corresponding record.	String
ProductAllocationId	Product allocation ID of the corresponding record.	String
Quantity	Quantity of the corresponding record.	String
Type	Type of the corresponding record.	String

Response Message Description: PromotionalItemsDroppedInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created promotionalitemsdropped	String

Request Message Description: PromotionalItemsDroppedUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the corresponding record.	String
ProductId	Product ID of the corresponding record.	String
ProductAllocationId	Product allocation ID of the corresponding record.	String
Quantity	Quantity of the corresponding record.	String
Type	Type of the corresponding record.	String

Response Message Description: PromotionalItemsDroppedUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated promotionalitemsdropped record.	String

Request Message Description: PromotionalItemsDroppedDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the promotionalitemsdropped record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted promotionalitemsdropped record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the promotionalitemsQuantity of the corresponding dropped record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the promotionalitemsdropped record.	String

LSSGOP_PromotionalItemsDropped Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_PromotionalItemsDropped	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_PromotionalItemsDropped	LS SGOP_PromotionalItemsDropped

Interface Description (WSDL) for LSSGOP_PromotionalItemsDropped

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

...\LSSGOP_PromotionalItemsDropped\http_siebel.com_asi_LSSGOP_PromotionalItemsDropped.WSDL

LSSGOP_RelatedAccount

Use this Web service to create, update, delete, and query records in the RelatedAccount object.

LSSGOP_RelatedAccount Operations

This Web service allows you to create, update, delete, and query records in the RelatedAccount object. For a list of operations, see the following table.

Name	Description
RelatedAccountInsert	Creates a relatedaccount record.
RelatedAccountUpdate	Updates an existing relatedaccount record.
RelatedAccountDelete	Deletes a relatedaccount record.
RelatedAccountQueryPage	Queries for a relatedaccount record.

Request Message Description: RelatedAccountInsert

For a description of this request message, see the following table.

Node	Description	Type
AccountId	Account Id of the corresponding record.	String
RelatedAccountId	Related account Id of the corresponding record.	String
RelationshipRole	Relationship role of the corresponding record.	String

Response Message Description: RelatedAccountInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	Id of the newly created relatedaccount record.	String

Request Message Description: RelatedAccountUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	Id of the relatedaccount record.	String
AccountId	Account Id of the corresponding record.	String
RelatedAccountId	Related account ID of the corresponding record.	String
RelationshipRole	Relationship role of the corresponding record.	String

Response Message Description: RelatedAccountUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated relatedaccount record.	String

Request Message Description: RelatedAccountDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the relatedaccount record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted relatedaccount record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the relatedaccount record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the relatedaccount record.	String

LSSGOP_RelatedAccount Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_RelatedAccount	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_RelatedAccount	LS SGOP_RelatedAccount

Interface Description (WSDL) for LSSGOP_RelatedAccount

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

...\LSSGOP_RelatedAccount\http_siebel.com_asi_LSSGOP_RelatedAccount.WSDL

LSSGOP_RelatedContact

Use this Web service to create, update, delete, and query records in the RelatedContact object.

LSSGOP_RelatedContact Operations

This Web service allows you to create, update, delete, and query records in the RelatedContact object. For a list of operations, see the following table.

Name	Description
RelatedContactInsert	Creates a relatedcontact record.
RelatedContactUpdate	Updates an existing relatedcontact record.
RelatedContactDelete	Deletes a relatedcontact record.
RelatedContactQueryPage	Queries for a relatedcontact record.

Request Message Description: RelatedContactInsert

For a description of this request message, see the following table.

Node	Description	Type
ContactId	Contact ID of the corresponding record.	String
RelatedContactId	Related contact ID of the corresponding record.	String
Role	Role of the corresponding record.	String

Response Message Description: RelatedContactInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created relatedcontact record.	String

Request Message Description: RelatedContactUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the relatedcontact record.	String
ContactId	ContactId of the corresponding record.	String
RelatedContactId	RelatedContactId of the corresponding record.	String
Role	Role of the corresponding record.	String

Response Message Description: RelatedContactUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated relatedcontact record.	String

Request Message Description: RelatedContactDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the relatedcontact record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted relatedcontact record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the relatedcontact record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the relatedcontact record.	String

LSSGOP_RelatedContact Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_RelatedContact	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_RelatedContact	LS SGOP_RelatedContact

Interface Description (WSDL) for LSSGOP_RelatedContact

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

...\LSSGOP_RelatedContact\http_siebel.com_asi_LSSGOP_RelatedContact.WSDL

LSSGOP_RelatedLiterature

Use this Web service to create, update, delete, and query records in the RelatedLiterature object.

LSSGOP_RelatedLiterature Operations

This Web service allows you to create, update, delete, and query the RelatedLiterature object. For a list of operations, see the following table.

Name	Description
RelatedLiteratureInsert	Creates a relatedliterature record.
RelatedLiteratureUpdate	Updates an existing relatedliterature record.
RelatedLiteratureDelete	Deletes a relatedliterature record.
RelatedLiteratureQueryPage	Queries for a relatedliterature record.

Request Message Description: RelatedLiteratureInsert

For a description of this request message, see the following table.

Node	Description	Type
LitId	Name of the account to be inserted.	String
ParLitId	ParLitId of the corresponding record.	String

Response Message Description: RelatedLiteratureInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created relatedliterature record.	String

Request Message Description: RelatedLiteratureUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of a relatedliterature record.	String
LitId	Literature ID of the corresponding record.	String
ParLitId	ParLitId of the corresponding record.	String

Response Message Description: RelatedLiteratureUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated relatedliterature record.	String

Request Message Description: RelatedLiteratureDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the account to be designated as relatedliterature.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted relatedliterature record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the account to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the relatedliterature record.	String

LSSGOP_RelatedLiterature Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_RelatedLiterature	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_RelatedLiterature	LS SGOP_RelatedLiterature

Interface Description (WSDL) for LSSGOP_RelatedLiterature

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

...\LSSGOP_RelatedLiterature\http_siebel.com_asi_LSSGOP_RelatedLiterature.WSDL

LSSGOP_RetailObjective

Use this Web service to create, update, delete, and query records in the RetailObjective object.

LSSGOP_RetailObjective Operations

This Web service allows you to create, update, delete, and query records in the RetailObjective object. For a list of operations, see the following table.

Name	Description
RetailObjectiveInsert	Creates a retailobjective record.
RetailObjectiveUpdate	Updates an existing retailobjective record.
RetailObjectiveDelete	Deletes a retailobjective record.
RetailObjectiveQueryPage	Queries for a retailobjective record.

Request Message Description: RetailObjectiveInsert

For a description of this request message, see the following table.

Node	Description	Type
Name	Name of the corresponding record.	String
Description	Description of the corresponding record.	String
StartDate	Start date of the corresponding record.	String
EndDate	End date of the corresponding record.	String
GoalRevenueDate	Goal revenue date of the corresponding record.	String
PeriodName	Period name of the corresponding record.	String
Type	Type of the corresponding record.	String
PromoNum	Promotion number of the corresponding record.	String

Response Message Description: RetailObjectiveInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created retailobjective	String

Request Message Description: RetailObjectiveUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the retailobjective record.	String
Name	Name of the corresponding record.	String
Description	Description of the corresponding record.	String
StartDate	Start date of the corresponding record.	String
EndDate	End date of the corresponding record.	String
GoalRevenueDate	Goal revenue date of the corresponding record.	String
PeriodName	Period name of the corresponding record.	String
Type	Type of the corresponding record.	String
PromoNum	Promotion number of the corresponding record.	String
Type	Name of the corresponding record.	String

Response Message Description: RetailObjectiveUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated retailobjective record.	String

Request Message Description: RetailObjectiveDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the retailobjective record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted retailobjective record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the retailobjective record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the retailobjective record.	String

LSSGOP_RetailObjective Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_RetailObjective	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_RetailObjective	LS SGOP_RetailObjective

Interface Description (WSDL) for LSSGOP_RetailObjective

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

...\LSSGOP_RetailObjective\http_siebel.com_asi_LSSGOP_RetailObjective.WSDL

LSSGOP_Revenue

Use this Web service to create, update, delete, and query records in the Revenue object.

LSSGOP_Revenue Operations

This Web service allows you to create, update, delete, and query records in the Revenue object. For a list of operations, see the following table.

Name	Description
RevenueInsert	Creates a revenue record.
RevenueUpdate	Updates an existing revenue record.
RevenueDelete	Deletes a revenue record.
RevenueQueryPage	Queries for a revenue record.

Request Message Description: RevenueInsert

For a description of this request message, see the following table.

Node	Description	Type
Date	Date of the corresponding record.	String

Response Message Description: RevenueInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created revenue record.	String

Request Message Description: RevenueUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the revenue record.	String
Date	Date of the corresponding record.	String

Response Message Description: RevenueUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated revenue record.	String

Request Message Description: RevenueDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the revenue record to be deleted	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted revenue	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the revenue to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the revenue.	String

LSSGOP_Revenue Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_Revenue	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_Revenue	LS SGOP_Revenue

Interface Description (WSDL) for LSSGOP_Revenue

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

...\LSSGOP_Revenue\http_siebel.com_asi_LSSGOP_Revenue.WSDL

LSSGOP_SampleDisclaimer

Use this Web service to create, update, delete, and query records in the SampleDisclaimer object.

LSSGOP_SampleDisclaimer Operations

This Web service allows you to create, update, delete, and query records in the SampleDisclaimer object. For a list of operations, see the following table.

Name	Description
SampleDisclaimerInsert	Creates a sampledisclaimer record.
SampleDisclaimerUpdate	Updates an existing sampledisclaimer record.
SampleDisclaimerDelete	Deletes a sampledisclaimer record.
SampleDisclaimerQueryPage	Queries for a sampledisclaimer record.

Request Message Description: SampleDisclaimerInsert

For a description of this request message, see the following table.

Node	Description	Type
Disclaimer	Name of the account to be inserted.	String
DisclaimerNumber	Disclaimer number.	Number

Response Message Description: SampleDisclaimerInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created sampledisclaimer record.	String

Request Message Description: SampleDisclaimerUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the sampledisclaimer record.	String
Disclaimer	Disclaimer of the co.rresponding record.	String
DisclaimerNumber	Disclaimer number of the corresponding record.	String

Response Message Description: SampleDisclaimerUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated sampledisclaimer record.	String

Request Message Description: SampleDisclaimerDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the sampledisclaimer record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted sampledisclaimer record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the sampledisclaimer record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the sampledisclaimer record.	String

LSSGOP_SampleDisclaimer Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_SampleDisclaimer	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_SampleDisclaimer	LS SGOP_SampleDisclaimer

Interface Description (WSDL) for LSSGOP_SampleDisclaimer

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

...\LSSGOP_SampleDisclaimer\http_siebel.com_asi_LSSGOP_SampleDisclaimer.WSDL

LSSGOP_SampleDropped

Use this Web service to create, update, delete, and query records in the SampleDropped object.

LSSGOP_SampleDropped Operations

This Web service allows you to create, update, delete, and query records in the SampleDropped object. For a list of operations, see the following table.

Name	Description
SampleDroppedInsert	Creates a sampledropped record.
SampleDroppedUpdate	Updates an existing sampledropped record.
SampleDroppedDelete	Deletes a sampledropped record.
SampleDroppedQueryPage	Queries for a sampledropped record.

Request Message Description: SampleDroppedInsert

For a description of this request message, see the following table.

Node	Description	Type
Name	Name of the corresponding record.	String
LotId	Lot ID of the corresponding record.	String
ProductAllocationId	Product allocation ID of the corresponding record.	String
Quantity	Quantity of the corresponding record.	String
Type	Type of the corresponding record.	String

Response Message Description: SampleDroppedInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created sampledropped record.	String

Request Message Description: SampleDroppedUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the sampledropped record.	String
Name	Name of the corresponding record.	String
LotId	Lot ID of the corresponding record.	Number
ProductAllocationId	Product allocation ID of the corresponding record.	Number
Quantity	Quantity of the corresponding record.	String
Type	Type of the corresponding record.	String

Response Message Description: SampleDroppedUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated sampledropped record.	String

Request Message Description: SampleDroppedDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the sampledropped record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted sampledropped record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the sampledropped record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the sampledropped record.	String

LSSGOP_SampleDropped Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_SampleDropped	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following

Siebel Repository Name	External Name
LS SGOP_SampleDropped	LS SGOP_SampleDropped

Interface Description (WSDL) for LSSGOP_SampleDropped

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

...\LSSGOP_SampleDropped\http_siebel.com_asi_LSSGOP_SampleDropped.WSDL

LSSGOP_SampleInventory

Use this Web service to create, update, delete, and query records in the SampleInventory object.

LSSGOP_SampleInventory Operations

This Web service allows you to create, update, delete, and query records in the SampleInventory object. For a list of operations, see the following table.

Name	Description
SampleInventoryInsert	Creates a sampleinventory record.
SampleInventoryUpdate	Updates an existing sampleinventory record.
SampleInventoryDelete	Deletes a sampleinventory record.
SampleInventoryQueryPage	Queries for a sampleinventory record.

Request Message Description: SampleInventoryInsert

For a description of this request message, see the following table.

Node	Description	Type
ProductId	Product ID of the corresponding record.	String
StockPeriodId	Stock period ID of the corresponding record.	String
ServerQuantity	Server quantity of the corresponding record.	String
ClientQuantity	Client quantity of the corresponding record.	String

Response Message Description: SampleInventoryInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created sampleinventory	String

Request Message Description: SampleInventoryUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the sampleinventory.	String
ProductId	Product ID of the corresponding record.	String
StockPeriodId	Stock period ID of the corresponding record.	String
ServerQuantity	Server quantity of the corresponding record.	String
ClientQuantity	Client quantity of the corresponding record.	String

Response Message Description: SampleInventoryUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated sampleinventory record.	String

Request Message Description: SampleInventoryDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the sampleinventory record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted sampleinventory record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the sampleinventory record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the sampleinventory record.	String

LSSGOP_SampleInventory Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_SampleInventory	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_SampleInventory	LS SGOP_SampleInventory

Interface Description (WSDL) for LSSGOP_SampleInventory

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

...\LSSGOP_SampleInventory\http_siebel.com_asi_LSSGOP_SampleInventory.WSDL

LSSGOP_SampleTransaction

Use this Web service to create, update, delete, and query records in the SampleTransaction object.

LSSGOP_SampleTransaction Operations

This Web service allows you to create, update, delete, and query records in the SampleTransaction object. For a list of operations, see the following table.

Name	Description
SampleTransactionInsert	Creates a sampletransaction record.
SampleTransactionUpdate	Update an existing sampletransaction record.
SampleTransactionDelete	Delete a sampletransaction record.
SampleTransactionQueryPage	Query for a sampletransaction record.

Request Message Description: SampleTransactionInsert

For a description of this request message, see the following table.

Node	Description	Type
Name	Name of the corresponding record.	String
TransactionDate	Transaction date of the corresponding record.	String
TransactionStatus	Transaction status of the corresponding record.	String

Response Message Description: SampleTransactionInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created sampletransaction.	String

Request Message Description: SampleTransactionUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the sampletransaction record.	String
Name	Name of the corresponding record.	String
TransactionDate	Transaction date of the corresponding record.	String
TransactionStatus	Transaction status of the corresponding record.	String

Response Message Description: SampleTransactionUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated account.	String

Request Message Description: SampleTransactionDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the sampletransaction record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted sampletransaction record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the sampletransaction record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the sampletransaction record.	String

LSSGOP_SampleTransaction Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_SampleTransaction	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_SampleDisclaimer	LS SGOP_SampleDisclaimer

Interface Description (WSDL) for LSSGOP_SampleTransaction

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

...\LSSGOP_SampleTransaction\http_siebel.com_asi_LSSGOP_SampleTransaction.WSDL

LSSGOP_Signature

Use this Web service to create, update, delete, and query records in the Signature object.

LSSGOP_Signature Operations

This Web service allows you to create, update, delete, and query records in the Signature object. For a list of operations, see the following table.

Name	Description
SignatureInsert	Creates a signature record.
SignatureUpdate	Updates an existing signature record.
SignatureDelete	Deletes a signature record.
SignatureQueryPage	Queries for a signature record.

Request Message Description: SignaturetInsert

For a description of this request message, see the following table.

Node	Description	Type
ActivityId	Activity ID of the corresponding record.	String
CallDate	Call date of the corresponding record.	String
ContactId	Contact ID of the corresponding record.	String
DisclaimerId	Disclaimer ID of the corresponding record.	String
Signature	Signature of the corresponding record.	String
SignatureBodyText	Signature body text of the corresponding record.	String
SignatureHeaderText	Signature header text of the corresponding record.	String

Response Message Description: SignatureInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created signature record.	String

Request Message Description: SignatureUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the signature record.	String
ActivityId	Activity ID of the corresponding record.	String
CallDate	Call date of the corresponding record.	String
ContactId	Contact ID of the corresponding record.	String
DisclaimerId	Disclaimer ID of the corresponding record.	String
Signature	Signature of the corresponding record.	String
SignatureBodyText	Signature body text of the corresponding record.	String
SignatureHeaderText	Signature header text of the corresponding record.	String

Response Message Description: SignatureUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	Activity ID of the corresponding record.	String

Request Message Description: SignatureDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the signature record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted signature record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the signature record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the signature record.	String

LSSGOP_Signature Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_Signature	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_Signature	LS SGOP_Signature

Interface Description (WSDL) for LSSGOP_Signature

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

...\LSSGOP_Signature\http_siebel.com_asi_LSSGOP_Signature.WSDL

LSSGOP_TransactionItem

Use this Web service to create, update, delete, and query records in the TransactionItem object.

LSSGOP_TransactionItem Operations

This Web service allows you to create, update, delete, and query records in the TransactionItem object. For a list of operations, see the following table.

Name	Description
TransactionItemInsert	Creates a transactionitem record.
TransactionItemUpdate	Updates a existing transactionitem record.
TransactionItemDelete	Deletes a transactionitem record.
TransactionItemQueryPage	Queries for a transactionitem record.

Request Message Description: TransactionItemInsert

For a description of this request message, see the following table.

Node	Description	Type
ProductId	Product ID of the corresponding record.	String
SampleTransactionId	Sample transaction ID of the corresponding record.	String
Lot	Lot of the corresponding record.	String
LineNumber	Line number of the corresponding record.	String
ItemStatus	Item status of the corresponding record.	String
Quantity	Quantity of the corresponding record.	String

Response Message Description: TransactionItemInsert

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the newly created transactionitem record.	String

Request Message Description: TransactionItemUpdate

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the transactionitem record.	String
ProductId	Product ID of the corresponding record.	String
SampleTransactionId	Sample transaction ID of the corresponding record.	String
Lot	Lot of the corresponding record.	String
LineNumber	Line number of the corresponding record.	String
ItemStatus	Item status of the corresponding record.	String
Quantity	Quantity of the corresponding record.	String

Response Message Description: TransactionItemUpdate

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the updated account.	String

Request Message Description: TransactionItemDelete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the transactionitem record to be deleted.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the deleted transactionitem record.	String

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of the transactionitem record to be queried.	String

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of the transactionitem record.	String

LSSGOP_TransactionItem Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
LSSGOP_TransactionItem	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP_TransactionItem	LS SGOP_TransactionItem

Interface Description (WSDL) for LSSGOP_TransactionItem

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

...\LSSGOP_TransactionItem\http_siebel.com_asi_LSSGOP_TransactionItem.WSDL

LSSGOP_ModificationTrackingPurge

Use this Web service to delete records from the ModificationTracking object.

LSSGOP_ModificationTrackingPurge Operations

This Web service allows you to delete records from the ModificationTracking object. For a list of operations, see the following table.

Name	Description
Delete	Deletes a modificationtracking record.

Request Message Description: Delete

For a description of this request message, see the following table.

Node	Description	Type
Id	ID of a modificationtracking record to be deleted.	String

Response Message Description: Delete

For a description of this response message, see the following table.

Node	Description	Type
Id	ID of a deleted modificationtracking record.	String

LSSGOP_ModificationTrackingPurge Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see the following table.

Name	Boundary Object Type	Class
Modification Tracking	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

For a description of the data objects for this Web service, see the following table.

Siebel Repository Name	External Name
LS SGOP Modification Tracking Purge	LS SGOP Modification Tracking

Interface Description (WSDL) for LSSGOP_ModificationTrackingPurge

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

...\LSSGOP_ModificationTrackingPurge\http_siebel.com_asi_ModificationTrackingPurge.WSDL