Siebel CRM Primary Web Services (M-Z)

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:

MatchAccountSiebelReqABCSImpl

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.

MatchAccountSiebelReqABCSImpl Operations

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

Name	Description
MatchAccount	Use this Web service to query an account to satisfy search criteria from a participating application and display the results in the Siebel CRM application without storing the data inthe Siebel database. This operation is called from the Match Account pop-up window when a user clicks the Go button to query account details from the participating application.

Request Message Description: MatchAccount

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

Node	Description	Type
MatchAccountReqMsg:payload	Optional	Hierarchy
CustomHeaderContext	Optional	Hierarchy

Response Message Description: MatchAccount

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

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
MatchAccountRespMsg:payload	Optional	Hierarchy
XMLHierarchyOutput	Optional	Hierarchy
faultactor	Optional	String
faultcode	Optional	String
faultstring	Optional	String
MatchAccountFaultMsg:payload	Optional	Integration Object

MatchAccountSiebelReqABCSImpl 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
SSWI External Account Integration 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
Fault	Fault

Methods

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

Operation	Method
MatchAccount	MatchAccount

Interface Description (WSDL) for MatchAccountSiebelReqABCSImpl

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

...WSDL\MatchAccountSiebelReqABCSImpl.wsdl

MatchContactSiebelReqABCSImpl

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 the Contact list or form applets and also from the Match Contact pop-up applet.

MatchContactSiebelReqABCSImpl Operations

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

Name	Description
MatchContact	Use this Web service to query a contact to satisfy search criteria from a participating application and display the results in the Siebel CRM application without storing the data in the Siebel database. This operation is called from the Match Contact pop-up window when a user clicks the Go button to query account details from the participating application.

Request Message Description: MatchContact

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

Node	Description	Type
MatchContactReqMsg:payload	Optional	Hierarchy
CustomHeaderContext	Optional	Hierarchy

Response Message Description: MatchContact

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

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

MatchContactSiebelReqABCSImpl 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 Contact Integration 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	SWIMatchContactVBCIO
Fault	Fault

Methods

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

Operation	Method
MatchContact	MatchContact

MktgDeduplicationService

Use this Web service to check whether a duplicate record exists for an account, contact, opportunity or prospect.

MktgDeduplicationService Operations

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

Node	Description
MktgDeduplicationServiceMatchAccount	Matches account information provided with the accounts in the system and returns the row ids of the duplicates found with the score for each account.
MktgDeduplicationServiceMatchOpportunity	Matches the opportunities.
MktgDeduplicationServiceMatchProspect	Matches the prospects.
MktgDeduplicationServiceMatchContact	Matches the contacts.

Request Message Description: MktgDeduplicationServiceMatchAccount

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

Node	Description	Type
DUNS Number	Dun and Bradstreet data universal numbering system number.	String
Name	Account name.	String
Primary Account City	City name.	String
Primary Account Country	Country name.	String
Primary Account Postal Code	City postal code.	String
Primary Account State	State.	String
Primary Account Street Address	Street address of primary account.	String

Response Message Description: MktgDeduplicationServiceMatchAccount

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

Node	Description	Type
HasMatch	The output string is “hasMatch” or “hasNoMatch”.	String
Match Info	Score of the match and row id of the record matched.	Integration Object

Response Message Description: MktgDeduplicationServiceMatchOpportunity

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

Node	Description	Type
Account Id	Opportunity’s account ID.	String
Business Unit Id	Opportunity’s business unit ID.	String
Name	Opportunity’s name.	String

Response Message Description: MktgDeduplicationServiceMatchOpportunity

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

Node	Description	Type
HasMatch	Output string as “hasMatch” or “hasNoMatch”.	String
Match Info	Score of the match and row id of the record matched.	Integration Object

Request Message Description: MktgDeduplicationServiceMatchProspect

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

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

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

Node	Description	Type
HasMatch	Output String as “hasMatch” or “hasNoMatch”.	String
Match Info	Score of the match and row id of the record matched.	Integration Object

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

Node	Description	Type
Account	Account name of contact.	String
Birth Date	Contact’s birth date.	String
Phone	Contact’s phone number.	String
City	Contact’s city of residence.	String
Country	Contact’s country of residence.	String
Email Address	Contact’s email address.	String
First Name	Contact’s first name.	String
Home Phone #	Contact’s home phone number.	String
Last Name	Contact’s last name.	String
Middle Name	Contact’s middle name.	String
Primary Postal Code	Contact’s primary postal code.	String
Social Security Number	Contact’s social security number.	String
State	Contact’s state of residence.	String
Street Address	Contact’s street address.	String
Work Phone #	Contact’s work phone number.	String

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

Node	Description	Type
HasMatch	Output String as “hasMatch” or “hasNoMatch”.	String
Match Info	Score of the match and row id of the record matched.	Integration Object

MktgImportDeduplicationService 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
Mktg Deduplication	Mktg Deduplication

Example Package for MktgDeduplicationService

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 (MatchAccount)

See the following file to view the sample code:

...\MktgDeduplicationService\MatchAccount_request.xml

Response (MatchAccount)

See the following file to view the sample code:

...\MktgDeduplicationService\MatchAccount_response.xml

Request (MatchOpportunity)

See the following file to view the sample code:

...\MktgDeduplicationService\MatchOpportuntity_request.xml

Response (MatchOpportunity)

See the following file to view the sample code:

...\MktgDeduplicationService\MatchOpportuntity_response.xml

Request (MatchProspect)

See the following file to view the sample code:

...\MktgDeduplicationService\MatchProspect_request.xml

Response (MatchProspect)

See the following file to view the sample code:

...\MktgDeduplicationService\MatchProspect_response.xml

Request (MatchContact)

See the following file to view the sample code:

...\MktgDeduplicationService\MatchContact_request.xml

Response (MatchContact)

See the following file to view the sample code:

...\MktgDeduplicationService\MatchContact_response.xml

Interface Description (WSDL) for MktgDeduplicationService

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.

...\MktgDeduplicationService\MktgDedup.wsdl

MktgImportService

This Web service is used for all the imports into the Siebel Marketing application such as Leads, Contacts, Prospects and so on.

MktgImportService Operations

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

Node	Description
MktgImportServiceInvokeImportJob	Schedules various import processes for Marketing.

Request Message Description: MktgImportServiceInvokeImportJob

This method gets the details of the records from the business component Invoke Import Jobs and schedules the import process. For a description of this request message, see the following table.

Node	Description	Type
ImportJobParams	Required. An instance of the integration object Import Job Integration Object.	Integration Object

Response Message Description: MktgImportServiceInvokeImportJob

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

Node	Description	Type
ErrorCode	Error code values are OK or NOTOK.	String
Error Message	Error message (if any)	String

MktgImportService 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
Mktg System Task Service	Business Service	CSSSystemTaskService

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 MktgImportService

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:

...\MktgImportService\MktgImportServiceInvokeImportJob_request.xml

Response

See the following file to view the sample code:

...\MktgImportService\MktgImportServiceInvokeImportJob_response.xml

Interface Description (WSDL) for MktgImportService

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.

...\MktgImportService\MktgImportService.wsdl

ModificationTracking

Use this Web service to query records in the ModificationTracking object.

ModificationTracking Operations

This Web service allows you to query records in the ModificationTracking object. For a list of operations, see the following table.

Name	Description
QueryPage	Creates a modificationtracking record.

Request Message Description: QueryPage

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

Node	Description	Type
Id	ID of a modificationtracking record to be queried.	String

Response Message Description: QueryPage

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

Node	Description	Type
Id	ID of a modificationtracking record.	String

ModificationTracking 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
Modification Tracking	LS SGOP Modification Tracking

Interface Description (WSDL) for ModificationTracking

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.

...\ModificationTracking\http_siebel.com_asi_ModificationTracking.WSDL

NetworkOrderEntry

Use this Web service to access network assets, as well as related attributes, attached files, and open orders. Additionally, use this Web service to validate a network based on product rules and return projected assets for a network.

NetworkOrderEntry Operations

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

Common Request Message Description

The service has six operations. They do not share a common request message format.

Common Response Message Description

The service has six operations. They do not share a common response message format.

NetworkOrderEntry Application Interface

This topic describes the application objects called by 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 BusService)
VORD NOE Complex Data Service	Business Service	CSSVORDWebService
VORD NOE Simple Data Service	Business Service	CSSVORDWebService

Data Object (Integration Object)

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

Siebel Repository Name	External Name	Business Service
VORD NOE Network Assets	VORD NOE Asset Attributes	VORD NOE Simple Data Service
VORD NOE Asset Attributes	VORD NOE Asset Attributes	VORD NOE Simple Data Service
VORD NOE Network Attachments	VORD Network Asset	VORD NOE Simple Data Service
VORD NOE Network Open Order Line Items	VORD Network Asset	VORD NOE Simple Data Service
VORD NOE Network Validation Rule	VORD Network Validation Rule	VORD NOE Complex Data Service
VORD NOE Projected Asset	VORD NOE Projected Asset	VORD NOE Complex Data Service

Methods

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

Operation	Business Service	Method
GetNetworkAssets	VORD NOE Simple Data Service	GetNetworkAssets
GetNetworkAssetAttributes	VORD NOE Simple Data Service	GetNetworkAssetAttributes
GetNetworkAssetAttachments	VORD NOE Simple Data Service	GetNetworkAssetAttachments
GetOpenNetworkOrders	VORD NOE Simple Data Service	GetOpenNetworkOrders
ValidateNetworkOrder	VORD NOE Complex Data Service	ValidateNetworkOrder
QueryProjectedNetworkAsset	VORD NOE Complex Data Service	QueryProjectedNetworkAsset

OrderDetailWebService

Use this Web service to query orders based on search criteria, and to retrieve details from a particular order. Details include payments, approvals, shipping, and billing charges, and tracked order shipment details. Additionally, you can copy current order lines to a cart, or cancel an order.

OrderDetailWebService Operations

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

Name	Description
OrderDetailQueryPage	Performs query operations based on the view criteria and the search specifications set on the PDS Order Detail integration object as the input. This operation is used for querying order details including the payment, approvals, and shipping, and billing details.
OrderDetailUpdate	Performs update operations on the PDS Order Detail integration object as the input. This operation is used for editing the details of an order such as copying lines of the current order or cancelling an order.

Request Message Description: OrderDetailQueryPage

Based on the view criteria and search specification set on the integration object, the order query can query the order header, line details of the order, approvals, payment, shipping, billing and shipment details. For a description of this request message, see the following table.

Node	Description	Type
OrderDetailQueryPage_Input	The method arguments are Orders IO with query parameters set, Language Mode (value is LDC) and viewMode (All).	Integration Object

Response Message Description: OrderDetailQueryPage

Based on the view criteria and search specification set on the integration object, information about order header, line details of the order, approvals, payment, shipping, billing and shipment details is returned in the response.For a description of this response message, see the following table.

Node	Description	Type
OrderDetailQueryPage_Output	The retrieved data for the query set on the view criteria and search specification.	Integration Object

Request Message Description: OrderDetailUpdate

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

Node	Description	Type
OrderDetailUpdate_Input	The method arguments are Orders IO with parameters set, Language Mode (value is LDC) and viewMode (All).	Integration Object

Response Message Description: OrderDetailUpdate

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

Node	Description	Type
OrderDetailUpdate_Output	The retrieved data for the update operation performed.	Integration Object

OrderDetailWebService 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. This Web service makes available the EAI UI Business Service PDS Order Detail, which provides update and query operations on the integration object PDS Order Detail.

Service Object (Business Service or Workflow)

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

Name	Boundary Object Type	Class
PDS Order Detail	Integration Object	CSSEAIUIDataService

Data Object (Integration Object)

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

Siebel Repository Name	External Name
PDS Order Detail	PDS Simplified Order

Example Package for OrderDetailWebService

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:

...\OrderDetailWebService\OrderDetailWebService_request.xml

Response

See the following file to view the sample code:

...\OrderDetailWebService\OrderDetailWebService_response.xml

Interface Description (WSDL) for OrderDetailWebService

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.

...\OrderDetailWebService\OrderDetail.wsdl

PaymentAuthorizationSalesOrderSiebelReqABCSImpl

Use this Web service to check whether this payment record is valid for the customer

PaymentAuthorizationSalesOrderSiebelReqABCSImpl Operations

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

Name	Description
PaymentAuthorization	Checks for the validity of the payment record.

Request Message Description: PaymentAuthorization

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

Node	Description	Type
PaymentAuthorizationSalesOrderReq Msg:ListOfSWIOrderIO	Optional	Hierarchy
CustomHeaderContext	Optional	Hierarchy

Response Message Description: PaymentAuthorization

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

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
PaymentAuthorizationSalesOrderResp Msg:ListOfSWIOrderIO	Optional	Hierarchy
XMLHierarchyOutput	Optional	Hierarchy
faultactor	Optional	String
faultcode	Optional	String
faultstring	Optional	String
SiebelFaultMsg:Fault	Optional	Integration Object

PaymentAuthorizationSalesOrderSiebelReqABCSImpl 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
SWISendPaymentAuthorization	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
PaymentAuthorization	PaymentAuthorization

Interface Description (WSDL) for PaymentAuthorizationSalesOrderSiebelReqABCSImpl

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.

...\PaymentAuthorizationSalesOrderSiebelReqABCSImpl\PaymentAuthorizationSalesOrderSiebelReqABCSImpl.wsdl

PaymentSiebelCommsReqABCS

Use this Web service to query for invoice details in the external Oracle Communications Billing and Revenue Management application that will be displayed on a billing profile in the Billing user interface.

PaymentSiebelCommsReqABCS Operations

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

Name	Description
QueryPayment	Queries for payments on a billing profile in the Siebel Communications Billing UI
SearchPayment	Searches for payments on a billing profile in the Siebel Communications Billing UI
CreatePayment	Creates payments on a billing profile in the Siebel Communications Billing UI
CreateInvoicePayment	Creates payments on a bill in the Siebel Communications Billing UI
QueryInvoicePayment	Queries for payments on a bill in the Siebel Communications Billing UI

Request Message Description: QueryPayment

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

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

Response Message Description: QueryPayment

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

Node	Description	Type
QueryPaymentRespMsg:ListOfCmuResponseBillingProfilePaymentsIo	Optional	Integration Object

Request Message Description: SearchPayment

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

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
SearchPaymentReqMsg:ListOfCmuRequestBillingProfilePaymentsSearchIo	Optional	Integration Object

Response Message Description: SearchPayment

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

Node	Description	Type
SearchPaymentRespMsg:ListOfCmuResponseBillingProfilePaymentsIo	Optional	Integration Object

Request Message Description: CreatePayment

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

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
CreatePaymentReqMsg:ListOfCmuRequestNewPaymentCaptureIo	Optional	Integration Object

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

Node	Description	Type
CreatePaymentRespMsg:ListOfCmuResponseNewPaymentsIo	Optional	Integration Object

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

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
CreateInvoicePaymentReqMsg:ListOfCmuRequestNewPaymentCaptureInvoiceIo	Optional	Integration Object

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

Node	Description	Type
CreateInvoicePaymentRespMsg:ListOfCmuResponseNewPaymentInvoiceIo	Optional	Integration Object

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

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

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

Node	Description	Type
QueryInvoicePaymentRespMsg:ListOfCmuResponseBilledUsgaePaymentsIo	Optional	Integration Object

PaymentSiebelCommsReqABCS 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
PaymentSiebelCommsReqABCS	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 Response Billed Usage Payments IO	Account
CMU Request Billed Usage IO	Account
CMU Request Billing Profile IO	Account
CMU Response Billing Profile Payments IO	Account
CMU Request Billing Profile Payments Search IO	Account
CMU Response Billing Profile Payments IO	Account
CMU Request New Payment Capture IO	Account
CMU Response New Payments IO	Account
CMU Request New Payment Capture Invoice IO	Account
CMU Response New Payment Invoice IO	Account

Methods

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

Operation	Method
QueryPayment	QueryPayment
SearchPayment	SearchPayment
CreatePayment	CreatePayment
CreateInvoicePayment	CreateInvoicePayment
QueryInvoicePayment	QueryInvoicePayment

Example Package for PaymentSiebelCommsReqABCS

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:

...\PaymentSiebelCommsReqABCS\Request.xml

Response

See the following file to view the sample code:

...\PaymentSiebelCommsReqABCS\Response.xml

Interface Description (WSDL) for PaymentSiebelCommsReqABCS

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.

...\PaymentSiebelCommsReqABCS\WSDL

PDSOrderHeader

Use this Web service to get header information for specific open orders.

PDSOrderHeader Operations

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

Name	Description
PDSOrderHeaderQueryPage	Get the header information of open orders for a specific asset.

Request Message Description: PDSOrderHeaderQueryPage

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

Node	Description	Type
PDSOrderHeaderQueryPage_Input	The request message includes the search criteria for order status and asset integration ID.	ComplexType

Response Message Description: PDSOrderHeaderQueryPage

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

Node	Description	Type
PDSOrderHeaderQueryPage_Output	The response message includes list of order headers matching the search criteria.	ComplexType

Example Package for PDSOrderHeader

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:

...\PDSOrderHeader\PDSOrderHeader_request.xml

Response

See the following file to view the sample code:

...\PDSOrderHeader\PDSOrderHeader_response.xml

Interface Description (WSDL) for PDSOrderHeader

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.

...\PDSOrderHeader\PDSOrderHeader.wsdl

PriceListsWS

Use this Web service to obtain price lists based on defined search specifications.

PriceListsWS Operations

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

Node	Description
GetPriceLists	Get all the price lists based on search spec.

Request Message Description: GetPriceLists

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

Node	Description	Type
GetPriceLists_Input	Request message includes the search specification.	ComplexType

Response Message Description: GetPriceLists

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

Node	Description	Type
GetPriceLists_Output	Response message includes the price lists matching the search specification.	ComplexType

Example Package for PriceListsWS

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:

...\PriceListsWS\PriceListsWS_request.xml

Response

See the following file to view the sample code:

...\PriceListsWS\PriceListsWS_response.xml

Interface Description (WSDL) for PriceListsWS

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.

...\PriceListsWS\PriceListsWS.wsdl

ProcessSalesOrderSiebelJMSProducer

Use this Web service to submit a sales order from the Siebel CRM application to the billing application and to create a customer account, if needed, in the billing application.

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

ProcessSalesOrderSiebelJMSProducer Operations

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

Operation Name	Description
Process	Submits a sales order to the billing application and creates a customer account, if needed, in the billing application.

Request Message Description: Process

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

Node	Description
Order	The details of the header for the order.
OrderItem	The details of the order item.
OrderItemXA	The properties of the order item.

ProcessSalesOrderSiebelJMSProducer Application Interface

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)
ProcessSalesOrderSiebelJMSProducer	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
PDS Order - No Hierarchy	PDS Simplified Order

Methods

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

Operation	Method
process	[BS: ProcessSalesOrderSiebelJMSProducer].process

Example Package for ProcessSalesOrderSiebelJMSProducer

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:

...\ProcessSalesOrderSiebelJMSProducer\ProcessSalesOrderSiebelJMSProducerRequest

Message.xml

Response

See the following file to view the sample code:

...\ProcessSalesOrderSiebelJMSProducer\ProcessSalesOrderSiebelJMSProducerResponse

Message.xml

Interface Description (WSDL) for ProcessSalesOrderSiebelJMSProducer

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.

...\ProcessSalesOrderSiebelJMSProducer\ProcessSalesOrderSiebelJMSProducer.xml

Product Configurator Web Service

Note: This version of Siebel Product Configurator Web Service is available only for implementations of Siebel CRM version 8.1 and later. To use the Siebel Configurator Web service with Siebel CRM version 8.0, see version 8.0 of Siebel CRM Web Services Reference.

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

Product Configurator Web Service Operations

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

Name	Description
GetCfgObjectStructure	Retrieves product relationships, attributes, linked items and resources.
GetCfgObjectGroupItems	Retrieves the Product UI definition, UI group and group items.
GetCfgObjectDefaultGroupItems	Retrieves Default Product Group Items (group items will be based on all relationships, attributes, linked items and resources).
BeginConfiguration	Enables customization of products stored in the Siebel database. Initializes the configurator session with a quote instance and product model.
UpdateConfiguration	Executes operations on the quote instance initialized in BeginConfiguration.
EndConfiguration	Release server resources used during the Begin or Update Configuration operation.

Request Message Description: GetCfgObjectStructure

GetCfgObjectStructure has the same request and response message.

GetCfgObjectGroupItems has the same request and response message.

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

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

Node	Description
WebChannelObjStructure	Required. This structure identified the objects that will be queries as well the data that will be returned about the objects.
Object	Required. One or more must be specified.
Name	Required. Name of an object (product or class). Either Name or Id is required.
Id	Required. Id of an object (product or class). Either Name or Id is required.
ObjectType	Required. Either Product or Class.
ParentClassId	Class Id of the parent.
DisplayName	Display name.
Description	Description.
Attribute	Zero or more (only those child objects that are specified will be queried for).
Name	Name of attribute. If empty, then all attributes are returned.
LocalType	Local type.
InternalType	Internal type.
OrigId	Internal Id.
DisplayName	Display name.
Hidden	Hidden flag.
Required	Required flag.
ReadOnly	Read Only flag.
ValidationSpec	Validation specification.
UnitOfMeasure	Unit of measure.
Description	Description.
AttributeDomain	Zero or more.
LocalValue	Local value.
InternalValue	Internal value.
AttributeDomainDecoration	Zero or more. Attribute domain specific properties name value pairs.
Name	Name of attribute.
Value	Value of attribute.
AttributeDefaultValue	Default value of the attribute. Only one of the value types will be populated depending on the type of the value.
DisplayValue	Display value.
String	String value.
Number	Number value.
Integer	Integer value.
Date	Date value.
Boolean	Boolean value.
AttributeRejectedValue	Rejected value of the attribute. Only one of the value types will be populated depending on the type of the value.
DisplayValue	Display value.
String	String value.
Number	Number value.
Integer	Integer value.
Date	Date value.
Boolean	Boolean value.
AttributeDecoration	Zero or more.
Name	Attribute properties name.
Value	Value pairs.
Relationship	Zero or more (only those child objects that are specified will be queried for).
Name	Name of relationship. If Name and or Id is specified, then only that particular relationship will be returned. If both are empty, then all relationships are returned.
Id	Id of relationship. If Name and or Id is specified, then only that particular relationship will be returned. If both are empty, then all relationships will be returned.
DisplayName	Display name.
ClassName	Class name.
ClassId	Class Id.
DefaultProductId	Default product Id.
DefaultCardinality	Default cardinality.
MinimumCardinality	Minimum cardinality.
MaximumCardinality	Maximum cardinality.
RelationshipDomain	Zero or more.
Name	Name of product. If Name and or Id is specified, then only that particular relationship domain will be returned. If both are empty, then all relationship domain products will be returned.
Id	Id of product. If Name and or Id is specified, then only that particular relationship domain will be returned. If both are empty, then all relationship domain products will be returned.
DisplayName	Display Name.
OrigId	Originating Id.
Description	Description.
RelationshipDomainDecoration	Zero or more.
Name	Relationship domain specific properties name.
Value	Value pairs.
RelationshipDecoration	Zero or more.
Name	Relationship properties name
Value	Value pairs.
LinkedItem	Zero or more (only those child objects that are specified will be queried for).
Name	Name of linked item.
Id	Id of linked item. If Name and or Id is specified, then only that particular linked item will be returned. If both are empty, then all linked items will be returned.
DisplayName	Display name.
VariableName	Variable Name.
SortSpec	Sort specification.
SearchSpec	Search specification.
NeedsExecution	The Needs Execution flag used for business component-based queries.
Expression	Expression.
DefaultValue	Default value.
BusinessObject	Business object for business component based query.
BusinessComponent	Business component for business component based query.
FieldName	Field name in the business component.
Active	Active flag.
LinkedItemDecoration	Linked Item properties.
Name	Name value.
Value	Pairs.
Resource	Zero or more (only those child objects that are specified will be queried for).
Name	Name of resource. If Name and or Id is specified, then only that particular resource will be returned. If both are empty, then all resources are returned.
Id	Id of resource. If Name and or Id is specified, then only that particular resource will be returned. If both are empty, then all resources are returned.
DisplayName	Display name.
ResourceDecoration	Resource properties.
Name	Name value.
Value	Pairs.
ObjectDecoration	Object properties.
Name	Name value.
Value	Pairs.

Request Message Description: GetCfgObjectGroupItems, GetCfgObjectDefaultGroupItems

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

Node	Description
WebChannelObjGroupItems	Required. This structure identified the objects that will be queries as well the data that will be returned about the objects.
Object	Required. One or more must be specified.
Name	Required. Name of Object (product or class). Either Name or Id is required.
Id	Required. Id of Object (product or class). Either Name or Id is required.
ObjectType	Required. Either Product or Class.
ParentClassId	Class Id of the parent.
DisplayName	Display name.
Description	Description.
UIOption	Zero or more.
Name	Name of UI option. If Name and or Id is specified, then only that particular UI option will be returned. If both are empty, then all UI options will be returned.
Id	Id of UI option. If Name and or Id is specified, then only that particular UI option will be returned. If both are empty, then all UI options will be returned.
Type	Type.
DisplayName	Display name.
Sequence	Sequence.
BaseTheme	Base theme.
ProductTheme	Product theme.
Responsibility	Zero or more.
Name	Name of responsibility. If Name and or Id is specified, then only that particular responsibility will be returned. If both are empty, then all responsibilities will be returned.
Id	Id of responsibility. If Name and or Id is specified, then only that particular responsibility will be returned. If both are empty, then all responsibilities will be returned.
Group	Zero or more.
Name	Name of group. If Name and or Id is specified, then only that particular group will be returned. If both are empty, then all groups will be returned.
Id	Id of Group. If Name value and or Id value is specified, then only that particular group will be returned. If both are empty, then all groups will be returned.
DisplayName	Display name.
Sequence	Sequence.
GroupTheme	Group theme.
Description	Description.
GroupItem	Zero or more.
Id	Id of Group Item. If Id and or Type is specified, then only that particular group item will be returned. If both are empty, then all group items will be returned.
Type	Type of Group Item (Relationship, Attribute, LinkedItem, or Resource). If Id and or Type is specified, then only that particular group item will be returned. If both are empty, then all group items will be returned.
Sequence	Sequence.
GroupItemTheme	Group item theme.
Attribute	An attribute child object of GetCfgObjectStructure request message.
Relationship	A relationship child object of GetCfgObjectStructure request message.
LinkedItem	A LinkedItem child object of GetCfgObjectStructure request message.
Resource	Refer to Resource child object of GetCfgObjectStructure request message.
GroupDecoration	Group properties.
Name	Name value.
Value	Pairs.
Object Decoration	Object properties name value pairs.

Request Message Description: BeginConfiguration

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

Node	Description
BeginConfiguration_Input	Required.
InitInstanceOperation	Required. The operation type for BeginConfiguration session.
	LOAD. This will load the hierarchy object from the db. HeaderId and RootId are required. IntegrationObjectName is needed to determine which table to query and what the structure of the hierarchy is.
	DEFAULT. This will load the hierarchy object from the db and create new line item for a product with its default instance. HeaderId and ProductId are required. IntegrationObjectName is needed to determine which table to query and what the structure of the hierarchy is.
	SET. This will load the hierarchy object from the ListOfQuote parameter (PDS Quote integration object). RootId is required to determine the root line item to use in this session.
	ADD. This will add a new line item to the hierarchy object from the ListOfQuote parameter (PDS Quote integration object). ProductId is required.
HeaderId	Required for InitInstanceOperation of LOAD / DEFAULT. Row Id of the Header.
RootId	Required for InitInstanceOperation of LOAD / SET. Row Id for the root line item.
ProductId	Required for InitInstanceOperation of DEFAULT / ADD. Product Id for the root line item.
ListOfQuote	Required for InitInstanceOperation of SET / ADD. Hierarchy object in PDS Quote integration object format.
ListOfData	List of products, attributes, or relationships on which user requires domain information (with exclusions) in CfgInteractData integration object format.
ProductData	Product type.
Item	Item name.
IntegrationId	Integration Id of the line item. If IntegrationId specified, then only this line item and its sub line items are looked at. ProductId is optional. If ProductId is also specified, then it should match IntegrationId. If IntegrationId and ProductId are not specified, then the root line item is looked at.
ProductId	Product Id of the line item. If IntegrationId specified, then only this line item and its sub line items are looked at. ProductId is optional. If ProductId is also specified, then that value should match the IntegrationId. If IntegrationId and ProductId are not specified, then the root line item is considered.
Name	Name of the product.
Quantity	Quantity.
RelationshipName	Relationship name. For sub line items, RelationshipName can be specified to limit the search to a particular relationship.
RootIntegrationId	Integration Id of the root line item.
PortId	Relationship ID.
ParentProductId	Parent Product ID.
ParentIntegrationId	Parent Integration ID.
CanDrilldown	Can drilldown flag. Used to indicate whether the line item is a customizable product.
ListPrice	List price.
NRCCxTotal	Non-recurring total price - only set on the root line item.
MRCCxTotal	Recurring total price - only set on the root line item.
CurrentPrice	Current price of the item after all the discounts have been factored in.
ExchangeDate	Exchange date of the pricing field values.
CurrencyCode	Currency code of the pricing field values.
HasGenericsFlag	Has Generics flag. Used to indicate whether the line item is incomplete.
EligibilityStatus	Eligibility status.
EligibilityReason	Eligibility reason.
Explanation	Explanation, if required.
ExplanationText	Text of explanation.
Relationship	Zero or more. List of relationships on which information is required.
Name	Name of relationship to query for. If empty, then all relationships are returned.
Id	Id. Always returned whether specified in the request or not.
Request Type	Indicates the type of the information that will be calculated for this relationship. Possible values include: SelectionInfo - Only current line items for this relationship will be outputted. DomainInfo - Only the possible domain items for this relationship will be outputted. Any other values result in both SelectionInfo and DomainInfo being calculated and outputted.
DomainItem	Zero or more. Domain items of the relationship. Always returned whether specified in Request or not.
Name	Name of domain item.
Id	Id of domain item.
ListPrice	List price.
ExchangeDate	Exchange date of the pricing field values.
CurrencyCode	Currency code of the pricing field values.
PriceType	Indicated the type of list price: One-time or Recurring.
CanDrilldown	Can Drilldown flag. Used to indicate whether the line item is a customizable product.
Excluded	Excluded flag indicates the whether this domain item is excluded by a Constraint, Eligibility & Compatibility rule, or Promotion.
Attribute	Zero or more. List of attributes on which information is required.
Name	Name of attribute to query for. If empty, then all attributes are returned.
ValueType	Type of attribute. Always returned whether specified in the request or not.
AttributeValue	Zero or more. List of attribute values. Always returned whether specified in the request or not.
DisplayValue	Display value.
StringValue	Value displayed in a string.
IntegerValue	Value displayed as integer.
NumberValue	Value displayed as number.
BooleanValue	Value displayed in Boolean format.
DateTimeValue	Date and time value.
Selected	Selected flag indicates whether this value is selected.
Excluded	Excluded flag indicates whether this value is excluded by a Constraint, Eligibility & Compatibility rule or Promotion.
Item	Zero or more. Same recursive structure as that already defined.
ListOfLinkedItems	Linked Items.
LinkedItems	Linked Items.
LinkedItemValue	One or more.
Name	Name of linked item.
ValueType	Type of value.
StatusText	Details on the error if any.
ConflictResolution	Values are Proceed or Undo. This indicates whether a Procced or Undo was done on the conflicts and also whether there were any other violations that resulted in an Undo (like Promotion or Cardinality).
Messages	Zero or one. List of messages.
MessageType	Zero or more.
MessageSource	Source of the messages (Eligibility, Promotion, Cardinality, Proceed Actions and so on).
Message	Message text.

Response Message Description: Begin Configuration

GetCfgObjectStructure has the same request and response message. For more information, see the previous table.

GetCfgObjectGroupItems and GetCfgObjectDefaultGroupItems have the same request and response messages. See the response message description for Begin Configuration for details.

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

Node	Description
BeginConfiguration_Output	Required.
Error_spcCode	Error code if error occurred.
Error_spcMessage	Error message if error occurred.
RootId	New item root Id.
RootIntegrationId	New item root Integration Id.
ListOfQuote	Quote instance if ReturnFullInstance input parameter was set to Y. See BeginConfiguration Request Message for details.
ListOfData	The domain information about products, attributes, and relationships as well current selections for the attributes, or relationships that was requested in the request message.
ListOfStatus	This indicates whether the request was successful or not and contains messages to be displayed.
Status	Required
StatusCode	Success, Warning, or Error. If the StatusCode is Success, then the operation was successful. If the StatusCode is Warning, then there were conflicts, messages are present in ListOfMessage, that were automatically resolved. If the StatusCode is Error, then there were conflicts, messages are present in ListOfMessage, that could not be resolved, and further requests to this session will not be honored.

Request Message Description: UpdateConfiguration

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

Node	Description
UpdateConfiguration_Input	Required.
ConflictAutoResolve	Proceed or Undo. If set to Proceed, then all conflicts are auto resolved. If set to Undo, then any conflict will result in an Undo of the entire batch.
FinishInstanceInFlag	If set Y, then FinishIt is called.
SaveInstanceInFlag	If set Y, then the instance is saved to the database.
RepriceInstanceInFlag	If set Y, then a reprice is called.
VerifyInstanceInFlag	If set Y, then verify the instance is called.
ListOfData	Same as ListOfData in BeginConfiguration Request Message.
ListOfRequest	List of Requests that will be executed on the product instance.
Requests	Requests.
Request	Zero or more.
Type	Type of request (AddItem, RemoveItem, SetItemQuantitty, SetAttribute, ReplaceItem).
Item	Zero or more requests.
AddProductId	Add product Id for AddItem, ReplaceItem.
Quantity	Quantity.
RelationshipId	Relationship Id which contains the new product for AddItem, ReplaceItem.
IntegrationId	Integration Id on which the operation will be performed.
Attribute	Zero or more SetAttribute request details.
Name	Name or attribute.
ValueType	Type of value.
AttributeValue	Zero or more.
DisplayValue	New display value of attribute
String	Value displayed in a string.
Number	Value displayed as number.
Integer	Value displayed as integer.
Date	Date.
Boolean	Value displayed in Boolean format.

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

Node	Description
UpdateConfiguration_Output	Required.
Error_spcCode	Error Code if error occurred.
Error_spcMessage	Error Message if error occurred.
FinishConfigurationOutFlag	Y or N. Indicates whether Finish Configuration was performed. It might not be performed if there were some errors.
RepriceOutFlag	Y or N. Indicates whether Reprice was done. It might not be performed if there were errors.
SaveInstanceOutFlag	Y or N. Indicates whether Save Instance was done. It might not be performed if there were conflicts.
VerifyOutFlag	Y or N. Indicates whether Verify was done. It might not be performed if there were errors.
ListOfData	The domain information about products, attributes, and relationships as well current selections for the attributes, or relationships that was requested in the request message.
ListOfStatus	This indicates whether the request was successful or not and contains messages to be displayed.

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

Node	Description
EndConfiguration_Input	Required.
SaveInstanceFlag	Save instance flag.

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

Node	Description
EndConfiguration_Output	Required.
Error_spcCode	Error Code if error occurred.
Error_spcMessage	Error Message if error occurred.
ListOfQuote	Quote instance.

Product Configurator 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 BusService)
Cfg Object Broker	Business Service	CSSCfgObjBrokerService
ConfiguratorWebChannelBeginConfig	Workflow	Not applicable
ConfiguratorWebChannelUpdateConfig	Workflow	Not applicable
ConfiguratorWebChannelEndConfig	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
CfgInteractData	ListOfData
CfgInteractRequest	ListOfRequest
CfgInteractStatus	ListOfStatus
CfgLinkedItems	ListOfLinkedItems
PDS Quote	ListOfQuote

Methods

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

Operation	Method
GetCfgObjectStructure	GetObjStructure
GetCfgObjectGroupItems	GetObjGroupItems
GetCfgObjectDefaultGroupItems	GetObjDefaultGroupItems

Example Package for Product Configurator

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 (GetObjDefaultGroupItems)

See the following file to view the sample code:

...\ProductConfigurator\GetObjDefaultGroupItems_request.xml

Response (GetObjDefaultGroupItems)

See the following file to view the sample code:

...\ProductConfigurator\GetObjDefaultGroupItems_response.xml

Request (GetObjGroupItems)

See the following file to view the sample code:

...\ProductConfigurator\GetObjGroupItems_request.xml

Response (GetObjGroupItems)

See the following file to view the sample code:

...\ProductConfigurator\GetObjGroupItems_response.xml

Request (GetObjStructure)

See the following file to view the sample code:

...\ProductConfigurator\GetObjStructure_request.xml

Response (GetObjStructure)

See the following file to view the sample code:

...\ProductConfigurator\GetObjStructure_response.xml

Interface Description (WSDL) for Product Configurator

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.

...\ProductConfigurator\ProductConfigurator.wsdl

Product Configurator Web Service for Orders

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

Note: This version of Product Configurator Web Service for Orders is available only for Siebel CRM version 8.1.1.10 and later. To use Product Configurator Web Service for Quotes with Siebel CRM version 8.0, see version 8.0 of Siebel CRM Web Services Reference.

Product Configurator Web Service for Orders Operations

The following table provides a list of the operations associated with this Web service.

Name	Description
GetObjStructureOrder	Retrieves the product relationships, attributes, linked items and resources.
GetObjGroupItemsOrder	Retrieves the product UI definition, UI group, and group items.
GetObjDefaultGroupItemsOrder	Retrieves the default product group items. Group items are based on all relationships, attributes, linked items and resources.
BeginConfigurationOrder	Enables customization of products stored in the Siebel database. Initializes the configurator session with an order instance and product model.
UpdateConfigurationOrder	Executes operations on the order instance initialized in BeginConfigurationOrder.
EndConfigurationOrder	Releases server resources used during the configuration of the product.

Request Message Description: GetObjStructureOrder

GetObjStructureOrder and GetObjGroupItemsOrder have the same request and response message.

GetObjDefaultGroupItemsOrder request and response message is the same as GetObjGroupItemsOrder. The Object’s direct child properties are ignored as well those of UIOption, Responsibilities, and Group. Only the GroupItem child is looked at and returned (others are copied to the Response message).

GroupItem behavior is similar to that of GetObjGroupItemsOrder.

The following table provides a description of the request message GetObjStructureOrder.

Node	Description
WebChannelObjStructure	Required.This structure specifies the objects that are queried and the data that is returned about the objects.
Object	Required. Specify one or more objects.
Name	The name of the object (product or class). Either Name or Id is required.
Id	The Id of an object (product or class). Either Name or Id is required.
ObjectType	Required. The object type, either Product or Class.
ParentClassId	The class Id of the parent object.
DisplayName	The display name.
Description	The description.
Attribute	Zero or more child objects to be queried for.
Name	The name of the attribute. If this value is empty, then all attributes are returned.
LocalType	The local type.
InternalType	The internal type.
OrigId	The internal Id.
DisplayName	The display name.
Hidden	The hidden flag.
Required	Required flag.
ReadOnly	Read-only flag.
ValidationSpec	The validation specification.
UnitOfMeasure	The unit of measure.
Description	The description.
AttributeDomain	Zero or more.
LocalValue	The local value.
InternalValue	The internal value.
AttributeDomainDecoration	Zero or more name value pairs of attribute-domain-specific properties.
Name	The name of the attribute.
Value	The value of the attribute.
AttributeDefaultValue	The default value of the attribute. Only one of the value types is populated depending on the type of the value.
DisplayValue	The display value.
String	A string value.
Number	A number value.
Integer	An integer value.
Date	A date value.
Boolean	A Boolean value.
AttributeRejectedValue	A rejected value of the attribute. Only one of the value types is populated depending on the type of the value.
DisplayValue	The display value.
String	A string value.
Number	A number value.
Integer	An integer value.
Date	A date value.
Boolean	A Boolean value.
AttributeDecoration	Zero or more.
Name	The attribute properties name.
Value	Value pairs.
Relationship	Zero or more relationships. Only those child objects that are specified are queried for.
Name	The name of the relationship. If Name or Id is specified, then only that particular relationship is returned. If both are empty, then all relationships are returned.
Id	The Id of the relationship. If Name or Id is specified, then only that particular relationship is returned. If both are empty, then all relationships are returned.
DisplayName	The display name.
ClassName	The class name.
ClassId	The class Id.
DefaultProductId	The default product Id.
DefaultCardinality	The default cardinality.
MinimumCardinality	The minimum cardinality.
MaximumCardinality	The maximum cardinality.
RelationshipDomain	Zero or more.
Name	The name of the product. If Name or Id is specified, then only that particular relationship domain will be returned. If both are empty, then all relationship domain products will be returned.
Id	The Id of the product. If Name or Id is specified, then only that particular relationship domain are returned. If both are empty, then all relationship domain products are returned.
DisplayName	The display name.
OrigId	The originating Id.
Description	The description of the product.
RelationshipDomainDecoration	Zero or more.
Name	The name of the specific properties of the relationship domain.
Value	Value pairs.
RelationshipDecoration	Zero or more.
Name	The relationship properties name.
Value	Value pairs.
LinkedItem	Zero or more linked items. Only those child objects that are specified are queried for.
Name	The name of the linked item.
Id	The Id of the linked item. If Name or Id is specified, then only that particular linked item is returned. If both are empty, then all linked items are returned.
DisplayName	The display name.
VariableName	The variable name.
SortSpec	The sort specification.
SearchSpec	The search specification.
NeedsExecution	The needs-execution flag, used for business-component-based queries.
Expression	The expression.
DefaultValue	The default value.
BusinessObject	The business object, used for business-component-based queries.
BusinessComponent	The business component, used for business-component-based queries.
FieldName	The field name in the business component.
Active	The active flag.
LinkedItemDecoration	The linked item properties.
Name	The name value.
Value	Value pairs.
Resource	Zero or more resources. Only those child objects that are specified will be queried for.
Name	The name of the resource. If Name or Id is specified, then only that particular resource is returned. If both are empty, then all resources are returned.
Id	The Id of the resource. If Name or Id is specified, then only that particular resource is returned. If both are empty, then all resources are returned.
DisplayName	The display name.
ResourceDecoration	The resource properties.
Name	The name value.
Value	Value pairs.
ObjectDecoration	The object properties.
Name	The name value.
Value	Value pairs.

Request Message Description: GetObjGroupItemsOrder, GetObjDefaultGroupItemsOrder

The following table provides a description of the request messages GetObjGroupItemsOrder and GetObjDefaultGroupItemsOrder.

Node	Description
WebChannelObjGroupItems	Required. This structure identifies the objects that will be queries and the data that will be returned for the objects.
Object	Required. One or more must be specified.
Name	The name of the object (product or class). Either Name or Id is required.
Id	The Id of the object (product or class). Either Name or Id is required.
ObjectType	Required. The type of the object, either Product or Class.
ParentClassId	The class Id of the parent.
DisplayName	The display name.
Description	The description.
UIOption	Zero or more.
Name	The name of the UI option. If Name or Id is specified, then only that particular UI option will be returned. If both are empty, then all UI options will be returned.
Id	The Id of the UI option. If Name or Id is specified, then only that particular UI option will be returned. If both are empty, then all UI options will be returned.
Type	The type.
DisplayName	The display name.
Sequence	The sequence.
BaseTheme	The base theme.
ProductTheme	The product theme.
Responsibility	Zero or more.
Name	The name of the responsibility. If Name or Id is specified, only that particular responsibility will be returned. If both are empty, then all responsibilities will be returned.
Id	The Id of the responsibility. If Name or Id is specified, only that particular responsibility will be returned. If both are empty, then all responsibilities will be returned.
Group	Zero or more.
Name	The name of the group. If Name or Id is specified, then only that particular group will be returned. If both are empty, then all groups will be returned.
Id	The Id of the group. If Name value or Id value is specified, then only that particular group will be returned. If both are empty, then all groups will be returned.
DisplayName	The display name.
Sequence	The sequence.
GroupTheme	The group theme.
Description	The description.
GroupItem	Zero or more.
Id	The Id of the group item. If Id or Type is specified, then only that particular group item will be returned. If both are empty, then all group items will be returned.
Type	The type of the group item (Relationship, Attribute, LinkedItem, or Resource). If Id or Type is specified, then only that particular group item will be returned. If both are empty, then all group items will be returned.
Sequence	The sequence.
GroupItemTheme	The theme of the group item.
Attribute	An attribute child object of GetObjStructureOrder request message.
Relationship	A relationship child object of GetObjStructureOrder request message.
LinkedItem	A LinkedItem child object of GetObjStructureOrder request message.
Resource	Refer to the Resource child object of GetObjStructureOrder request message.
GroupDecoration	The group properties.
Name	The name value.
Value	Pairs.
Object Decoration	The object properties of the name value pairs.

Request Message Description: BeginConfigurationOrder

The following table provides a description of the request message, BeginConfigurationOrder.

Node	Description
BeginConfigurationOrder_Input	Required.
InitInstanceOperation	Required. The operation type for the BeginConfigurationOrder session. There are the following options: Load. Loads the hierarchy object from the database. HeaderId and RootId are required. IntegrationObjectName is required to determine which table to query and what the structure of the hierarchy is. Default. Load the hierarchy object from the database and creates a new line item for a product with its default instance. HeaderId and ProductId are required. IntegrationObjectName is required to determine which table to query and what the structure of the hierarchy is. Set. Loads the hierarchy object from the ListOfOrder parameter (PDS Order integration object). RootId is required to determine the root line item to use in this session. Add. Adds a new line item to the hierarchy object from the ListOfOrder parameter (PDS Order integration object). ProductId is required.
HeaderId	Required for InitInstanceOperation of LOAD or DEFAULT. The row Id of the header.
RootId	Required for InitInstanceOperation of LOAD or SET. The row Id for the root line item.
ProductId	Required for InitInstanceOperation of DEFAULT or ADD. The product Id for the root line item.
ListOfOrder	Required for InitInstanceOperation of SET or ADD. The hierarchy object in PDS Order integration object format.
ListOfData	The list of products, attributes, or relationships for which a user requires the domain information (with exclusions) in CfgInteractData integration object format.
ProductData	The product type.
Item	The item name.
IntegrationId	The integration Id of the line item. If IntegrationId is specified, then only this line item and its subline items are considered. ProductId is optional. If ProductId is also specified, then it must match IntegrationId. If the IntegrationId and ProductId are not specified, then the root line item is considered.
ProductId	The product Id of the line item. If IntegrationId specified, then only this line item and its subline items are considered. ProductId is optional. If ProductId is also specified, then it must match IntegrationId. If IntegrationId and ProductId are not specified, then the root line item is considered.
Name	The name of the product.
Quantity	The quantity.
RelationshipName	The relationship name. For subline items, RelationshipName can be specified to limit the search to a particular relationship.
RootIntegrationId	The integration Id of the root line item.
PortId	The relationship Id.
ParentProductId	The parent product Id.
ParentIntegrationId	The parent Integration Id.
CanDrilldown	The can-drilldown flag. It indicates whether the line item is a customizable product.
ListPrice	The list price.
NRCCxTotal	The nonrecurring total price. Set this price only on the root line item.
MRCCxTotal	The recurring total price. Set this price only on the root line item.
CurrentPrice	The current price of the item after all the discounts have been applied.
ExchangeDate	The exchange date of the pricing field values.
CurrencyCode	The currency code of the pricing field values.
HasGenericsFlag	The has-generics flag. It indicates whether the line item is incomplete.
EligibilityStatus	The eligibility status.
EligibilityReason	The eligibility reason.
Explanation	The explanation, if required.
ExplanationText	The text of the explanation.
Relationship	Zero or more. The list of relationships for which information is required.
Name	The name of the relationship to query for. If the query is empty, then all relationships are returned.
Id	The Id. It is always returned whether specified in the request or not.
Request Type	Indicates the type of the information that is calculated for this relationship. The values include: SelectionInfo. Only current line items for this relationship are generated. DomainInfo. Only the possible domain items for this relationship are generated. Any other value. Both of the previous values are generated.
DomainItem	Zero or more domain items of the relationship. Always returned whether specified in the request or not.
Name	The name of the domain item.
Id	The Id of the domain item.
ListPrice	The list price.
ExchangeDate	The exchange date of the pricing field values.
CurrencyCode	The currency code of the pricing field values.
PriceType	Indicates the type of list price: one-time or recurring.
CanDrilldown	The can-drill-down flag. It indicates whether the line item is a customizable product.
Excluded	The excluded flag. It indicates whether this domain item is excluded by a constraint, eligibility and compatibility rule, or a promotion.
Attribute	Zero or more attributes for which information is required.
Name	The name of attribute to query for. If the query is empty, then all attributes are returned.
ValueType	The type of the attribute. It is always returned whether specified in the request or not.
AttributeValue	Zero or more attribute values. It is always returned whether specified in the request or not.
DisplayValue	The display value.
StringValue	The value displayed as a string.
IntegerValue	The value displayed as an integer.
NumberValue	The value displayed as a number.
BooleanValue	The value displayed as a Boolean value.
DateTimeValue	The date and time value.
Selected	The selected flag. It indicates whether this value is selected.
Excluded	The Excluded flag. It indicates whether this value is excluded by a constraint, eligibility and compatibility rule, or promotion.
Item	Zero or more items. Same recursive structure as already defined.
ListOfLinkedItems	The linked items.
LinkedItems	The linked items.
LinkedItemValue	One or more values of linked items.
Name	The name of the linked item.
ValueType	The type of value.
StatusText	The details of the error, if an error occurs.
ConflictResolution	Indicates whether a Proceed or Undo operation was performed on the conflicts and also whether any other violations occurred that resulted in an Undo operation. The values are: Proceed or Undo.
Messages	Zero or one message.
MessageType	Zero or more message types.
MessageSource	The source of the messages, which might be eligibility, promotion, cardinality, proceed actions, and so on.
Message	The message text.
ReturnFullInstance	Indicates whether the Order instance is returned in the ListOfOrder parameter of the response message. The values are: Y (default) and N.

Response Message Description: BeginConfigurationOrder

GetObjGroupItemsOrder and GetObjDefaultGroupItemsOrder have the same request and response messages. See the response message description for BeginConfigurationOrder for details. The following table includes a description of this response message BeginConfigurationOrder.

Node	Description
BeginConfigurationOrder_Output	Required.
Error_spcCode	Displays an error code if an error occurs.
Error_spcMessage	Displays an error message if an error occurs.
RootId	The new item’s root Id.
RootIntegrationId	The new item’s root integration Id.
ListOfOrder	Indicates the order instance, if the ReturnFullInstance input parameter was set to Y. See BeginConfigurationOrder Request Message for details.
ListOfData	The domain information about products, attributes, or relationships and the current selections for the attributes, or relationships that was requested in the request message. See the Request Message for more details.
ListOfStatus	Indicates whether the request was successful or not and contains messages to be displayed.
Status	Required.
StatusCode	The values are: Success. The operation was successful. Warning. Some conflicts occurred that were automatically resolved. The messages are present in ListOfMessages. Error. Some conflicts could not be resolved. Any further requests to this session will not be responded to. Messages are present in ListOfMessages.

Request Message Description: UpdateConfigurationOrder

The following table includes a description of this request message UpdateConfigurationOrder.

Node	Description
UpdateConfigurationOrder_Input	Required.
ConflictAutoResolve	The values are: Proceed. All conflicts are resolved automatically. Undo. Any conflict will undo the entire batch job.
FinishInstanceInFlag	If this flag is set to Y, then FinishIt is called.
SaveInstanceInFlag	If this flag is set to Y, then the instance is saved to the database.
RepriceInstanceInFlag	If this flag is set to Y, then reprice is called.
VerifyInstanceInFlag	If this flag is set to Y, then the verify instance is called.
ListOfData	Same as ListOfData in BeginConfigurationOrder Request Message.
ListOfRequest	The list of requests that are executed on the product instance.
Requests	The requests.
Request	Zero or more.
Type	The type of request. The values are: AddItem, RemoveItem, SetItemQuantitty, SetAttribute, and ReplaceItem.
Item	Zero or more requests.
AddProductId	The add product Id for AddItem or ReplaceItem.
Quantity	The quantity.
RelationshipId	The relationship Id that contains the new product for AddItem or ReplaceItem.
IntegrationId	The integration Id on which the operation is performed.
Attribute	Zero or more SetAttribute request details.
Name	The name of the attribute.
ValueType	The type of value.
AttributeValue	Zero or more.
DisplayValue	The new display value of the attribute
String	The value displayed as a string.
Number	The value displayed as a number.
Integer	The value displayed as an integer.
Date	The value displayed as a date.
Boolean	The value displayed as a Boolean value.

The following table includes a description of this request message UpdateConfigurationOrder.

Node	Description
UpdateConfigurationOrder_Output	Required.
Error_spcCode	Displays an error code if an error occurs.
Error_spcMessage	Displays an error message if an error occurs.
FinishConfigurationOutFlag	Y or N. Indicates whether Finish Configuration was done. It might not be performed if errors occur.
RepriceOutFlag	Y or N. Indicates whether a Reprice operation was done. It might not be performed if errors occur.
SaveInstanceOutFlag	Y or N. Indicates whether the Save Instance was done. It might not be performed if conflicts occur.
VerifyOutFlag	Y or N. Indicates whether Verify was done. It might not be performed if there were errors.
ListOfData	The domain information about products, attributes, or relationships as well as current selections for the attributes, or relationships requested in the request message.
ListOfStatus	Indicates whether the request was successful or not, and contains messages to be displayed.

The following table includes a description of this request message EndConfigurationOrder.

Node	Description
EndConfigurationOrder_Input	Required.
SaveInstanceFlag	The save-instance flag.

The following table includes a description of this request message EndConfigurationOrder.

Node	Description
EndConfigurationOrder_Output	Required.
Error_spcCode	Displays an error code if an error occurs.
Error_spcMessage	Displays an error message if an error occurs.
ListOfOrder	The order instance.

Product Configurator Web Service for Orders 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)

The following table includes a description of the service objects for the Product Configurator Web Service for Orders.

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

Data Objects (Integration Object)

The following table includes a description of the date objects for the Product Configurator Web Service for Orders.

Siebel Repository Name	External Name
CfgInteractData	ListOfData
CfgInteractRequest	ListOfRequest
CfgInteractStatus	ListOfStatus
CfgLinkedItems	ListOfLinkedItems
PDS Order	ListOfOrder

Methods

The following table includes a description of the methods for the Product Configurator Web Service for Orders.

Operation	Method
GetObjStructureOrder	GetObjStructure
GetObjGroupItemsOrder	GetObjGroupItems
GetObjDefaultGroupItemsOrder	GetObjDefaultGroupItems

Example Package for Product Configurator Web Service for Orders

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:

...\ProductConfiguratorforOrders

Response

See the following file to view the sample code:

...\ProductConfiguratorforOrders

Interface Description (WSDL) for Product Configurator Web Service for Orders

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.

...\ProductConfiguratorforOrders

Product Import

Use this Web service to add and update product definitions and product structures in the Siebel CRM application. In this Web service, upsert denotes a combination of the insert and update operations.

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

Product Import Operations

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

Operation Name

Description

Product Import Insert

This operation:

Inserts the root product definition. Generates an error if the product definition exists.
Upserts the related products in the product structure. Performs the insert operation if the child product structure does not exist. Performs the update operation if the child product structure exists.
Upserts the workspace project.

Product Import Update

This operation:

Updates the root product definition and the related products in the product structure. Generates an error if the product definition or the child product structure does not exist.
Upserts the workspace project.

Product Import Upsert

This operation:

Upserts the root product definition and the related products in the product structure. Performs the insert operation if the product definition or the child product structure does not exist. Performs the update operation if the product definition or the child product structure exists.
Upserts the workspace project.

Request Message Description: Product Import Insert

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

Node	Description
SiebelMessage	The Siebel message for the integration object of CMU Product Integration.

Request Message Description: Product Import Update

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

Node	Description
SiebelMessage	The Siebel message for the integration object of CMU Product Integration.

Request Message Description: Product Import Upsert

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

Node	Description
SiebelMessage	The Siebel message for the integration object of CMU Product Integration.

Application Interface for Product Import

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)
Product Import	Business Service	CSSCMUProdWebSvc

Business Service User Property

For a description of the user properties for this Business Service, see the following table.

Name	Value	Comment
Data Sync Service	EAI Siebel Adapter	EAI Adapter service that is invoked.
Data Sync Service: Attribute	CMU Attribute	Integration object name for data sync service. Currently not supported.
Data Sync Service: Class	CMU Product Class	Integration object name for data sync service. Currently not supported.
Data Sync Service: Product	CMU Product	Integration object name for data sync service.
Data Sync Service: Workspace	CMU Joint Workspace	Integration object name for data sync service.
Definition Business Component	CMU Product Definition VBC	See the first note after this table.
Definition Business Object	CMU Admin ISS Product Definition	See the first note after this table.
Detail Business Component	CMU ISS Product Details BusComp	See the first note after this table.
Integration Field Map: Auto Explode Flag	Product\|CMU Internal Product VOD\| Auto Explode Flag	See the second note after this table.
Integration Field Map: Billable Flag	Product\|CMU Internal Product VOD\| Billable Flag	See the second note after this table.
Integration Field Map: Billing Service Type	Product\|CMU Internal Product VOD\| Billing Service Type	See the second note after this table.
Integration Field Map: Billing Type	Product\|CMU Internal Product VOD\| Billing Type	See the second note after this table.
Integration Field Map: Business Unit Id	Product\|CMU Internal Product VOD\| Primary Organization ID	See the second note after this table.
Integration Field Map: Check Eligibility Flag	Product\|CMU Internal Product VOD\| Pre Pick CD	See the second note after this table.
Integration Field Map: Description	Product\|CMU Internal Product VOD\| Description	See the second note after this table.
Integration Field Map: Effective End Time	Product\|CMU Internal Product VOD\| End Date	See the second note after this table.
Integration Field Map: Effective Start Time	Product\|CMU Internal Product VOD\| Start Date	See the second note after this table.
Integration Field Map: Inclusive Eligibility Flag	Product\|CMU Internal Product VOD\| Inclusive Eligibility Flag	See the second note after this table.
Integration Field Map: Orderable Flag	Product\|CMU Internal Product VOD\| Orderable	See the second note after this table.
Integration Field Map: Price Type	Product\|CMU Internal Product VOD\| Price Type	See the second note after this table.
Integration Field Map: Product Id	Product\|CMU Internal Product VOD\| ID	See the second note after this table.
Integration Field Map: Product Name	Product\|CMU Internal Product VOD\| Name	See the second note after this table.
Integration Field Map: Product Type	Product\|CMU Internal Product VOD\| Product Type Code	See the second note after this table.
Integration Field Map: Sales Product Flag	Product\|CMU Internal Product VOD\| Sales Product Flag	See the second note after this table.
Integration Field Map: Service Instance Flag	Product\|CMU Internal Product VOD\| Service Instance	See the second note after this table.
Integration Field Map: Service Product Flag	Product\|CMU Internal Product VOD\| Sales Service Flag	See the second note after this table.
Integration Field Map: Structure Type	Product\|CMU Internal Product VOD\| Product Def Type Code	See the second note after this table.
Integration Field Map: Track As Asset Flag	Product\|CMU Internal Product VOD\| Track As Asset Flag	See the second note after this table.
Integration Field Map: Type	Product\|CMU Internal Product VOD\| Type	See the second note after this table.
Integration Field Map: Unit of Measure	Product\|CMU Internal Product VOD\| Unit of Measure	See the second note after this table.
Integration Field Map: Vendor Id	Product\|CMU Internal Product VOD\| Vendor ID	See the second note after this table.
Integration Object: External	CMU Product Integration	See the first note after this table.
Integration Object: Product	CMU Admin ISS Product Definition	See the first note after this table.
Integration Object: Product Structure	CMU Admin ISS Product Structure	See the first note after this table.
Integration Object: Workspace	CMU Admin ISS Joint Workspace Definition	See the first note after this table.
Preset Value: CMU Attribute VOD BusComp	VOD Type:ISS_ATTR_DEF	See the first note after this table.
Preset Value: CMU Attribute Versions BusComp	Version:1	See the first note after this table.
Preset Value: CMU ISS Product Attribute BusComp	Last Version:0	See the first note after this table.
Preset Value: CMU ISS Product Details BusComp	Last Version:0	See the first note after this table.
Preset Value: CMU ISS Product Structure Admin BusComp	Last Version:0	See the first note after this table.
Preset Value: CMU ISS Product VOD BusComp	VOD Type:ISS_PROD_DEF	See the first note after this table.
Preset Value: CMU ISS Product Versions BusComp	Released Flag:N	See the first note after this table.
Preset Value: CMU Internal Product Organization	Organization ID:	See the first note after this table.
Product Business Component	CMU Internal Product VOD	See the first note after this table.
Required Integration Component 1	CMU Attribute Versions BusComp	See the first note after this table.
Required Integration Component 2	CMU ISS Product VOD BusComp	See the first note after this table.
Required Integration Component 3	CMU ISS Product Versions BusComp	See the first note after this table.
Required Integration Component 4	CMU ISS Product Details BusComp	See the first note after this table.
Required Integration Component 5	CMU Internal Product Organization	See the first note after this table.
Structure Business Component	CMU Product Structure VBC	See the first note after this table.
Structure Internal Business Component	CMU ISS Product Structure Admin BusComp	See the first note after this table.
Version Business Component	CMU ISS Product Versions BusComp	See the first note after this table.
Workspace Business Component	CMU ISS Joint Workspace BusComp	See the first note after this table.
Workspace Business Object	CMU Admin ISS Joint Workspace Definition	See the first note after this table.
Workspace Object Business Component	CMU ISS Joint Workspace Object BusComp	See the first note after this table.
Workspace Project Business Component	ISS Joint Workspace BusComp	See the first note after this table.
Workspace Project Business Object	Admin ISS Joint Workspace Definition	See the first note after this table.
Workspace Project Item Business Component	ISS Joint Workspace VOD Pick BusComp	See the first note after this table.
Workspace Project Lock Business Component	ISS Joint Workspace VOD Lock BusComp	See the first note after this table.

Note: You must change the value of the operation if you use an integration object, integration component, business object, or business component with a different name.

Note: The value of this operation is the field map. The first part is the data type (for example, product, class, and attribute). The second part is the integration component name. The third part is the integration component field name.

Data Object (Integration Object)

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

Siebel Repository Name	External Name
CMU Product Integration	CMU Product Integration

Methods

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

Operation	Method
Product Import Insert	[BS: Product Import].Insert
Product Import Update	[BS: Product Import]. Update
Product Import Upsert	[BS: Product Import]. Upsert

Example Package for Product Import

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:

...\ProductImport\ProductImport_request.xml

Response

See the following file to view the sample code:

...\ProductImport\ProductImport_response.xml

Interface Description for Product Import

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.

...\ProductImport\Product Import.wsdl

Product Offer

Use this Web service to retrieve and apply product offer information.

Product Offer Operations

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

Node	Description
GetProductOffer	Retrieves a flat, nonhierarchical list of product offers. This operation does not require any input data. Optional input is the offer ID, the offer name, or a search specification to retrieve a specific list of offers. Output of this operation returns product offer header information such as Offer Id, Offer Name and Offer Description. When an offer ID not provided in the input message, the output will list all the product offers defined in the application.
GetProductOfferStructure	Retrieves the detailed structure of a specific product offer. The input message requires the offer ID. The output message returns product offer definition data such as product offer responses, actions, workflow parameters, named parameters, recommendations, eligibility and compatibility rules, and messages.
GetRecommendedOffers	Retrieves the recommended product offers for a specific account. It also retrieves recommended offers for a specific asset, open quote, or open order. If the account ID is specified in the input message, then the output message will return all the recommended product offers for that account. If the Account ID, Document ID, and Mode are specified in the input message, then the output message will return the recommended offers for that specific asset or open order or open quote This operation only returns recommended product offers. It does not return recommend promotions as part of the response message. Also, this operation enforces response suppression, which means the same offer is not recommended for an account that has previously accepted the offer.
ApplyOfferToCreateOrder	Applies a product offer to an account whose type is set to Residential. The input message requires the account ID and offer ID. If the offer requires modification to the customer's asset, then the asset ID is also required. The output message returns the complete order structure. The user has the option to retrieve just the order ID, or the order number without returning the full order structure. For offers that require user interaction, in other words, offers with named parameters, the input message must be configured with run-time values. Values include attribute value, field value, base product, component product, or upgrade product.
ApplyOfferToCreateQuote	Applies a product offer to an account of a type other than residential. The input message requires the account ID, and offer ID. The output message returns the complete quote structure. The user can retrieve just the quote ID or quote number without returning the full quote structure For offers that require user interaction, in other words, offers with named parameters, the input message must be configured with run-time values. Values include attribute value, field value, base product, component product, or upgrade product.

Request Message Description: GetProductOffer

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

Node

Description

Type

RAFProductOfferListIO

Based on an integration object that is used for both the request and response messages.

The user can pass the offer ID to query relevant offer details.

Integration object

Response Message Description: GetProductOffer

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

Node	Description	Type
RAFProductOfferListIO	Based on an integration object that is used for both the request and response message.	Integration object

Request Message Description: GetProductOfferStructure

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

Node	Description	Type
RAFProductOfferStructureIO	Identifies the objects that will be queried for the product offer ID or name. The input message required is offer ID or offer name	Integration object

Response Message Description: GetProductOfferStructure

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

Node

Description

Type

RAFProductOfferStructureIO

The output message has a hierarchy that contains details from the product offer header and all child details of the specified offer. Child objects include:

Product Offer E and C
Product Offer Recommendations
Product Offer Responses
Product Offer Actions
Product Offer Parameters
Product Offer Messages

Integration object

Request Message Description: GetRecommendedOffers

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

Node	Description	Type
Account Id	Required. The account ID of the offer that has been queried.	String
DocId	Optional. Values can be Asset ID, Open Order ID or Open Quote ID for the recommended offer that has been queried.	String
Mode	Value can be Asset, Order, or Quote. Mode is required when document ID is specified.	String

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

Node	Description	Type
RAFProductOfferRecommendationsIO	The output message contains a list of all the product offers recommended for the Account, or the document details that were part of the request message. The response message contains a hierarchy message which contains details of the product offer.	Integration object

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

Node	Description	Type
Offer Id	Required. The offer ID that has to be applied.	String
Response	Required. Values can include, Accept, Reject and so on. You must provide the language independent code	String
Account Id	Required. The account on which the offer will be applied.	String
Document Id	Asset ID or order ID on which the offer will be applied.	String
Mode	The asset, or order. This supports the apply offer operations on an open order.	String
SaveInstanceFlag	Possible values are Y or N. If set to Y, then the order is saved to the database. If set to N, then the order persists in memory. The default setting is Y.	String
ReturnFullInstanceFlag	Possible values are Y or N. If set to Y, then the detailed order structure is returned in the response message. If set to N, then only the order is returned. The default setting is Y.	String
RAFActionListIO	Action List is required when the product offer includes user input details. Run-time values that have user input information are provided in the request message. This includes the action details and parameters for that action.	Integration object

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

Node	Description	Type
PDSOrder	The order document structure that has been created. This field is populated when the ReturnFullInstanceFlag is set to Y.	Integration object
Order Id	The order ID after the offer has been applied. This field is populated when the SaveInstanceFlag is set to Y.	String
Order Number	The order number after the offer has been applied. This field is populated when the SaveInstanceFlag is set to Y.	String

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

Node	Description	Type
Offer Id	Required. The offer ID that has to be applied.	String
Response	Required. Values can include, Accept, Reject and so on. You must provide the language independent code.	String
Account Id	Required. The account on which the offer will be applied.	String
Document Id	Asset ID or order ID on which the offer will be applied.	String
Mode	The asset, or order. This supports the Apply Offer operations on an open order.	String
SaveInstanceFlag	Possible values are Y or N. If set to Y, then the order is saved to the database. If set to N, then the order persists in memory. The default setting is Y.	String
ReturnFullInstanceFlag	Possible values are Y or N. If set to Y, then the detailed order structure is returned in the response message. If set to N, then only the order is returned. The default setting is Y.	String
RAFActionListIO	Action list is required when the product offer includes user input details. Run-time values that have user input information are provided in the request message. This includes the action details and parameters for that action.	Integration object

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

Node	Description	Type
PDSQuote	The quote document structure that has been created. This field is populated when the ReturnFullInstanceFlag is set to Y.	Integration object
Quote Id	The quote ID after the offer has been applied. This field is populated when the SaveInstanceFlag is set to Y.	String
Quote Number	The quote number after the offer has been applied. This field is populated when the SaveInstanceFlag is set to Y.	String

Product Offer 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
GetProductOfferPort: RAF Product Offer Query Service	Business Service	CSSEAIDataSyncService
GetProductOfferStructurePort: RAF Query Product Offer Structure Workflow	Workflow	Not applicable
GetRecommendedOffersPort	Workflow	Not applicable
ApplyOfferToCreateOrderPort	Workflow	Not applicable
ApplyOfferToCreateQuotePort	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
RAFProductOfferListIO	RAF Product Offer
RAFProductOfferStructureIO	RAF Product Offer Structure
RAFProductOfferRecommendationIO	Product Offer Recommendation
RAFActionListIO	RAF Action List
PDS Quote	PDS Simplified Quote
PDS Order	PDS Simplified Order

Example Package for Product Offer

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 (ApplyOfferToCreateOrder)

See the following file to view the sample code:

...\ProductOffer\ApplyOfferToCreateOrder

Response (ApplyOfferToCreateOrder)

See the following file to view the sample code:

...\ProductOffer\ApplyOfferToCreateOrder

Request (ApplyOfferToCreateOrder_NamedParameter)

See the following file to view the sample code:

...\ProductOffer\ApplyOfferToCreateOrder_NamedParameter

Response (ApplyOfferToCreateOrder_NamedParameter)

See the following file to view the sample code:

...\ProductOffer\ApplyOfferToCreateOrder_NamedParameter

Request (ApplyOfferToCreateQuote)

See the following file to view the sample code:

...\ProductOffer\ApplyOfferToCreateQuote

Response (ApplyOfferToCreateQuote)

See the following file to view the sample code:

...\ProductOffer\ApplyOfferToCreateQuote

Request (ApplyOfferToCreateQuote_NamedParameter)

See the following file to view the sample code:

...\ProductOffer\ApplyOfferToCreateQuote_NamedParameter

Response (ApplyOfferToCreateQuote_NamedParameter)

See the following file to view the sample code:

...\ProductOffer\ApplyOfferToCreateQuote_NamedParameter

Request (GetProductOffer)

See the following file to view the sample code:

...\ProductOffer\GetProductOffer

Response (GetProductOffer)

See the following file to view the sample code:

...\ProductOffer\GetProductOffer

Request (GetProductOfferStructure)

See the following file to view the sample code:

...\ProductOffer\GetProductOfferStructure

Response (GetProductOfferStructure)

See the following file to view the sample code:

...\ProductOffer\GetProductOfferStructure

Request (GetRecommendedProductOffers)

See the following file to view the sample code:

...\ProductOffer\GetRecommendedProductOffers

Response (GetRecommendedProductOffers)

See the following file to view the sample code:

...\ProductOffer\GetRecommendedProductOffers

Interface Description (WSDL) for Product Offer

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.

...\ProductOffer\WSDL

Product Offer - Apply Multiple Product Offers

Use this web service to apply multiple product offers to generate a quote or an order. For more information about the business scenarios and product offers related to the Apply Multiple Product Offers web service, see Siebel Pricing Administration Guide.

Apply Multiple Product Offers Operations

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

Name

Description

ApplyMultipleOffersforOrder

Applies a product offer to an account whose type is set to Residential.

The input message requires the account ID and a list of the offer ID's, including the correct sequence number. If the offer requires modification to the customer's asset, then the asset ID is also required.

The output message returns the complete order structure. The user has the option to save the order structure in the Siebel database or generate the order in memory.

Optionally, the input message can include either the order ID or the complete order structure.

If the input message contains the order ID, then the web service updates the order structure in the Siebel database instead of creating a new order structure. If the input message contains the order structure, then the web service updates the order structure in memory instead of creating a new order structure.

ApplyMultipleOffersforQuote

Applies a product offer to an account of a type other than residential.

The input message requires the account ID and a list of offer ID's, including the correct sequence number. If the offer requires modification to the customer's asset, then the asset ID is also required.

The output message returns the complete quote structure. The user has the option to save the quote structure in the Siebel database or generate the quote structure in memory.

Optionally, the input message can include either the quote ID or the complete quote structure.

If the input message contains the quote ID, then the web service updates the quote structure in the Siebel database instead of creating a new quote structure. If the input message contains the quote structure, then the web service updates the quote structure in memory instead of creating a new quote.

Request Message Description: ApplyMultipleOffersforOrder

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

Name	Description	Type
ListOfRAFproductofferIO	Required. The list of offer ID's that have to be applied.	Integration object
SaveInstance	Required. Values are either Y or N. If the value is set to Y, then the order is saved to the Siebel database. If the value is set to N, then the order persists in memory.	String
AccountId	Required. The account ID on which the offer will be applied.	String
AssetId	Optional. The Asset ID on which the offer will be applied. The Asset ID is required if there is a modification to the customer's asset	String
DocId	Optional. The Order ID on which the offer will be applied. If the DocId parameter is provided, the SaveInstance flag is set to Y internally and the order is saved to the Siebel database.	String
ListOfOrder	Optional. The complete order structure on which the offer will be applied. If the ListOfOrder parameter is provided, the SaveInstance flag is set to N internally and the order is generated in memory. The ApplyMultipleOffersforOrder web service accepts either the DocId parameter or the ListOfOrder parameter. The DocId parameter and the ListOfOrder parameter are mutually exclusive.	Integration object

Response Message Description: ApplyMultipleOffersforOrder

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

Name

Description

Type

SIS OM Order using <ListOfOrder>

The order document structure that has been created.

When the order is generated in memory, the order ID value is set to NoId and the order name value is set to null.

Integration object

Mode

Specifies the document format and is set to the order.

String

Request Message Description: ApplyMultipleOffersforQuote

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

Name	Description	Type
ListOfRAFproductofferIO	Required. The list of offer ID's that have to be applied.	Integration object
SaveInstance	Required. Possible values are Y or N. If the value is set to Y, then the quote is saved to the Siebel database. If the value is set to N, then the quote persists in memory.	String
AccountId	Required. The account ID on which the offer will be applied.	String
AssetId	Optional. The asset ID on which the offer will be applied. The Asset ID is required if there is a modification to the customer's asset.	String
DocId	Optional. The quote ID on which the offer will be applied. If the DocId parameter is provided, then the SaveInstance flag is set to Y internally and the quote will be saved to the Siebel database.	String
ListOfQuote	Optional. The complete quote structure on which the offer will be applied. If the ListOfQuote parameter is provided, the SaveInstance flag is set to N internally and the quote will be generated in memory. The ApplyMultipleOffersforOrder web service accepts either the DocId parameter or the ListOfQuote parameter. The DocId parameter and the ListOfQuote parameter are mutually exclusive.	Integration object

Response Message Description: ApplyMultipleOffersforQuote

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

Name

Description

Type

SIS OM Quote using <ListOfQuote>

The quote document structure that has been created.

When the quote is generated in memory, the quote ID value is set to NoId and the quote name is set to null.

Integration object

Mode

Specifies the document format and is set to quote.

String

Apply Multiple Product Offers Application Interface

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

Service Object (Business Service or Workflow)

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

Name	Boundary Object Type	Class
ApplyMultipleOffersforOrderPort	Workflow Process	RAF Apply Multiple Offer To Create Order Web Service
ApplyMultipleOffersforQuotePort	Workflow Process	RAF Apply Multiple Offer To Create Quote Web Service

Data Object (Integration Object)

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

Siebel Repository Name	External Name
RAFProductOfferIO	RAF Product Offer
SIS OM Order	MACD Performance Order
SIS OM Quote	MACD Performance Quote

Example Package for Product Offer - Apply Multiple Product Offers

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

Request (BuildYourOwnBundle)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\BuildYourOwnBundle - Request Message.txt

Response (BuildYourOwnBundle)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\BuildYourOwnBundle - Response 
Message.txt

Request (Change Plan - InMemory Upgrade)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Change Plan - InMemory Upgrade - Request 
Message.txt

Response (Change Plan - InMemory Upgrade)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Change Plan - InMemory Upgrade - 
Response Message.txt

Request (Existing Customer - Upsell Add-ons)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Existing Customer - Upsell Add-ons - 
Request Message.txt

Response (Existing Customer - Upsell Add-ons)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Existing Customer - Upsell Add-ons - 
Response Message.txt

Request (New Acquisition - Add Equipment)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\New Acquisition - Add Equipment - 
Request Message.txt

Response (New Acquisition - Add Equipment)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\New Acquisition - Add Equipment - 
Response Message.txt

Request (New Acquisition - InMemory)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\New Acquisition - InMemory - Request 
Message.txt

Response (New Acquisition - InMemory)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\New Acquisition - InMemory - Response 
Message.txt

Request (New Acquisition - SavetoDB)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\New Acquisition - SavetoDB - Request 
Message .txt

Response (New Acquisition - SavetoDB)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\New Acquisition - SavetoDB - Response 
Message .txt

Request (ReplaceSIM)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\ReplaceSIM - Request Message.txt

Response (ReplaceSIM)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\ReplaceSIM - Response Message.txt

Request (Validate Asset - International Calling Package)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Validate Asset - International Calling 
Package - Request Message.txt

Response (Validate Asset - International Calling Package)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Validate Asset - International Calling 
Package - Response Message.txt

Request (Validate Asset - Premium Voicemail)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Validate Asset - Premium Voicemail - 
Request Message.txt

Response (Validate Asset - Premium Voicemail)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product Offers\Validate Asset - Premium Voicemail - 
Response Message.txt

Request (Modify_InMemory_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product 
Offers\Modify_InMemory_ApplyMultipleOffersforQuote_Request.xml

Response (Modify_InMemory_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product 
Offers\Modify_InMemory_ApplyMultipleOffersforQuote_Response.xml

Request (Modify_InMemory_WithQuoteStructure_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product 
Offers\Modify_InMemory_WithQuoteStructure_ApplyMultipleOffersforQuote_Request.xml

Response (Modify_InMemory_WithQuoteStructure_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product 
Offers\Modify_InMemory_WithQuoteStructure_ApplyMultipleOffersforQuote_Response.xml

Request (Modify_Sync_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product 
Offers\Modify_Sync_ApplyMultipleOffersforQuote_Request.xml

Response (Modify_Sync_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product 
Offers\Modify_Sync_ApplyMultipleOffersforQuote_Response.xml

Request (Modify_Sync_WithQuoteStructure_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product 
Offers\Modify_Sync_WithQuoteStructure_ApplyMultipleOffersforQuote_Request.xml

Response (Modify_Sync_WithQuoteStructure_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product 
Offers\Modify_Sync_WithQuoteStructure_ApplyMultipleOffersforQuote_Response.xml

Request (New_InMemory_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product 
Offers\New_InMemory_ApplyMultipleOffersforQuote_Request.xml

Response (New_InMemory_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product 
Offers\New_InMemory_ApplyMultipleOffersforQuote_Response.xml

Request (New_Sync_WithQuote_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product 
Offers\New_Sync_WithQuote_ApplyMultipleOffersforQuote_Request.xml

Response (New_Sync_WithQuote_ApplyMultipleOffersforQuote)

See the following file to view the sample code:

...\Product Offer-Apply Multiple Product 
Offers\New_Sync_WithQuote_ApplyMultipleOffersforQuote_Response.xml

Interface Description (WSDL) for Product Offer - Apply Multiple Product Offers

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

See the following file to view the message schema:

…WSDL\Apply Multiple Product Offers Webservice.wsdl
…XSD\ RAFProductOfferIO.xsd
…XSD\SIS OM Order.xsd
…XSD\SIS OM Quote.xsd

ProductSearchService

Use this business service (SearchProductService) for searching the Product business component and performing an eligibility check.

ProductSearchService Operations

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

Node

Description

Type

ExecuteSearch

Retrieves products based on passed criteria.

Input: SearchProductInputSiebelMessage

Output: SearchProductResponseSiebelMessage

Request Message Description: ExecuteSearch

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

Node	Description	Type
EligibilityMode	Eligibility mode.	String
ABOFlag	ABO flag.	String
AccountContractedProductsOnlyFlag	Flag designated only products contracted through a given account.	String
AccountId	Account ID.	String
AccountType	Type of Account.	String
ClassId	Class ID.	String
CurrencyCode	Currency code.	String
DiscountPercent	Discount in percent.	String
DisplayName	Display name.	String
EligibilityDisplayMode	Mode of eligibility.	String
ExchangeDate	Date of exchange.	String
HeaderId	Header ID.	String
Mode	Mode.	String
PriceListId	Price List ID.	String
City	City name.	String
PostalCode	Postal code.	String
State	State name.	String
Country	Country name.	String
BusObjName	Name of the business object.	String
BusCompName	Name of the business component.	String
SignalMode	Signal mode.	String
ContextRowId	The context row ID.	String
ContextMode	The context mode.	String
SearchText	Search criteria.	String
Hits	Records to be fetched.	String
Threshold	Threshold value.	String
Timeout	Timeout value.	String
FromPrice	Price range.	String
ToPrice	Price range.	String
Attribute	Attribute name.	String
Feature	Feature.	String

Response Message Description: ExecuteSearch

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

Node	Description	Type
TotalRecords	Total number of records retrieved.	String
ProductId	Product ID.	String

ProductSearchService 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
SearchProductService	Business Service	CSSSrchProductSvc

Data Object (Integration Object)

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

Siebel Repository Name	External Name
Context	PDS Catalog Context
SearchProductInputSiebelMessage	SearchProductInputIO
SearchProductResponseSiebelMessage	SearchProductResponseIO

Example Package for ProductSearchService

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:

...\ProductSearchService\ProductSearchService_request.xml

Response

See the following file to view the sample code:

...\ProductSearchService\ProductSearchService_response.xml

Interface Description (WSDL) for ProductSearchService

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.

...\ProductSearchService\ProductSearch.wsdl

Promotion Asset Web Service

Use this Web service to retrieve a promotion instance, which consists of the asset structure of a promotion and its related components as defined in the Installed Assets applet in Siebel CRM.

Note: This is an internal Web service used for Siebel and AIA integration. It should not be modified if an e2e setup is being used.

Promotion Asset Web Service Operations

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

Name	Description
SWIAssetManagementPromotionQueryByExample	Queries for assets related to a promotion.

Request Message Description: SWIAssetManagementPromotionQueryByExample

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

Name	Description	Type
ListofSWIAssetManagement PromotionQueryByExample	Assets associated with the promotion.	Integration Object
AssetMgmtPromotionAsset	The asset record.	String
IntegrationId	The Integration ID of the asset.	String

Response Message Description: SWIAssetManagementPromotionQueryByExample

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

Name	Description	Type
ListofSWIAssetManagement PromotionQueryByExample	Container for assets associated with the promotion.	Integration Object
SWIAssetMgmtPromotionAsset	The asset record.	String
AccountType	Account type.	String
AssetId	Asset ID.	String
BillingAccount	Billing account.	String
BillingAccountId	Billing account ID.	String
BillingProfileId	Billing profile ID.	String
BillingProfileName	Billing profile name.	String
BillingType	Billing type.	String
Comments	Any comments.	String
IntegrationId	The integration ID of the asset.	String
Name	The asset name.	String
ParentAssetName	Parent asset name.	String
ParentAssetNumber	Parent asset number.	String
ProdItemId	Product item ID.	String
ProdPromId	Product promotion ID.	String
ProdPromInstanceId	Product promotion instance ID.	String
ProdPromName	Product promotion name.	String
ProdPromRuleId	Product promotion rule ID.	String
ProdPromSourceId	The source ID of the product promotion.	String
ProdType	Product type.	String
Productid	The product ID.	String
ProductName	The product name.	String
ProductSPNDefinitionId	The class part number ID of the product.	String
ProductType	Product type.	String
ProductVersion	Product version.	String
ProductXAClassId	The class ID of the product.	String
PromGroupId	Promotion group ID.	String
PromGroupInstanceId	Promotion group instance ID.	String
PromGroupName	Promotion group name.	String
PromGroupRuleId	Promotion group rule ID.	String
PromGroupRuleType	Promotion group rule type.	String
PromotionGroupType	Promotion group type.	String
Quantity	Quantity value.	String
RootAssetId	Root asset ID.	String
RootIntegrationId	Root integration ID.	String
RootProdPromInstanceId	Root product promotion instance ID.	String
RootProductId	Root product ID.	String
RootPromotionGroupId	Root promotion group ID.	String
RootPromotionId	Root promotion ID.	String
ServiceAccount	Service account.	String
ServiceAccountId	Service account ID.	String
ServiceFlag	Service flag.	String
ServiceType	Service type.	String
Status	Status.	String
Type	Promotion type.	String
ServiceInstance	Service instance.	String
ListofSwiAssetMgmtPromotionComponentAsset	Container for component assets associated with the promotion.	Integration object.
SwiAssetMgmtPromotionComponentAsset	Promotion component assets.	String
AccountType	Account type.	String
AssetId	Asset ID.	String
BillingAccount	Billing account.	String
BillingAccountId	Billing account ID.	String
BillingProfileId	Billing profile ID.	String
BillingProfileName	Billing profile name.	String
BillingType	Billing type.	String
Comments	Any comments.	String
IntegrationId	The integration ID of the asset.	String
Name	The asset name.	String
ParentAssetName	Parent asset name.	String
ParentAssetNumber	Parent asset number.	String
ProdItemId	Product item ID.	String
ProdPromId	Product promotion ID.	String
ProdPromInstanceId	Product promotion instance ID.	String
ProdPromName	Product promotion name.	String
ProdPromRuleId	Product promotion rule ID.	String
ProdPromSourceId	The source ID of the product promotion.	String
ProdType	Product type.	String
Productid	The product ID.	String
ProductName	The product name.	String
ProductSPNDefinitionId	The class part number ID of the product.	String
ProductType	Product type.	String
ProductVersion	Product version.	String
ProductXAClassId	The class ID of the product.	String
PromGroupId	Promotion group ID.	String
PromGroupInstanceId	Promotion group instance ID.	String
PromGroupName	Promotion group name.	String
PromGroupRuleId	Promotion group rule ID.	String
PromGroupRuleType	Promotion group rule type.	String
PromotionGroupType	Promotion group type.	String
Quantity	Quantity value.	String
RootAssetId	Root asset ID.	String
RootIntegrationId	Root integration ID.	String
RootProdPromInstanceId	Root product promotion instance ID.	String
RootProductId	Root product ID.	String
RootPromotionGroupId	Root promotion group ID.	String
RootPromotionId	Root promotion ID.	String
ServiceAccount	Service account.	String
ServiceAccountId	Service account ID.	String
ServiceFlag	Service flag.	String
ServiceType	Service type.	String
Status	Status.	String
Type	Promotion type.	String
ServiceInstance	Service instance.	String

PromotionAssetWebService 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
SWI Asset Management Promotion	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
SWIAssetManagementPromotion	SWIAssetManagementIO

Example Package for PromotionAssetWebService

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:

...\PromotionAssetWebService\Request.xml

Response

See the following file to view the sample code:

...\PromotionAssetWebService\Response.xml

Interface Description (WSDL) for PromotionAssetWebService

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.

...\PromotionAssetWebService\PromotionAssetWebService.wsdl

PromotionWebService

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

Use this Web service to get product promotion information, apply product promotion, get promotion commitment information and to upgrade a promotion.

PromotionWebService Operations

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

Name	Description
getProductPromotionDefinition	Returns promotion detail information.
ApplyProductPromotion	Add a promotion and all default components to a quote or order.
getPromotionCommitments	Get promotion commitment information for a given promotion asset.
UpgradePromotionToQuote	Upgrade or migrate a promotion instance to another promotion and generate a quote with the updated assets information.
UpgradePromotionToOrder	Upgrade or migrate a promotion instance to another promotion and generate an order with the updated assets information.

Request Message Description: GetProductPromotionDefinition

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

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

Response Message Description: GetProductPromotionDefinition

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

Name	Description	Type
ProdPromDefinition	In SiebelMessage format of the integration object ISS Promotion Definition for WS.	Not applicable
PromDomainProduct	In SiebelMessage format of the integration object PDS Product Interface'. Could be either default domain product details or all domain product details depending on input arguments.	Not applicable
Err_spcCode	Error Code if error occurred.	Not applicable
Err_spcMessage	Error Message if error occurred.	Not applicable

Request Message Description: ApplyProductPromotion

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

Name	Description	Type
EligibilityMode	Optional. The default value is 2. Could be 0, 1, 2.	Not applicable
PricingMode	Optional. The default value as Y. Possible values are Y or N.	Not applicable
ProdPromId	Required.	Not applicable
ProdPromInstanceId	Optional, depending on usage scenarios. This parameter lets you add a promotion to an existing quote and associate products already on the quote with the promotion. For more information on using this parameter, see My Oracle Support and query for Doc ID: 1924501.1.	Not applicable
LineItemId	Optional, depending on usage scenarios.	Not applicable
Quantity	Optional. The default value is 1.	Not applicable
SiebelMessage	Required, in SiebelMessage format of the integration object PDS Quote.	Not applicable

Response Message Description: ApplyProductPromotion

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

Name	Description	Type
SiebelMessage	Required. In SiebelMessage format of the integration object PDS Quote.	Not applicable
Err_spcCode	Error code if one occurred.	Not applicable
Err_spcMessage	Error message if one occurred.	Not applicable

Request Message Description: getPromotionCommitments

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

Name	Description	Type
Asset Integration Id	Required. Asset Integration ID of the Promotion Instance Asset.	String

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

Name	Description	Type
PromotionCommitments	An instance of the integration object ISS Promotion Commitments.	Integration Object

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

Name	Description	Type
NewPromotionId	Required. RowId of new promotion.	String
AssetNumber	Asset number of the selected promotion asset. Provide either AssetNumber or AssetIntegrationId.	String
AssetIntegrationId	Asset integration ID of the selected promotion asset. Provide either AssetNumber or AssetIntegrationId.	String
ActiveDocumentId	A Document in Siebel Order Management refers to a Quote or an Order. Each Document can have multiple children (Quote Items or Order Line Items). ActiveDocumentId refers to the current active Document that the current process is working on. In this Web service call, it is the Quote ID of the active Quote to which the generated quote item has to be added. This is an optional input.	String
AccountId	Account ID of the account that owns the selected promotion asset being upgraded.	String
OverridePenaltyAmount	Penalty amount for upgrading the promotion, if any.	String
OverrideProratePlanId	If there is a penalty for upgrading the promotion, also pass in the prorate plan used to prorate this penalty, if any.	String

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

Name	Description	Type
QuoteIO	An instance of the integration object PDS Quote.	Integration Object

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

Name	Description	Type
NewPromotionId	Required. RowId of new promotion.	String
AssetNumber	Asset Number of the selected promotion asset. Provide either AssetNumber or AssetIntegrationId.	String
AssetIntegrationId	Asset Integration ID of the selected promotion asset. Provide either AssetNumber or AssetIntegrationId.	String
ActiveDocumentId	A Document in Siebel Order Management refers to a Quote or an Order. Each Document can have multiple children (Quote Items or Order Line Items). ActiveDocumentId refers to the current active Document that the current process is working on. In this Web service call, it is the Order ID of the active Order to which the generated order item has to be added. This is an optional input.	String
AccountId	Account ID of the account that owns the selected promotion asset being upgraded.	String
OverridePenaltyAmount	Penalty amount for upgrading the promotion, if any.	String
OverrideProratePlanId	If there is a penalty for upgrading the promotion, also pass in the prorate plan used to prorate this penalty, if any.	String

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

Name	Description	Type
OrderIO	An instance of the integration object PDS Order.	Integration Object

PromotionWebService 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
ISS Promotion WS - GetPromotionCommitments	Workflow
ISS Promotion WS-Upgrade Promotion-Quote	Workflow
ISS Promotion WS-Upgrade Promotion-Order	Workflow

Data Object (Integration Object)

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

Siebel Repository Name	External Name
ISS Promotion Commitments	ISS Promotion Commitments
PDS Quote	PDS Quote
PDS Order	PDS Order

Example Package for PromotionWebService

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 PromotionWebService

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.

...\PromotionWebService\PromotionWebService.wsdl

QueryTransportationSalesOrderItineraryListSiebelReq ABCSImpl Web Service

Use this outbound Web service to submit an order to the rating engine and get ratings in response. This Web service submits an order request to the third-party application to get feasible solutions for this transportation order.

QueryTransportationSalesOrderItineraryListSiebelReqABCSImpl Operations

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

Name	Description
QueryTransportationSalesOrderItineraryList	Submits the order request

Request Message Description: QueryTransportationSalesOrderItineraryList

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

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
QueryTransportationSalesOrderItineraryListReqMsg:Query TransportationSales_1	Optional	Integration Object

Response Message Description: QueryTransportationSalesOrderItineraryList

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

Node	Description	Type
QueryTransportationSalesOrderItineraryListReqMsg:Query TransportationSales_1	Optional	Integration Object

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

Siebel Repository Name	Boundary Object Type	Class
QueryTransportationSalesOrderItinerary ListSiebelReqABCSImplService	Business Service	CSSWSOutboundDispatcher

This object is called from the virtual business component context. Unlike other Web services, which are generally called by clicking a button or selecting a menu item, this Web service is called when an applet based on the appropriate virtual business component is displayed.

Data Objects (Integration Object)

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

Siebel Repository Name	External Name
SWIOrderIO	PDS Simplified Order
SWIOrderEntry(Sales)IORes	Order Entry (Sales)

Methods

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

Operation	Method
SWIOrderIO	PDS Simplified Order
SWIOrderEntry(Sales)IORes	Order Entry (Sales)

Example Package for QueryTransportationSalesOrderItineraryListSiebelReqABCSImpl Service

To view an example of the messages 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.

Request

See the following file to view the sample code:

...\SWISubmitOrder\Ratings_Request.xml

Message Schema (WSDL) for QueryTransportationSalesOrderItineraryListSiebelReqABCSImpl Service

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.

...WSDL\Ratings.wsdl

QuoteAddItemsWS

Use this Web service to add the default instance (products) to the Quote Object.

QuoteAddItemsWS Operations

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

Name	Description
QuoteAddItems	Add quote line items.

Request Message Description: QuoteAddItems

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

Node	Description
Instance	Required. An instance of the integration object PDS Quote.
GetProductDataRequest	Required. An instance of the integration object Added Products. The namespace is http://siebel.com/OrderManagement/Quote/ProductData. This instance will include the product IDs that will be added.
Item, ProductId	Required field for each item. The product that will be added to the Instance.
Item, Quantity	Quantity of the product. Not a required field. The default value is 1.
GetPricing	Y or N. Turns on (Y) or off (N) Pricing.
CheckEligibility	Y or N. Turns on (Y) or off (N) Eligibility Check.

Response Message Description: QuoteAddItems

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

Node	Description
Instance	Same as the input argument Instance. For more information, see the previous table. Based on the integration object PDS Quote. The updated instance will contain the new added products.

QuoteAddItems Application Interface

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

Service Object (Business Service or Workflow)

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

Name	Boundary Object Type	Class (if BusService)
Web Channel Quote Add Default Items	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
Added Products	None (XML)
PDS Quote	PDS Simplified Quote

Example Package for QuoteAddItems

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:

...\QuoteAddItemsWS\QuoteAddItemsWS_request.xml

Response

See the following file to view the sample code:

...\QuoteAddItemsWS\QuoteAddItemsWS_response.xml

Message Schema (WSDL) for QuoteAddItems

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

...\QuoteAddItemsWS\http_siebel.com_OrderManagement_Quote_QuoteAddItemsWS.wsdl

QuoteCheckOutWebService

Use this Web service to perform payment authorizations for quotes.

QuoteCheckOutWebService Operations

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

Node	Description
QuoteCheckOut	Executes payment authorization. If the authorization fails, then the operation stops and returns. Otherwise, the quote is submitted to order.

Request Message Description: QuoteCheckOut

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

Node	Description	Type
QuoteCheckOut_Input	The request message includes the ID of the quote to be submitted, a flag to indicate whether to do credit card authorization, and a flag to indicate whether to submit the quote to order.	ComplexType
InvokeId	Not used.	Not applicable

Response Message Description: QuoteCheckOut

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

Node	Description	Type
QuoteCheckOut_Output	The response message includes the ID of the order converted from quote.	ComplexType

Example Package for QuoteCheckOutWebService

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:

...\QuoteCheckOutWebService\QuoteCheckOutWebService_request.xml

Response

See the following file to view the sample code:

...\QuoteCheckOutWebService\QuoteCheckOutWebService_response.xml

Interface Description (WSDL) for QuoteCheckOutWebService

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.

..\QuoteCheckOutWebService\QuoteCheckOutWebService.wsdl

QuoteDetailWebService

Use this Web service to retrieve, update, insert, or delete details on a quote record.

QuoteDetailWebService Operations

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

Node	Description
QuoteDetailGet	Requests and retrieves quote detail.
QuoteDetailUpdate	Updates quote details.
QuoteDetailInsert	Inserts new quote detail.
QuoteDetailDelete	Deletes quote details.
QuoteDetailInit	Quote is initialized from database.

Request Message Description: QuoteDetailGet

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

Node	Description	Type
QuoteDetailGet_Input	Quote object passed to the Web service. It includes the search criteria.	ComplexType

Response Message Description: QuoteDetailGet

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

Node	Description	Type
QuoteDetailGet_Output	Quote object returned. It includes the detail of the quote header and the payment information.	ComplexType

Request Message Description: QuoteDetailUpdate

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

Node	Description	Type
QuoteDetailUpdate_Input	Quote to be updated into database.	ComplexType

Response Message Description: QuoteDetailUpdate

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

Node	Description	Type
QuoteDetailUpdate_Output	Quote returned with updated information.	ComplexType

Request Message Description: QuoteDetailInsert

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

Node	Description	Type
QuoteDetailInsert_Input	Quote to be inserted into the database.	ComplexType

For a description of this response message, seethe following table.

Node	Description	Type
QuoteDetailDelete_Output	Quote returned from the Web service.	ComplexType

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

Node	Description	Type
QuoteDetailDelete_Input	Quote to be deleted from database.	ComplexType

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

Node	Description	Type
QuoteDetailDelete_Output	Quote returned from the Web service.	ComplexType

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

Node	Description	Type
QuoteDetailInit_Input	Quote to be initialized from the database.	ComplexType

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

Node	Description	Type
QuoteDetailInit_Output	Quote returned from the Web service.	ComplexType

Example Package for QuoteDetailWebService

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:

...\QuoteDetailWebService\QuoteDetailWebService_request.xml

Response

See the following file to view the sample code:

...\QuoteDetailWebService\QuoteDetailWebService_response.xml

Interface Description (WSDL) for QuoteDetailWebService

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.

...\QuoteDetailWebService\QuoteDetailWebService.wsdl

QuoteWebService and OrderWebService

Use this set of Web services to manipulate the Quote or Order data.

QuoteWebService and OrderWebService Operations

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

Name	Description
SynchronizeQuote	Provides CRUD operations on quote and quote items. SyncronizeQuote is a standard EAI-based synchronization operation using the PDQ Quote integration object. For more information see the topic on the Synchronize method in Integration Platform Technologies: Siebel Enterprise Application Integration.
Update Order	Updates the order header information.
Update Order Item	Updates the line items for a specific order.
Update Quote	Updates the quote header information.
Update Quote Item	Updates the line items for a specific quote.
Delete Order	Deletes a given order.
Delete Order Item	Deletes the line items on a specific order.
Delete Quote	Deletes a given quote.
Delete Quote Item	Deletes the line items on a specific quote.
Insert Order	Inserts an order.
Insert Order Item	Adds the line items on a given order.
Insert Quote	Inserts a quote.
Insert Quote Item	Adds the line items on a given quote.
Get Quote	Queries the quote.
Get Order	Queries an order.

Request Message Description: SynchronizeQuote

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

Node	Description
QuoteIO	Required.

Response Message Description: SynchronizeQuote

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

Node	Description
QuoteIO	Required.

Request Message Description: Query, Update, Delete Quote

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

QueryByExample/QueryById/InsertQuote/DeleteQuote Request Message.

Node	Description
QuoteIO	Required. An instance of the integration object PDS Quote.

Response Message Description: Query, Update, Delete, Quote

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

QueryByExample/QueryById/InsertQuote/DeleteQuote Response Message.

Node	Description
QuoteIO	Required. An instance of the integration object PDS Quote.

Request Message Description: Query, Update, Delete Quote Item

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

QueryByExample/UpdateQuoteItem/InsertQuoteItem/DeleteQuoteItem Request Message.

Node	Description
QuoteItemIO	Required. An instance of the integration object PDS Quote Item.

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

QueryByExample/UpdateQuoteItem/InsertQuoteItem/DeleteQuoteItem Response Message.

Node	Description
QuoteItemIO	Required. An instance of the integration object PDS Quote Item.

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

QueryByExample/QueryById/InsertOrder/DeleteOrder Request Message.

Node	Description
OrderIO	Required. An instance of the integration object PDS Order.

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

QueryByExample/QueryById/InsertOrder/DeleteOrder Response Message.

Node	Description
OrderIO	Required. An instance of the integration object PDS Order.

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

QueryByExample/UpdateOrderItem/InsertOrderItem/DeleteOrderItem Request Message.

Node	Description
OrderItemIO	Required. An instance of the integration object PDS Order Item.

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

QueryByExample/UpdateOrderItem/InsertOrderItem/DeleteOrderItem Response Message.

Node	Description
OrderItemIO	Required. An instance of the integration object PDS Order Item.

QuoteWebService and OrderWebService Application Interface

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

Service Object (Business Service or Workflow)

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

Name	Boundary Object Type	Class (if BusService)
PDQ Quote	BusinessService	CSSEAIDataSyncService
PDS Quote	Business Service	CSSEAIDataSyncService
PDS Quote Item	Business Service	CSSEAIDataSyncService
PDS Order	Business Service	CSSEAIDataSyncService
PDS Order Item	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
PDS Quote	PDS Simplified Quote
PDS Quote Item	PDS Simplified Quote
PDS Order	PDS Simplified Order
PDS Order Item	PDS Simplified Order

Example Package for QuoteWebService

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:

...\Quote_and_Order\QuoteWebService_request.xml

Response

See the following file to view the sample code:

...\Quote_and_Order\QuoteWebService_response.xml

Message Schema (WSDL) for QuoteWebService

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

...\Quote_and_Order\QuoteWebService.wsdl

QuotingWebService

Use this Web service for simple, anonymous quoting. The Web service passes pricing and other related information, without synchronizing, to create a quote in Siebel CRM. All operations are performed in memory on the integration object. When a customer confirms the quote, the Sync Quote flag is set and a quote is created in Siebel CRM.

The following flags control the various workflows or steps executed during the process:

CalculateShippingCostFlag (Y/N): when enabled, this flag triggers the Shipping Cost Calculation step.
CalculateTaxFlag: when enabled, this flag triggers the Tax Calculator step.
CheckEligibilityFlag: when enabled, this flag triggers the E&C (Eligibility and Compatibility) check sub-process.
Delta Action Code Flag: when enabled, this flag causes Asset Based Ordering to check the Action Code field.
PricingFlag: when enabled, this flag triggers the RePricing step of the QuoteIO (1st Reprice).
QueryQuoteFlag: when enabled, this flag triggers the reQuery the Quote step which returns the updated QuoteIO to the requesting application.
RepricingFlag: when enabled, this flag triggers the Reprice (Again) step after any updates have been made.
SyncQuoteFlag: when enabled, this flag triggers the Synch Quote operation after the first reprice has been completed. This flag only impacts non-ABO as in ABO the Delta Action Code Flag's sub-process handles the synchronization.
VerifyPromotionFlag: when enabled, this flag triggers the Verify the Quote's Promotions step.

QuotingWebService Operations

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

Name	Description
ExecuteQuoting	Saves the quote to the database. Checks eligibility, verifies the promotion, or calculates the price, shipping charge and tax based on the pass-in flag.

Request Message Description: ExecuteQuoting

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

Node	Description	Type
ExecuteQuoting_Input	The request message includes the quote to be saved. It also includes the following flags: Flag to indicate whether to check ligibility. Flag to indicate whether to calculate the price for the quote. Flag to indicate whether to calculate the shipping cost. Flag to indicate whether to calculate the tax. Flag to indicate whether to verify the promotion. Flag to indicate whether to query the quote back from database or just return the quote in memory.	ComplexType
Repricing Flag	Quote that is already synchronized to the database is repriced if this flag is set to Y. Used to Reprice the Quote after any previous steps which may have impacted the overall price of the Quote (such as Shipping, Promotion Verify, and so on).	String
Target Document	Not currently used. Added for future enhancements.	Not applicable
Use UMF	Not currently used. Added for future enhancements.	Not applicable
Wait Flg	Not currently used.	Not applicable
Continue Recomm	Not currently used.	Not applicable
InvokedId	Not currently used.	String
PickListName	Name of the picklist (if any).	String
NamedSearchSpec	Search specification of quote.	String
ExecutionMode	The mode in which the quote is to be performed.	String
LOVLanguageMode	The language mode from the seeded list.	String
ViewMode	The view mode set for the object.	String
PriceOnSync	Not currently used.	String
Skip Query Order	Not currently used.	String

Response Message Description: ExecuteQuoting

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

Node	Description	Type
ExecuteQuoting_Output	The response message includes the quote returned from Web service.	ComplexType
CC Violated Flag	Returned as an output property from the Verify Promotion step to indicate whether the Promotion has been violated.	String

QuotingWebService 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
Web Channel Quoting 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 Simplified Quote

Example Package for QuotingWebService

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:

...\QuotingWebService\QuotingWebService_request.xml

Response

See the following file to view the sample code:

...\QuotingWebService\QuotingWebService_response.xml

Interface Description (WSDL) for QuotingWebService

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.

...\QuotingWebService\QuotingWebService.wsdl

Response

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

Response Operations

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

Name	Description
ResponseCreateResponse	Creates a response.
ResponseSourceCodeLookup	This operation is used to determine the campaign history record.
ResponseUpdateResponse	Updates a response.

Request Message Description: ResponseCreateResponse

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

Node	Description	Type
Response IO	Required input parameter.	Integration Object

Response Message Description: ResponseCreateResponse

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

Node	Description	Type
Response Id	Row ID of the new response.	String
Error Message	Error message, if any.	String
Success Flag	Y or N.	String

Request Message Description: ResponseSourceCodeLookup

This method takes in Ids and Codes of Offer, Campaign and Treatment and returns the S_CAMP_CON_ID. For a description of this request message, see the following table.

Node	Description	Type
Campaign Code	Campaign code of response source.	String
Campaign Id	Campaign ID of response source.	String
Offer Code	Offer code for response.	String
Offer Id	Offer ID for response.	String
Source Code	Source code for response.	String
Treatment Code	Treatment code for response.	String
Treatment Id	Treatment ID for response.	String

Response Message Description: ResponseSourceCodeLookup

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

Node	Description	Type
S_CAMP_CON_ID	Row ID of the response.	String
Error Message	Error message, if any.	String
Success Flag	Y or N.	String

Request Message Description: ResponseUpdateResponse

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

Node	Description	Type
Response IO	Required input parameter.	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

Example Package for Response

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 (ResponseCreateResponse)

See the following file to view the sample code:

...\Response\ResponseCreateResponse_request.xml

Response (ResponseCreateResponse)

See the following file to view the sample code:

...\Response\ResponseCreateResponse_response.xml

Request (ResponseSourceCodeLookup)

See the following file to view the sample code:

...\Response\ResponseSourceCodeLookup_request.xml

Response (ResponseSourceCodeLookup)

See the following file to view the sample code:

...\Response\ResponseSourceCodeLookup_response.xml

Request (ResponseUpdateResponse)

See the following file to view the sample code:

...\Response\ResponseUpdateResponse_request.xml

Response (ResponseUpdateResponse)

See the following file to view the sample code:

...\Response\ResponseUpdateResponse_request.xml

Interface Description (WSDL) for Response

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.

...\Response\Response.wsdl

RetrieveAttachmentService

This Web service has one standard QueryPage method to retrieve attachment documents.

RetrieveAttachmentService Operations

Provides search solution results. Business Service (Search Solution Service) for Searching Solution business component. For a list of operations associated with this Web service, see the following table.

Name

Parameters

Description

QueryPage

Input: Attachment ID

Output: AttachmentDocIO (Attachment File Content)

This retrieves the attachment content for a given attachment ID.

Request Message Description: RetrieveAttachmentService

This fetches the Attachment content for a given attachment ID. For a description of this request message, see the following table.

Node	Description	Type
Id	Document ID	String
ModId	Modification ID	String
ResFileAutoUpdFlg	Y or N	String
ResFileDate	File Date	String
ResFileDeferFlg	Y or N	String
ResFileDockReqFlg	Y or N	String
ResFileDockStatFlg	Y or N	String
ResFileDockStatus	Y or N	String
ResFileExt	File Extension	String
ResFileName	File Name	String
ResFileRev	File ID	String
ResFileSize	File Size	String
ResFileSrcPath	File Source Path	String
ResFileSrcType	File Source Type	String
ResFileBuffer	File Buffer	String
LOVLanguageMode	Language Independent code	String
ExecutionMode	Execution Mode	String
ViewMode	Visibility Access Mode	String

Response Message Description: RetrieveAttachmentService

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

Node	Description	Type
Id	Document ID	String
ModId	Modification ID	String
ResFileAutoUpdFlg	Y or N	String
ResFileDate	File Date	String
ResFileDeferFlg	Y or N	String
ResFileDockReqFlg	Y or N	String
ResFileDockStatus	Y or N	String
ResFileExt	File Extension	String
ResFileName	File Name	String
ResFileRev	File ID	String
ResFileSize	File Size	String
ResFileSrcPath	File Source Path	String
ResFileSrcType	File Source Type	String
ResFileBuffer	File Buffer	String

RetrieveAttachmentService Application Interface

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
RetrieveAttachmentService	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
SiebelMessageIn	AttachmentDocIO
SiebelMessageOut	AttachmentDocIO

Example Package for RetrieveAttachmentService

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:

...\RetrieveAttachment\RetrieveAttachment_request.xml

Response

See the following file to view the sample code:

...\RetrieveAttachment\RetrieveAttachment_response.xml

Interface Description (WSDL) for RetrieveAttachmentService

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.

...\RetrieveAttachment\RetrieveAttachment.wsdl

RTD_NBA Integration Service

This Web service is part of Siebel In-Memory Next Best Action. The Web service enables you to integrate Siebel Contact Center with Oracle Real-Time Decisions (RTD) Server. It includes three operations: CallAdvisor, CallInformant, and ProcessResponseAction.

CallAdvisor enables an agent to view an offer selected for a customer based on the customer’s input.
CallInformant passes messages to Oracle RTD which contain information about a specific unit in a business process.
ProcessResponseAction processes Actions defined for a specific Response.

RTD_NBA Integration Service Operations

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

Name

Description

CallAdvisor

Makes an Advisor call to Oracle Real-Time Decisions (RTD) Server which processes input from a customer and returns offers based on that input.

CallInformant

Calls an Informant, which contains information about a specific unit in a business process.

ProcessResponseAction

This operation does the following:

Updates the recommendation history record with the selected Response.
Makes an RTD Informant call about the selected Response, then.
Performs any predefined Actions for the selected Response.

Request Message Description: CallAdvisor

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

Node	Description	Type
Application	Required. The Inline Service name on the Oracle RTD server. For example, SiebelB2B or SiebelB2C and so on.	String
Attributes	Optional. An instance of the RTD Attributes integration object. Used to send additional attributes for the RTD Advisor call in Name - Value pairs.	Integration Object
IntergrationPoint	Required. The Integration Point name on the Oracle RTD Server. Used to specify a specific integration point among the multiple advisors created in RTD Decision Studio.	String
SessionKeys	Required. An instance of the RTD SessionKeys integration object. Customer information can be added as session key attributes as Name - Value pairs. RTD obtains the customer information from session key attributes of the Web service call.	Integration Object
Trace	Optional. Enables extra logging. Possible values are TRUE or FALSE. The default value is FALSE.	String
TrackRecommendations	Required. Possible values are 'Y' or 'N'. If set to Y, CallAdvisor input attribute details and recommendations details returned by RTD for the corresponding CallAdvisor call are tracked in the Siebel database as a history.	String.

Response Message Description: CallAdvisor

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

Node	Description	Type
ChoiceGroupEvents	Optional. An instance of the integration object RTD Admin CG Events. It contains all the Choice Groups and associated events for all the recommendation types returned by RTD. This is Integration object and name of the IO is RTD Admin CG Events. Please mention tht the output is an instance of this IO.	Integration Object
ClusterVersion	Optional. The cluster version.	String
LogInfo	Optional. Log information.	String
RecommendationTrackID	Optional. The Request ID of the tracked Recommendations. This ID is used in the ProcessResponseAction call to update the selected Response.	String
Response:response	Optional. An instance of the integration object 'res'. Contains the recommendation details returned by the RTD server for the corresponding Advisor call.	Integration Object
Service Version	Optional. Service version.	String.
TraceInfo	Optional. Trace information.	String

Request Message Description: CallInformant

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

Node	Description	Type
Application	Required. The Inline Service name on the RTD Server. For example, SiebelB2B or SiebelB2C and so on.	String
Attributes	Optional. An instance of the RTD Attributes integration object. Used to send additional attributes for the RTD Informant call in Name - Value pairs.	Integration Object
IntegrationPoint	Required. The integration point name, such as IdentifyCustomer, on the RTD Server. This parameter is used to specify a specific Integration point among the multiple Informants created in RTD Decision Studio.	String
SessionKeys	Required. An instance of the RTD SessionKeys integration object. Customer information can be added as session key attributes in Name - Value pairs. RTD obtains the customer information from session key attributes contained in the Web service call.	Integration Object
Trace	Optional. Enables extra logging. Possible values are TRUE or FALSE. The default value is FALSE.	String

Response Message Description: CallInformant

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

Node	Description	Type
ClusterVersion	Optional. Cluster version.	String
LogInfo	Optional. Log information.	String
ServiceVersion	Optional. Service version.	String
TraceInfo	Optional. Trace information.	String

Request Message Description: ProcessResponseAction

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

Node	Description	Type
Accepted Msg Resp Id	Required. The ID of the Choice Group Event for which the Response is selected. Note: All the Response details are provided in the corresponding CallAdvisor Web service method output or are predefined in the Siebel CRM application UI Administration-Marketing, Response Management (RTD) view.	String
Application	Required. The Inline Service name on the RTD Server. For example, SiebelB2B or SiebelB2C and so on.	String
Channel	Required. The channel of the recommendation. This value is used in Informant call of the ProcessResponseAction method.	String
Offer Category	Required. The Offer Category of the recommendation for which the response is chosen	String
RTD Choice Event Name	Required. The Choice Event Name value defined on the RTD Server.	String
Recommendation Id	Required. The Recommendation ID of the recommendation for which the response is chosen.	String
Recommendation Name	Required. The name of the recommendation for which the response is chosen.	String
SessionKeyField	Required. The session key field name that must be used in the Informant call of the ProcessResponseAction method. This value is not used if the SessionKeys integration object structure is passed in the input.	String
SessionKeyValue	Required. The session key value must be used in the Informant call of that ProcessResponseAction method. This value is not used if the SessionKeys integration object structure is passed in the input.	String
Accepted Message Id	Optional. The ID of the Choice Group for which the response is selected. Note: All the Response details are provided in the corresponding CallAdvisor Web service method output or are predefined in the Siebel CRM application UI Administration-Marketing, Response Management (RTD) view.	String
RTD Attributes	Optional. Attributes for an RTD Informant call in the RTD Attributes integration object structure. If not specified, the default attributes are set to make the Informant call.	Integration object
IntegrationPoint	Optional. The RTD Integration Point to be called for Informant call. The default value is TrackChoiceEvent.	Sting
RTD SessionKeys	Optional. The session keys for the RTD Informant call in the integration object structure. If not specified, the default SessionKeys are set to make the Informant call.	Integration object
Trace	Optional. Enables extra logging. Possible values are TRUE or FALSE. The default value is FALSE.	String
AccountId	Optional. This value is used in the context of named workflow parameters to retrieve account-related information.	String
ContactId	Optional. This value is used in the context of named workflow parameters retrieve contact-related information.	String
RecommendationTrackID	Optional. The Request ID of the tracked recommendation history. This value is provided in the CallAdvisor ouput if choosen to track the recommendations.This value is empty if you chose not to track the recommendations in the Advisor call.	String

RTD_NBA Integration 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
RTD_NBA Integration Service	Business Service	CSSNBAIntegrationService

Data Object (Integration Object)

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

Siebel Repository Name	External Name
RTD Attributes	Attributes
res	res
RTD Admin CG Events	ChoiceGroupEvents
RTD SessionKeys	SessionKeys

Methods

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

Operation	Method
Call Advisor	CallAdvisor
Call Informant	CallInformant
ProcessResponseAction	ProcessResponseAction

Example Package for RTD_NBA Integration 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 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:

...\RTD_NBA Integration Service\CallAdvisor\CallAdvisor_request.txt
...\RTD_NBA Integration Service\CallInformant\CallAdvisor_request.txt
...\RTD_NBA Integration 
Service\ProcessResponseAction\ProcessResponseAction_request.txt

Response

See the following file to view the sample code:

...\RTD_NBA Integration Service\CallAdvisor\CallAdvisor_response.txt
...\RTD_NBA Integration Service\CallInformant\CallInformant_response.txt

Interface Description (WSDL) for RTD_NBA Integration 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.

...\RTD_NBA Integration Service\http___siebel.com_CustomUI_RTD_NBA Integration Service.wsdl

SCOAExportWS

Use this outbound Web Service to export an update commerce job to Siebel Commerce Object Aggregator (SCOA).

SCOAExportWS Operations

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

Name	Description
StartExportJob	Export a content job to SCOA

Request Message Description: StartExportJob

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

Node	Description	Type
JobId	Update Commerce Job Id	String

Response Message Description: StartExportJob

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

Node	Description	Type
Return	Return status from SCOA	String

SCOAExportWS 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
SCOAExportWS	Business Service	CSSWSOutboundDispatcher

Methods

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

Operation	Method
StartExportJob	StartExportJob

Example Package for SCOAExportWS

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:

...\ SCOAExport\SCOAExportRequest.xml

Response

See the following file to view the sample code:

...\ SCOAExport\SCOAExportResponse.xml

Interface Description (WSDL) for SCOAExportWS

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.

...\SCOAExport\SCOAExportWS.WSDL

searchSolution

Use this Web service to search for solutions based on user inputs, and retrieve a solution as a search result.

searchSolution Operations

The operations provide search solution results. The Web service uses the business service called Search Solution Service of Searching Solution business component. For a list of operations associated with this Web service, see the following table.

Name

Parameters

Description

searchSolution.searchSolution

Input: SearchInputsIO (SearchText, SolutionType, To, From).

Output: SearchResultsIO (Total Records, Solution ID, Solution Title, Last Update Date).

Performs a search on a solution based on specified input.

searchSolution.getSolution

Input: SolutionId.

Output: SolutionResultIO (Solution ID, Solution Title, Last Update Date, FAQ, Resolution Text, Solution Type, SolnAttachmentList (Attachment ID, File Name, Last Updated Date, Type) ).

Retrieves solution from search results.

Request Message Description: searchSolution

Performs a search on a solution based on specified input. For a description of this request message, see the following table.

Node	Description	Type
SearchText	Text to be searched.	String
SolutionType	Type of Solution.	String
From	Index of Record.	String
To	Index of Record.	String

Response Message Description: searchSolution

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

Node	Description	Type
TotalRecords	Total number of records fetched.	String
From	Index of the first record returned.	String
SolutionId	Solution ID.	String
SolutionTitle	Solution Title.	String
LastUpdateDate	Last update date of the record.	String
To	Index of the last record fetched.	String

Request Message Description: getSolution

Retrieves solution from search results. For a description of this request message, see the following table.

Node	Description	Type
SolutionId	Solution ID	String

Response Message Description: getSolution

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

Node	Description	Type
FAQ	Frequently Asked Question	String
LastUpdateDate	Last update date of the record	String
AttachmentId	Attachment ID	String
AttachmentType	Type of Attachment	String
Name	Name	String
ResolutionText	Resolution Text message	String

searchSolution Application Interface

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
Search Solution Service	Business Service	CSSSrchSolutionSvc

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SolutionResultSiebelMessage	SolutionResultIO
SearchInputsSiebelMessage	SearchInputsIO
SearchResultsSiebelMessage	SearchResultsIO

Example Package for searchSolution

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:

...\searchSolution\searchSolution_request.xml

Response

See the following file to view the sample code:

...\searchSolution\searchSolution_response.xml

Interface Description (WSDL) for searchSolution

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.

...\searchSolution\searchSolution.wsdl

SelfServiceAccount

This Web service makes available the EAI UI business service SelfServiceAccount, which provides CRUD and query operations on the integration object SS_Account_IO.

This Web service makes available the Execute and Query Methods in the SelfServiceAccount business service as Web service operations.

SelfServiceAccount Operations

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

Name	Description
SelfServiceAccountExecute	Performs CRUD operations on the instance of SS_Account_IO provided as input. This operation is used in Siebel Self-Service for adding, editing and deleting BusinessAddress to an Account.
SelfServiceAccountQueryPage	Performs Query operation based on the viewCriteria and searchSpec set on the instance of SS_Account_IO provided as input. This operation is used in Siebel Self-Service for querying the details of an Account, inclusive of the Business Addresses associated to the account.

Request Message Description: SelfServiceAccountExecute

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

Node	Description
SelfServiceAccountExecute_Input	Container element for the Execute Operation request.
ListOfSSAccount	Corresponds to an instance of SS_Account_IO.
ListOfSSAccount/ Account	Set operation accordingly. If account details need to be updated, then set the operation to Update. If the business address needs to be added or updated, then set operation to Skipnode.
ListOfSSAccount/ Account /Id	Set the ID of the account as a ViewCriteria, if the purpose is to update the account or create and update business address for the given account.
ListOfSSAccount/ Account / ListOfAccountBusinessAddress	Container element to hold the list of business addresses to be created or updated for the account.
ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress	Used to create or update the business address of the Account. Set operation appropriately as Insert or Update and enable the IsPrimaryMVG setting, if this address needs to be made the primary address on the Account.
ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ Id	If the operation is update on AccountBusinessAddress, then set this field to the specific address of the account.
ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ StreetAddress (Similarly StreetAddress2, AddressLine3, State, City, County, Country)	Set appropriate values for the details of this address.
ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ MainAddressFlag	Set to TRUE if the address is the main address for the account.
ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ BillAddressFlag	Set TRUE if the address is the billable address for the account.
ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ ShipAddressFlag	Set TRUE to fetch if the address is the shippable address for the account.
ListOfSSAccount/ Account / ListOfAccountBusinessAddress/ AccountBusinessAddress/ ActiveStatus	Set to TRUE, if only the active addresses of the account need to be retrieved.
ListOfAccountBusinessAddress/ AccountBusinessAddress/ ModId	Set the ModId while updating, so as to make sure that the record is not updated in the interim.
ExecutionMode	For more information, see Business Processes and Rules: Siebel Enterprise Application Integration.
LOVLanguageMode	For more information, see Business Processes and Rules: Siebel Enterprise Application Integration.
ViewMode	For more information, see Business Processes and Rules: Siebel Enterprise Application Integration.

Response Message Description: SelfServiceAccountExecute

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

Node	Description
SelfServiceAccountExecute_Output	Container element for the Execute Operation response.
ListOfSSAccount	Corresponds to an instance of SS_Account_IO.
ListOfSSAccount/ Account	Account name.
ListOfSSAccount/ Account /Id	ID of the account.
ListOfSSAccount/ Account / Mod Id	Mod ID for the account record.
ListOfSSAccount/ Account / ListOfBusinessAddress	Container element for the list of created or updated business address of the account.
ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress	For each created or updated business address of the account.
ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ Id	ID of the address created or updated.
ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ ModId	ModId of the address record created or updated.

Request Message Description: SelfServiceAccountQueryPage

This operation is used to query the details of the Account or to query the list of business addresses associated with an account. This operation also retrieves the following information for a given account: primary address ID, primary Bill To Address ID, primary Ship To Address ID, as well as determining if each of the retrieved addresses are Billable or Shippable. Siebel Self-Service Applications version 8.1 use LOVLanguageMode as ‘LDC’ and ViewMode as ‘All’ for this Web service. For a description of this request message, see the following table.

Node	Description
SelfServiceAccountQueryPage_Input	Container element for the QueryPage Operation request.
ListOfSSAccount	Corresponds to an instance of SS_Account_IO.
ListOfSSAccount/ Account	Account name.
ListOfSSAccount/ Account /Id	Set the ID of the account as a ViewCriteria.
ListOfSSAccount/ Account / PrimaryAddressId	Empty. Used to fetch the ID of the primary address of the account.
ListOfSSAccount/ Account / PrimaryBillToAddressId	Empty. Used to fetch the ID of the Primary Bill To address of the account.
ListOfSSAccount/ Account / PrimaryShipToAddressId	Empty. Used to fetch the ID of the Primary Ship To address of the account.
ListOfSSAccount/ Account / ListOfBusinessAddress	To fetch the business address of the account.
ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress	Empty.
ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ Id	Empty (Set it to retrieve a specific address of this account).
ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ StreetAddress (Similarly StreetAddress2, AddressLine3, State, City, County, Country)	Empty. Set appropriate View Criteria for filtering addresses.
ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ MainAddressFlag	Empty. Used to fetch if the address is the main address for the account.
ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ BillAddressFlag	Empty. Used to fetch if the address is the Billable Address for the account.
ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ ShipAddressFlag	Empty. Used to fetch if the address is the Shippable Address for the account.
ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ ActiveStatus	Set to TRUE, only if the active addresses of the account need to be retrieved.
ListOfSSAccount/ Account /	Empty.
ListOfBusinessAddress/ BusinessAddress/ ModId	Empty. Used to fetch the ModId to be sent back while updating, so as to make sure that the record is not updated in the interim.
ExecutionMode	For more information, see Business Processes and Rules: Siebel Enterprise Application Integration.
LOVLanguageMode	For more information, see Business Processes and Rules: Siebel Enterprise Application Integration.
ViewMode	For more information, see Business Processes and Rules: Siebel Enterprise Application Integration.

Response Message Description: SelfServiceAccountQueryPage

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

Node	Description
SelfServiceAccountQueryPage_Output	Container element for the QueryPage Operation response.
ListOfSSAccount	Corresponds to an instance of SS_Account_IO.
ListOfSSAccount/ Account
ListOfSSAccount/ Account /Id	ID of the account.
ListOfSSAccount/ Account / PrimaryAddressId	Retrieved ID of the Primary Address of the account.
ListOfSSAccount/ Account / PrimaryBillToAddressId	Retrieved ID of the Primary Bill To address of the account.
ListOfSSAccount/ Account / PrimaryShipToAddressId	Retrieved ID of the Primary Ship To address of the account.
ListOfSSAccount/ Account / ListOfBusinessAddress	Container element for the retrieved Business Address of the account.
ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress	For each retrieved business address of the account.
ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ Id	ID of the address.
ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ StreetAddress (Similarly StreetAddress2, AddressLine3, State, City, County, Country)	Details of the business address.
ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ MainAddressFlag	True, if the address is the main Address for the account.
ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ BillAddressFlag	True, if the address is the Billable Address for the account.
ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ ShipAddressFlag	True, if the address is the Shippable Address for the account.
ListOfSSAccount/ Account / ListOfBusinessAddress/ BusinessAddress/ ActiveStatus	True, if the address is active.
ListOfBusinessAddress/ BusinessAddress/ ModId	Empty; to fetch the ModId to be sent back while updating, so as to make sure that the record is not updated in the interim.

SelfServiceAccount Application Interface

This topic describes the application objects called by this Web service. This Web service makes available the EAI UI business service SelfServiceAccount, which provides CRUD and query operations on the integration object SS_Account_IO. For more information on application implementation, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

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

Name	Boundary Object Type	Class
SelfServiceAccount	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
SS_Account_IO	SS_Account_IO

Example Package for SelfServiceAccount

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 (SelfServiceAccountExecute)

See the following file to view the sample code:

...\SelfServiceAccount\SelfServiceAccountExecute_request.xml

Response (SelfServiceAccountExecute)

See the following file to view the sample code:

...\SelfServiceAccount\SelfServiceAccountExecute_response.xml

Request (SelfServiceAccountQueryPage)

See the following file to view the sample code:

...\SelfServiceAccount\SelfServiceAccountQueryPage_request.xml

Response (SelfServiceAccountQueryPage)

See the following file to view the sample code:

...\SelfServiceAccount\SelfServiceAccountQueryPage_response.xml

Interface Description (WSDL) for SelfServiceAccount

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.

...\SelfServiceAccountQueryPage\SelfServiceAccount.wsdl

SelfServiceAccountRootPath

This Web service makes available the EAI UI business service SelfServiceAccountRootPath, which provides query operations on integration object SS_AccountRootPath_IO.

This Web service makes available the Query Method in the SelfServiceAccount business service as a Web service operation. In Siebel Self-Service Applications, version 8.1, this operation is used in the context of Global Accounts - Account Hierarchy. For a given account, this operation is used for retriving the path to the root account and also to fetch the price lists of the accounts along this path.

SelfServiceAccountRootPath Operations

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

Name	Description
SelfServiceAccountRootPathQueryPage	Performs a query operation based on the viewCriteria and searchSpec set on the instance of SS_AccountRootPath_IO provided as input. The response contains the list of accounts along the path to the root account and the priceList set for each of these accounts.

Request Message Description: SelfServiceAccountRootPathQueryPage

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

Node	Description
SelfServiceAccountRootPathQueryPage_Input	Container element for the QueryPage operation request.
ListOfSSAccountRootPath	Corresponds to an instance of SS_AccountRootPath_IO.
ListOfSSAccountRootPath /SSAccountRootPath	Container element, which holds the columns to be queried, and the criteria to be used.
ListOfSSAccountRootPath /SSAccountRootPath /ParPartyId	Empty.
ListOfSSAccountRootPath /SSAccountRootPath /PartyId	Empty.
ListOfSSAccountRootPath /SSAccountRootPath /PartyName	Empty.
ListOfSSAccountRootPath /SSAccountRootPath /PriceListId	Empty.
ListOfSSAccountRootPath /SSAccountRootPath /RelationTypeCode	Empty.
ListOfSSAccountRootPath /SSAccountRootPath /Level1PartyId	ID of the Account, from which the path to the root Account needs to be identified.
ExecutionMode	Forward only.
LOVLanguageMode	LDC.
ViewMode	All.

Response Message Description: SelfServiceAccountRootPathQueryPage

The response contains the details based on the query set on the Payment integration object .

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

Node	Description
SelfServiceAccountRootPathQueryPage_Output	Container element for the QueryPage Operation response.
ListOfSSAccountRootPath	Corresponds to an instance of SS_AccountRootPath_IO.
ListOfSSAccountRootPath /SSAccountRootPath	Container element, which corresponds to an Account that is present along the path to the root Account.
ListOfSSAccountRootPath /SSAccountRootPath /ParPartyId	If ParPartyId is null, the retrieved account is deemed as the root account. Otherwise, this account is one of the accounts in the path.
ListOfSSAccountRootPath /SSAccountRootPath /PartyId	ID of the retrieved account.
ListOfSSAccountRootPath /SSAccountRootPath /PartyName	Name of the retrieved account.
ListOfSSAccountRootPath /SSAccountRootPath /PriceListId	PriceListId of the retrieved account.
ListOfSSAccountRootPath /SSAccountRootPath /RelationTypeCode	SELF or DIRECT or INDIRECT.
ListOfSSAccountRootPath /SSAccountRootPath /Level1PartyId	DIRECT. The Account is the parent the Level1PartyId.

SelfServiceAccountRootPath Application Interface

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

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

Example Package for SelfServiceAccountRootPath

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:

...\SelfServiceAccountRootPath\SelfServiceAccountRootPath_request.xml

Response

See the following file to view the sample code:

Note: You need to filter out unnecessary SELF relationship records returned in this response.

...\SelfServiceAccountRootPath\SelfServiceAccountRootPath_response.xml

Interface Description (WSDL) for SelfServiceAccountRootPath

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.

...\SelfServiceAccountRootPath\SelfServiceAccountRootPath.wsdl

SelfServiceAllAccountsList

This Web service makes available the EAI UI business service SelfServiceAllAccountsList, which provides query operations on the integration object SS_AllAccount_List_IO.

This Web service make available the Query Method in the SelfServiceAllAccountsList Business Service as Web service operation. In Siebel Self-Service Applications version 8.1, this operation is used in the context of Global Accounts - Account Hierarchy. For a given root account, this operation is used for retriving all the children accounts that are directly or indirectly related to it, including itself.

SelfServiceAllAccountsList Operations

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

Name	Description
SelfServiceAllAccountsListQueryPage	Performs Query operation based on the viewCriteria (contains the Root Account ID) on the instance of SS_AllAccount_List_IO provided as input. The response contains the list of accounts that are related to the root account.

Request Message Description: SelfServiceAllAccountsListQueryPage

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

Node	Description	Type
SelfServiceAllAccountsListQueryPage_Input	Container element for the QueryPage Operation request.	String
ListOfSSAllAccount	Corresponds to an instance of SS_AllAccount_List_IO.	String
ListOfSSAllAccount /SSAllAccountList	Container element, which holds the columns to be queried, and the criteria to be used.	String
ListOfSSAllAccount /SSAllAccountList	Empty.	String
/ModId	Set the Root Account ID as the view criteria.	String
ListOfSSAllAccount /SSAllAccountList /ParentPartyId	Empty.	String
ListOfSSAllAccount /SSAllAccountList /RelationTypeCode ListOfSSAllAccount /SSAllAccountList /Level1AccountStatus /Level1ApprovalStatus Level1BusinessPhone Level1EmailAddress Level1FaxNumber Level1ParentPartyId Level1PartyLocation Level1PartyName Level1PriceListId Level1PrimaryAddressId Level1PrimaryBillToAddressId Level1PrimaryContactId Level1PrimaryShipToAddressId Level1Type	Empty	String
Level2ParentAccountName	Empty (Columns to be retrieved in the response)	String
ExecutionMode	Empty	String
LOVLanguageMode	ForwardOnly	String
ViewMode	LDC	String

Response Message Description: SelfServiceAllAccountsListQueryPage

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

Node	Description	Type
SelfServiceAllAccountsListQueryPage_Input	Container element for the QueryPage Operation response.	String
ListOfSSAllAccount	Corresponds to an instance of SS_AllAccount_List_IO.	String
ListOfSSAllAccount /SSAllAccountList /ModId	Container element, which holds the columns to be queried, and the criteria to be used.	String
ListOfSSAllAccount /SSAllAccountList /ParentPartyId	Empty.	String
ListOfSSAllAccount /SSAllAccountList /PartyId	AccountId of the child account.	String
ListOfSSAllAccount /SSAllAccountList /RelationTypeCode	Whether the child is directly or indirectly under this root account. Can be SELF, DIRECT or INDIRECT.	String
ListOfSSAllAccount /SSAllAccountList /Level1AccountStatus, Level1ApprovalStatus, Level1BusinessPhone, Level1EmailAddress, Level1FaxNumber, Level1PartyName, Level1PartyLocation, Level1PriceListId, Level1PrimaryAddressId, Level1PrimaryBillToAddressId, Level1PrimaryContactId, Level1PrimaryShipToAddressId, Level1Type	Retrieved details of the child account.	String
ListOfSSAllAccount /SSAllAccountList /Level1ParentPartyId	Immediate Parent of this child account. For accounts with RelationTypeCode as DIRECT, it matches the root account ID itelsef.	String
ListOfSSAllAccount /SSAllAccountList /Level2ParentAccountName	AccountName of the Immediate Parent of this child account.	String

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

Example Package for SelfServiceAllAccountsList

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:

...\SelfServiceAllAccountsList\SelfServiceAllAccountsList_request.xml

Response

See the following file to view the sample code:

...\SelfServiceAllAccountsList\SelfServiceAllAccountsList_response.xml

Interface Description (WSDL) for SelfServiceAllAccountsList

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.

...\SelfServiceAllAccountsList\SelfServiceAllAccountsList.wsdl

SelfServiceContact

This Web service makes available the EAI UI business service SelfServiceContact, which provides CRUD and query operations on the integration object SS_Contacts_IO.

This Web service makes available the Execute and Query Methods in the SelfServiceContact business service as Web service operations.

Note: Though most of the Contact and Account management activities can be performed using SelfServiceContact Web service, Siebel Self-Service Applications use the SelfServiceRegistration Web service, which also accepts an instance of the integration object SS_Contacts_IO. The SelfServiceRegistration Web service calls the SelfServiceRegistration workflow, which delegates the integration object to SelfServiceContact business service.

As a result, in Siebel Self-Service Applications, the SelfServiceContact Web service is most often used for the QueryPage operation.

SelfServiceContact Operations

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

Name

Description

SelfServiceContactExecute

Used to set the direction of a query on a business component. Valid values are ForwardOnly and Bidirectional. The default value is Bidirectional.

The ForwardOnly value is more efficient than Bidirectional, and is recommended in cases where you must process a large number of records in the forward direction only (such as for report generation). For operations that are likely to return more than 10000 records, use ForwardOnly to avoid errors.

For more information on executing queries, see the topic on the ExecuteQuery business component method in Siebel Object Interfaces Reference.

SelfServiceContactQueryPage

Performs a query operation based on the viewCriteria and searchSpec set on the instance of SS_Contacts_IO provided as input. This operation is used in Siebel Self-Service Applications version 8.1 for querying the details of the contact, inclusive of the Personal Addresses associated to the contact.

Request Message Description: SelfServiceContactExecute

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

Node	Description	Type
ExecutionMode	Used to set the direction of a query on a business component. Valid values are ForwardOnly and Bidirectional. The default value is Bidirectional. ForwardOnly is generally recommended over Bidirectional in cases where you must process a large number of records in the forward direction only (such as for report generation). For operations that are likely to return more than 10000 records it is recommended that you use ForwardOnly. For more information on executing queries, see the topic on the ExecuteQuery business component method in Integration Platform Technologies: Siebel Enterprise Application Integration.	View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library.
LOVLanguageMode	LIC Language Independent Code or LDC Language Dependent Code.	String
ViewMode	The default view mode is All. The visibility mode is applied to the business object. Valid values are: Manager, Sales Rep, Personal, Organization, Sub-Organization, Group, Catalog, and All. Note: The ViewMode user property used on the integration object has priority over the ViewMode method argument.	Complex Type
Contact	Corresponds to a record in SS_Contacts_IO. Set the operation accordingly. If Contact details require an update, or if child elements such as Personal Address are present, use the Update operation. Otherwise, set the operation to SkipNode.	String
Contact /Id	ID of the Contact. Set this if the mode on Contact node is Update or SkipNode.	String
Contact /ListOfAccount	Container element for the assigned accounts of this contact. If the mode on the Contact is Insert, then the accounts specified in this list are inserted and assigned to the newly created contact. If the mode on Contact is Skipnode, then accounts specified in this list are made as the only accounts assigned for this contact. All other existing assigned accounts are unassigned by default.	String
Contact /ListOfAccount/ Account	Contact account	String
Contact /ListOfAccount/ Account/ Name, PrimaryContactId, Type	Details of the assigned account.	String
Contact/ ListOfContactCommunicationAddress	Contact address.	String
Contact /ListOfContactCommunicationAddress /ContactCommunicationAddress / AlternateEmailAddress	Alternate email address value to be edited or created.	String
Contact /ListOfContactCommunicationAddress /ContactCommunicationAddress /CommunicationAddressId	ID of the alternate email address value to be edited; blank for adding new alternate email address.	String

Response Message Description: SelfServiceContactExecute

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

Node	Description	Type
SelfServiceContactExecute_Output	Container element for the Execute Operation request.	Complex Type
ListOfSSContact	Corresponds to an instance of SS_Contacts_IO.	View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library.
ListOfSSContact/Contact/Id, ModId	ID and ModId of Inserted, or Updated Contact Record.	String
ListOfSSContact/Contact/ListOfAccount/Account/Id, Mod Id	ID and ModId of Inserted, or Updated Account Record.	String
ListOfSSContact/Contact/ListOfCommunicationAddress/CommunicationAddress/Id, Mod Id	ID and ModId of Inserted, or Updated CommunicationAddress Record.	String

Request Message Description: SelfServiceContactQueryPage

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

Node	Description	Type
SelfServiceContactQueryPage_Input	Container element for the QueryPage Operation request.	Complex Type
ListOfSSContact	Corresponds to an instance of SS_Contacts_IO.	View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library.
ListOfSSContact/Contact	Set contact information.	Complex Type
Contact/ Id	Set the ID of the Contact as a ViewCriteria.	View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library.
Contact/ ModId	Retrieve and pass back while updating, to make sure that Contact record is not updated in the interim.	Complex Type
Contact/ FirstName, MiddleName, LastName, Status, EmailAddress, CellularPhone, HomePhone, FaxPhone, WorkPhone, TimeZoneId, EmailSRUpdatesFlag, SendPromotions	Empty (Columns to be retrieved).	View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library.
Contact/ LoginName, ApprovalStatus, ChallengeQuestion, ChallengeAnswer	Empty (Columns to be retrieved). These columns are related to the username information.	String
Contact/ PrimaryAccountName, PrimaryAddressId, PrimaryAddressName PrimaryPersonalAddressId	Empty (Columns to be retrieved).	String
Contact/ ListOfContactCommunicationAddress	Container element for the AlternateEmailAddress to be retrieved. Contact can have similar subnodes for querying PersonalAddress, Account and AccountBusinessAddress.	String
Contact /ListOfContactCommunicationAddress /ContactCommunicationAddress	Contact communications address.	String
Contact /ListOfContactCommunicationAddress /ContactCommunicationAddress /AlternateEmailAddress	Empty (Columns to be retrieved). Alternate Email Address of the contact.	String
Contact /ListOfContactCommunicationAddress /ContactCommunicationAddress /CommunicationAddressId	Empty (Columns to be retrieved). ID of the Alternate Email Address of the contact.	Complex Type
ExecutionMode	ForwardOnly.	View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library.
LOVLanguageMode	LIC Language Independent Code or LDC Language Dependent Code.	String
ViewMode	All.	Complex Type

Response Message Description: SelfServiceContactQueryPage

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

Node	Description	Type
SelfServiceContactQueryPage_Output	Container element for the QueryPage Operation response.	Complex Type
ListOfSSContact	Corresponds to an instance of SS_Contacts_IO.	View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library.
ListOfSSContact/Contact	Set contact information.	Complex Type
Contact/ Id	ID of the Contact being queried.	View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library.
Contact/ ModId	Container element for the QueryPage Operation response.	Complex Type
Contact/ FirstName, MiddleName, LastName, Status, EmailAddress, CellularPhone, HomePhone, FaxPhone, WorkPhone, TimeZoneId, EmailSRUpdatesFlag, SendPromotions	Primitive details of the contact. EmailSRUpdatesFlag and SendPromotions contain the preferences shown in Siebel Self-Service Applications version 8.1 Registration screens.	View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library.
Contact/ LoginName, ApprovalStatus, ChallengeQuestion, ChallengeAnswer	These nodes contain the values for the username information.	String
Contact/ PrimaryAccountName, PrimaryAddressId, PrimaryAddressName PrimaryPersonalAddressId	These nodes contain the values for the PrimaryAccountName, Primary BusinAddressId, Primary BusinessAddressName and PrimaryPersonalAddressId respectively.	String
Contact/ ListOfContactCommunicationAddress	Container element for the AlternateEmailAddress retrieved.	String
Contact /ListOfContactCommunicationAddress /ContactCommunicationAddress	Email address of the contact.	String
Contact /ListOfContactCommunicationAddress /ContactCommunicationAddress /AlternateEmailAddress	Alternate email address of the contact.	String
Contact /ListOfContactCommunicationAddress /ContactCommunicationAddress /CommunicationAddressId	ID of the alternate email address of the contact.	Complex Type
ExecutionMode	ForwardOnly.	View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library.
LOVLanguageMode	LDC.	String
ViewMode	All.	Complex Type

SelfServiceContact 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
SelfServiceContact	BusinessService	CSSEAIUIDataService

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SS_Contacts_IO	SS_Contacts_IO

Example Package for SelfServiceContact

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 (SelfServiceContactQueryPage)

See the following file to view the sample code:

...\SelfServiceContact\SelfServiceContactQueryPage_request.xml

Response (SelfServiceContactQueryPage)

See the following file to view the sample code:

...\SelfServiceContact\SelfServiceContactQueryPage_request.xml

Request (SelfServiceContactExecute)

See the following file to view the sample code:

...\SelfServiceContact\SelfServiceContactExecute_request.xml

Response (SelfServiceContactExecute)

See the following file to view the sample code:

...\SelfServiceContact\SelfServiceContactExecute_request.xml

Interface Description (WSDL) for SelfServiceContact

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.

...\SelfServiceContact\SelfServiceContact.wsdl

SelfServicePaymentHistory

This Web service queries the Payment History details as specified by the search criteria for any contact logged into the application. Payment details like Payment type, Payment profile, transaction amount, type and date for different orders against which the payment was made by a contact can be queried.

SelfServicePaymentHistory Operations

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

Name	Description
SelfServicePaymentHistoryQueryPage	Performs query operations set on the SS_PaymentHistory_IO Integration Object as the input.this method is used for querying the payment details for different orders performed by a contact.

Request Message Description: SelfServicePaymentHistoryQueryPage

Based on the query criteria set on the integration object, payment related details like the payment profile details, transaction amount, type and date along with the order numbers can be queried. For a description of this request message, see the following table.

Node	Description	Type
SelfServicePaymentHistoryQueryPage_Input	The method arguments are Payment Integration Object, Language Mode (value is LDC) and viewMode (All).	Integration Object

Response Message Description: SelfServicePaymentHistoryQueryPage

The response contains the details based on the query set on the Payment Integration Object. For a description of this response message, see the following table.

Node	Description	Type
SelfServicePaymentHistoryQueryPage_Output	Integration Object	The retrieved data for the query performed.

SelfServicePaymentHistory Application Interface

This Web service makes available the EAI UI business service SelfServicePaymentHistory, which provides update and query operations on the integration object SS_PaymentHistory_IO. For more information on application implementation, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

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

Name	Boundary Object Type	Class
SelfServicePaymentHistory	Integration Object	CSSEAIUIDataService

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SS_PaymentHistory_IO	Payments

Example Package for SelfServicePaymentHistory

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:

...\SelfServicePaymentHistory\SelfServicePaymentHistoryRequest.xml

Response

See the following file to view the sample code:

...\SelfServicePaymentHistory\SelfServicePaymentHistoryResponse.xml

Interface Description (WSDL) for SelfServicePaymentHistory

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.

...\SelfServicePaymentHistory\SelfServicePaymentHistory.wsdl

SelfServicePostLoginProcess

This Web service makes available the SelfServicePostLoginProcess workflow as LoadUserDetails operation. The response of this Web service is determined by the P_Mode request parameter, as displayed in P_Mode Request Parameter.

P_Mode Request Parameter

For a description of the P_Mode request parameter, see the following table.

P_Mode	Response
OnlyLoadResponsibilities	Returns only the responsibilities for the given user name.
SkipLoadResponsibilities	Returns only the contact details for the given user name.
LoadEverything	Returns both the contact details and responsibilities for the given user name.

SelfServicePostLoginProcess Operations

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

Name	Description
LoadUserDetails	This operation triggers the SelfServicePostLoginProcess workflow.

Request Message Description: LoadUserDetails

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

Node	Description	Type
P_Mode	For a description, see P_Mode Request Parameter.	String
ListOfSSContact	An SS_Contact_IO instance, where in ListOfSSContact/Contact/LoginName contains the username of the user for whom the details need to be retrieved.	Integration Object
P_LoginName	Refer to the SelfServiceContact.doc for the details on ListOfContact and its subnodes.	String
getUserResponsibilitiesResponse	Username of the user for whom the details need to be retrieved.	Complex Type
getUserResponsibilitiesResponse /listOfUserResponsibilities/	Container element for Responsibilities. Maps to an instance of getUserResponsibilitiesResponse integration object.	View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library.

Response Message Description: LoadUserDetails

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

Node	Description	Type
LoadUserDetails_Output	Container element for the LoadUserDetails operation response.	Complex Type
ListOfSSContact	An SS_Contact_IO instance, where in ListOfSSContact/Contact/Id contains the contactId of the user for whom the details are retrieved.	View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library.
getUserResponsibilitiesResponse	Refer to the SelfServiceContact.doc for the other nodes in ListOfContact and its complex subnodes, like Account and PersonalAddress, which will have the retrieved accounts(assigned) and PersonalAddress of the contact respectively.	Complex Type
getUserResponsibilitiesResponse /listOfUserResponsibilities/ userResponsibilities/ responsibilityValue	Will be blank when mode is SkipLoadResponsibilities.	View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library.
Error_spcCode	Name of the Responsibility.	Complex Type
Error_spcMessage	Error Code returned by the Workflow.	View the WSDL by clicking the Related Files link next to the link for Siebel CRM Web Services Reference on the Siebel documentation library.

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

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SelfServiceContact	SelfServiceContact
getUserResponsibilitiesResponse	getUserResponsibilitiesResponse

Example Package for SelfServicePostLoginProcess

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 (LoadUserDetails_OnlyLoadResponsibilities)

See the following file to view the sample code:

...\SelfServicePostLoginProcess\LoadUserDetails_OnlyLoadResponsibilities_request.xml

Response (LoadUserDetails_OnlyLoadResponsibilities)

See the following file to view the sample code:

...\SelfServicePostLoginProcess\LoadUserDetails_OnlyLoadResponsibilities_response.xml

Request (LoadUserDetails_SkipLoadResponsibilities)

See the following file to view the sample code:

...\SelfServicePostLoginProcess\LoadUserDetails_SkipLoadResponsibilities_request.xml

Response (LoadUserDetails_SkipLoadResponsibilities)

See the following file to view the sample code:

...\SelfServicePostLoginProcess\LoadUserDetails_SkipLoadResponsibilities_response.xml

Interface Description (WSDL) for SelfServicePostLoginProcess

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.

...\SelfServicePostLoginProcess\SelfServicePostLoginProcess.wsdl

SelfServiceRegistration

The Enroll operation of this Web service invokes the SelfServiceRegistration workflow, which internally uses the business services listed in this topic to manage contacts, assigned accounts, assigned personal, or business addresses, create user names, manage assigned responsibilities, send welcome or password update notifications and create Inbox Items to simulate pending registration approvals.

Activity of the workflow is determined by the P_mode input parameter passed to this Web service operation.

P_Mode Request Parameter

For a description of the P_Mode request parameter, see the following table.

P_Mode	Response
CreateContact	Used for creating a contact without a username. Used in Siebel Self-ServiceSelf-Service Applications version 8.1 for contact creation in the Contacts, Administration screen, and other usages in the Contacts, Profile, and the Contacts, Account views.
UpdateContact	Used for updating a contact without a username. Used in Siebel Self-Service Applications version 8.1 in the Contacts, Administration screen, and the Contacts, Profile, and Contacts , Account views. Also used for Personal Info updating from Contacts, Profile view.
CreateUser	Creates a new contact, and a username in the associated LDAP directory, then assigns responsibilities, sends a welcome a notification to the user, and then creates an inbox item for the administrator, if approval is needed. Need to pass the Usertype details (like approval required), notification template, inbox and approval types, when the mode is CreateUser. Used in Siebel Self-Service Applications version 8.1 for making a contact as a user in the Contacts - Administration screen. Also used for all self-service registrations.
UpdateUser	Used for updating a contact with a username and manage the assigned accounts and responsibilities. Used in Siebel Self-Service Applications version 8.1 in the Contacts - Administration screen to update user information.
ResetPasswordOnly	Used for resetting the password of the currently logged in user of the Siebel application session or in the anonymous session. Also used in Forgot Password Flow (for an anonymous session).

SelfServiceRegistration Operations

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

Name	Description
Enroll	Internally calls the business services listed in Business Services Called by Enroll Operation.

Business Services Called by Enroll Operation

The following business services are called by the Enroll operation:

EAITransactionService Business Service
SelfServiceContact Business Service
PRM ANI Utility Service Business Service
PRM ANI Utility Service Business Service
SiebelWebRegistrationService Business Service
Self-Service User Business Service
EAITransactionService Business Service
ISS Approval Bus Service Business Service
Outbound Communications Manager Business Service
SessionAccessService Business Service
Response Message Description: CreateContact

EAITransactionService Business Service

For a description of this business service, see the following table.

Step, Name, Method	Description
Business Service Step	Begin Transaction
Business Service Name	EAITransactionService
Business Service Method	Begin Transaction
Description	This step is used to initiate a transaction. BeginTransaction will not take any parameters as input.

SelfServiceContact Business Service

For a description of this business service, see the following tables.

Step, Name, Method	Description
Business Service Step	Create, and update contact and account records
Business Service Name	SelfServiceContact
Business Service Method	Execute
Description	This step is used to create or update Contact, Account, Contact Address, Contact_Account relationships and Alternate Communication Address. The Contact integration object with appropriate action specified at the request elements is prepared in the java layer and passed as a Process Property to the workflow. This step executes an EAIUI Service to execute the operations specified at each step in the integration object and returns a ContactIO with the ids specified for each step. Sample SOAP request portions of SS_Contacts_IO are shown in the following subtopics.

The input arguments for Self-ServiceSelf-Service Contact Business Service are shown in the following table.

Argument Name	Type	Property Name
SiebelMessageIn	Process Property	P_ContactIO(SS_Contacts_IO)
ViewMode	Process Property	All
LanguageMode	Process Property	LDC
ExecutionMode	Process Property	BiDirectional

The output arguments for Self-ServiceSelf-Service Contact Business Service are shown in the following table.

Argument Name	Type	Property Name
SiebelMessageOut	Output Argument	P_ContactIO(SS_Contacts_IO)

PRM ANI Utility Service Business Service

For a description of this business service, see the following tables.

Step, Name, Method	Description
Business Service Step	Retrieve Contact ID
Business Service Name	PRM ANI Utility Service
Business Service Method	GetProperty
Description	This step is used to retrieve the contact ID, given the contact IO. In Siebel Self-Service Applications version 8.1, this step is only applicable during the Register your company flow to retrieve the ID of the newly created corporate account, which is then sent to Trigger Approval, and established as the root account. Hence, the caller (java API that calls the proxy) shall ignore the errors reported by this step.

The input arguments for PRM ANI Utility Service Business Service are shown in the following table.

Argument Name	Type	Property Name
Hierarchy Path:	Literal	Contact
Property Name	Literal	ID
SiebelMessage	Hierarchy	P_ContactIO(SS_Contacts_IO)

The output arguments for PRM ANI Utility Service Business Service are shown in the following table.

Argument Name	Type	Property Name
Property Value	Output Argument	P_ContactId

PRM ANI Utility Service Business Service

For a description of this business service, see the following tables

Step, Name, Method	Description
Business Service Step	Retrieve Account ID (called only when accountId Process Property is null)
Business Service Name	PRM ANI Utility Service
Business Service Method	GetProperty
Description	This step is used to retrieve the account ID, given the contact IO. In Siebel Self-Service Applications version 8.1, this step is only applicable during the Register your company flow to retrieve the ID of the newly created corporate account, which is then sent to Trigger Approval, and established as the root account. Hence, the caller (java API that calls the proxy) shall ignore the errors reported by this step.

The input arguments for PRM ANI Utility Service Business Service are shown in the following table.

Argument Name	Type	Property Name
Hierarchy Path:	Literal	Contact
Property Name	Literal	Account ID
SiebelMessage	Hierarchy	P_ContactIO (SS_Contacts_IO)

The output arguments for PRM ANI Utility Service Business Service are shown in the following table.

Argument Name	Type	Property Name
Property Value	Output Argument	AccountId

SiebelWebRegistrationService Business Service

For a description of this business service, see the following tables.

Step, Name, Method	Description
Business Service Step	Create User
Business Service Name	SiebelWebRegistrationService
Business Service Method	Promote
Description	This step executes the SiebelWebRegistrationService business service to create a Web_User for the given contactid. The business service needs to create Web Channel User of Web User Type, LDAP user record, S_USER record and also update the security question and answer.

The input arguments for SiebelWebRegistrationService Business Service are shown in the following table.

Argument Name	Type	Property Name
Contactid	Process Property	P_ContactId
Type	Process Property	P_Usertype
Proxy User	Process Property	P_ProxyEmpLoginName
LoginName	Process Property	P_LoginName
Password	Process Property	P_NewPassword
securityQuestion	Process Property	P_ChallengeQuestion
securityAnswer	Process Property	P_ChallengeAnswer

The output arguments for SiebelWebRegistrationService Business Service are shown in the following table.

Argument Name	Type	Property Name
SuccessCode	Output Argument	P_CreateUserStatus
ErrorMessage	Output Argument	Error Message

Self-Service User Business Service

For a description of this business service, see the following tables.

Step, Name, Method	Description
Business Service Step	Assign Responsibilities
Business Service Name	SelfServiceUser
Business Service Method	Execute
Description	This step is used to create the responsibilities in the Siebel database. It uses a new EAIUI Service named SelfServiceUser that creates the S_PER_RESP records for the given user ID and the responsibility ID.

The input arguments for Self-Service User Business Service are shown in the following table.

Argument Name	Type	Property Name
SiebelMessageIn	Process Property	P_UserIO
ViewMode	Process Property	All
LanguageMode	Process Property	LDC

The output arguments for Self-Service User Business Service are shown in the following table.

Argument Name	Type	Property Name
SiebelMessageOut	Output Argument	P_UserIO

EAITransactionService Business Service

For a description of this business service, see the following tables.

Step, Name, Method	Description
Business Service Step	Commit Transaction
Business Service Name	EAITransactionService
Business Service Method	EndTransaction
Description	This step uses EAITransactionService. EndTransaction to commit the transaction. The parameter Is Abort need be set to False to commit the transaction.

The input arguments for EAITransactionService Business Service are shown in the following table.

Argument Name	Type	Property Name
Is Abort	Literal	False

ISS Approval Bus Service Business Service

For a description of this business service, see the following tables.

Step, Name, Method	Description
Business Service Step	Trigger Approval
Business Service Name	ISS Approval Bus Service
Business Service Method	CreateNewApprovalTasks
Description	This step uses ISS Approval Bus Service. CreateNewApprovalTasks business service method to create new Inbox Items based on the Inbox Type and Approval Types specified. This step is executed only if approval is required by the user type, based on the P_UsertypeApprovalRequd process property. Note that P_AccountId contains the root account of the corporate account under which the contact, or user is being created. Hence, for newly created corporate account (Register your company flow), P_AccountId is set to the ID of the newly created account. For more information, see Siebel Self-Service Application Developer's Guide.

The input arguments for ISS Approval Bus Service Business Service are shown in the following table.

Argument Name	Type	Property Name
RequestingBusComp	Literal	Value = Contact
Approval Item ID	Process Property	P_ContactId
Approval Level Name	Process Property	P_UsertypeApprovalType
Inbox Type	Process Property	P_UsertypeInboxType
Approval Level Context	Process Property	P_AccountId

Outbound Communications Manager Business Service

For a description of this business service, see the following tables.

Step, Name, Method	Description
Business Service Step	Trigger Notification
Business Service Name	Outbound Communications Manager
Business Service Method	CreateRequest
Description	This step is used to trigger the notification based on the notification template specified, using the Outbound Communications Manager. CreateRequest. This business service method substitutes the necessary values from the Contact business component which is loaded for the ID specified. For more information, see Siebel Self-Service Application Developer's Guide.

The input arguments for Outbound Communications Manager Business Service are shown in the following table.

Argument Name	Type	Property Name
RecipientBusComp	Literal	Not applicable
SourceIdList	Process Property	P_ContactId
PackageNameList	Process Property	P_NotificationTemplateName
RequestLanguageCode	Process Property	P_Language
RequestLocaleCode	Process Property	P_Locale
ProcessMode	Literal	Not applicable
RequestName	Literal	Not applicable
RecipientGroup	Process Property	Not applicable

SessionAccessService Business Service

For a description of this business service, see the following tables.

Step, Name, Method	Description
Business Service Step	Set new password in Siebel session
Business Service Name	SessionAccessService
Business Service Method	SetProfileAttr
Description	This business service is used to set the password in a Siebel CRM session. For more information, see Siebel Self-Service Application Developer's Guide.

The Input Arguments for SessionAccessService Business Service are shown in the following table.

Argument Name	Type	Property Name
Name	Literal	Not applicable
Value	Process Property	P_NewPassword
PackageNameList	Process Property	P_NotificationTemplateName
RequestLanguageCode	Process Property	P_Language
RequestLocaleCode	Process Property	P_Locale
ProcessMode	Literal	Not applicable
RequestName	Literal	Not applicable
RecipientGroup	Process Property	Not applicable

Response Message Description: CreateContact

For a description of this business service, see the following table.

Node	Description	Type
Process_spcInstance_spcId	Not of consequence in response.	String
Object_spcId	Not of consequence in response.	String
Siebel_spcOperation_spcObject_spcId	Not of consequence in response.	String
Error_spcCode	Not of consequence in response.	String
Error_spcMessage	Not of consequence in response.	String
ListOfSSContact	Contains an instance of the output integration object SS_Contacts_IO that holds the ID and ModId of the contact, and or account that is created or updated. See SelfServiceContact for more information on the Structure and subnodes of ListOfSSContact. Maps to the P_ContactIO process property in the workflow.	Integration Object
P_ContactId	Not of consequence in response.	String
P_AccountId	Derived Root Account ID For more information, see Siebel Self-Service Application Developer's Guide on the Siebel Bookshelf.	String
P_DefaultOrgId	Not of consequence in response.	String
P_Mode	Not of consequence in response.	String
P_Usertype	Not of consequence in response.	String
P_LoginName	Username created	String
P_DefaultProxyEmployee	Not of consequence in response.	String
P_LoginId	Value returned by SiebelWebRegistration business service.	String
P_CreateUserStatus	The status set on the newly created user. Inactive, for pending users.	String
P_Password	Not of consequence in response.	String
P_NewPassword	Not of consequence in response.	String
P_ChallengeQuestion	Not of consequence in response.	String
P_ChallengeAnswer	Not of consequence in response.	String
ListOfSSUser	Contains an instance of the input integration object Users that holds the ID and Mode ID of the user-responsibility mapping for the updated responsibility assignments. See SelfServiceUser for more information on the structure and subnodes of ListOfSSUser. Maps to the P_UserIO process property in the workflow.	Integration Object
P_UsertypeApprovalRequd	Not of consequence in response.	String
P_UsertypeApprovalType	Not of consequence in response.	String
P_UsertypeInboxType	Not of consequence in response.	String
P_UsertypeNotifTemplateName	Not of consequence in response.	String
P_RecipientGroup	Not of consequence in response.	String
P_Language	Not of consequence in response.	String
P_Locale	Not of consequence in response.	String

Self-Service Registration 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
SelfServiceRegistration	Workflow

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SelfServiceContact	SelfServiceContact
Users	Users

Example Package for SelfServiceRegistration

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 and Response Samples are provided for the following scenarios:

Create a B2C contact and a user name and trigger notification.
Create a B2B contact as Inactive and create a user name and trigger notification and create Inbox Items for approval.
Update Personal addresses of an existing Contact.
Update Contact details, Account Assignments, Responsibility Assignments, Password resetting for an existing contact.

Request

Create a B2C contact and user name and trigger notification.

See the following file to view the sample code:

...\SelfServiceRegistration\SelfServiceRegistration_1_request.xml

Response

Create a B2C contact and user name and trigger notification.

See the following file to view the sample code:

...\SelfServiceRegistration\SelfServiceRegistration_1_request.xml

Request

Create a B2B contact as Inactive and create a user name and trigger notification and create Inbox Items for approval.

See the following file to view the sample code:

...\SelfServiceRegistration\SelfServiceRegistration_2_request.xml

Response

Create a B2B contact as Inactive and create a user name and trigger notification and create Inbox Items for approval.

See the following file to view the sample code:

...\SelfServiceRegistration\SelfServiceRegistration_2_response.xml

Request

Update Personal Addresses of an existing contact.

See the following file to view the sample code:

...\SelfServiceRegistration\SelfServiceRegistration_3_request.xml

Response

Update Personal Addresses of an existing contact.

See the following file to view the sample code:

...\SelfServiceRegistration\SelfServiceRegistration_3\_response.xml

Request

Update Contact Details, Account Assignment, Responsibility Assignment, Password resetting for an existing contact.

See the following file to view the sample code:

...\SelfServiceRegistration\SelfServiceRegistration_4_request.xml

Response

Update Contact Details, Account Assignment, Responsibility Assignment, Password resetting for an existing contact

See the following file to view the sample code:

...\SelfServiceRegistration\SelfServiceRegistration_4_response.xml

Interface Description (WSDL) for SelfServiceRegistration

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.

...\SelfServiceRegistration\SelfServiceRegistration.wsdl

SelfServiceResponsibility

This Web service makes available the EAI UI business service SelfServiceResponsibility, which provides a query operation on the integration object SS_Responsibility_IO. Additionally, this Web service makes available the Query Method in the SelfServiceResponsibility business service as a Web service operation.

SelfServiceResponsibility Operations

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

Name

Description

SelfServiceResponsibilityQueryPage

Performs Query operation based on the view criteria and search specification set on the instance of SS_Responsibility_IO provided as input.

This operation is used in Siebel Self-Service Applications version 8.1 for retrieving the ID and Name of Web Enabled Responsibilities.

Request Message Description: SelfServiceResponsibilityQueryPage

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

Node	Description
SelfServiceResponsibilityQueryPage_Input	Container element for SelfServiceResponsibility Web service input for QueryPage operation.
ListOfSSResponsibility	Container element for the list of SS_Responsibility_IO. Corresponds to an SS_Responsibility_IO integration object.
ListOfSSResponsibility/Responsibility	Corresponds to the primary integration component Responsibility.
ListOfSSResponsibility/Responsibility/AccessType	Set to Yes, for retrieving only Web Enabled Responsibilities.
ListOfSSResponsibility/Responsibility/Id	Empty; Placeholder for the ID of the responsibility to be retrieved.
ListOfSSResponsibility/Responsibility/Name	Empty; Placeholder for the name of the responsibility to be retrieved.

Response Message Description: SelfServiceResponsibilityQueryPage

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

Node	Description
SelfServiceResponsibilityQueryPage_Output	Container element for SelfServiceResponsibility Web service output for QueryPage operation.
ListOfSSResponsibility	Container element for the list of SS_Responsibility_IO. Corresponds to an SS_Responsibility_IO integration object.
ListOfSSResponsibility/Responsibility	Corresponds to the primary Integration component Responsibility.
ListOfSSResponsibility/Responsibility/AccessType	Yes for Web Enabled Responsibility.
ListOfSSResponsibility/Responsibility/Id	Retrieved ID of the responsibility.
ListOfSSResponsibility/Responsibility/Name	Retrieved name of the responsibility.

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

Example Package for SelfServiceResponsibility

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:

...\SelfServiceResponsibility\SelfServiceResponsibility_request.xml

Response

See the following file to view the sample code:

...\SelfServiceResponsibility\SelfServiceResponsibility_response.xml

Interface Description (WSDL) for SelfServiceResponsibility

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.

...\SelfServiceResponsibility\SelfServiceResponsibility.wsdl

SelfServiceSmtpEmail

The SendSmtpEmail operation of this Web service invokes the SelfServiceSmtpEmail workflow, which internally uses the Outbound Communications Manager business service for sending non-template based SMTP email.

SelfServiceSmtpEmail Operations

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

Name	Description
SendSmtpEmail	Invokes the SelfServiceSmtpEmail workflow.

Request Message Description: SendSmtpEmail

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

Node	Description	Type
FromAddress	Email address of the sender.	String
MessageToList	Semicolon-separated list of email addresses for the TO line.	String
MessageCCList	Semicolon-separated list of email addresses for the CC line.	String
MessageBCCList	Semicolon-separated list of email addresses for the BCC line.	String
MessageSubject	Descriptive subject line for the message.	String
MessageBody	Message content in plain-text.	String
MessageHTMLBody	Message content in HTML. This parameter when specified would override the parameter MessageBody.	String
Error Code	Error code, if any.	String
Error Message	Error message, if any.	String
Object Id	Object ID.	String
Process Instance Id	ID of process instance.	String
Siebel Operation Object Id	ID of Siebel operation.	String

Response Message Description: SendSmtpEmail

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

Node	Description	Type
FromAddress	Not of consequence in response.	String
MessageToList	Not of consequence in response.	String
MessageCCList	Not of consequence in response.	String
MessageBCCList	Not of consequence in response.	String
MessageSubject	Not of consequence in response.	String
MessageBody	Not of consequence in response.	String
MessageHTMLBody	Not of consequence in response.	String
Error Code	Error code, if any, for exceptions raised while submitting the request. This is automatically set from the workflow.	String
Error Message	Error details, if any, for exceptions raised while submitting the request. This is automatically set from the workflow.	String
Object Id	Standard WF Output.	String
Process Instance Id	Standard WF Output.	String
Siebel Operation Object Id	Standard WF Output.	String

SelfServiceSmtpEmail 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
SelfServiceSmtpEmail	Workflow Process

Example Package for SelfServiceSmtpEmail

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:

...\SelfServiceSmtpEmail\SelfServiceSmtpEmail_request.xml

Response

See the following file to view the sample code:

...\SelfServiceSmtpEmail\SelfServiceSmtpEmail_response.xml

Interface Description (WSDL) for SelfServiceSmtpEmail

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.

...\SelfServiceSmtpEmail\SelfServiceSmtpEmail.wsdl

SelfServiceTemplateEmail

The SendTemplateEmail operation of this Web Service invokes the SelfServiceTemplateEmail workflow, which internally uses the Outbound Communications Manager business service for sending template based SMTP email.

SelfServiceTemplateEmail Operations

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

Name	Description
SendTemplateEmail	Invokes the SelfServiceTemplateEmail workflow.

Request Message Description: SendTemplateEmail

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

Node	Description	Type
TemplateName	The communication template name to be used in the request.	String
SourceRecipientGroupName	The source recipient group name. Either the name of Siebel-seeded recipient group or a custom one.	String
SourceObjectID	ROW_ID of the source object component of the recipient group. This would determine the data retrieved for processing the template and recipient address for the email.	String
TemplateLanguageCode	Language code the template. A template must exist with the name and language combination specified. Defaulting is not recommended.	String
TemplateLocaleCode	Locale code the template. A template must exist with the name and locale combination specified. Defaulting is not recommended.	String
RequestName	An optional string that would help trace the outbound communication requests at the server side.	String
RequestStatus	Status code for the outbound request placed.	String
Error Code	None	String
Error Message	None	String
Object Id	None	String
Process Instance Id	None	String
Siebel Operation Object Id	None	String

Response Message Description: SendTemplateEmail

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

Node	Description	Type
TemplateName	Not of consequence in response.	String
SourceRecipientGroupName	Not of consequence in response.	String
SourceObjectID	Not of consequence in response.	String
TemplateLanguageCode	Not of consequence in response.	String
TemplateLocaleCode	Not of consequence in response.	String
RequestName	Not of consequence in response.	String
RequestStatus	Not of consequence in response.	String
Error Code	Error code, if any, for exceptions raised while submitting the request. This is automatically set from the workflow.	String
Error Message	Error details, if any, for exceptions raised while submitting the request. This is automatically set from the workflow.	String
Object Id	Standard WF Output.	String
Process Instance Id	Standard WF Output.	String
Siebel Operation Object Id	Standard WF Output.	String

SelfServiceTemplateEmail 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
SelfServiceTemplateEmail	Workflow Process

Data Object (Integration Object)

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

Siebel Repository Name	External Name
Not applicable	Not applicable

Example Package for SelfServiceTemplateEmail

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:

...\SelfServiceTemplateEmail\SelfServiceTemplateEmail_request.xml

Response

See the following file to view the sample code:

...\SelfServiceTemplateEmail\SelfServiceTemplateEmail_response.xml

Interface Description (WSDL) for SelfServiceTemplateEmail

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.

...\SelfServiceTemplateEmail\SelfServiceTemplateEmail.wsdl

SelfServiceTimeZone

Use this Web service to retrieve all the Siebel time zone values. These values are retrieved in the session language if it is a locale that is supported by Siebel CRM. If not, the values are retrieved in the base language. The language is set using the search specification.

SelfServiceTimeZone Operations

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

Name	Description
SelfServiceTimeZoneQueryPage	Performs query operations based on the search specification set on the language as input. This operation is used to get the Siebel time zone values based on the language which is set in the search specification.

Request Message Description:SelfServiceTimeZoneQueryPage

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

Node	Description	Type
SelfServiceTimeZoneQueryPage_Input	The method arguments are the TimeZone integration object with query parameters set, Language Mode as LDC and viewMode (All).	Integration Object

Response Message Description: SelfServiceTimeZoneQueryPage

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

Node	Description	Type
SelfServiceTimeZoneQueryPage_Output	The list of the time zone values that are returned in the language that is set in the search specification.	Integration Object

SelfServiceTimeZone Application Interface

This topic describes the application objects called by the SelfServiceTimeZone. This Web service makes available the business service SelfServiceTimeZone which provides query operation on the integration object SS_TimeZone_IO.

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
SelfServiceTimeZone	Integration Object	CSSEAIUIDataService

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SS_TimeZone_IO	Time Zone

Example Package for SelfServiceTimeZone

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:

...\SelfServiceTimeZone\SelfServiceTimeZone_request.xml

Response

See the following file to view the sample code:

...\SelfServiceTimeZone\SelfServiceTimeZone\_response.xml

Interface Description (WSDL) for SelfServiceTimeZone

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.

...\SelfServiceTimeZone\SelfServiceTimeZone.wsdl

SelfServiceUser

This Web service makes available the EAI UI business service SelfServiceUser, which provides CRUD and query operations on the integration object Users. Additionally, this Web service makes available the Execute and Query methods in the SelfServiceUser business service as Web service operations.

SelfServiceUser Operations

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

Name

Description

SelfServiceUserExecute

Performs CRUD operations on the instance of the Users integration object provided as input.

Though Siebel Self-Service Applications, version 8.1 do not use this Web service operation for managing responsibilities of a user, the SelfServiceRegistration Workflow used instead, uses the same business service (SelfServiceUser) internally.

SelfServiceUserQueryPage

Performs Query operation based on the view criteria and search specifcations set on the instance of Users integration object provided as input.

This operation is used in Siebel Self-Service Applications, version 8.1 for retrieving the responsibilities of the users in delegated administration.

Request Message Description:SelfServiceUserExecute

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

Node	Description
SelfServiceUserExecute_Input	Container element for SelfServiceUser Web service input for Execute operation.
ListOfSSUser	Container element for the list of users. Corresponds to a User integration object.
ListOfSSUser/User	Corresponds to the primary integration component User. Set the mode as skipnode for adding, or removing responsibilities of the user.
ListOfSSUser/User/LoginName	Set the user name for which the associated responsibilities need to be reset.
ListOfSSUser/User/ ListOfSSUserResponsibility	Container element for User_Responsibility integration component.
ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility	Corresponds to the User_Responsibility integration component. Represents a responsibility association, for each responsibility to be added and or retained with the user. Earlier assigned responsibilities that are not listed here are deleted by default.
ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Id	Set the ID of the responsibility to be assigned and or retained to the user.

Response Message Description: SelfServiceUserExecute

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

Node	Description
SelfServiceUserExecute_Output	Container element for SelfServiceUser Web service output for Execute operation.
ListOfSSUser	Container element for the list of Users. Corresponds to a Users integration object.
ListOfSSUser/User	Corresponds to the primary integration component User.
ListOfSSUser/User/LoginName	User name for which the assigned responsibilities are updated.
ListOfSSUser/User/ ListOfSSUserResponsibility	Container element for User_Responsibility integration component.
ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility	Corresponds to the User_Responsibility integration component. Each entry represents a responsibility assigned to the user.
ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Id	ID of the responsibility assigned to the user.

Request Message Description: SelfServiceUserQueryPage

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

Node	Description
SelfServiceUserQueryPage_Input	Container element for SelfServiceUser Web service input for QueryPage operation.
ListOfSSUser	Container element for the list of Users. Corresponds to a Users integration object.
ListOfSSUser/User	Corresponds to the primary integration component User.
ListOfSSUser/User/LoginName	Set the Username for which the associated responsibilities needs to be loaded.
ListOfSSUser/User/ ListOfSSUserResponsibility	Container element for User_Responsibility integration component.
ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility	Corresponds to the User_Responsibility integration component. Represents a responsibility associated to the user.
ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Id	Empty; to query the ID of the responsibility assigned to the user.
ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Responsibility	Empty; to query the Name of the responsibility assigned to the user.

Response Message Description: SelfServiceUserQueryPage

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

Node	Description
SelfServiceUserQueryPage_Output	Container element for SelfServiceUser Web service output for QueryPage operation.
ListOfSSUser	Container element for the list of Users. Corresponds to a Users integration object.
ListOfSSUser/User	Corresponds to the primary integration component User.
ListOfSSUser/User/LoginName	User name for which the assigned responsibilities are retrieved.
ListOfSSUser/User/ ListOfSSUserResponsibility	Container element for User_Responsibility integration component.
ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility	Corresponds to the User_Responsibility integration component. Each entry represents a responsibility assigned to the user.
ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Id	ID of the responsibility assigned to the user.
ListOfSSUser/User/ ListOfSSUserResponsibility/ SSUserResponsibility/Responsibility	Name of the responsibility assigned to the user.

SelfServiceUser 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
SelfServiceUser	BusinessService	CSSEAIUIDataService

Data Object (Integration Object)

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

Siebel Repository Name	External Name
Users	Users

Example Package for SelfServiceUser

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:

...\SelfServiceUser\SelfServiceUser_request.xml

Response

See the following file to view the sample code:

...\SelfServiceUser\SelfServiceUser_response.xml

Interface Description (WSDL) for SelfServiceUser

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.

...\SelfServiceUser\SelfServiceUser.wsdl

SelfServiceWebSite

This Web service is used for creating, retrieving, updating, and deleting sites. It makes available two methods, Query and the Execute methods in its business service SelfServiceWebSite as Webservice operations.

SelfServiceWebSite Operations

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

Name	Description
SelfServiceWebSiteExecute	Perform various operations such as creating, updating, or deleting of sites with SelfServiceWebSite integration object as the input.
SelfServiceWebSiteQueryPage	Performs query operations based on the querycriteria. set on SelfServiceWebSite integration object as the input. This operation is used to query for the site details.

Request Message Description:SelfServiceWebSiteExecute

Creating, updating, or deleting operations on a site can be performed based on the query criteria that is set. For a description of this request message, see the following table.

Node	Description	Type
SelfServiceWebSiteExecute_Input	The method arguments are the Site integration object, Language Mode (value is LDC) and viewMode (All).	Integration Object

Response Message Description: SelfServiceWebSiteExecute

The response contains the details based on the query set on the Site integration object. For a description of this response message, see the following table.

Node	Description	Type
SelfServiceWebSiteExecute_Output	The data retrieved based on the query set.	Integration Object

Request Message Description:SelfServiceWebSiteQueryPage

Based on the querycriteria set on the integration object, site related details are queried. For a description of this request message, see the following table.

Node	Description	Type
SelfServiceWebSiteQueryPage_Input	The method arguments are Site integration object with query parameters set, Language Mode as LDC and viewMode (All).	Integration Object

Response Message Description: SelfServiceWebSiteQueryPage

The response contains the details based on the update query set on the Site integration object. For a description of this response message, see the following table.

Node	Description	Type
SelfServiceTimeZoneQueryPage_Output	The list of the time zone values that are returned in the language that is set in the search specification.	Integration Object

SelfServiceWebSite Application Interface

This topic describes the application objects called by the SelfServiceWebSite Web service. This Web service makes available the business service SelfServiceWebSite, which provides execute and query operations on the integration object SS_WebSite_IO. For more information on application implementation, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

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

Name	Boundary Object Type	Class
SelfServiceWebSite	Integration Object	CSSEAIUIDataService

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SS_WebSite_IO	SS_WebSite_BO

Example Package for SelfServiceWebSite

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 (SelfServiceWebSiteExecute)

See the following file to view the sample code:

...\SelfServiceWebSite\SelfServiceWebSiteExecute_request.xml

Response (SelfServiceWebSiteExecute)

See the following file to view the sample code:

...\SelfServiceWebSite\SelfServiceWebSiteExecute_response.xml

Request (SelfServiceWebSiteQuery)

See the following file to view the sample code:

...\SelfServiceWebSite\SelfServiceWebSiteQuery_request.xml

Response (SelfServiceWebSiteQuery)

See the following file to view the sample code:

...\SelfServiceWebSite\SelfServiceWebSiteQuery_response.xml

Interface Description (WSDL) for SelfServiceWebSite

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.

...SelfServiceWebSiteQuery\SelfServiceWebSite.wsdl

ServiceRequest

Use this Web service to create, read, update the Service Request and to create, read, update, and delete the child objects like Activities, Attachments, Solutions and Service Request Agreements.

ServiceRequest Operations

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

Name	Description
ServiceReqInsert_Input	Used to create the service request.
ServiceReqUpdate_Input	Used to update the service request.
ServiceReqExecute_Input	Used to create and update the service request. Also this is used to create and Update child objects such as Activities, Attachment, Solution, Service Request Agreement.
ServiceReqQueryPage_Input	Used to query the service request and its child objects such as Activities, Attachment, Solution, Service Request Agreement.
ServiceReqInit_Input	Used to get the default values for the service request.
ServiceReqDelete_Input	Used to delete the child objects such as Activities, Attachment, Solution, Service Request Agreement.

Request Message Description: ServiceReqInsert_Input

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

Node	Description
Abstract	Abstract of the service request.

Response Message Description: ServiceReqInsert_Input

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

Node	Description
Id	Returns the Row_Id of the service request.
Mod_Id	Returns the Mod_Id of the service request.

Request Message Description: ServiceReqUpdate_Input

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

Node	Description
Id	Row ID of the service request is required.

Response Message Description: ServiceReqUpdate_Input

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

Node	Description
Id	Returns the Row_Id of the service request.
Mod_Id	Returns the Mod_Id of the service request.

Request Message Description: ServiceReqExecute_Input Request

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

Node	Field	Description
Service Request	Id	Row ID of the service request.
Service Request	Abstract	Abstract of the service request is required.
Activities	Id	Row ID of the Aactivity.
Activities	Type	Type is required.
Activities	Description2	Description of the activity.
Attachment	Id	Row ID of the attachment.
Attachment	ActivityId	Activity ID of the attachment. In this case the Service Request ID.
Attachment	ActivityComments	Comments for the attachment.
Attachment	ActivityFileAutoUpdFlg	File Auto flag for the attachment.
Attachment	ActivityFileDeferFlg	File Defer flag for the attachment.
Attachment	ActivityFileDockReqFlg	File Dock Required flag for the attachment.
Attachment	ActivityFileDockStatFlg	File Dock Status flag for the attachment.
Attachment	ActivityFileSrcType	Type of the Attachment. Valid values are File or URL.
Attachment	ActivityFileSrcPath	Location of the file or URL for the attachment.
Attachment	ActivityFileName	File name for the attachment, in case of attachment type File.
Attachment	ActivityFileRev	File Revision for the attachment, in case of attachment type File.
Attachment	ActivityFileSize	File Size for the attachment, in case of attachment type File.
Attachment	ActivityFileExt	File extension for the attachment, in case of attachment type File.
Attachment	ActivityFileBuffer	Contents to be attached.
Attachment	ActivityFileBuffer	Contents to be attached.
Solution	Id	Row ID of the solution is required
Solution	Name	Name of the solution.
Agreement	Id	Row ID of the agreement is required.
Agreement	AgreementName	Name of the agreement.

Response Message Description: ServiceReqExecute_Input Request

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

Node	Description
Id	Returns the Row_Id of the service request. The child object’s Row ID is also returned.
Mod_Id	Returns the Mod_Id of the service request. The child object’s Mod_Id is also returned.

Request Message Description: ServiceReqQueryPage_Input

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

Node	Description
Id	Row ID of the service request.

Response Message Description: ServiceReqQueryPage_Input

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

Node	Description
Service Request	Returns all the information of the service request.
Child Objects	Returns all the child information for that service request.

Request Message Description: ServiceReqInit_Input

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

Node	Description
Service Request	Passes the service request attributes.

Response Message Description: ServiceReqInit_Input

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

Node	Description
Service. Request	Returns default information of the service request.

Request Message Description: ServiceReqDelete_Input

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

Node	Description
Id	Row ID of the service request.
Id	Row ID of the activity.
Id	Row ID of the attachment.
Id	Row ID of the solution.
Id	Row ID of the service request agreement.

Response Message Description: ServiceReqDelete_Input

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

Node	Description
Id	Returns the Ro_ Id of the service request. Also returns the Row ID of the child object.
Mod_Id	Returns the Mod_Id of the service request. Also returns the Mod ID.

ServiceRequest 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
ServiceReq	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
ServiceReqIO	Service Request (SelfService)

Example Package for ServiceRequest

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:

...\ServiceRequest\ServiceRequest_request.xml

Response

See the following file to view the sample code:

...\ServiceReqWS\ServiceRequest_response.xml

Interface Description (WSDL) for ServiceRequest

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.

...\ServiceRequest\ServiceRequest.wsdl

SessionAccessWS

This Web service call is used to terminate the Siebel CRM session. This Web service makes available the business service SessionAccessService which provides the business service method Ping which is used to set a message to terminate the Siebel CRM session.

SessionAccessWS Operations

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

Name	Description
sessionAccessPing	This is used for setting a message as an input.

Request Message Description:sessionAccessPing

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

Node	Description	Type
SessionAccessPing_Input	Container element.	Not applicable
SessionAccessPing_Input/msgIn	Set as Self-Service Logout Request.	String

Response Message Description: sessionAccessPing

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

Node	Description	Type
SessionAccessPing_Output	Container element.	Not applicable
SessionAccessPing_Input/msgOut	Sent as the number 1 which indicates successful termination of the session.	String

SessionAccessWS Application Interface

This topic describes the application objects called by the SessionAccessWS. This Web service makes available the business service SessionAccessService which provides the method Ping which is used to set a message to terminate the Siebel CRM session. 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
SessionAccessService	Business Service	CSSUIFSessionAccessService

Example Package for SessionAccessWS

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:

...\SessionAccessWS\SessionAccess_request.xml

Response

See the following file to view the sample code:

...\SessionAccessWS\SessionAccess_response.xml

Interface Description (WSDL) for SessionAccessWS

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.

...\SessionAccessWS\SessionAccessWS.wsdl

SFA_Activity_BS

Use this Web service to insert an activity which is associated to a selected list of contacts into the Siebel database.

SFA_Activity_BS Operations

These operations are presented as a WSDL to the clients accessing it. For a list of operations associated with this Web service, see the following table.

Name	Description
SFAInsertActivity	Creates an activity record in the database and associates a contact record to it.

Response Message Description: SFAInsert Activity

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

Node	Description
SFA_Activity_IO	Required. An instance of the integration object SFA_Activity.

Response Message Description: SFAInsertActivity

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

Node	Description
SFA_Activity_IO	Required. An instance of the integration object SFA_Activity.

SFA_Activity_BS 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 BusService)
SFAActivity_BS	Business Service	CSSEAIUIDataService

Data Object (Integration Object)

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

Siebel Repository Name	Boundary Object Type	External Name
SFA_Activity_IO	Siebel Business Object	Action

Methods

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

Operation	Method
Insert	Insert

Example Package for SFA_Activity_BS

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:

...\SFA_Activity_BS\SFA_Activity_BS_request.xml

Response

See the following file to view the sample code:

...\SFA_Activity_BS\SFA_Activity_BS_response.xml

Interface Description (WSDL) for SFA_Activity_BS

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.

...\SFA_Activity_BS\SFA_Activity_BS.wsdl

SWIAdjustmentStatusUpdate

Use this Web service to update the Status, Sub Status, and Status Description fields of an adjustment record.

SWIAdjustmentStatusUpdate Operations

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

Name	Description
SWIAdjustmentStatusUpdate	Updates the Status, Sub Status, and Status Description fields of the adjustment record.

Calls Workflow SWIAdjustmentStatusUpdate

This Web service can be used either to call a business service or to call a workflow. This Web service calls the SWIAdjustmentStatusUpdate workflow, which extracts information about the Status, Sub Status, and Status Description fields and updates the Siebel database accordingly for that adjustment record.

SWIAdjustmentStatusUpdate 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
SWIAdjustmentStatusUpdate	Workflow	Not Applicable

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SWISIAAdjustmentIO	SIA Adjustment

Methods

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

Operation	Method
SWIAdjustmentStatusUpdate	SWIAdjustmentStatusUpdate

Example Package for SWIAdjustmentStatusUpdate

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 from Oracle Application Integration Architecture

See the following file to view the sample code:

...\SWIAdjustmentStatusUpdate\SWIAdjustmentStatusUpdate_request.xml

Interface Description (WSDL) for SWIAdjustmentStatusUpdate

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.

...\SWIAdjustmentStatusUpdate\SWIAdjustmentStatusUpdate.wsdl

SWIAdminISSAttributeDefnIO

Use this Web service to perform query operations on product attribute definitions.

SWIAdminISSAttributeDefnIO Operations

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

Name	Description
AttributeDefinitionQueryById	Queries by using the attribute ID
AttributeDefinitionQueryByExample	Queries by name, ID, or any valid input

Request Message Description: AttributeDefinitionQueryById

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

Node	Description	Type
PrimaryRowId	Required	String

Response Message Description: AttributeDefinitionQueryById

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

Node	Description	Type
SiebelMessage	Required	Integration Object

Request Message Description: AttributeDefinitionQueryByExample

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

Node	Description	Type
SiebelMessage	Required	Integration Object

Response Message Description: AttributeDefinitionQueryByExample

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

Node	Description	Type
SiebelMessage	Required	Integration Object

SWIAdminISSAttributeDefnIO 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
SWI Product Attributes	Business 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
SWIAdminISSAttributeDefnIO	SWI Admin Attribute VOD Definition

Methods

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

Operation	Method
AttributeDefinitionQueryById	QueryById
AttributeDefinitionQueryByExample	QueryByExample

SWIAdminISSClassDefinitionIO

Use this Web service to perform query operations on product class definitions.

SWIAdminISSClassDefinitionIO Operations

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

Name	Description
ProductClassQueryById	Queries by using the class ID
ProductClassQueryByExample	Queries by name, ID, or any valid input

Request Message Description: ProductClassQueryById

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

Node	Description	Type
PrimaryRowId	Required	String

Response Message Description: ProductClassQueryById

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

Node	Description	Type
SiebelMessage	Required	Integration Object

Request Message Description: ProductClassQueryByExample

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

Node	Description	Type
SiebelMessage	Required	Integration Object

Response Message Description: ProductClassQueryByExample

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

Node	Description	Type
SiebelMessage	Required	Integration Object

SWIAdminISSClassDefinitionIO 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
SWI Product Class Hierarchy	Business Service	CSSCMUProdClassWebSvc

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SWIAdminISSClassDefinitionIO	SWI Admin ISS Class Definition

Methods

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

Operation	Method
ProductClassQueryById	QueryById
ProductClassQueryByExample	QueryByExample

SWIAssetManagement

Use this inbound Web service to start Siebel Configurator.

SWIAssetManagement Operations

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

Operation	Description
SWIAssetManagementInsert	Inserts
SWIAssetManagementUpdate	Updates
SWIAssetManagementSynchronize	Synchronizes

Request Message Description: SWIAssetManagementInsert

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

Node	Description	Type
SiebelMessage	Required.	Integration Object
UTCCanonical	A value of Y means that all date-type fields in the payload are in UTC standard format.	String

Response Message Description: SWIAssetManagementInsert

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

Node	Description	Type
SiebelMessage	Required	Integration Object

Request Message Description: SWIAssetManagementUpdate

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

Node	Description	Type
SiebelMessage	Required	Integration Object
UTCCanonical	A value of Y means that all date-type fields in the payload are in UTC standard format.	String

Response Message Description: SWIAssetManagementUpdate

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

Node	Description	Type
SiebelMessage	Required	Integration Object

Request Message Description: SWIAssetManagementSynchronize

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

Node	Description	Type
SiebelMessage	Required	Integration Object
UTCCanonical	A value of Y means that all date-type fields in the payload are in UTC standard format.	String

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

Node	Description	Type
SiebelMessage	Required	Integration Object

SWIAssetManagement 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 Asset Management Service	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
SWIAssetManagementIO	SWI Asset Management

Methods

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

Operation	Method
SWIAssetManagementInsert	Inserts
SWIAssetManagementUpdate	Updates
SWIAssetManagementSynchronize	Synchronizes

Interface Description (WSDL) for SWISWIAssetManagment

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

...WSDL\SWIAssetManagment.wsdl

SWIContactServices

Use this inbound Web service to support Query, Upsert and Synchronize operations for Contact records and contact child details.

SWIContactServices Operations

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

Name

Description

SWIContactServicesInsertOrUpdate

Calls Insert or Update method used for inserting a new contact along with the child details into the Siebel database. If the contact is already present in the Siebel database, then the contact will be updated with the details from the request message.

SWIContactServicesQueryByExample

Calls the Query by Example method to Query Contact details along with the child details from the Siebel database.

SWIContactServicesSynchronize

Calls the Synchronize method to synchronize the contact in the request message with the contact details in the Siebel database.

If the child details that are part of the request message are not present in the Siebel database, then they are inserted. If any additional child is present in the database and not part of request message, then it is deleted from the database.

Request Message Description: SWIContactServicesInsertOrUpdate

Inserts a new contact along with the child details in to the Siebel database. If the contact is already present in the Siebel database then the contact record is updated with any new details contained in the request message.

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

Node	Description	Type
Alias	Alias of the contact record.	String
CellularPhone	Mobile phone number of the contact.	String
ContactPersonTitle	Contact’s title.	String
CurrencyCode	Contact’s account currency code.	String
DateofBirth	Contact’s birth date.	String
EmailAddress	Contact’s email address.	String
FaxPhone	Contact’s fax number.	String
FirstName	Contact’s first name.	String
Gender	Contact’s gender.	String
HomePhone	Contact’s home phone number.	String
JobTitle	Contact’s job title.	String
LastName	Contact’s last name.	String
MM	Mr. or Mrs.	String
MaritalStatus	Contact’s marital status.	String
MiddleName	Contact’s middle name.	String
RowId	Row ID of Siebel Contact record	String
SocialSecurityNumber	Contact’s social security number.	String
Status	Contact record’s status.	String
WorkPhone	Contact’s work phone number.	String
AIAIntegrationId	ID value used for mapping the request message and response message contact details.	String
ListofOrganization	Container for Organization	String
PersonalAddress	Contact’s home address.	String
Id	Siebel row ID of the Contact record.	String
AddressName	Contact’s address name.	String
City	Contact’s city of residence.	String
Country	Contact’s country of residence.	String
PostalCode	Contact’s postal code.	String
Province	Contact’s province, if applicable.	String
State	Contact’s state of residence.	String
StreetAddress1	Line 1 details for the contact.	String
StreetAddress2	Line 2 details for the contact.	String
AIAIntegrationId	ID value used for mapping the request and response message.	String

Response Message Description: SWIContactServicesInsertOrUpdate

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

Node	Description	Type
Alias	Alias of contact record.	String
CellularPhone	Contact’s mobile phone number.	String
ContactPersonTitle	Contact’s title.	String
CurrencyCode	Contact account currency code.	String
DateofBirth	Contact’s birth date.	String
EmailAddress	Contact’s email address.	String
FaxPhone	Contact’s fax number.	String
FirstName	Contact’s first name.	String
Gender	Contact’s gender.	String
HomePhone	Contact’s home phone number.	String
JobTitle	Contact’s job title.	String
LastName	Contact’s last name.	String
MM	Mr. or Mrs.	String
MaritalStatus	Contact’s marital status.	String
MiddleName	Contact’s middle name.	String
RowId	Row ID of Siebel Contact record	String
SocialSecurityNumber	Contact’s social security number.	String
Status	Contact status.	String
WorkPhone	Contact’s work phone number.	String
AIAIntegrationId	ID value used for mapping the request message and response message contact details.	String
ListofOrganization	Container for organization record.	String
PersonalAddress	Contact’s home address.	String
Id	Row ID of the Contact record In the Siebel database	String
AddressName	Address name	String
City	Contact’s city.	String
Country	Contact’s country.	String
PostalCode	Contact’s postal code.	String
Province	Contact’s province (if applicable).	String
State	Contact’s state.	String
StreetAddress1	Line 1 details for the contact.	String
StreetAddress2	Line 2 details for the contact.	String
AIAIntegrationId	ID value used for mapping the request and response message.	String

Request Message Description: SWIContactServicesQueryByExample

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

Node	Description	Type
RowId	Row ID of Siebel Contact record	String
ListOfAccount	List of Account records.	String
ListofPersonalAddress	List of personal address records of contact.	String
PersonalAddress	Contact’s personal address.	String

Response Message Description: SWIContactServicesQueryByExample

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

Node	Description	Type
Id	Row ID.	String
Alias	Alias of contact record.	String
CellularPhone	Contact’s mobile phone number.	String
ContactPersonTitle	Contact’s title.	String
CurrencyCode	Contact account currency code.	String
DateofBirth	Contact’s birth date.	String
EmailAddress	Contact’s email address.	String
FaxPhone	Contact’s fax number.	String
FirstName	Contact’s first name.	String
Gender	Contact’s gender.	String
HomePhone	Contact’s home phone number.	String
JobTitle	Contact’s job title.	String
LastName	Contact’s last name.	String
MM	Mr. or Mrs.	String
MaritalStatus	Contact’s marital status.	String
MiddleName	Contact’s middle name.	String
MotherMaidenName	Contact’s mother’s maiden name.	String
PrimaryOrganizationId	Primary organization for contact.	String
RowId	Row ID in Siebel data table.	String
SocialSecurityNumber	Contact’s social security number.	String
Status	Status of contact record.	String
WorkPhone	Contact’s work telephone number.	String
ListofAccount	Container for Account.	Integration Component
ListofComInvoiceProfile	Container for invoice profile.	Integration Component
ListofOrganization	Container for Organization.	Integration Component
ListofPersonalAddress	Container for personal address records.	Integration Component
PersonalAddress	Contact’s personal address.	String
ListofUCMContactPrivacy	Privacy details for Contact record.	Integration Component

Request Message Description: SWIContactServicesSynchronize

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

Node	Description	Type
Id	Row ID.	String
Alias	Alias of contact record.	String
CellularPhone	Contact’s mobile phone number.	String
ContactPersonTitle	Contact’s title.	String
CurrencyCode	Contact’s account currency code.	String
DateofBirth	Contact’s birth date.	String
EmailAddress	Contact’s email address.	String
FaxPhone	Contact’s fax number.	String
FirstName	Contact’s first name.	String
Gender	Contact’s gender.	String
HomePhone	Contact’s home phone number.	String
JobTitle	Contact’s job title.	String
LastName	Contact’s last name.	String
MM	Mr. or Mrs.	String
MaritalStatus	Contact’s marital status.	String
MiddleName	Contact’s middle name.	String
MotherMaidenName	Contact’s mother’s maiden name.	String
PrimaryOrganizationId	Primary organization for contact.	String
RowId	Row ID in Siebel data table.	String
SocialSecurityNumber	Contact’s social security number.	String
Status	Status of contact record.	String
WorkPhone	Contact’s work telephone number.	String
AIAIntegrationId	ID value used for mapping the request message and response message contact details.	String
ListofOrganization	Container for Organization.	Integration Component
ListofPersonalAddress	Container for personal address records.	Integration Component

Response Message Description: SWIContactServicesSynchronize

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

Node	Description	Type
Id	Row ID.	String
Alias	Alias of contact record.	String
CellularPhone	Contact’s mobile phone number.	String
ContactPersonTitle	Contact’s title.	String
CurrencyCode	Contact’s account currency code.	String
DateofBirth	Contact’s birth date.	String
EmailAddress	Contact’s email address.	String
FaxPhone	Contact’s fax number.	String
FirstName	Contact’s first name.	String
Gender	Contact’s gender.	String
HomePhone	Contact’s home phone number.	String
JobTitle	Contact’s job title.	String
LastName	Contact’s last name.	String
MM	Mr. or Mrs.	String
MaritalStatus	Contact’s marital status.	String
MiddleName	Contact’s middle name.	String
MotherMaidenName	Contact’s mother’s maiden name.	String
PrimaryOrganizationId	Primary organization for contact.	String
RowId	Row ID in Siebel data table.	String
SocialSecurityNumber	Contact’s social security number.	String
Status	Status of contact record.	String
WorkPhone	Contact’s work telephone number.	String
AIAIntegrationId	ID value used for mapping the request message and response message contact details.	String
ListofOrganization	Container for Organization.	Integration Component
ListofPersonalAddress	Container for personal address records.	Integration Component

SWIContactServices 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 Contact Service	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
SWIContactIO	SWI Contact

Methods

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

Operation	Method
SWIContactServicesInsertOrUpdate	InsertOrUpdate
SWIContactServicesQueryByExample	QueryByExample
SWIContactServicesSynchronize	Synchronize

SWICreateAdjustment

Use this Web service to create adjustments in the external Oracle Communications Billing and Revenue Management application by submitting a request to the Oracle Communications Billing and Revenue Management Advanced Queue (AQ) facility.

SWICreateAdjustment Operations

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

Name	Description
CreateAdjustment	Creates adjustments in the external Oracle Communications Billing and Revenue Management application.

Request Message Description: CreateAdjustment

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

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

Response Message Description

There is no response message. The request is being posted to the Oracle Communications Billing and Revenue Management facility.

SWICreateAdjustment 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
SWICreateAdjustment	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 Adjustment IO	Account

Methods

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

Operation	Method
CreateAdjustment	CreateAdjustment

SWICustomerParty

Use this inbound Web service to support Query, Upsert and Synchronize operations for contact records and contact child details.

SWICustomerParty Operations

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

Name

Description

SWICustomerPartyInsertOrUpdate

Calls the Insert or Update method used for inserting a new account along with the child details into the Siebel database. If the account is already present in the Siebel database, then the account will be updated with any new details contained in the request message.

SWICustomerPartyQueryByExample

Calls the Query by Example method to query the Siebel database for account details along with any child details.

SWICustomerPartySynchronize

Calls Synchronize method to synchronize the account record contained in the request message with the account details in Siebel database.

If the child details that are part of request message are not present in the Siebel database, then the details are inserted. If any additional child are present in the Siebel database and are not part of request message, then those details are deleted from the database.

Request Message Description: SWICustomerPartyInsertOrUpdate

Inserts a new account along with the child details into the Siebel database. If the account is already present in the Siebel database, then the Account record is updated with the details contained in the request message.

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

Note: All nodes in the following table, bar the first node apply to SWIcustomerpartyIO.

Node	Description	Type
ListofSWIcustomerpartyIO	An instance of the integration object ListofSWIcustomerpartyIO.	Integration Object
Account	Account name.	String
AccountStatus	Status of account record.	String
DUNSNumber	Dun and Bradstreet data universal numbering system number.	String
MainFaxNumber	Main fax number of account.	String
MainPhoneNumber	Main phone number of account.	String
Name	Account name.	String
HomePage	Account’s home page address.	String
AIAIntegrationId	ID value used for mapping the request message and response message account details.	String
Location	Account’s location.	String
RowId	Row ID of Siebel Account record.	String
ListofCutAddress	Optional. Business address.	Integration Component
ListofContact	Contact details	Integration Component
ListofInternalDivision	Internal division details.	Integration Component
City	City where account is located.	String
Country	Country where account is located.	String
County	County where account is located.	String
PostalCode	Postal code of account.	String
Province	Province (if applicable) where account is located.	String
AIAIntegrationId	Contact’s social security number.	String
Status	Contact status.	String
WorkPhone	Contact’s work phone number.	String
AIAIntegrationId	ID value used for mapping the request message and response message contact details.	String
ListofOrganization	Container for organization record.	String
PersonalAddress	Contact’s home address.	String
Id	Row ID of the Contact record in Siebel data table.	String
AddressName	Address name	String
City	Contact’s city.	String
Country	Contact’s country.	String
PostalCode	Contact’s postal code.	String
Province	Contact’s province (if applicable).	String
State	Contact’s state.	String
StreetAddress1	Line 1 details for the contact.	String
StreetAddress2	Line 2 details for the contact.	String
AIAIntegrationId	ID value used for mapping the request and response message.	String

Response Message Description: SWICustomerPartyInsertOrUpdate

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

Note: All nodes in the following table, bar the first node apply to SWIcustomerpartyIO.

Node	Description	Type
ListofSWIcustomerpartyIO	An instance of the integration object ListofSWIcustomerpartyIO.	Integration Object
Account	Account name.	String
AccountStatus	Status of account record.	String
DUNSNumber	Dun and Bradstreet data universal numbering system number.	String
HomePage	Account’s home page address.	String
Location	Account’s location.	String
MainFaxNumber	Account’s main fax number.	String
MainPhoneNumber	Account’s main phone number.	String
Name	Account name.	String
AIAIntegrationId	ID value used for mapping the request message and response message account details.	String
ListofCutAddress	Optional. Business address.	Integration Component
ListofContact	Contact details.	Integration Component
ListOfInternalDivision	Internal division details.	Integration Component

Request Message Description: SWICustomerPartyQueryByExample

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

Note: All nodes in the following table, bar the first node apply to SWIcustomerpartyIO.

Node	Description	Type
ListofSWIcustomerpartyIO	An instance of the integration object ListofSWIcustomerpartyIO.	Integration Object
RowId	Row ID of account in Siebel data table.	String
ListofCutAddress	Optional. Business address.	Integration Component

Response Message Description: SWICustomerPartyQueryByExample

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

Note: All nodes in the following table, bar the first node apply to SWIcustomerpartyIO.

Node	Description	Type
ListofSWIcustomerpartyIO	An instance of the integration object ListofSWIcustomerpartyIO.	Integration Object
Account	Account name.	String
AccountStatus	Status of account record.	String
AccountTypeCode	Dun and Bradstreet data universal numbering system number.	String
CurrencyCode	Account’s currency code.	String
DUNSNumber	Dun and Bradstreet data universal numbering system number.	String
HomePage	Homepage of account	String
IntegrationId	Integration ID.	String
Location	Account location.	String
MainFaxNumber	Main fax number of account.	String
MainPhoneNumber	Main phone number of account.	String
Name	Account name.	String
ParentAccountId	Account ID of parent account.	String
PrimaryAddressId	Primary address of account.	String
PrimaryBillToAddressId	Primary billing address of account.	String
PrimaryContactId	Primary Contact ID for the account.	String
PrimaryOrganizationId	Primary Organization ID for the account.	String
PrimaryShipToAddress	Primary shipping address for the account.	String
RowId	Row ID in Siebel data table.	String
Type	Account type.	String
ListofCutAddress	Optional. Business address.	Integration Component
ListofContact	Contact details.	Integration Component
ListofInternalDivision	Internal division details.	Integration Component

Request Message Description: SWICustomerPartySynchronize

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

Note: All nodes in the following table, bar the first node apply to SWIcustomerpartyIO.

Node	Description	Type
ListofSWIcustomerpartyIO	An instance of the integration object ListofSWIcustomerpartyIO.	Integration Object
Account	Account name.	String
AccountStatus	Status of account record.	String
DUNSNumber	Dun and Bradstreet data universal numbering system number.	String
MainFaxNumber	Main fax number of account.	String
MainPhoneNumber	Main phone number of account.	String
Name	Account name.	String
HomePage	Account’s home page address.	String
AIAIntegrationId	ID value used for mapping the request message and response message account details.	String
Location	Account’s location.	String
RowId	Row ID of Siebel Account record.	String
ListofCutAddress	Optional. Business address.	Integration Component
ListofContact	Contact details.	Integration Component
ListofInternalDivision	Internal division details.	Integration Component
City	City where account is located.	String
Country	Country where account is located.	String
County	County where account is located.	String
PostalCode	Postal code of account.	String
Province	Province (if applicable) where account is located.	String
AIAIntegrationId	Contact’s social security number.	String
Status	Contact status.	String
WorkPhone	Contact’s work phone number.	String
AIAIntegrationId	ID value used for mapping the request message and response message contact details.	String
ListofOrganization	Container for organization record.	String
PersonalAddress	Contact’s home address.	String
Id	Row ID of the Contact record in Siebel data table.	String
AddressName	Address name	String
City	Contact’s city.	String
Country	Contact’s country.	String
PostalCode	Contact’s postal code.	String
Province	Contact’s province (if applicable).	String
State	Contact’s state.	String
StreetAddress1	Line 1 details for the contact.	String
StreetAddress2	Line 2 details for the contact.	String
AIAIntegrationId	ID value used for mapping the request and response message.	String

Response Message Description: SWICustomerPartySynchronize

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

Note: All nodes in the following table, bar the first node apply to SWIcustomerpartyIO.

Node	Description	Type
ListofSWIcustomerpartyIO	An instance of the integration object ListofSWIcustomerpartyIO.	Integration Object
Account	Account name.	String
AccountStatus	Status of account record.	String
DUNSNumber	Dun and Bradstreet data universal numbering system number.	String
HomePage	Account’s home page address.	String
Location	Account’s location.	String
MainFaxNumber	Account’s main fax number.	String
MainPhoneNumber	Account’s main phone number.	String
Name	Account name.	String
AIAIntegrationId	ID value used for mapping the request message and response message account details.	String
ListofCutAddress	Optional. Business address.	Integration Component
ListofContact	Contact details.	Integration Component
ListOfInternalDivision	Internal division details.	Integration Component

SWICustomerParty 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 Customer Party Service	Business Service	CSSEAIDataSyncService

Data Object (Integration Object)

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

Table Data Object

Siebel Repository Name	External Name
SWICustomerPartyIO	Account

SWILocationServices

Use this Web service to perform the following basic operations on locations:

Back up location
Query location

SWILocationServices Operations

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

Name	Description
SWILocationQuery	Queries the location information in the Siebel business application as requested by the third-party application
SWILocationSynchronize	Synchronizes the location information in the Siebel business application with the location information in the third-party application

Request Message Description: SWILocationQuery

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

Node	Description	Type
PrimaryRowId	Required	String

Response Message Description: SWILocationQuery

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

Node	Description	Type
SiebelMessage	Required	Integration Object

Request Message Description: SWILocationSynchronize

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

Node	Description	Type
SiebelMessage	Required	Integration Object
StatusObject	Optional	String

Response Message Description: SWILocationSynchronize

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

Node	Description	Type
SiebelMessage	Required	Integration Object

SWILocationServices 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 Location Adapter	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
SWIFMLocationIOFM	Location

Methods

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

Operation	Method
SWILocationQuery	QueryById
SWILocationSynchronize	Synchronize

SWILocationSync

Use this outbound Web service to submit an order into the order queue.

SWILocationSync Operations

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

Name	Description
SyncTransportationStopList	Submits the location request in the Siebel business application into the asynchronous queue of the third-party application

Request Message Description: SyncTransportationStopList

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

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
SWILocationSyncReqMsg:SyncTransportationStopList	Optional	Integration Object

Response Message Description: SyncTransportationStopList

Not applicable.

SWILocationSync 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
SWILocationSync	Business Service	CSSWSOutboundDispatcher
SWISendLocation	Workflow	Not applicable

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SWIFMLocationIOFM	Location

Method

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

Operation	Method
SyncTransportationStopList	SyncTransportationStopList

SWILSClinicalActivityTemplate

Use this Web service to send activity template values for a given template type from the Siebel CRM application. An external application can invoke this Web service using valid Siebel application user credentials for authentication.

SWILSClinicalActivityTemplate Operations

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

Operation Name	Description
TemplateQueryByExample	Used to send Activity template values for a given template type.

Request Message Description: TemplateQueryByExample

This Web service can be invoked with the Type value so that only related activity templates are returned. If you do not provide input, then all activity templates are returned. For a description of this request message, see the following table.

Node	Description	Type
Id	Optional. Row Id.	Character data
Searchspec	Optional. Search specification.	Character data
AutoTrigger	Optional. Auto Trigger flag.	Boolean
Description	Optional. Activity template description.	Character data
Name	Optional. The name of the Activity template.	Character data
ParentTemplateId	Optional. The parent template ID.	Character data
ProtocolId	Optional. Protocol ID.	Character data
ProtocolTitle	Optional. Protocol title.	Character data
Public	Optional. Public flag.	Boolean
TemplateType	Optional. The template type.	Character data
Type	Optional. Type.	Character data

Response Message Description: TemplateQueryByExample

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

Node	Description	Type
Id	Row ID of the Activity template record.	Character data
AutoTrigger	Auto Trigger flag. Values are Y or N.	Boolean
Description	Activity template description.	Character data
Name	Activity template name.	Character data
ParentTemplateId	Parent template ID.	Character data
ProtocolId	Protocol ID.	Character data
ProtocolTitle	Protocol title.	Character data
Public	Public flag. Values are Y or N.	Boolean
TemplateType	Template type, such as document, activity, and so on	Character data
Type	Activity template type.	Character data

SWILSClinicalActivityTemplate 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 Activity Template Service	Business 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 Activity Template	Activity Template

Example Package for SWILSClinicalActivityTemplate

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:

...\SWILSClinicalActivityTemplate\SWILSClinicalActivityTemplate-QueryByExample-request.xml

Interface Description (WSDL) for SWILSClinicalActivityTemplate

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.

...\SWILSClinicalActivityTemplate\SWILSClinicalActivityTemplate.WSDL

SWILSClinicalCreateSiteVisitGeo Location

Monitoring visits are required by Federal regulations. Siebel Clinical users, also known as monitors, are often working from the field and perform site visits based on protocol requirements and objectives. Often, monitors are required to conduct unplanned visits and will have to adjust existing plans for planned site visits. Monitors may carry mobile devices which capture a site’s GPS information. A third-party application allows the user to select the Site Visit record, check in site location details, and then send them to Siebel Life Sciences.

If more than one monitor checks in location details from a third party application to Siebel Life Sciences for the same site visit, then multiple Geo Location Records are created in Siebel Life Sciences. Similarly if the same user checks in at a different time, multiple Geo Location Records are created.

SWILSClinicalCreateSiteVisitGeoLocation Operations

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

Name	Description
insert	Reads the input parameters for the site visit and saves the information in Siebel Life Sciences.

Request Message Description: insert

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

Node	Description	Type
SiteVisitId	Required. Site visit ID (Siebel database row ID).	Character data
UserId	Required. Siebel database row ID for the Siebel Clinical visit team member.	Character data
VisitDate	Required. Site visit date time for CRA.	Date and time
Latitude	Optional. Site location latitude.	Number
Longitude	Optional. Site location longitude.	Number
Comments	Optional. Any comments provided by the monitor.	Character data

Response Message Description: insert

There is no response message for the insert operation. In the event of an error, an error message will be delivered.

SWILSClinicalCreateSiteVisitGeoLocation 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 (Workflow)

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

Name	Boundary Object Type	Class
SWI LS Clinical Create Site Visit Geo Location	Workflow	Not applicable.

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 Site Visits Geo Loc IO	LS Clinical Site Visits Geo Location

Example Package for SWILSClinicalCreateSiteVisitGeoLocation

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:

...\SWILSClinicalCreateSiteVisitGeoLocation\SWILSClinicalCreateSiteVisitGeo

Location_request.xml

Response

See the following file to view the sample code:

...\SWILSClinicalCreateSiteVisitGeoLocation\SWILSClinicalCreateSiteVisitGeo

Location_response.xml

Interface Description (WSDL) for SWILSClinicalCreateSiteVisitGeoLocation

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.

...\SWILSClinicalCreateSiteVisitGeoLocation\SWILSClinicalCreateSiteVisitGeoLocation.wsdl

SWILSClinicalGetEmployees

Use this Web service to retrieve employee information. An external application can invoke this Web service using valid Siebel application user credentials for authentication. Additionally, consider the following:

If no input is provided for any tags in the LSClinicalGetEmployeesQueryByExample operation, then the Web service returns all employee records. If the returned number of records is more than the predefined maximum size, then the Web service returns an error message prompting the user to refine the search.
When using the LSClinicalGetEmployeesQueryPage operation, this Web service returns an error message if the page size field is empty (or blank).
This Web service is used to return all employees from an organization or sub-organization to which an authenticated user is associated.

SWILSClinicalGetEmployees Operations

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

Operation Name	Description
LSClinicalGetEmployeesQueryByExample	Used to return employees in a single result set.
LSClinicalGetEmployeesQueryById	Used to return employees based on given primary row ID.
LSClinicalGetEmployeesQueryPage	Used to return employees in pages.

Request Message Description: LSClinicalGetEmployeesQueryByExample

This operation can be invoked with either the employee ID or login name. This ensures that only the corresponding employee details are returned. Other fields can also be used to refine the search criteria. If no input is provided, then all the employees are returned. For a description of this request message, see the following table.

Node	Description	Type
Employee.Id	Optional. Row ID of employee.	Character data
Employee.EMailAddr	Optional. Email address.	Character data
Employee.FirstName	Optional. First name.	Character data
Employee.JobTitle	Optional. Job title.	Character data
Employee.LastName	Optional. Last name.	Character data
Employee.LoginName	Optional. User ID.	Character data
Employee.Phone	Optional. Phone number	Number
RelatedPosition.Division	Optional. Employee division.	Character data
RelatedResponsibility.Responsibility	Optional. Employee responsibility.	Character data

Request Message Description: LSClinicalGetEmployeesQueryPage

This operation can be invoked with either the employee ID or login name. This ensures that only employee details are returned. You can use other fields to refine the search criteria. If all employee details are required, then pass an asterisk (*) for all nodes. The result set will be in pages with page size.

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

Node	Description	Type
Employee.Id	Required. Row ID of the employee record. Can be either an asterisk (*), or a valid Row ID.	Character data
Employee.FirstName	Required. Employee’s first name. Can be either an asterisk (*), or the employee’s first name.	Character data
Employee.LastName	Required. Employee’s last name. Can be either an asterisk (*), or the employee’s last name.	Character data
Employee.LoginName	Required. User ID. Can be either an asterisk (*), or the employee’s user ID.	Character data
RelatedPosition. Division	Required. Employee division. Can be either an asterisk (*), or the employee division.	Character data
RelatedResponsibility. Responsibility	Required. Employee responsibility. Can be either an asterisk (*), or employee responsibility.	Character data

Request Message Description: LSClinicalGetEmployeesQueryById

This operation can be invoked with the employee row ID so that only corresponding employee details are returned. For a description of this request message, see the following table.

Node	Description	Type
PrimaryRowId	Required. The row ID of the employee.	Character data

Response Message Description: LSClinicalGetEmployeesQueryById, LSClinicalGetEmployeesQueryByExample and LSClinicalGetEmployeesQueryPage

Each of these operations uses the same response message. For a description of the response message, see the following table.

Node	Description	Type
Employee.Id	Row ID of the employee.	Character data
Employee.EMailAddr	Email address.	Character data
Employee.FirstName	First name.	Character data
Employee.JobTitle	Job title.	Character data
Employee.LastName	Last name.	Character data
Employee.LoginName	User ID.	Character data
Employee.Phone	Phone number.	Number
RelatedPosition.Division	Employee division.	Character data
RelatedResponsibility.Responsibility	Employee responsibility.	Character data

SWILSClinicalGetEmployees 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 Get Employees	Business 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 Employee Interface	Employee

Example Package for SWILSClinicalGetEmployees

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:

...\SWILSClinicalGetEmployees\SWILSClinicalGetEmployees-QueryByExample-request.xml 
...\SWILSClinicalGetEmployees\SWILSClinicalGetEmployees-QueryPage-request.xml
...\SWILSClinicalGetEmployees\SWILSClinicalGetEmployees-QueryById-request.xml

Interface Description (WSDL) for SWILSClinicalGetEmployees

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.

...\SWILSClinicalGetEmployees\SWILSClinicalGetEmployees-QueryByExample.WSDL
...\SWILSClinicalGetEmployees\SWILSClinicalGetEmployees-QueryPage.WSDL
...\SWILSClinicalGetEmployees\SWILSClinicalGetEmployees-QueryById.WSDL

SWILSClinicalGetSiteContacts

Use this Web service to retrieve all protocol site contacts. An external application can invoke this Web service using valid Siebel application user credentials for authentication. Additionally, consider the following:

If the page size field is empty (or blank) in the LSClinicalGetSiteContactsQueryPage operation, then the Web service returns an error message. Only provided tags can be used with this operation.
The LSClinicalGetSiteContactsQueryById operation supports only one instance of a Siebel message.
The mobile application user may want to add a new contact to the ‘Attendees’ list in clinical trip report.
In this case, the mobile user must have all contacts of that site in the mobile server side, so that one can add more contacts to attendees in clinical trip report. This Web service helps by returning all those site contacts to external application.

SWILSClinicalGetSiteContacts Operations

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

Operation Name	Description
LSClinicalGetSiteContactsQueryById	Used to send contacts of a site given the Site Row ID.
LSClinicalGetSiteContactsQueryPage	Used to send contacts of multiple sites in pages.
LSClinicalGetSiteContactsQueryByExample	Used to send contacts of multiple sites as a single result set.

Request Message Description: LSClinicalGetSiteContactsQueryById

Use this operation if the external application requires the contacts associated with a particular site. The operation passes the site row ID that corresponds to each requested contact. For a description of this request message, see the following table.

Node	Description	Type
PrimaryRowId	Required. Protocol site row ID.	Character data

Request Message Description: LSClinicalGetSiteContactsQueryByExample

Use this operation to query contacts from a limited number of sites. Different search criteria can be used. For a description of this request message, see the following table.

Node	Description	Type
ClinicalProtocolSite.Id	Optional. Row ID of protocol site.	Character data
ClinicalProtocolSite. Searchspec	Optional. Search specification.	Character data
ClinicalProtocolSite. SiteNumber	Optional. Site number.	Character data
ClinicalProtocolSite. SiteUId	Optional. Site ID.	Character data
ClinicalAccountInvestigatorRole.Id	Optional. Row ID of the site contact.	Character data
ClinicalAccountInvestigatorRole. ConflictId	Optional. Conflict ID.	Character data
ClinicalAccountInvestigatorRole. Searchspec	Optional. Search specification.	Character data
ClinicalAccountInvestigatorRole. City	Optional. Contact’s city.	Character data
ClinicalAccountInvestigatorRole. ContactId	Optional. Row ID of contact.	Character data
ClinicalAccountInvestigatorRole. Country	Optional. Contact’s country.	Character data
ClinicalAccountInvestigatorRole. EmailAddress	Optional. Contact’s email address.	Character data
ClinicalAccountInvestigatorRole. FaxPhone	Optional. Contact’s fax and phone number.	Character data
ClinicalAccountInvestigatorRole. FirstName	Optional. Contact’s first name.	Character data
ClinicalAccountInvestigatorRole. LastName	Optional. Contact’s last name.	Character data
ClinicalAccountInvestigatorRole. MiddleName	Optional. Contact’s middle name.	Character data
ClinicalAccountInvestigatorRole. PostalCode	Optional. Postal code.	Character data
ClinicalAccountInvestigatorRole. PrimaryPersonalAddressId	Optional. Primary address ID.	Character data
ClinicalAccountInvestigatorRole. PrimarySpecialty	Optional. Primary medical specialty.	Character data
ClinicalAccountInvestigatorRole. Region	Optional. Region.	Character data
ClinicalAccountInvestigatorRole. Role	Optional. Role.	Character data
ClinicalAccountInvestigatorRole. State	Optional. State.	Character data
ClinicalAccountInvestigatorRole. StreetAddress	Optional. Street address.	Character data
ClinicalAccountInvestigatorRole. WorkPhone	Optional. Work phone.	Character data

Request Message Description: LSClinicalGetSiteContactsQueryPage

Use this operation to query the contacts from all, or a large number of sites. For a description of this request message, see the following table.

Node	Description	Type
ClinicalProtocolSite.Id	Required. Can be either an asterisk (*), or the row ID of the protocol site.	Character data
ClinicalProtocolSite. SiteUId	Required. Can be either an asterisk (*), or the site ID.	Character data
ClinicalAccountInvestigatorRole.Id	Required. Can be either an asterisk (*), or the row ID the site contact.	Character data
ClinicalAccountInvestigatorRole. ContactId	Required. Can be either an asterisk (*), or the row ID of the contact.	Character data
ClinicalAccountInvestigatorRole. FirstName	Required. Can be either an asterisk (*), or the contact’s first name.	Character data
ClinicalAccountInvestigatorRole. LastName	Required. Can be either an asterisk (*), or the contact’s last name.	Character data

Response Message Description: LSClinicalGetSiteContactsQueryPage, LSClinicalGetSiteContactsQueryById and LSClinicalGetSiteContactsQueryByExample

For a description of the response messages, see the following table.

Node	Description	Type
ClinicalProtocolSite. SiteNumber	Site Number.	Character data
ClinicalProtocolSite. SiteUId	Site ID.	Character data
ClinicalAccountInvestigatorRole.Id	Row ID of the site contact.	Character data
ClinicalAccountInvestigatorRole. City	Contact’s city.	Character data
ClinicalAccountInvestigatorRole. ContactId	Row ID of the contact.	Character data
ClinicalAccountInvestigatorRole. Country	Contact’s country.	Character data
ClinicalAccountInvestigatorRole. EmailAddress	Contact’s email.	Character data
ClinicalAccountInvestigatorRole. FaxPhone	Contact’s fax, and phone number.	Character data
ClinicalAccountInvestigatorRole. FirstName	Contact’s first name.	Character data
ClinicalAccountInvestigatorRole. LastName	Contact’s last name.	Character data
ClinicalAccountInvestigatorRole. MiddleName	Contact’s middle name	Character data
ClinicalAccountInvestigatorRole. PostalCode	Postal code.	Character data
ClinicalAccountInvestigatorRole. PrimaryPersonalAddressId	Primary address ID.	Character data
ClinicalAccountInvestigatorRole. PrimarySpecialty	Primary medical specialty.	Character data
ClinicalAccountInvestigatorRole. Region	Region.	Character data
ClinicalAccountInvestigatorRole. Role	Role.	Character data
ClinicalAccountInvestigatorRole. State	State.	Character data
ClinicalAccountInvestigatorRole. StreetAddress	Street address.	Character data
ClinicalAccountInvestigatorRole. WorkPhone	Work phone.	Character data

SWILSClinicalGetSiteContacts 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 GetSiteContacts	Business 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_Clinical Account Investigator Role	Clinical Protocol Site

Example Package for SWILSClinicalGetSiteContacts

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:

...\SWILSClinicalGetSiteContacts\SWILSClinicalGetSiteContacts-QueryById-request.xml 
...\SWILSClinicalGetSiteContacts\SWILSClinicalGetSiteContacts-QueryByExample-
request.xml 
...\SWILSClinicalGetSiteContacts\SWILSClinicalGetSiteContacts-QueryPage-request.xml

Interface Description (WSDL) for SWILSClinicalGetSiteContacts

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.

...\SWILSClinicalGetSiteContacts\SWILSClinicalGetSiteContacts-QueryByExample.WSDL
...\SWILSClinicalGetSiteContacts\SWILSClinicalGetSiteContacts-QueryPage.WSDL
...\SWILSClinicalGetSiteContacts\SWILSClinicalGetSiteContacts-QueryById.WSDL

SWILSClinicalGetSiteSnapshot

This Web service captures a snapshot of subject status accrual data and returns the resulting data. An external application can invoke this Web service with any valid Siebel CRM user credentials for authentication. The Web service returns an error message if the SiteVisitId field is blank.

SWILSClinicalGetSiteSnapshot Operations

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

Operation Name	Description
CaptureSnapshot	Captures subject status accruals data and returns the same to external application.

Request Message Description: CaptureSnapshot

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

Node	Description	Type
SiteVisitId	Required. Site visit row ID.	Character data
CaptureSnapshot	Optional. Default N. Value 'Y' will capture the data and returns the results. Value 'N' will return only the existing data.	Character data

Response Message Description: CaptureSnapshot

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

Node	Description	Type
Id	Row ID.	Character data
ActualNumber	Actual number.	Number
Comments	Comments.	Character data
ReviewerComments	Reviewer comments	Character data
AccrualsNumber	Accruals number.	Character data
SiteVisit	Site visit.	Character data
StatusCode	Status code.	Character data
TimeStamp	Time stamp.	Date
VisitTypeCode	Visit type code.	Character data

SWILSClinicalGetSiteSnapshot 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 Get Site Snapshot Service	Workflow	Not applicable

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 Status Snapshot IO	Clinical Trip Report

Example Package for SWILSClinicalGetSiteSnapshot

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:

...\SWILSClinicalGetSiteSnapshot\SWILSClinicalGetSiteSnapshot-CaptureSnapshot-
request.xml

Response

See the following file to view the sample code:

...\SWILSClinicalGetSiteSnapshot\SWILSClinicalGetSiteSnapshot-response.xml

Interface Description (WSDL) for SWILSClinicalGetSiteSnapshot

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.

...\SWILSClinicalGetSiteSnapshot\SWILSClinicalGetSiteSnapshot.WSDL

SWILSClinicalGetSmartScriptDetails

This Web service returns smart script details such as questions, pages, question branching, and page branching details.

SWILSClinicalGetSmartScriptDetails Operations

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

Operation Name	Description
SmartScriptQueryById	Returns smart script details for the smart script whose row ID matches the given Row ID.
SmartScriptQueryByExample	Used to query smart scripts on different criteria. If no input is provided for any tag, then the Web service returns all smart script details from the system.

Request Message Description: SmartScriptQueryById

This operation accepts the Row ID of a smart script and returns the details of that particular smart script.

Request Message Description: SmartScriptQueryByExample

This operation has several tags to accept the input. You can provide input to any of the tags to retrieve specific details. No field is mandatory. The most important tag is "Name" which accepts the smart script name and returns the details of that specific to the smart script.

Response Message Description: SmartScriptQueryById and SmartScriptQueryByExample

For an example of the response message, see Example Package for SWILSClinicalGetSmartScriptDetails.

SWILSClinicalGetSmartScriptDetails 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 Get Smart Script Details	Business 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 Get Smart Script Details IO	LS Clinical Smart Scripts
LS Clinical Get Smart Script Details Internal IO	LS Clinical Smart Scripts

Example Package for SWILSClinicalGetSmartScriptDetails

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:

...\SWILSClinicalGetSmartScriptDetails\SWILSClinicalGetSiteSnapshot-QueryByExample-
request.xml 
...\SWILSClinicalGetSmartScriptDetails\SWILSClinicalGetSiteSnapshot-QueryById-
request.xml

Response

See the following file to view the sample code:

...\SWILSClinicalGetSmartScriptDetails\SWILSClinicalGetSmartScriptDetails-response.xml

Interface Description (WSDL) for SWILSClinicalGetSmartScriptDetails

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.

...\SWILSClinicalGetSmartScriptDetails\SWILSClinicalGetSmartScriptDetails.WSDL

SWILSClinicalGetStateModelService

Use this Web service to send the state transitions for a given state model name. An external application can invoke this Web service using any valid Siebel application user credentials for authentication. Additionally, consider the following:

If no input is provided for any tags in the LSClinicalGetStateModelServiceQueryByExample operation, then the Web service returns all state transitions for all state models in the Clinical Trial Management System application. An error message might result if the result set is large in number, then the user is prompted to refine the search.
An external application can invoke this Web service with either operation depending on the scenario.
If the page size field is empty (or blank) in the LSClinicalGetStateModelServiceQueryPage operation, then the Web service returns an error message.
The mobile application user may want to update the trip report status from one state to the next valid state. The user must know the valid To Status value from the current status. In this case, the mobile user must have all valid states for a given state model name.
Use this Web service to return all valid state transitions for a given state model name.

SWILSClinicalGetStateModelService Operations

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

Operation Name	Description
LSClinicalGetStateModelServiceQueryPage	Returns state model transitions in pages.
LSClinicalGetStateModelServiceQueryByExample	Returns state model transitions as one result set.

Request Message Description: LSClinicalGetStateModelServiceQueryByExample

You can invoke this operation in this Web service with a state model name value so that only related state model transitions are returned. If you provide no input, then all the state model transition values are returned. For a description of this request message, see the following table.

Node	Description	Type
StateModel.Id	Optional. Row ID of state model name.	Character data
StateModel. Searchspec	Optional. Search specification.	Character data
StateModel.Name	Optional. State model name.	Character data
StateModel-Transition.Id	Optional. Row ID of the transition record.	Character data
StateModel-Transition. FromStateName	Optional. From state name.	Character data
StateModel-Transition. PublicFlag	Optional. Public flag. Values are Y or N.	Boolean
StateModel-Transition. RuleExpression	Optional. Rule expression.	Character data
StateModel-Transition. RuleFieldName	Optional. Rule field name.	Character data
StateModel-Transition. RuleOperator	Optional. Rule operator.	Character data
StateModel-Transition. RuleValue	Optional. Rule value.	Character data
StateModel-Transition. ToStateName	Optional. To state name. A user can change the status drop down value from one state to another state.	Character data

Request Message Description: LSClinicalGetStateModelServiceQueryPage

You can invoke this operation with the state model name value so that only related state model transitions are returned. If all state model transition values are required, then pass an asterisk (*) for all nodes. The result set will be in pages with a page size. For a description of this request message, see the following table.

Node	Description	Type
StateModel.Id	Required. The row ID of the state model name. Can be either an asterisk (*), or a valid row ID.	Character data
StateModel.Name	Required. State model name. Can be either an asterisk (*), or a valid state model name.	Character data
StateModel-Transition.Id	Required. Row ID of transition record. Can be either an asterisk (*), or the row ID of the transition state.	Character data
StateModel-Transition. FromStateName	Required. From state name. Can be either an asterisk (*), or From State name.	Character data
StateModel-Transition. PublicFlag	Required. Public flag. Possible values are Y or N. Can be either an asterisk (*), or public flag.	Boolean
StateModel-Transition. ToStateName	Required. To state name. Can be either an asterisk (*), or To State name.	Character data

Response Message Description: LSClinicalGetStateModelServiceQueryByExample and LSClinicalGetStateModelServiceQueryPage

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

Node	Description	Type
StateModel.Id	Row ID of the state model name.	Character data
StateModel.Name	State model name.	Character data
StateModel-Transition. FromStateName	From State name.	Character data
StateModel-Transition. PublicFlag	Public flag. Possible values are Y or N.	Boolean
StateModel-Transition. RuleExpression	Rule expression.	Character data
StateModel-Transition. RuleFieldName	Rule field name.	Character data
StateModel-Transition. RuleOperator	Rule operator.	Character data
StateModel-Transition. RuleValue	Rule value.	Character data
StateModel-Transition. ToStateName	To State name.	Character data

SWILSClinicalGetStateModelService 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 Get State Model Service	Business 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 State Model - Interface IO	State Model

Example Package for SWILSClinicalGetStateModelService

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:

...\SWILSClinicalGetStateModelService\SWILSClinicalGetStateModelService-QueryByExample-request.xml
...\SWILSClinicalGetStateModelService\SWILSClinicalGetStateModelService-QueryPage-request.xml

Interface Description (WSDL) for SWILSClinicalGetStateModelService

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.

...\SWILSClinicalGetStateModelService\SWILSClinicalGetStateModelService-
QueryByExample.WSDL
...\SWILSClinicalGetStateModelService\SWILSClinicalGetStateModelService-QueryPage.WSDL

SWILSClinicalGetSubjectVisitDetails

Use this Web service to send all subject visit details from a particular protocol site. An external application can invoke this Web service using any valid Siebel application user credentials for authentication. Additionally, consider the following:

If no input is provided for any tags in LSClinicalGetSubjectVisitDetailsQueryByExample operation, then the Web service returns all subject visit details. An error message might result if the result set is larger than the predefined maximum size, and then the user is prompted to refine the search.
An external application can invoke this Web service with any methods depends on the scenario.
This Web service will return an error message if the page size is empty (or blank) in the QueryPage method.
Only provided tags need to be used with the QueryPage method.
The mobile application user might want to add or update a new Case Report form record to a trip report. Is so, then the user must have all the available subject visit details for a particular protocol site at the target host.
The external user can use this Web service to get all subject visit details for a given search criteria.

SWILSClinicalGetSubjectVisitDetails Operations

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

Operation Name	Description
LSClinicalGetSubjectVisitDetailsQueryById	Returns subject visit details for a given protocol site ID.
LSClinicalGetSubjectVisitDetailsQueryPage	Returns subject visit details in pages.
LSClinicalGetSubjectVisitDetailsQueryByExample	Returns subject visit details in a single result set based on a given search criteria.

Request Message Description: LSClinicalGetSubjectVisitDetailsQueryByExample

You can invoke this operation with the protocol site ID to ensure that only the corresponding site related to subject visits is returned. If no input is provided, then all the subject visits from all sites are returned. For a description of this request message, see the following table.

Node	Description	Type
Id	Optional. Row ID of subject visit record.	Character data
Searchspec	Optional. Search specification.	Character data
CRFPages	Optional. Number of Case Report form pages.	Integer
ActivityUID	Optional. Activity ID.	Character data
Category	Optional. Category, such as Visit.	Character data
ParentActivityId	Optional. Parent activity ID.	Character data
ParentTemplateVersionId	Optional. Parent template version.	Character data
ProtocolSiteId	Optional. Protocol site ID.	Character data
Screen	Optional. Subject screen number.	Character data
SubjectDOB	Optional. Date of birth.	Date and time
SubjectId	Optional. Subject row ID.	Character data
SubjectInitial	Optional. Subject initials.	Character data
Template	Optional. Template.	Character data
TemplateFlag	Optional. Template flag.	Character data
TemplateId	Optional. Template ID.	Character data
TemplateVersion	Optional. Template version.	Character data
Type	Optional. Visit type.	Character data

Request Message Description: LSClinicalGetSubjectVisitDetailsQueryPage

Invoke this method by passing an asterisk (*) to all of the tags to return all subject visit details from all sites. The result set is returned in pages with page size. For a description of this request message, see the following table.

Node	Description	Type
Id	Required. Row ID of a subject visit record. Can be either an asterisk (*), or a valid row ID.	Character data
ActivityUID	Required. Activity ID. Can be either an asterisk (*), or a valid activity ID.	Character data
Category	Required. A category such as Visit, and so on. Can be either an asterisk (*), or a valid category value.	Character data
ParentTemplateVersionId	Required. Parent template version. Can be either an asterisk (*), or a valid parent template version ID.	Character data
ProtocolSiteId	Required. Protocol site ID. Can be either an asterisk (*), or a valid protocol site ID.	Character data
Screen	Required. Subject screen number. Can be either an asterisk (*), or a valid screen value.	Character data
SubjectId	Required. Subject row ID. Can be either an asterisk (*), or a valid subject ID.	Character data
SubjectInitial	Required. Subject initial. Can be either an asterisk (*), or a valid subject initial value.	Character data
Template	Required. Template. Can be either an asterisk (*), or a valid template value.	Character data
TemplateFlag	Required. Template flag. Can be either an asterisk (*), or a valid template flag. Values are Y or N.	Character data
TemplateId	Required. Template ID. Can be either an asterisk (*), or a valid template ID.	Character data
TemplateVersion	Required. Template version. Can be either an asterisk (*), or a valid template version.	Character data
Type	Required. Visit type. Can be either an asterisk (*), or a valid type value.	Character data

Request Message Description: LSClinicalGetSubjectVisitDetailsQueryById

One can invoke this method in this Web service by passing the exact Row Id of a particular subject visit record. For a description of this request message, see the following table.

Node	Description	Type
PrimaryRowId	Required. The primary row ID of the subject visit record.	Character data

Response Message Description: LSClinicalGetSubjectVisitDetailsQueryByExample, LSClinicalGetSubjectVisitDetailsQueryPage and LSClinicalGetSubjectVisitDetailsQueryById

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

Node	Description	Type
Id	Row ID of the subject visit record.	Character data
CRFPages	The number of case report form pages	Integer
ActivityUID	Activity ID.	Character data
Category	Category, such as visit, and so on.	Character data
ParentActivityId	Parent activity ID.	Character data
ParentTemplateVersionId	Parent template version.	Character data
ProtocolSiteId	Protocol site ID.	Character data
Screen	Subject screen number.	Character data
SubjectDOB	Date of birth.	Date Time
SubjectId	Subject row ID.	Character data
SubjectInitial	Subject initial.	Character data
Template	Template.	Character data
TemplateFlag	Template flag.	Character data
TemplateId	Template ID.	Character data
TemplateVersion	Template version.	Character data
Type	Visit type.	Character data

SWILSClinicalGetSubjectVisitDetails 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 GetSubjectVisitDetails	Business 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 Visit Plan	LS Clinical Visit Plan

Example Package for SWILSClinicalGetSubjectVisitDetails

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:

...\SWILSClinicalGetSubjectVisitDetails\SWILSClinicalGetSubjectVisitDetails-QueryByExample-request.xml 
...\SWILSClinicalGetSubjectVisitDetails\SWILSClinicalGetSubjectVisitDetails-QueryById-request.xml
...\SWILSClinicalGetSubjectVisitDetails\SWILSClinicalGetSubjectVisitDetails-QueryPage-request.xml

Interface Description (WSDL) for SWILSClinicalGetSubjectVisitDetails

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.

...\SWILSClinicalGetSubjectVisitDetails\SWILSClinicalGetSubjectVisitDetails-
QueryByExample.WSDL
...\SWILSClinicalGetSubjectVisitDetails\SWILSClinicalGetSubjectVisitDetails-
QueryPage.WSDL
...\SWILSClinicalGetSubjectVisitDetails\SWILSClinicalGetSubjectVisitDetails-
QueryById.WSDL

SWILSClinicalInsertEmployees

Use this Web service to insert employees into the Assigned To MVG for check list items, followup items, all followup items, and site visit team. You can also use this Web service to remove employees from Assigned To MVG for check list items, followup items, all followup items, and site visit team. The external application can invoke this Web service using any valid Siebel application user credentials for authentication. Additionally, consider the following:

If no input is provided for any tags in both operations, then an error message is generated.
An external application can invoke this Web service with any operation depending on the scenario.
Mobile application users can assign or delete employees to or from the Assigned To fields in check list items, individual followup items, all followup items, and site visit teams.

SWILSClinicalInsertEmployees Operations

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

Operation Name	Description
LSClinicalInsertEmployeesInsert	Used to insert employees into the Assigned To field for different item types.
LSClinicalInsertEmployeesDelete	Used to delete employees from the Assigned To field in different item types.

Request Message Description: LSClinicalInsertEmployeesInsert

This operation can be invoked to insert employees either into a site visit team or into the Assigned To field in check list items, followup items, or all followup items. For a description of this request message, see the following table.

Node	Description	Type
ActivityId	Required. Activity ID.	Character data.
EmpId	Required. Employee ID.	Character data.

Request Message Description: LSClinicalInsertEmployeesDelete

Invoke this operation to delete employees either from a site visit team or from the Assigned To field in check list items, followup items, or all followup items. For a description of this request message, see the following table.

Node	Description	Type
ActivityId	Required. Activity ID.	Character data.
EmpId	Required. Employee ID.	Character data.

SWILSClinicalInsertEmployees 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 Insert Employees	Business 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 Checklist Assignee	LS Clinical Checklist Assignee

Example Package for SWILSClinicalInsertEmployees

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:

...\SWILSClinicalInsertEmployees\SWILSClinicalInsertEmployees-Insert-request.xml 
...\SWILSClinicalInsertEmployees\SWILSClinicalInsertEmployees-Delete-request.xml

Interface Description (WSDL) for SWILSClinicalInsertEmployees

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.

...\SWILSClinicalInsertEmployees\SWILSClinicalInsertEmployees-Insert.WSDL
...\SWILSClinicalInsertEmployees\SWILSClinicalInsertEmployees-Delete.WSDL

SWILSClinicalListOfValues

Use this Web service to send the LOV details for a given LOV type from a Siebel CRM application. The third-party application can invoke this Web service using any valid Siebel CRM user ID as authentication.

An external application can invoke this Web service with either operation depending on the scenario.
This Web service returns an error message when the LOVQueryPage operation is used with blank page size.
If no input is provided for the tags in the LOVQueryByExample operation, then the Web service will attempt to return all the available records from the Siebel database. If this result set exceeds the predefined maximum size, then the Web service returns an error which instructs the user to refine the search criteria.
Use only provided tags with the LOVQueryPage operation.
Mobile users have all available LOV values on the mobile server to allow them to choose values for clinical trip reports.

SWILSClinicalListOfValues Operations

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

Operation Name	Description
LOVQueryPage	Used to send LOV details for a given LOV type.
LOVQueryByExample	Used to send LOV details for a given LOV type.

Request Message Description: LOVQueryPage

Use this operation when the given search specification retrieves a large number of records at the root component. To avoid returning one large Siebel message, you can specify the number of records to be returned using the PageSize argument. For a description of this request message, see the following table.

Node	Description	Type
Language	Required. A valid language code such as ENU. Can be either an asterisk (*), or a valid Language code.	Character data
LanguageName	Required. The name of the language which can be either an asterisk (*), or a valid language name such as English-American.	Character data
Modifiable	Required. Modifiable flag which can be either an asterisk (*), or a valid Boolean flag such as Y or N.	Boolean
Multilingual	Required. Multilingual flag which can be either an asterisk (*), or a valid Boolean flag such as Y or N.	Boolean
Name	Required. Language independent code (LIC) which can be either an asterisk (*), or a valid LIC code.	Character data
ReplicationLevel	Required. Replication level which can be either an asterisk (*), or a valid replication level.	Character data
Translate	Required. The Translate flag which can be either an asterisk (*), or a valid Boolean flag such as Y or N.	Boolean
Type	Required. LOV Type. Can be either an asterisk (*), or a valid LOV type.	Character data
Value	Required. Display value Can be either an asterisk (*), or a valid display value.	Character data

Request Message Description: LOVQueryByExample

Use this operation if the external application requires only a limited number of LOV type values. For example, to get all LOV type values for all LOVs whose name starts with AAG, then you can call this method with Type value set as follows:

AAG*

If this operation is invoked with no input for any fields, then the Web service attempts to return all the LOV records as one Siebel message. If the number of LOV records is more than the predefined maximum page size, then the Web service returns an error message prompting the user to refine the search criteria. This operation requires the use of some criteria such as Type, Language, Order By, and so on.

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

Node	Description	Type
Id	Optional. Row ID of LOV type value.	Character data
Searchspec	Optional. Search specification.	Character data
Active	Optional. Active or inactive flag.	Boolean
Bitmap	Optional. Bit map.	Character data
BitmapId	Optional. Bit map ID.	Character data
ClassCode	Optional. Class code.	Character data
Description	Optional. Description of the LOV type value.	Character data
High	Optional. High value range.	Character data
Language	Optional. Language code.	Character data
LanguageName	Optional. Name of the language.	Character data
Low	Optional. Low value range.	Character data
Modifiable	Optional. Modifiable flag.	Boolean
Multilingual	Optional. Multilingual flag.	Boolean
Name	Optional. Language independent code.	Character data
OrderBy	Optional. Order by value.	Number
OrganizationId	Optional. Organization ID.	Character data
Parent	Optional. Parent LIC Code.	Character data
ParentId	Optional. Parent LIC code row ID.	Character data
ReplicationLevel	Optional. Replication level.	Character data
SubType	Optional. Name of parent LIC.	Character data
TargetHigh	Optional. Target high value in a range.	Number
TargetLow	Optional. Target low value in a range.	Number
Translate	Optional. Translate flag.	Boolean
Type	Optional. LOV type.	Character data
Value	Optional. Display value.	Character data
WeightingFactor	Optional. Weighting factor.	Number

Response Message Description: LOVQueryByExample and LOVQueryPage

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

Node	Description	Type
Id	Row Id of LOV type value.	Character data
Active	Active or Inactive Flag.	Boolean
Bitmap	Bit map.	Character data
BitmapId	Bit map ID.	Character data
ClassCode	Class code.	Character data
Description	Description of LOV type value.	Character data
High	High value in a range.	Character data
Language	Language code.	Character data
LanguageName	Name of the language.	Character data
Low	Low value in a range.	Character data
Modifiable	Modifiable flag.	Boolean
Multilingual	Multilingual flag.	Boolean
Name	Language independent code.	Character data
OrderBy	Order by value.	Number
OrganizationId	Organization ID.	Character data
Parent	Parent LIC code.	Character data
ParentId	Parent LIC code row ID.	Character data
ReplicationLevel	Replication level.	Character data
SubType	Name of parent LIC.	Character data
TargetHigh	Target high value in a range.	Number
TargetLow	Target low value in a range.	Number
Translate	Translate flag.	Boolean
Type	LOV type.	Character data
Value	Display value.	Character data
WeightingFactor	Weighting factor.	Number

SWILSClinicalListOfValues 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 List Of Value Service	Business 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 List Of Values	List Of Values

Example Package for SWILSClinicalListOfValues

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:

...\SWILSClinicalListOfValues\SWILSClinicalListOfValues-QueryPage-request.xml 
...\SWILSClinicalListOfValues\SWILSClinicalListOfValues-QueryByExample-request.xml

Interface Description (WSDL) for SWILSClinicalListOfValues

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.

...\SWILSClinicalListOfValues\SWILSClinicalListOfValues-QueryByExample.WSDL
...\SWILSClinicalListOfValues\SWILSClinicalListOfValues-QueryPage.WSDL

SWILSClinicalProtocolSiteGetSites

Use this Web service to populate the My Sites view for a user based on provided login credentials. An external application can invoke this Web service by passing valid Siebel application user credentials for authentication. If a user tries to access another user's sites, then the Web service can be called with the user’s login credentials and the other user’s login name. In this case, the sites that are common to both users are returned. For example, if the user SADMIN wants to access his sites, then the Web service is called with SADMIN login credentials for Siebel authentication and the login name of the SADMIN user. If the SADMIN user wants to access sites assigned to CWALKER, then the Web service is called with the SADMIN login credentials for Siebel authentication and the login name of CWALKER. The result set will include only the sites that are common to SADMIN and CWALKER.

Additionally, consider the following:

A PageSize variable with a value greater than 0 is required.
This Web service supports sort specification (SortSpec) which is used to sort the output based on provided sort criteria.

SWILSClinicalProtocolSiteGetSites Operations

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

Operation Name	Description
QuerySites	Used to send sites belongs to the given user.

Request Message Description: QuerySites

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

Node	Description	Type
Login	Required. The login name of a user such as SADMIN, CWALKER, and so on.	Character data

Response Message Description: QuerySites

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

Parent Node	Field	Type
ClinicalProtocolSiteForMobileIntegration	Id	Character data
ClinicalProtocolSiteForMobileIntegration	AddressId	Character data
ClinicalProtocolSiteForMobileIntegration	AmountCurrencyCode	Character data
ClinicalProtocolSiteForMobileIntegration	AmountExchangeDate	Date
ClinicalProtocolSiteForMobileIntegration	City	Character data
ClinicalProtocolSiteForMobileIntegration	ClinicalProgramName	Character data
ClinicalProtocolSiteForMobileIntegration	Country	Character data
ClinicalProtocolSiteForMobileIntegration	Email	Character data
ClinicalProtocolSiteForMobileIntegration	FaxNumber	Character data
ClinicalProtocolSiteForMobileIntegration	InitiationCompletedDate	Date
ClinicalProtocolSiteForMobileIntegration	InvestigatorFirstName	Character data
ClinicalProtocolSiteForMobileIntegration	InvestigatorFullName	Character data
ClinicalProtocolSiteForMobileIntegration	InvestigatorLastName	Character data
ClinicalProtocolSiteForMobileIntegration	PhoneNumber	Character data
ClinicalProtocolSiteForMobileIntegration	PrimaryInvestigatorId	Character data
ClinicalProtocolSiteForMobileIntegration	ProtocolId	Character data
ClinicalProtocolSiteForMobileIntegration	ProtocolNumber	Character data
ClinicalProtocolSiteForMobileIntegration	ProtocolSiteId	Character data
ClinicalProtocolSiteForMobileIntegration	ProtocolTitle	Character data
ClinicalProtocolSiteForMobileIntegration	Region	Character data
ClinicalProtocolSiteForMobileIntegration	SiteId	Character data
ClinicalProtocolSiteForMobileIntegration	SiteName	Character data
ClinicalProtocolSiteForMobileIntegration	SiteNumber	Character data
ClinicalProtocolSiteForMobileIntegration	SiteType	Character data
ClinicalProtocolSiteForMobileIntegration	State	Character data
ClinicalProtocolSiteForMobileIntegration	StreetAddress	Character data
ClinicalProtocolSiteForMobileIntegration	TerminatedDate	Date
ClinicalProtocolSiteForMobileIntegration	TotalContractAmount	Number
ClinicalProtocolSiteForMobileIntegration	WithholdingAmount	Number
ClinicalProtocolSiteForMobileIntegration	WithholdingPercentage	Number
ClinicalProtocolSiteForMobileIntegration	Zip	Character data
ClinicalProtocolSiteForMobileIntegration	PrimarySiteAddress	Character data
ClinicalProtocolSiteForMobileIntegration	AddressType	Character data
ClinicalProtocolSiteForMobileIntegration	PrimarySiteAddressId	Character data
ClinicalProtocolSiteforMobileIntegration_SubjectTemplate	IRBApprovalDate	Date
ClinicalProtocolSiteforMobileIntegration_SubjectTemplate	Version	Character data
ClinicalAccountInvestigatorRole	Id	Character data
ClinicalAccountInvestigatorRole	City	Character data
ClinicalAccountInvestigatorRole	Country	Character data
ClinicalAccountInvestigatorRole	EmailAddress	Character data
ClinicalAccountInvestigatorRole	FaxPhone	Character data
ClinicalAccountInvestigatorRole	FirstName	Character data
ClinicalAccountInvestigatorRole	LastName	Character data
ClinicalAccountInvestigatorRole	PostalCode	Character data
ClinicalAccountInvestigatorRole	PrimarySpecialty	Character data
ClinicalAccountInvestigatorRole	Region	Character data
ClinicalAccountInvestigatorRole	Role	Character data
ClinicalAccountInvestigatorRole	State	Character data
ClinicalAccountInvestigatorRole	StreetAddress	Character data
ClinicalAccountInvestigatorRole	WorkPhone	Character data
LsClinicalAccountAddress	Id	Character data
LsClinicalAccountAddress	AccountId	Character data
LsClinicalAccountAddress	AccountLoc	Character data
LsClinicalAccountAddress	AccountName	Character data
LsClinicalAccountAddress	ActiveStatus	Character data
LsClinicalAccountAddress	AddressId	Character data
LsClinicalAccountAddress	AddressName	Character data
LsClinicalAccountAddress	AddressType	Character data
LsClinicalAccountAddress	Altitude	Number
LsClinicalAccountAddress	CLLI	Character data
LsClinicalAccountAddress	City	Character data
LsClinicalAccountAddress	Country	Character data
LsClinicalAccountAddress	DisableDataCleansing	Character data
LsClinicalAccountAddress	EndDate	Date
LsClinicalAccountAddress	FaxNumber	Character data
LsClinicalAccountAddress	LATA	Character data
LsClinicalAccountAddress	Latitude	Number
LsClinicalAccountAddress	LocalOperatingCompany	Character data
LsClinicalAccountAddress	LocalOperatingCompany Site	Character data
LsClinicalAccountAddress	LocationFlag	Boolean
LsClinicalAccountAddress	LocationType	Character data
LsClinicalAccountAddress	Longitude	Number
LsClinicalAccountAddress	ParentAddress	Character data
LsClinicalAccountAddress	PhoneNumber	Character data
LsClinicalAccountAddress	PostalCode	Character data
LsClinicalAccountAddress	Prefix	Character data
LsClinicalAccountAddress	IsPrimaryAddress	Boolean
LsClinicalAccountAddress	RateCenter	Character data
LsClinicalAccountAddress	StartDate	Date
LsClinicalAccountAddress	State	Character data
LsClinicalAccountAddress	StreetAddress	Character data
LsClinicalAccountAddress	StreetAddress2	Character data
LsClinicalAccountAddress	Type	Character data
LsClinicalAccountAddress	UTMEasting	Character data
LsClinicalAccountAddress	UTMNorthing	Character data
ClinicalProtocolSiteAddressBc	Id	Character data
ClinicalProtocolSiteAddressBc	AddressLine1	Character data
ClinicalProtocolSiteAddressBc	AddressLine2	Character data
ClinicalProtocolSiteAddressBc	AddressType	Character data
ClinicalProtocolSiteAddressBc	City	Character data
ClinicalProtocolSiteAddressBc	Country	Character data
ClinicalProtocolSiteAddressBc	Description	Character data
ClinicalProtocolSiteAddressBc	Email	Character data
ClinicalProtocolSiteAddressBc	Fax	Character data
ClinicalProtocolSiteAddressBc	ParentAddress	Character data
ClinicalProtocolSiteAddressBc	Phone	Character data
ClinicalProtocolSiteAddressBc	State	Character data
ClinicalProtocolSiteAddressBc	Zip	Character data
LsClinicalContactAddress	Id	Character data
LsClinicalContactAddress	ActiveFlag	Boolean
LsClinicalContactAddress	AddressId	Character data
LsClinicalContactAddress	AlignmentFlag	Boolean
LsClinicalContactAddress	City	Character data
LsClinicalContactAddress	Country	Character data
LsClinicalContactAddress	DEAExpr	Date
LsClinicalContactAddress	DEA	Character data
LsClinicalContactAddress	EndDate	Date Time
LsClinicalContactAddress	Fax	Character data
LsClinicalContactAddress	Phone	Character data
LsClinicalContactAddress	PostalCode	Character data
LsClinicalContactAddress	ProfessionalId	Character data
LsClinicalContactAddress	StartDate	Date Time
LsClinicalContactAddress	State	Character data
LsClinicalContactAddress	StreetAddress	Character data
LsClinicalContactAddress	Type	Character data
Contact	Id	Character data
Contact	CellularPhone	Character data
Contact	CompanyIdentifier	Character data
Contact	EmailAddress	Character data
Contact	FirstName	Character data
Contact	JobTitle	Character data
Contact	LastName	Character data
Contact	PersonUId	Character data
Contact	Type	Character data
Contact	WorkPhone	Character data
Contact_Position	EmployeeFirstName	Character data
Contact_Position	EmployeeLastName	Character data
Contact_Position	Position	Character data
Contact_Position	PositionId	Character data
Contact_Position	PositionPrimaryAddressId	Character data
Contact_Position	Login	Character data

SWILSClinicalProtocolSiteGetSites 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 Get Sites	Workflow	Not applicable
LS Clinical Protocol Site Get User Position	Workflow	Not applicable

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 Get Sites Input IO	Clinical Protocol Site for Mobile Integration
LS Clinical Protocol Site Get Sites Intermediate IO	Clinical Protocol Site for Mobile Integration
LS Clinical Protocol Site Get Sites Output IO	Clinical Protocol Site for Mobile Integration

Example Package for SWILSClinicalProtocolSiteGetSites

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:

...\SWILSClinicalProtocolSiteGetSites\SWILSClinicalProtocolSiteGetSites_request.xml

Interface Description (WSDL) for SWILSClinicalProtocolSiteGetSites

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.

...\SWILSClinicalProtocolSiteGetSites\SWILSClinicalProtocolSiteGetSites.WSDL

SWILSClinicalQueryProtocolSite_SiteVisits

Use Siebel Life Sciences as the master system for the objects in the Study hierarchy, such as the protocol, site, and site visits. In a biotechnology or pharmaceutical company, after Protocols and Sites are created in the Siebel database, the information might be required in other downstream third-party applications used to study of protocol. Siebel Life Sciences can provide information on protocols, based on input parameters that are contained in the Web service request messages provided by third-party applications.

Requests can be limited by the User ID or by the protocol number, or both. When the input parameters of the Protocol Number field and User ID (Site Visit Team Member) are provided, the Web service returns only the information from the related sites and site visits. There is no output for users, protocols, or users who are not associated with the protocol.

SWILSClinicalQueryProtocolSite_SiteVisits Operations

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

Name	Description
query	Queries the Clinical Trial Management System application to retrieve protocol, site, and site visit information.

Request Message Description: query

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

Node	Description	Type
UserId	Required. Passes a valid site visit team member login ID to get the corresponding user's site visits or passes (*) to get site visit details of all users.	Character data
Protocol Number	Required. Passes a valid protocol number to get a user's site visits in the given protocol or passes (*) to get site visits of a user in all protocols.	Character data
PageSize	Required. Number of protocol sites the user wants to view in a single page. The number must be greater than zero.	Number
StartRowNum	Optional. First record you want to start with.	Number
Sort Spec	Used to sort the clinical protocol site records based on the given sort specifications. The Clinical Research Associate can query and prioritize site visits based on fields such as status, Site ID and so on. Other fields include: Account Main Phone Number Account Status Address Id Primary Investigator Id Protocol Id Protocol Number Protocol Site Id Protocol Title Region Region Id Site Id Site Number Status Investigator First Name Investigator Last Name	Comma-separated list of Clinical Protocol Site for Mobile Integration business component fields made available in the integration.

Response Message Description: query

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

Parent Node	Field	Type	Description
ClinicalProtocolSite	ProtocolNumber	Character data	Display protocol and site details.
ClinicalProtocolSite	ProtocolId	Character data	Display protocol and site details.
ClinicalProtocolSite	ProtocolSiteId	Character data	Display protocol and site details.
ClinicalProtocolSite	ProtocolTitle	Character data	Display protocol and site details.
ClinicalProtocolSite	Region	Character data	Display protocol and site details.
ClinicalProtocolSite	RegionId	Character data	Display protocol and site details.
ClinicalProtocolSite	SiteId	Character data	Display protocol and site details.
ClinicalProtocolSite	AccountMainPhone Number	Character data	Display protocol and site details.
ClinicalProtocolSite	Account	Character data	Display protocol and site details.
ClinicalProtocolSite	SiteNumber	Character data	Display protocol and site details.
ClinicalProtocolSite	PrimaryInvestigatorId	Character data	Display protocol and site details.
ClinicalProtocolSite	AddressId	Character data	Display protocol and site details.
ClinicalProtocolSite	Planned	Integer	Display protocol and site details.
ClinicalProtocolSite	AccountStatus	Character data	Display protocol and site details.
ClinicalProtocolSite	Status	Character data	Display protocol and site details.
ClinicalProtocolSite	AccountType	Character data	Display protocol and site details.
ClinicalProtocolSite	UserId	Character data	Display protocol and site details.
ClinicalProtocolSiteAddressBc	Fax	Character data	Display details of addresses associated with the site.
ClinicalProtocolSiteAddressBc	City	Character data	Display details of addresses associated with the site.
ClinicalProtocolSiteAddressBc	AddressLine2	Character data	Display details of addresses associated with the site.
ClinicalProtocolSiteAddressBc	Phone	Character data	Display details of addresses associated with the site.
ClinicalProtocolSiteAddressBc	State	Character data	Display details of addresses associated with the site.
ClinicalProtocolSiteAddressBc	Country	Character data	Display details of addresses associated with the site.
ClinicalProtocolSiteAddressBc	Zip	Character data	Display details of addresses associated with the site.
ClinicalAccountInvestigatorRole	FirstName	Character data	Display site contact details.
ClinicalAccountInvestigatorRole	FaxPhone	Character data	Display site contact details.
ClinicalAccountInvestigatorRole	EmailAddress	Character data	Display site contact details.
ClinicalAccountInvestigatorRole	WorkPhone	Character data	Display site contact details.
ClinicalAccountInvestigatorRole	State	Character data	Display site contact details.
ClinicalAccountInvestigatorRole	LastName	Character data	Display site contact details.
ClinicalTripReport	Done	Date and Time	Display site visit details.
ClinicalTripReport	Description	Character data	Display site visit details.
ClinicalTripReport	Comment	Character data	Display site visit details.
ClinicalTripReport	Id	Character data	Display site visit details.
ClinicalTripReport	InvestigatorFirst Name	Character data	Display site visit details.
ClinicalTripReport	InvestigatorLast Name	Character data	Display site visit details.
ClinicalTripReport	Planned2	Date and Time	Display site visit details.
ClinicalTripReport	Status	Character data	Display site visit details.
ClinicalTripReport	Type	Character data	Display site visit details.
ClinicalTripReport	TripReportStatus	Character data	Display site visit details.
LsClinicalSiteVisitEmployee	Login	Character data	Display site visit team member details.
LsClinicalSiteVisitEmployee	Emp Id	Character data	Display site visit team member details.
LsClinicalSiteVisitEmployee	IsPrimaryOwner	Character data	Display site visit team member details.
query	LastPage	Character data	Displays True if the page is last, otherwise it will display False.

SWILSClinicalQueryProtocolSite_SiteVisits 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 (Workflow)

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

Name	Boundary Object Type	Class
SWI LS Clinical Query Protocol Site_Site Visits	Workflow	Not applicable.

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_Site Visits Input IO	Clinical Protocol Site for Mobile Integration
LS Clinical Protocol Site_Site Visits Output IO	Clinical Protocol Site for Mobile Integration

Example Package for SWILSClinicalQueryProtocolSite_SiteVisits

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:

...\SWILSClinicalQueryProtocolSite_SiteVisits\SWILSClinicalQueryProtocolSite_SiteVisits_request.xml

Response

See the following file to view the sample code:

...\SWILSClinicalQueryProtocolSite_SiteVisits\SWILSClinicalQueryProtocolSite_SiteVisits_response.xml

Interface Description (WSDL) for SWILSClinicalQueryProtocolSite_SiteVisits

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.

...\SWILSClinicalQueryProtocolSite_SiteVisits\SWILSClinicalQueryProtocolSite_SiteVisits.wsdl

SWI LS Clinical Payments Inbound

Use this Web service to update the incoming status, and to check the details of a payment for a site. An external application invokes this Web service with payment number, status, currency code, and check date. If the Payment Number or Status fields are null, then no updates are made to the Siebel Life Sciences application. If the currency code is null in the Web service, then the currency code presented in Siebel Life Sciences will be used. An error message is returned in the event of an error.

SWI LS Clinical Payments Inbound Operations

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

Name	Description
UpdateClinicalPayment	Updates the payment status, and checks the details of a payment for a particular site.

Request Message Description: UpdateClinicalPayment

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

Note: An external application can pass values for other nodes, apart from those listed in the following table. Values in the following table are updated in the Siebel Life Sciences application.

Node	Description	Type
Payment Number	Required.	Character data
Status	Required. Status of the payment.	Character data
AmountCurrencyCode	Optional.	Character data
CheckDate	Optional.	Date
CheckNumber	Optional.	Character data
PaymentFeedback	Optional. Customer feedback or comments.	Character data
VATAmount	Optional. Value added tax amount.	Currency

Response Message Description: UpdateClinicalPayment

There is no response message for the UpdateClinicalPayment operation.

SWI LS Clinical Payments Inbound 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 (Workflow)

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

Name	Boundary Object Type	Class
SWI LS Clinical Payments Inbound	Workflow	Not applicable.

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

Example Package for SWI LS Clinical Payments

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:

...\LSClinicalPayments\UpdateClinicalPayment_request.xml

Interface Description (WSDL) for SWI LS Clinical Payments

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.

...\LSClinicalPayments\SWI_LS_Clinical_Payments_Inbound.wsdl

SWILSClinicalSiteContactsTrainingInterfaceService

Use this web service to return the training details of site contacts to external applications and to update the training records from external applications to Siebel Clinical Trial Management System. This Web service supports four methods.

SWILSClinicalSiteContactsTrainingInterfaceService Operations

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

Operation Name	Description
ContactsTrainingQueryById	Returns the training details of all contacts in a site.
ContactsTrainingQueryPage	It can be used to retrieve training details of all contacts of a site by means of pages or to retrieve training details of all contacts across all sites in terms of pages.
ContactsTrainingInsertOrUpdate	Used to update contact training details like completed date and comments.
ContactsTrainingQueryByExample	Used to return training details of all contacts of a site or training details of all contacts of all sites.

Request Message Description: ContactsTrainingQueryById

This method accepts the Row Id of a site and returns the training details of all contacts in that site.

Request Message Description: ContactsTrainingQueryPage

This method has several tags to accept the input. You can provide input to any of the provided tags to retrieve specific details. No field is mandatory. The most important tags are Id in ClinicalProtocolSite if you want the training details of all contacts of a particular site and Id in ClinicalAccountInvestigatorRole if you want the training details of a specific contact.

Request Message Description: ContactsTrainingInsertOrUpdate

This method is used to update the training records of contacts. You can update more than one training record of a contact, you can update training records of more than one contact at a time, or you can update training records of all contacts of all sites.

Request Message Description: ContactsTrainingQueryByExample

This method is used to return training records of all contacts for all sites (where the calling user is part of the site team) by default if no data is provided for any tag. You can get filtered data by providing values at required tags.

Response Message Description:

For a sample response message, see Example Package for SWILSClinicalSiteContactsTrainingInterfaceService.

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

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

Name	Boundary Object Type	Class
LS Clinical Site Contacts Training Interface Service	Business 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 Site Contact Training Information IO	Clinical Protocol Site
LS Clinical Site Contact Training Information Internal IO	Clinical Protocol Site

Example Package for SWILSClinicalSiteContactsTrainingInterfaceService

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

Request

See the following files to view the sample code:

…\LSClinical\SWILSClinicalSiteContactsTrainingInterfaceService-QueryByExample-
request.xml
…\LSClinical\SWILSClinicalSiteContactsTrainingInterfaceService-QueryById-request.xml
…\LSClinical\SWILSClinicalSiteContactsTrainingInterfaceService-QueryPage-request.xml
…\LSClinical\SWILSClinicalSiteContactsTrainingInterfaceService-InsertOrUpdate-
request.xml

Response

See the following file to view the sample response. All the tags are self explanatory:

…\LSClinical\SWILSClinicalSiteContactsTrainingInterfaceService-response.xml

Interface Description (WSDL) for SWILSClinicalSiteContactsTrainingInterfaceService

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

See the following file to view the message schema:

…\LSClinical\SWILSClinicalSiteContactsTrainingInterfaceService.WSDL

SWILSClinicalTripReportInterfaceService

Use this Web service to send trip report details to external applications and also to update the trip report details into your clinical trial management system. The user who invokes this Web service must be present in the site visit team. Also, consider the following:

If no input is provided for any tags in the TripReportQueryByExample operation, shown in the table in SWILSClinicalTripReportInterfaceService Operations. then the Web service will return all those site visit details where the user is part of site visit teams. If the number of records are larger than the predefined maximum size, then the Web service returns an error prompting the user to refine the search and limit the result set.
An external application can invoke this Web service with any of the listed operations depending on the scenario.
This Web service returns an error message if the Page Size field is empty (or blank) in the TripReportQueryPage operation.
Only provided tags can be used with TripReportQueryPage operation.
Mobile application users might need to update trip information offline. In this case, trip reports can be accessed from the clinical trial management system using query operations. The information can then be updated on the mobile device and then sent back to the clinical trial management system to complete the update.

SWILSClinicalTripReportInterfaceService Operations

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

Operation Name	Description
TripReportQueryById	Used to query the trip report details based on give trip report Id or Site Visit Row Id.
TripReportQueryPage	Used to query the trip report details in pages based on given filter criteria.
TripReportQueryByExample	Used to query the trip report details based on given filter criteria.
TripReportSynchronize	Used to synchronize the trip report and its child records.
TripReportUpdate	Used to update the trip report header details.
TripReportInsertOrUpdate	Used either to update the trip report and its child components or to insert new child items of trip report.

Request Message Description: TripReportQueryById

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

Node	Description	Type
PrimaryRowId	Required. The site visit row ID.	Character data

Request Message Description: TripReportQueryPage

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

Node	Description	Type
ClinicalTripReport.Id	Required. The site visit row ID. Can be either an asterisk (*), or a valid row ID.	Character data
ClinicalTripReport. ActivityUID	Required. Site visit activity ID. Can be either an asterisk (*), or a valid activity ID.	Character data
ClinicalTripReport. Description	Required. The trip report description. Can be either an asterisk (*), or a valid description.	Character data
ClinicalTripReport. DisplayInvestigatorFirstName	Required. Can be either an asterisk (*), or valid First Name.	Character data
ClinicalTripReport. DisplayInvestigatorLastName	Required. The last name of the principal investigator. Can be either an asterisk (*), or a valid last name.	Character data
ClinicalTripReport. ProtocolNumber	Required. The protocol number. Can be either an asterisk (*), or a valid protocol number.	Character data
ClinicalTripReport. ProtocolSiteId	Required. The site row ID. Can be either an asterisk (*), or a valid protocol site ID.	Character data
ClinicalTripReport. ProtocolTitle	Required. The protocol title. Can be either an asterisk (*), or a valid protocol title.	Character data
ClinicalTripReport. SiteName	Required. The trip report account. Can be either an asterisk (*), or a valid site name.	Character data
ClinicalTripReport. SiteNumber	Required. The site number. Can be either an asterisk (*), or a valid site number.	Character data
ClinicalTripReport. Status	Required. The trip report status. Can be either an asterisk (*), or a valid status value.	Character data
ClinicalTripReport. TripReportStatus	Required. The trip report status. Can be either an asterisk (*), or a valid trip report status.	Character data
ClinicalTripReport.Type	Required. The visit type. Can be either an asterisk (*), or a valid visit type value.	Character data
LsClinicalSiteVisitAssignee.Id	Required. The row ID of the employee in the site visit team. Can be either an asterisk (*), or valid row ID.	Character data
LsClinicalSiteVisitAssignee. ActivityId	Required. The activity ID of the employee in the site visit team.Can be either an asterisk (*), or a valid activity ID.	Character data
LsClinicalSiteVisitAssignee. EmpId	Required. The employee ID. Can be either an asterisk (*), or a valid employee ID.	Character data
LsClinicalSiteVisitAssignee. FirstName	Required. The employee’s first name. Can be either an asterisk (*), or a valid first name.	Character data
LsClinicalSiteVisitAssignee. LastName	Required. The employee’s last name. Can be either an asterisk (*), or a valid last name.	Character data
LsClinicalSiteVisitAssignee. UserId	Required. The user ID. Can be either an asterisk (*), or a valid user ID.	Character data
ClinicalAttendee.Id	Required. The attendee row ID. Can be either an asterisk (*), or a valid attendee row ID.	Character data
ClinicalAttendee. EmployeeFlag	Required. The employee flag. Can be either an asterisk (*), or the employee flag.	Boolean
ClinicalAttendee. FirstName	Required. The attendee’s first name. Can be either an asterisk (*), or a valid first name.	Character data
ClinicalAttendee. LastName	Required. The attendee’s last name. Can be either an asterisk (*), or a valid last name.	Character data
ClinicalAttendeeStatic.Id	Required. The attendee row ID. Can be either an asterisk (*), or a valid row ID.	Character data
ClinicalAttendeeStatic. ActivityId	Required. The attendee’s activity ID. Can be either an asterisk (*), or a valid activity ID.	Character data
ClinicalAttendeeStatic. ContactId	Required. The contact ID. Can be either an asterisk (*), or a valid contact ID.	Character data
ClinicalChecklist.Id	Required. The checklist row ID. Can be either an asterisk (*), or valid checklist row ID.	Character data
ClinicalChecklist.ActivityUID	Required. The checklist activity ID. Can be either an asterisk (*), or a valid activity ID.	Character data
ClinicalChecklist. CreatedByName	Required. The created user name. Can be either an asterisk (*), or a valid created user name.	Character data
ClinicalChecklist. ParentActivityId	Required. The parent activity ID. Can be either an asterisk (*), or a valid parent activity ID.	Character data
ClinicalFollowUp.Id	Required. The clinical followup row ID. Can be either an asterisk (*), or a valid followup row ID.	Character data
ClinicalFollowUp. ActivityUID	Required. The activity ID. Can be either an asterisk (*), or a valid activity ID.	Character data
ClinicalFollowUp. CreatedByName	Required. The created user name. Can be either an asterisk (*), or a valid created user name.	Character data
ClinicalFollowUp. ParentActivityId	Required. The parent activity ID. Can be either an asterisk (*), or a valid parent activity ID.	Character data
ClinicalFollowUpSiteLevel.Id	Required. The followup site level row ID. Can be either an asterisk (*), or a valid followup site level row ID.	Character data
ClinicalFollowUpSiteLevel. ActivityUID	Required. The activity ID. Can be either an asterisk (*), or a valid activity ID.	Character data
ClinicalFollowUpSiteLevel. CreatedByName	Required. The created user name. Can be either an asterisk (*), or a valid created user name.	Character data
ClinicalFollowUpSiteLevel. ParentActivityId	Required. The parent activity ID. Can be either an asterisk (*), or a valid parent activity ID.	Character data
LsCaseReportFormsTracking.Id	Required. The case report form row ID. Can be either an asterisk (*), or a valid case report form row ID.	Character data
LsCaseReportFormsTracking.ActivityUID	Required. The activity ID. Can be either an asterisk (*), or a valid activity ID.	Character data
LsCaseReportFormsTracking.ParentActivityId	Required. Can be either an asterisk (*), or valid Parent Activity Id.Parent Activity Id	Character data
LsCaseReportFormsTracking.ParentTemplate Version	Required. The template version. Can be either an asterisk (*), or a valid parent template version.	Character data
LsCaseReportFormsTracking.SubjectInitial	Required. The subject initial. Can be either an asterisk (*), or a valid subject initial.	Character data
LsCaseReportFormsTracking.SubjectNumber	Required. The subject number. Can be either an asterisk (*), or a valid subject number.	Character data
LsCaseReportFormsTracking.Visit	Required. The visit name. Can be either an asterisk (*), or a valid visit name.	Character data
LsCaseReportFormsTracking.VisitType	Required. The visit type. Can be either an asterisk (*), or a valid visit type.	Character data

Request Message Description: TripReportQueryByExample

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

Node	Description	Type
ClinicalTripReport.Id	Optional. The site visit row ID.	Character data
ClinicalTripReport. Searchspec	Optional. The search specification.	Character data
ClinicalTripReport. ActivityUID	Optional. The site visit activity ID.	Character data
ClinicalTripReport. ApproverLogin	Optional. The approver login.	Character data
ClinicalTripReport. Comment	Optional. Comments.	Character data
ClinicalTripReport. Completed	Optional. The completed flag.	Boolean
ClinicalTripReport. Description	Optional. The trip report description.	Character data
ClinicalTripReport. DisplayInvestigatorFirstName	Optional. The PI first name.	Character data
ClinicalTripReport. DisplayInvestigatorLastName	Optional. The PI last name.	Character data
ClinicalTripReport. Done	Optional. The completed date.	UTC Date Time
ClinicalTripReport. Planned	Optional. The planned date.	UTC Date Time
ClinicalTripReport. ProtocolNumber	Optional. The protocol number.	Character data
ClinicalTripReport. ProtocolSiteId	Optional. The site row ID.	Character data
ClinicalTripReport. ProtocolTitle	Optional. The protocol title.	Character data
ClinicalTripReport. ReviewerComments	Optional. Reviewer comments.	Character data
ClinicalTripReport. ReviewerLogin	Optional. The reviewer login ID.	Character data
ClinicalTripReport. ApproverComments	Optional. Approver comments.	Character data
ClinicalTripReport. SiteName	Optional. Trip report account.	Character data
ClinicalTripReport. SiteNumber	Optional. Site number.	Character data
ClinicalTripReport. Status	Optional. Status.	Character data
ClinicalTripReport. TemplateName	Optional. Template name.	Character data
ClinicalTripReport. TripReportCompleted	Optional. Trip report completed date.	Date
ClinicalTripReport. TripReportStatus	Optional. Trip report status.	Character data
ClinicalTripReport.Type	Optional. Visit type.	Character data
LsClinicalSiteVisitAssignee.Id	Optional. Row ID of the employee in the site visit team.	Character data
LsClinicalSiteVisitAssignee.Searchspec	Optional. The search specification.	Character data
LsClinicalSiteVisitAssignee. ActivityId	Optional. The activity ID of the employee in the site visit team.	Character data
LsClinicalSiteVisitAssignee. ConfigurationName	Optional. The configuration name.	Character data
LsClinicalSiteVisitAssignee. EMailAddr	Optional. Email address.	Character data
LsClinicalSiteVisitAssignee. EmpId	Optional. Employee ID.	Character data
LsClinicalSiteVisitAssignee. FirstName	Optional. The employee’s first name.	Character data
LsClinicalSiteVisitAssignee. IsPrimaryOwner	Optional. Is Primary Owner flag.	Character data
LsClinicalSiteVisitAssignee. JobTitle	Optional. Job title.	Character data
LsClinicalSiteVisitAssignee. LastName	Optional. The employee’s last name.	Character data
LsClinicalSiteVisitAssignee. Phone	Optional. Phone number.	Character data
LsClinicalSiteVisitAssignee. ShiftName	Optional. The shift name.	Character data
LsClinicalSiteVisitAssignee. UserId	Optional. The User ID.	Character data
ClinicalAttendee.Id	Optional. The Attendee’s Row ID.	Character data
ClinicalAttendee. Searchspec	Optional. The search specification.	Character data
ClinicalAttendee. DisplayRole	Optional. The display role.	Character data
ClinicalAttendee. EmployeeFlag	Optional. The employee flag.	Boolean
ClinicalAttendee. FirstName	Optional. First name.	Character data
ClinicalAttendee. LastName	Optional. Last name.	Character data
ClinicalAttendee. Position	Optional. Position	Character data
ClinicalAttendeeStatic.Id	Optional. Attendee’s row ID.	Character data
ClinicalAttendeeStatic. ActivityId	Optional. Attendee’s activity ID.	Character data
ClinicalAttendeeStatic. ContactId	Optional. Contact ID.	Character data
ClinicalChecklist.Id	Optional. Checklist row ID.	Character data
ClinicalChecklist. Searchspec	Optional. Search specification.	Character data
ClinicalChecklist.ActivityUID	Optional. Checklist activity ID.	Character data
ClinicalChecklist. Category	Optional. Category	Character data
ClinicalChecklist. CreatedByName	Optional. Created user name.	Character data
ClinicalChecklist. Description	Optional. Description.	Character data
ClinicalChecklist. Display	Optional. Display for calendar activities.	Character data
ClinicalChecklist. ParentActivityId	Optional. Parent activity ID.	Character data
ClinicalChecklist. ShortComment	Optional. Comments.	Character data
ClinicalChecklist. Status	Optional. Status.	Character data
ClinicalChecklist. Type	Optional. Type.	Character data
ClinicalFollowUp.Id	Optional. Row ID of the clinical followup record.	Character data
ClinicalFollowUp. ActivityUID	Optional. Activity ID.	Character data
ClinicalFollowUp. CreatedByName	Optional. Created user name.	Character data
ClinicalFollowUp. Description	Optional. Description.	Character data
ClinicalFollowUp. Display	Optional. Display.	Character data
ClinicalFollowUp. Done	Optional. Completed date.	UTC Date Time
ClinicalFollowUp. Due	Optional. Due date.	UTC Date Time
ClinicalFollowUp. ParentActivityId	Optional. Parent activity ID.	Character data
ClinicalFollowUp. ShortComment	Optional. Comments.	Character data
ClinicalFollowUp. Status	Optional. Status.	Character data
ClinicalFollowUp. Type	Optional. Activity type.	Character data
ClinicalFollowUpSiteLevel.Id	Optional. Row ID of the followup site level record.	Character data
ClinicalFollowUpSiteLevel. ActivityUID	Optional. Activity ID.	Character data
ClinicalFollowUpSiteLevel. Category	Optional. Category.	Character data
ClinicalFollowUpSiteLevel. CreatedByName	Optional. Created user name.	Character data
ClinicalFollowUpSiteLevel. Description	Optional. Description.	Character data
ClinicalFollowUpSiteLevel. Display	Optional. Display.	Character data
ClinicalFollowUpSiteLevel. Done	Optional. Completed date.	UTC Date Time
ClinicalFollowUpSiteLevel. Due	Optional. Due date.	UTC Date Time
ClinicalFollowUpSiteLevel. ParentActivityId	Optional. Parent activity ID.	Character data
ClinicalFollowUpSiteLevel. ShortComment	Optional. Comments.	Character data
ClinicalFollowUpSiteLevel. Status	Optional. Status.	Character data
ClinicalFollowUpSiteLevel. Type	Optional. Type.	Character data
LsCaseReportFormsTracking.Id	Optional. Row ID of the case report form.	Character data
LsCaseReportFormsTracking. CRFPages	Optional. Number of case report form pages.	Integer
LsCaseReportFormsTracking. ActivityType	Optional. Activity type.	Character data
LsCaseReportFormsTracking. ActivityUID	Optional. Activity Id	Character data
LsCaseReportFormsTracking. Category	Optional. Category.	Character data
LsCaseReportFormsTracking. Comments	Optional. Comments.	Character data
LsCaseReportFormsTracking. OwnedById	Optional. Owner user ID.	Character data
LsCaseReportFormsTracking. ParentActivityId	Optional. Parent activity ID.	Character data
LsCaseReportFormsTracking. ParentTemplateVersion	Optional. Template version.	Character data
LsCaseReportFormsTracking. PrivateFlag	Optional. Private flag.	Boolean
LsCaseReportFormsTracking. Retrieved	Optional. Retrieved flag.	Boolean
LsCaseReportFormsTracking. RetrievedDate	Optional. Retrieved date.	UTC Date Time
LsCaseReportFormsTracking. SourceDocumentVerfied	Optional. Source Document Verified flag.	Boolean
LsCaseReportFormsTracking. SourceDocumentVerifiedDate	Optional. Source Document Verified date.	UTC Date Time
LsCaseReportFormsTracking. SubjectInitial	Optional. Subject initial.	Character data
LsCaseReportFormsTracking. SubjectNumber	Optional. Subject number.	Character data
LsCaseReportFormsTracking. Visit	Optional. Visit name.	Character data
LsCaseReportFormsTracking. VisitType	Optional. Visit type.	Character data

Request Message Description: TripReportInsertOrUpdate

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

Node	Description	Type
ClinicalTripReport.Id	Required. Site visit row ID.	Character data
ClinicalTripReport. ActivityUID	Optional. Site visit activity ID.	Character data
ClinicalTripReport. ApproverLogin	Optional. Approver login.	Character data
ClinicalTripReport. Comment	Optional. Comments.	Character data
ClinicalTripReport. Completed	Optional. Completed flag.	Boolean
ClinicalTripReport. Description	Required. Trip Report Description	Character data
ClinicalTripReport. DisplayInvestigatorFirstName	Optional. The first name of the principal investigator.	Character data
ClinicalTripReport. DisplayInvestigatorLastName	Optional. PI last name.	Character data
ClinicalTripReport. Done	Optional. Completed date.	UTC Date Time
ClinicalTripReport. Planned	Optional. Planned date.	UTC Date Time
ClinicalTripReport. ProtocolSiteId	Required. Site row ID.	Character data
ClinicalTripReport. ReviewerComments	Optional. Reviewer comments.	Character data
ClinicalTripReport. ReviewerLogin	Optional. Reviewer login ID.	Character data
ClinicalTripReport. ApproverComments	Optional. Approver comments.	Character data
ClinicalTripReport. SiteNumber	Optional. Site number.	Character data
ClinicalTripReport. Status	Required. Status.	Character data
ClinicalTripReport. TemplateName	Optional. Template name.	Character data
ClinicalTripReport. TripReportCompleted	Optional. Trip report completed date.	Date
ClinicalTripReport. TripReportStatus	Optional. Trip report status.	Character data
ClinicalTripReport. Type	Required. Visit type.	Character data
LsClinicalSiteVisitAssignee. Id	Optional. Row ID of the employee in the site visit team.	Character data
LsClinicalSiteVisitAssignee. ActivityId	Required. Activity ID of the employee in the site visit team.	Character data
LsClinicalSiteVisitAssignee. ConfigurationName	Optional. Configuration name.	Character data
LsClinicalSiteVisitAssignee. EMailAddr	Optional. Email address.	Character data
LsClinicalSiteVisitAssignee. EmpId	Required. Employee ID.	Character data
LsClinicalSiteVisitAssignee. FirstName	Optional. Employee first name.	Character data
LsClinicalSiteVisitAssignee. IsPrimaryOwner	Optional. The Is Primary Owner flag.	Character data
LsClinicalSiteVisitAssignee. JobTitle	Optional. Job title.	Character data
LsClinicalSiteVisitAssignee. LastName	Optional. Employee last name.	Character data
LsClinicalSiteVisitAssignee. Phone	Optional. Phone number.	Character data
LsClinicalSiteVisitAssignee. ShiftName	Optional. Shift name.	Character data
LsClinicalSiteVisitAssignee. UserId	Optional. User ID.	Character data
ClinicalAttendeeStatic. Id	Optional. Row ID of the attendee.	Character data
ClinicalAttendeeStatic. ActivityId	Required. Activity ID of the attendee.	Character data
ClinicalAttendeeStatic. ContactId	Required. Contact ID.	Character data
ClinicalChecklist. Id	Required. Checklist row ID.	Character data
ClinicalChecklist. ActivityUID	Required. Checklist activity ID.	Character data
ClinicalChecklist. Category	Required. Category.	Character data
ClinicalChecklist. CreatedByName	Optional. Created user name	Character data
ClinicalChecklist. Description	Optional. Description.	Character data
ClinicalChecklist. Display	Optional. Display.	Character data
ClinicalChecklist. ParentActivityId	Required. Parent activity ID.	Character data
ClinicalChecklist. ShortComment	Optional. Comments.	Character data
ClinicalChecklist. Status	Optional. Status.	Character data
ClinicalChecklist. Type	Optional. Type.	Character data
LsClinicalChecklistAssignee. Id	Optional. Checklist assignee Row ID.	Character data
LsClinicalChecklistAssignee. ActivityId	Required. Activity ID.	Character data
LsClinicalChecklistAssignee. ConfigurationName	Optional. Configuration name.	Character data
LsClinicalChecklistAssignee. EMailAddr	Optional. Email address.	Character data
LsClinicalChecklistAssignee. FirstName	Optional. First name.	Character data
LsClinicalChecklistAssignee. IsPrimaryOwner	Optional. Primary Owner flag.	Character data
LsClinicalChecklistAssignee. JobTitle	Optional. Job title.	Character data
LsClinicalChecklistAssignee. LastName	Optional. Last name.	Character data
LsClinicalChecklistAssignee. Phone	Optional. Phone.	Character data
LsClinicalChecklistAssignee. UserId	Optional. User ID.	Character data
LsClinicalChecklistAssignee. ShiftName	Optional. Shift name.	Character data
LsClinicalChecklistAssignee. EmpId	Required. Employee ID.	Character data
ClinicalFollowUp. Id	Required. Clinical followup Row ID.	Character data
ClinicalFollowUp. ActivityUID	Required. Activity ID.	Character data
ClinicalFollowUp.Category	Required.	Character data
ClinicalFollowUp. CreatedByName	Optional. Created user name.	Character data
ClinicalFollowUp. Description	Optional. Description.	Character data
ClinicalFollowUp. Display	Optional. Display.	Character data
ClinicalFollowUp. Done	Optional. Completed date.	UTC Date Time
ClinicalFollowUp. Due	Optional. Due Date	UTC Date Time
ClinicalFollowUp. ParentActivityId	Required. Parent activity ID.	Character data
ClinicalFollowUp. ShortComment	Optional. Comments.	Character data
ClinicalFollowUp. Status	Optional. Status.	Character data
ClinicalFollowUp. Type	Optional. Activity type.	Character data
LsClinicalFollowUpAssignee. Id	Optional. Followup item assignee row ID.	Character data
LsClinicalFollowUpAssignee. ActivityId	Required. Activity ID.	Character data
LsClinicalFollowUpAssignee. ConfigurationName	Optional. Configuration name.	Character data
LsClinicalFollowUpAssignee. EMailAddr	Optional. Email address.	Character data
LsClinicalFollowUpAssignee. EmpId	Required. Employee ID.	Character data
LsClinicalFollowUpAssignee. FirstName	Optional. First name.	Character data
LsClinicalFollowUpAssignee. IsPrimaryOwner	Optional. Primary Owner flag.	Character data
LsClinicalFollowUpAssignee. JobTitle	Optional. Job title.	Character data
LsClinicalFollowUpAssignee. LastName	Optional. Last name.	Character data
LsClinicalFollowUpAssignee. Phone	Optional. Phone.	Character data
LsClinicalFollowUpAssignee. ShiftName	Optional. Shift name.	Character data
LsClinicalFollowUpAssignee. UserId	Optional. User ID.	Character data
LsCaseReportFormsTracking. Id	Required. Case report form row ID.	Character data
LsCaseReportFormsTracking. CRFPages	Optional. The number of case report form pages.	Integer
LsCaseReportFormsTracking. ActivityType	Optional. Activity type.	Character data
LsCaseReportFormsTracking. ActivityUID	Required. Activity ID.	Character data
LsCaseReportFormsTracking. Category	Required. Category.	Character data
LsCaseReportFormsTracking. Comments	Optional. Comments.	Character data
LsCaseReportFormsTracking. OwnedById	Optional. Owner User ID.	Character data
LsCaseReportFormsTracking. ParentActivityId	Required. Parent activity ID.	Character data
LsCaseReportFormsTracking. ParentTemplateVersion	Required. Template version.	Character data
LsCaseReportFormsTracking. PrivateFlag	Optional. The Private flag.	Boolean
LsCaseReportFormsTracking. Retrieved	Optional. Retrieved flag.	Boolean
LsCaseReportFormsTracking. RetrievedDate	Optional. Retrieved date.	UTC Date Time
LsCaseReportFormsTracking. SourceDocumentVerfied	Optional. The Source Document Verified flag.	Boolean
LsCaseReportFormsTracking. SourceDocumentVerifiedDate	Optional. Source document verified date.	UTC Date Time
LsCaseReportFormsTracking. SubjectInitial	Required. Subject initial.	Character data
LsCaseReportFormsTracking. SubjectNumber	Required. Subject number.	Character data
LsCaseReportFormsTracking. Visit	Required. Visit name.	Character data
LsCaseReportFormsTracking. VisitType	Required. Visit type.	Character data
LsClinicalGeoLocation. Id	Required. Geo location row ID.	Character data
LsClinicalGeoLocation. Comments	Optional. Comments.	Character data
LsClinicalGeoLocation. EmpId	Required. Employee ID.	Character data
LsClinicalGeoLocation. Latitude	Optional. Latitude.	Number
LsClinicalGeoLocation. LoginId	Optional. Login ID.	Character data
LsClinicalGeoLocation. Longitude	Optional. Longitude.	Number
LsClinicalGeoLocation. SiteVisitId	Required. Site visit row ID.	Character data
LsClinicalGeoLocation VisitDate	Required. Visit date.	Date Time

Request Message Description: TripReportUpdate

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

Node	Description	Type
ClinicalTripReport.Id	Required. Site visit row ID.	Character data
ClinicalTripReport. ActivityUID	Optional. Site visit activity ID.	Character data
ClinicalTripReport. ApproverLogin	Optional. Approver login.	Character data
ClinicalTripReport. Comment	Optional. Comments.	Character data
ClinicalTripReport. Completed	Optional. The Completed flag.	Boolean
ClinicalTripReport. Description	Required. Trip report description.	Character data
ClinicalTripReport. DisplayInvestigatorFirstName	Optional. PI first name.	Character data
ClinicalTripReport. DisplayInvestigatorLastName	Optional. PI last name.	Character data
ClinicalTripReport. Done	Optional. Completed date.	UTC Date Time
ClinicalTripReport. Planned	Optional. Planned date.	UTC Date Time
ClinicalTripReport. ProtocolSiteId	Required. Site row ID.	Character data
ClinicalTripReport. ReviewerComments	Optional. Reviewer comments.	Character data
ClinicalTripReport. ReviewerLogin	Optional. Review login ID.	Character data
ClinicalTripReport. ApproverComments	Optional. Approver comments.	Character data
ClinicalTripReport. SiteNumber	Optional. Site number.	Character data
ClinicalTripReport. Status	Required. Status.	Character data
ClinicalTripReport. TemplateName	Optional. Template name.	Character data
ClinicalTripReport. TripReportCompleted	Optional. Trip report completed date.	Date
ClinicalTripReport. TripReportStatus	Optional. Trip report status.	Character data
ClinicalTripReport. Type	Required. Visit type.	Character data

Request Message Description: TripReportSynchronize

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

Node	Description	Type
ClinicalTripReport.Id	Required. Site visit row ID.	Character data
ClinicalTripReport. ApproverLogin	Optional. Approver login.	Character data
ClinicalTripReport. Comment	Optional. Comments.	Character data
ClinicalTripReport. Completed	Optional. Completed flag.	Character data
ClinicalTripReport. Description	Required. Trip report description.	Character data
ClinicalTripReport. DisplayInvestigatorFirstName	Optional. First name of principal investigator.	Character data
ClinicalTripReport. DisplayInvestigatorLastName	Optional. Last name of the principal investigator.	Character data
ClinicalTripReport. Done	Optional. Completed date.	UTC Date Time
ClinicalTripReport. Planned	Optional. Planned date.	UTC Date Time
ClinicalTripReport. ProtocolSiteId	Required. Site row ID.	Character data
ClinicalTripReport. ReviewerComments	Optional. Reviewer comments,	Character data
ClinicalTripReport. ReviewerLogin	Optional. Reviewer login ID.	Character data
ClinicalTripReport. ApproverComments	Optional. Approver comments.	Character data
ClinicalTripReport. SiteNumber	Optional. Site number.	Character data
ClinicalTripReport. Status	Required. Status.	Character data
ClinicalTripReport. TemplateName	Optional. Template name.	Character data
ClinicalTripReport. TripReportCompleted	Optional. Trip report completed date.	Date
ClinicalTripReport. TripReportStatus	Optional. Trip report status.	Character data
ClinicalTripReport. Type	Required. Visit type.	Character data
LsClinicalSiteVisitAssignee. Id	Optional. Row ID of the employee in the site visit team.	Character data
LsClinicalSiteVisitAssignee. ActivityId	Required. Activity ID of the employee in the site visit team.	Character data
LsClinicalSiteVisitAssignee. ConfigurationName	Optional. Configuration name.	Character data
LsClinicalSiteVisitAssignee. EMailAddr	Optional. Email address.	Character data
LsClinicalSiteVisitAssignee. EmpId	Required. Employee ID.	Character data
LsClinicalSiteVisitAssignee. FirstName	Optional. Employee first name.	Character data
LsClinicalSiteVisitAssignee. IsPrimaryOwner	Optional. Is Primary Owner flag.	Character data
LsClinicalSiteVisitAssignee. JobTitle	Optional. Job title.	Character data
LsClinicalSiteVisitAssignee. LastName	Optional. Employee last name.	Character data
LsClinicalSiteVisitAssignee. Phone	Optional. Phone number.	Character data
LsClinicalSiteVisitAssignee. ShiftName	Optional. Shift name.	Character data
LsClinicalSiteVisitAssignee. UserId	Optional. User ID.	Character data
ClinicalAttendeeStatic. Id	Optional. Attendees row ID.	Character data
ClinicalAttendeeStatic. ActivityId	Required. Attendee’s Activity ID.	Character data
ClinicalAttendeeStatic. ContactId	Required. Contact ID.	Character data
ClinicalFollowUp. Id	Required. Clinical followup row ID.	Character data
ClinicalFollowUp. ActivityUID	Required. Activity ID.	Character data
ClinicalFollowUp. Category	Required. Category.	Character data
ClinicalFollowUp. CreatedByName	Optional. Created user name.	Character data
ClinicalFollowUp. Description	Optional. Description.	Character data
ClinicalFollowUp. Display	Optional. Display.	Character data
ClinicalFollowUp. Done	Optional. Completed date.	UTC date and time.
ClinicalFollowUp. Due	Optional. Due date.	UTC date and time.
ClinicalFollowUp. ParentActivityId	Required. Parent Activity ID.	Character data
ClinicalFollowUp. ShortComment	Optional. Comments.	Character data
ClinicalFollowUp. Status	Optional. Status.	Character data
ClinicalFollowUp. Type	Optional. Activity type.	Character data
LsClinicalFollowUpAssignee. Id	Required. Followup item assignee row ID.	Character data
LsClinicalFollowUpAssignee. ActivityId	Required. Activity ID.	Character data
LsClinicalFollowUpAssignee. ConfigurationName	Optional. Configuration name.	Character data
LsClinicalFollowUpAssignee. EMailAddr	Optional. Email address.	Character data
LsClinicalFollowUpAssignee. EmpId	Required. Employee ID.	Character data
LsClinicalFollowUpAssignee. FirstName	Optional. First name.	Character data
LsClinicalFollowUpAssignee. IsPrimaryOwner	Optional. Primary Owner flag.	Character data
LsClinicalFollowUpAssignee. JobTitle	Optional. Job title.	Character data
LsClinicalFollowUpAssignee. LastName	Optional. Last name.	Character data
LsClinicalFollowUpAssignee. Phone	Optional. Phone.	Character data
LsClinicalFollowUpAssignee. ShiftName	Optional. Shift name.	Character data
LsClinicalFollowUpAssignee. UserId	Optional. User ID.	Character data
LsCaseReportFormsTracking. Id	Required. Case report form row ID.	Character data
LsCaseReportFormsTracking. CRFPages	Optional. Number of Case report form pages.	Character data
LsCaseReportFormsTracking. ActivityType	Optional. Activity type.	Character data
LsCaseReportFormsTracking. ActivityUID	Required. Activity ID.	Character data
LsCaseReportFormsTracking. Category	Required. Category.	Character data
LsCaseReportFormsTracking. Comments	Optional. Comments.	Character data
LsCaseReportFormsTracking. OwnedById	Optional. Owner’s user ID.	Character data
LsCaseReportFormsTracking. ParentActivityId	Required. Parent activity ID.	Character data
LsCaseReportFormsTracking. ParentTemplateVersion	Optional. Template version.	Character data
LsCaseReportFormsTracking. PrivateFlag	Optional. Private flag.	Character data
LsCaseReportFormsTracking. Retrieved	Optional. Retrieved flag.	Character data
LsCaseReportFormsTracking. RetrievedDate	Optional. Retrieved date.	UTC date and time
LsCaseReportFormsTracking. SourceDocumentVerfied	Optional. Source Document Verified flag.	Character data
LsCaseReportFormsTracking. SourceDocumentVerifiedDate	Optional. Source document verified date.	UTC date and time.
LsCaseReportFormsTracking. SubjectInitial	Optional. Required subject initial.	Character data
LsCaseReportFormsTracking. SubjectNumber	Required. Subject number.	Character data
LsCaseReportFormsTracking. Visit	Required. Visit name.	Character data
LsCaseReportFormsTracking. VisitType	Required. Visit type.	Character data

Response Message Description: All SWILSClinicalTripReportInterfaceService Query Operations

For a description of these response messages, see the following table.

Node	Description	Type
ClinicalTripReport. Id	Site visit row ID.	Character data
ClinicalTripReport. ActivityUID	Site visit activity ID.	Character data
ClinicalTripReport. ApproverLogin	Approver login.	Character data
ClinicalTripReport. Comment	Comments.	Character data
ClinicalTripReport. Completed	The Completed flag.	Boolean
ClinicalTripReport. Description	Trip report description.	Character data
ClinicalTripReport. DisplayInvestigatorFirstName	The first name of the principal investigator.	Character data
ClinicalTripReport. DisplayInvestigatorLastName	The last name of the principal investigator.	Character data
ClinicalTripReport. Done	Completed date.	UTC date time
ClinicalTripReport. Planned	Planned date.	UTC Date Time
ClinicalTripReport. ProtocolNumber	Protocol number.	Character data
ClinicalTripReport. ProtocolSiteId	Site row ID.	Character data
ClinicalTripReport. ProtocolTitle	Protocol title.	Character data
ClinicalTripReport. ReviewerComments	Reviewer comments.	Character data
ClinicalTripReport. ReviewerLogin	Reviewer login ID.	Character data
ClinicalTripReport. ApproverComments	Approver comments.	Character data
ClinicalTripReport. SiteName	Trip report account.	Character data
ClinicalTripReport. SiteNumber	Site number.	Character data
ClinicalTripReport. Status	Status.	Character data
ClinicalTripReport. TemplateName	Template name.	Character data
ClinicalTripReport. TripReportCompleted	Trip report completed date.	Date
ClinicalTripReport. TripReportStatus	Trip report status.	Character data
ClinicalTripReport. Type	Visit type.	Character data
LsClinicalSiteVisitAssignee. Id	Row ID of the employee in the site visit team.	Character data
LsClinicalSiteVisitAssignee. ActivityId	Activity ID of the employee in the site visit team.	Character data
LsClinicalSiteVisitAssignee. ConfigurationName	Configuration name.	Character data
LsClinicalSiteVisitAssignee. EMailAddr	Email address.	Character data
LsClinicalSiteVisitAssignee. EmpId	Employee ID.	Character data
LsClinicalSiteVisitAssignee. FirstName	Employee first name.	Character data
LsClinicalSiteVisitAssignee. IsPrimaryOwner	Is Primary Owner flag.	Character data
LsClinicalSiteVisitAssignee. JobTitle	Job title.	Character data
LsClinicalSiteVisitAssignee. LastName	Employee last name.	Character data
LsClinicalSiteVisitAssignee. Phone	Phone number.	Character data
LsClinicalSiteVisitAssignee. ShiftName	Shift name.	Character data
LsClinicalSiteVisitAssignee. UserId	User ID.	Character data
LSClinicalSiteVisitAssignee_Position. Division	Division.	Character data
LSClinicalSiteVisitAssignee_Position. Name	Position name.	Character data
LSClinicalSiteVisitAssignee_Responsibility. Responsibility	Responsibility.	Character data
LSClinicalSiteVisitAssignee_Responsibility. PrimaryOrganization	Primary organization.	Character data
ListOfLSClinicalSiteVisitAssignee_Subcontractor. Subcontractor Name	Subcontractor name.	Character data
ClinicalAttendee. Id	Row ID of the attendee.	Character data
ClinicalAttendee. DisplayRole	Display role.	Character data
ClinicalAttendee. EmployeeFlag	Employee flag.	Boolean
ClinicalAttendee. FirstName	First name.	Character data
ClinicalAttendee. LastName	Last name.	Character data
ClinicalAttendee. Position	Position.	Character data
ClinicalAttendeeStatic. Id	Attendees row ID.	Character data
ClinicalAttendeeStatic. ActivityId	Attendee Activity ID.	Character data
ClinicalAttendeeStatic. ContactId	Contact ID	Character data
ClinicalChecklist. Id	Checklist row ID	Character data
ClinicalChecklist. ActivityUID	Checklist Activity ID.	Character data
ClinicalChecklist. Category	Category.	Character data
ClinicalChecklist. CreatedByName	Created user name.	Character data
ClinicalChecklist. Description	Description.	Character data
ClinicalChecklist. Display	Display.	Character data
ClinicalChecklist. ParentActivityId	Parent activity ID.	Character data
ClinicalChecklist. ShortComment	Comments.	Character data
ClinicalChecklist. Status	Status.	Character data
ClinicalChecklist. Type	Type.	Character data
LsClinicalChecklistAssignee. Id	Checklist assignee row ID.	Character data
LsClinicalChecklistAssignee. ActivityId	Activity ID.	Character data
LsClinicalChecklistAssignee. ConfigurationName	Configuration name.	Character data
LsClinicalChecklistAssignee. EMailAddr	Email address.	Character data
LsClinicalChecklistAssignee. FirstName	First name.	Character data
LsClinicalChecklistAssignee. IsPrimaryOwner	Is Primary Owner flag.	Character data
LsClinicalChecklistAssignee. JobTitle	Job title.	Character data
LsClinicalChecklistAssignee. LastName	Last name.	Character data
LsClinicalChecklistAssignee. Phone	Phone number.	Character data
LsClinicalChecklistAssignee. UserId	User ID.	Character data
LsClinicalChecklistAssignee. ShiftName	Schedule name.	Character data
LsClinicalChecklistAssignee. EmpId	Employee ID.	Character data
ClinicalFollowUp. Id	Clinical followup row ID.	Character data
ClinicalFollowUp. ActivityUID	Activity ID.	Character data
ClinicalFollowUp. Category	Category.	Character data
ClinicalFollowUp. CreatedByName	Created user name.	Character data
ClinicalFollowUp. Description	Description.	Character data
ClinicalFollowUp. Display	Display.	Character data
ClinicalFollowUp. Done	Completed date.	UTC Date Time
ClinicalFollowUp. Due	Due date.	UTC Date Time
ClinicalFollowUp. ParentActivityId	Parent activity ID	Character data
ClinicalFollowUp. ShortComment	Comments.	Character data
ClinicalFollowUp. Status	Status.	Character data
ClinicalFollowUp. Type	Activity type.	Character data
LsClinicalFollowUpAssignee. Id	Followup assignee row ID.	Character data
LsClinicalFollowUpAssignee. ActivityId	Activity ID.	Character data
LsClinicalFollowUpAssignee. ConfigurationName	Configuration name.	Character data
LsClinicalFollowUpAssignee. EmailAddr	Email address.	Character data
LsClinicalFollowUpAssignee. EmpId	Employee ID.	Character data
LsClinicalFollowUpAssignee. FirstName	First name.	Character data
LsClinicalFollowUpAssignee. IsPrimaryOwner	Is Primary Owner flag.	Character data
LsClinicalFollowUpAssignee. JobTitle	Job title.	Character data
LsClinicalFollowUpAssignee. LastName	Last name.	Character data
LsClinicalFollowUpAssignee. Phone	Phone number.	Character data
LsClinicalFollowUpAssignee. ShiftName	Schedule name.	Character data
LsClinicalFollowUpAssignee. UserId	User ID.	Character data
LSClinicalFollowUpAssignee_Position. Division	Position division.	Character data
LSClinicalFollowUpAssignee_Position. Name	Position.	Character data
LSClinicalFollowUpAssignee_Responsibility. Responsibility	Responsibility.	Character data
LSClinicalFollowUpAssignee_Subcontractor. SubcontractorName	Subcontractor name.	Character data
ClinicalFollowUpSiteLevel. Id	Followup site level row ID.	Character data
ClinicalFollowUpSiteLevel. ActivityUID	Activity ID.	Character data
ClinicalFollowUpSiteLevel. Category	Category.
ClinicalFollowUpSiteLevel. CreatedByName	Created user name.	Character data
ClinicalFollowUpSiteLevel. Description	Description.	Character data
ClinicalFollowUpSiteLevel. Display	Display.	Character data
ClinicalFollowUpSiteLevel. Done	Completed date.	UTC Date Time
ClinicalFollowUpSiteLevel. Due	Due date.	UTC Date Time
ClinicalFollowUpSiteLevel. ParentActivityId	Parent activity ID.	Character data
ClinicalFollowUpSiteLevel. ShortComment	Comments.	Character data
ClinicalFollowUpSiteLevel. Status	Status.	Character data
ClinicalFollowUpSiteLevel. Type	Type.	Character data
LsClinicalFollowUpSiteLevelAssignee. Id	Site level assignee row ID.	Character data
LsClinicalFollowUpSiteLevelAssignee. ActivityId	Activity ID.	Character data
LsClinicalFollowUpSiteLevelAssignee. ConfigurationName	Configuration name.	Character data
LsClinicalFollowUpSiteLevelAssignee. EMailAddr	Email address.	Character data
LsClinicalFollowUpSiteLevelAssignee. EmpId	Employee ID.	Character data
LsClinicalFollowUpSiteLevelAssignee. FirstName	First Name	Character data
LsClinicalFollowUpSiteLevelAssignee. IsPrimaryOwner	The Primary Owner flag.	Character data
LsClinicalFollowUpSiteLevelAssignee. JobTitle	Job title.	Character data
LsClinicalFollowUpSiteLevelAssignee. LastName	Last name.	Character data
LsClinicalFollowUpSiteLevelAssignee. Phone	Phone.	Character data
LsClinicalFollowUpSiteLevelAssignee. ShiftName	Shift name.	Character data
LsClinicalFollowUpSiteLevelAssignee. UserId	User ID.	Character data
LSClinicalFollowUpSiteLevelAssignee_Position. Division	Position division.	Character data
LSClinicalFollowUpSiteLevelAssignee_Position. Name	Position.	Character data
LSClinicalFollowUpSiteLevelAssignee_Responsibility. Responsibility	Responsibility.	Character data
LSClinicalFollowUpSiteLevelAssignee_Subcontractor. SubcontractorName	Contractor name.	Character data
LsCaseReportFormsTracking. Id	Case report form row ID.	Character data
LsCaseReportFormsTracking. CRFPages	Number of case report form pages.	Number
LsCaseReportFormsTracking. ActivityType	Activity type.	Character data
LsCaseReportFormsTracking. ActivityUID	Activity ID.	Character data
LsCaseReportFormsTracking. Category	Category.	Character data
LsCaseReportFormsTracking. Comments	Comments.	Character data
LsCaseReportFormsTracking. OwnedById	Owner user ID.	Character data
LsCaseReportFormsTracking. ParentActivityId	Parent activity ID.	Character data
LsCaseReportFormsTracking. ParentTemplateVersion	Template version.	Character data
LsCaseReportFormsTracking. PrivateFlag	Private flag.	Boolean
LsCaseReportFormsTracking. Retrieved	Retrieved flag.	Character data
LsCaseReportFormsTracking. RetrievedDate	Retrieved date.	UTC Date Time
LsCaseReportFormsTracking. SourceDocumentVerified	Source Document Verified flag.	Boolean
LsCaseReportFormsTracking. SourceDocumentVerifiedDate	Source document verification date	UTC Date Time
LsCaseReportFormsTracking. SubjectInitial	Subject initial.	Character data
LsCaseReportFormsTracking. SubjectNumber	Subject number.	Character data
LsCaseReportFormsTracking. Visit	Visit name.	Character data
LsCaseReportFormsTracking. VisitType	Visit type.	Character data
LsClinicalGeoLocation. Id	Geo location row ID.	Character data
LsClinicalGeoLocation. Comments	Comments.	Character data
LsClinicalGeoLocation. EmpId	Employee ID.	Character data
LsClinicalGeoLocation. Latitude	Latitude.	Number
LsClinicalGeoLocation. LoginId	Login user.	Character data
LsClinicalGeoLocation. Longitude	Longitude.	Number
LsClinicalGeoLocation. SiteVisitId	Site visit row ID.	Character data
LsClinicalGeoLocation. VisitDate	Visit date.	Date Time

SWILSClinicalTripReportInterfaceService 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 Trip Report Interface Services	Business 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 Trip Report Interface IO	Clinical Trip Report

Example Package for SWILSClinicalTripReportInterfaceService

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:

...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-
QueryByExample-request.xml 
...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-
QueryPage-request.xml
...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-
QueryById-request.xml
...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-
InsertOrUpdate-request.xml
...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-
Update-request.xml
...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-
Synchronize-request.xml

Interface Description (WSDL) for SWILSClinicalTripReportInterfaceService

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.

...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-
QueryByExample.WSDL
...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-
QueryPage.WSDL
...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-
QueryById.WSDL
...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-
InsertOrUpdate.WSDL
...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-
Synchronize.WSDL
...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-
Update.WSDL

SWILSClinicalTripReportTemplates

This Web service returns only those templates whose type is Clinical Trip Report. This is a specific Web service to LS Clinical as it returns only clinical trip report types. The external application can filter the data using available fields in the Web service. This Web service supports only one operation: QueryByExample

SWILSClinicalTripReportTemplates Operations

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

Operation Name	Description
TripReportTemplateQueryByExample	Used to query trip report templates whose type is Clinical Trip Report only.

Request Message Description: TripReportTemplateQueryByExample

You can use available tags to filter the data. If no data is provided for any tag the Web service returns all available trip report templates. The most important tag in this request message is 'Name'. Use this tag to retrieve specific trip report templates

Response Message Description: TripReportTemplateQueryByExample

For an example of the response message, see Example Package for SWILSClinicalGetSmartScriptDetails.

SWILSClinicalTripReportTemplates 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 Trip Report Template Service	Business 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 Trip Report Template IO	LS Clinical Trip Report Template
LS Clinical Trip Report Template Internal IO	LS Clinical Trip Report Template

Example Package for SWILSClinicalTripReportTemplates

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:

...\SWILSClinicalTripReportTemplates\SWILSClinicalTripReportTemplates-QueryByExample-
request.xml

Response

See the following file to view the sample code:

...\SWILSClinicalTripReportTemplates\SWILSClinicalTripReportTemplates-response.xml

Interface Description (WSDL) for SWILSClinicalTripReportTemplates

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.

...\SWILSClinicalTripReportTemplates\SWILSClinicalTripReportTemplates.WSDL

SWI LS Medical Product Issue Create Inbox Item Inbound

Use this Web service to create inbox items with provided comments to invoke a message to owners of a product issue in Siebel Life Sciences. An external application invokes this Web service with a required product issue ID, and, optionally, with comments. When the inbox items are created with the product issue number as the subject, the product issue owners click the hyperlink to navigate to the corresponding product issue. An error message is returned in the event of failed connection attempts.

SWI LS Medical Product Issue Create Inbox Item Inbound Operations

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

Name	Description
LS Medical Product Issue Create Inbox Item Inbound	Creates an inbox item for the product issue ID provided in the Web service

Request Message Description: LS Medical Product Issue Create Inbox Item Inbound

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

Node	Description	Type
Id	Required. The product issue ID.	Character data
OwnerComments	Optional. The message that is passed to the product issue owners.	Character data

Response Message Description: LS Medical Product Issue Create Inbox Item Inbound

There is no response message for operation.

SWI LS Medical Product Issue Create Inbox Item Inbound 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 (Workflow)

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

Name	Boundary Object Type	Class
LS Medical Product Issue Create Inbox Item Inbound	Workflow	Not applicable

Data Object (Integration Object)

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

Siebel Repository Name	External Name
LSMedicalFromSafetyIntegProductIssueInterface	LS Medical Product Issue

Example Package for SWI LS Medical Product Issue Create Inbox Item Inbound

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:

...\LSMedicalProductIssue\CreateInboxItem_request.xml

Interface Description (WSDL) for SWI LS Medical Product Issue Create Inbox Item Inbound

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.

...\LSMedicalProductIssue\SWI_LS_Medical_Product_Issue_Create_Inbox_Item_Inbound.wsdl

SWI LS Medical Update Product Issue Inbound

Use this Web service to update product issue information such as AE Case ID, Safety Received Date, Status, and so on in Siebel Life Sciences. An external application invokes this Web service with the product issue ID, and with the new data updates to the information already in the Siebel database. An error message is returned in the event of failed connection attempts.

SWI LS Medical Update Product Issue Inbound Operations

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

Name	Description
LS Medical Update Product Issue Inbound	Updates Product Issue information such as AE Case ID, Safety Received Date, and Status

Request Message Description: LS Medical Update Product Inbound

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

Node	Description	Type
Id	Required. The product issue ID.	Character data
AECaseId	Optional. Corresponding safety system ID.	Character data
SafetyReceivedDate	Optional. The date on which safety system accepted the product issue.	Date
Status	Optional. The status of the product issue.	Character data

Response Message Description: LS Medical Update Product Inbound

There is no response message for operation.

SWI LS Medical Update Product Issue Inbound 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 (Workflow)

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

Name	Boundary Object Type	Class
LS Medical Update Product Issue Inbound	Workflow	Not applicable

Data Object (Integration Object)

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

Siebel Repository Name	External Name
LSMedicalFromSafetyIntegProductIssueInterface	LS Medical Product Issue

Example Package for SWI LS Medical Update Product Issue Inbound

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:

...\LSMedicalProductIssue\UpdateProductIssue_request.xml

Interface Description (WSDL) for SWI LS Medical Update Product Issue Inbound

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.

...\LSMedicalProductIssue\SWI_LS_Medical_Update_Product_Issue_Inbound.wsdl

SWIMergeServices

Use this inbound Web service to support merging of Account, Contact and Address records.

SWIMergeServices Operations

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

Name

Description

SWIMergeServices

Calls the Merge method of the business service SWI Merge Service which is used for merging one or more accounts to another account record. This Web service merges child records of the losing objects to the wining object and deletes the losing object records.

Takes the business object name, business component name, one winning record's ID value and one or more losing record's ID values as the arguments in .xml format.

Request Message Description: SWIMergeServices

Specifies the Siebel business object name and business component name, one wining object record‘s ID values and one or more losing objects record’s ID values.

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

Note: All nodes in the following table, bar the first node, apply to ListOfSWImergeobjectIO.

Node	Description	Type
ListOfSWImergeobjectIO	An instance of the integration object ListofSWImergeobjectIO.	Integration Object
SWIMergeObject	Integration object name.	Integration Object
BusinessComponentName	Name of business component.	String
BusinessObjectName	Name of business object.	String
MergeId	ID number assigned to merged item.	String
ListofSWILosingObject	Container element for the Losing Object details which is an instance of the VBC SWI Losing Object. Contains the details of the object that is merged to another object.	Integration Component
SWILosingObject	Losing object.	String
LosingObjectId	Losing object ID.	String
ParentRowId	Parent row ID of losing object.	String
ListOfSWIWinningObject	Container element for the Winning Object details which is an instance of the VBC SWI Winning Object. Contains the details of the object that is merged to another object.	Integration Component
SWIWinningObject	Winning object.	String
ParentRowId	Parent row ID of winning object.	String
WinningObjectId	Winning object ID.	String

Response Message Description: SWIMergeServices

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

Note: All nodes in the following table, bar the first node, apply to ListOfSWImergeobjectIO.

Node	Description	Type
ListOfSWImergeobjectIO	An instance of the integration object ListofSWImergeobjectIO.	Integration Object
SWIMergeObject	Integration object name.	Integration Object
BusinessComponentName	Name of the business component.	String
BusinessObjectName	Name of the business object.	String
MergeId	ID number assigned to merged item.	String
ListofSWILosingObject	Container element for the Losing Object details which is an instance of the VBC SWI Losing Object. Contains the details of the object that is merged to another object.	Integration Component
SWILosingObject	Losing object.	String
LosingObjectId	Losing object ID.	String
ParentRowId	Parent row ID of losing object.	String
ListOfSWIWinningObject	Container element for the Winning Object details which is an instance of the VBC SWI Winning Object. Contains the details of the object that is merged to another object.	Integration Component
SWIWinningObject	Winning object.	String
ParentRowId	Parent row ID of winning object.	String
WinningObjectId	Winning object ID.	String

SWIMergeServices 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
SWIMergeServices	Business Service	CSSMergeService

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SWIMergeObjectIO	SWI Merge Object

SWIOrderUpsert

Use this Web service to perform the following basic operations on a sales order:

Back up the order.
Update or insert (upsert) the order.
Cascade down updates to the order.
Trigger an auto asset for the order.

SWIOrderUpsert Operations

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

Name	Description
SWIOrderUpsert	Inserts or updates order details

Request Message Description: SWIOrderUpsert

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

Node	Description	Type
SWIOrderIO	Required	Integration Object
Auto-Asset Flag	Optional	String
Backup Order Flag	Optional	String
Cascade Down Flag	Optional	String
UTCCanonical	A value of Y means that all date-type fields in the payload are in UTC standard format.	String

Response Message Description: SWIOrderUpsert

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

Node	Description	Type
SWIOrderIO	Required. An instance of the integration object SWIOrder.	Integration Object

SWIOrderUpsert 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 (Workflow)

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

Name	Boundary Object Type	Class
SWIOrderupsert	Workflow	Not applicable.

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SWIOrderIO	PDS Simplified Order

Interface Description (WSDL) for SWIOrder IO

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.

...\SWIOrderUpsert\SWIOrderIO.wsdl

SWI Price List IO

Use this Web service for querying, creating, updating, and deleting price lists. The Web service enables you to associate an existing organization or many organizations with a price list.

SWIPriceList Operations

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

Name	Description
SWIPriceList_Insert	Creates a price list.
SWIPriceList_Update	Provides the name of the price list along with the updated field values and the operation updates the price list.
SWIPriceList_QueryByExample	Provides the price list using a unique value, such as name, and all price list details are returned.
SWIPriceList_QueryById	Provides price list ID and all price list details are returned.
SWIPriceList_Delete	Deletes an existing price list.

Request Message Description: SWIPriceList_Insert

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

Node	Description	Type
SWI Price List IO	Required. An instance of the Integration Object Price List. Price List is the parent header and Organization is the child.	Integration Object

Response Message Description: SWIPriceList_Insert

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

Node	Description	Type
ID	The price list ID created after an insert operation.	String
Name	The name of the price list.	String.

Request Message Description: SWIPriceList_Update

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

Node	Description	Type
SWI Price List IO	Required. An instance of the Integration Object Price List. Price List is the parent header and Organization is the child.	Integration Object

Response Message Description: SWIPriceList_Update

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

Node	Description	Type
ID	The price list ID created after an update operation.	String
Name	The name of the price list.	String.

Request Message Description: SWIPriceList_QueryByExample

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

Node	Description	Type
SWI Price List IO	Required. An instance of the Integration Object Price List. Price List is the parent header and Organization is the child.	Integration Object

Response Message Description: SWIPriceList_QueryByExample

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

Node	Description	Type
ID	The price list ID displayed after an query operation.	String
Name	The name of the price list.	String.
Organization	Organization name of the price list.	String

Request Message Description: SWIPriceList_QueryById

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

Node	Description	Type
SWI Price List IO	Required. An instance of the Integration Object Price List. Price List is the parent header and Organization is the child.	Integration Object

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

Node	Description	Type
ID	The price list ID displayed after the query operation.	String
Name	The name of the price list.	String.
Organization	Organization name of the price list.	String

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

Node	Description	Type
SWI Price List IO	Required. An instance of the Integration Object Price List. Price List is the parent header, and Organization is the child.	Integration Object

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

Node	Description	Type
ID	The price list ID deleted after the delete operation.	String
Name	The name of the price list.	String.

SWI Price List IO 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
SWI Price List BS	Business 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
SWI Price List IO	Admin Price List

Example Package for SWI Price List IO

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 files to view the sample code:

...\SWIPriceListIO\Delete\request.xml

...\SWIPriceListIO\Insert\request.xml

...\SWIPriceListI\QueryByExample\request.xml

...\SWIPriceListIO\QueryById\request.xml

...\SWIPrice List IO\Update\request.xml

Response

See the following files to view the sample code:

...\SWIPriceListIO\Delete\response.xml

...\SWIPriceListIO\Insert\response.xml

...\SWIPriceListIO\QueryByExample\response.xml

...\SWIPriceListIO\QueryById\response.xml

...\SWIPriceListIO\Update\response.xml

Interface Description (WSDL) for SWI Price List IO

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.

...\SWIPriceListIO\WSDL\http_siebel_asi_SWIPriceList.WSDL

SWIISSPriceListItemIO

Use this inbound Web service to perform basic operations, such as create, update, modify, and delete price list line items.

SWIISSPriceListItemIO Operations

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

Name	Description
SWIPriceListItemInsert	Creates a price list line item.
SWIPriceListItemUpdate	Updates a price list line item.
SWIPriceListItemUpsert	Inserts or updates a price list item.
SWIPriceListItemDelete	Deletes a price list line item.

Request Message Description: SWIPriceListItemInsert

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

Node

Description

Type

SWIISSPriceListItemIO

Required. An instance of the Integration Object SWIISSPriceListItem.

To insert a price list line item, note that price list (PriceListId), product (ProductId) and start date (StartDate) are user keys and the payload must provide these fields.

Integration Object

Response Message Description: SWIPriceListItemInsert

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

Node	Description	Type
PriceListItemID	The PriceListItemID that is created after the insert operation.	String
PriceListId	The PriceListID that is associated with PriceListItemID.	String
ProductId	The Product ID that is associated to PriceListItemID.	String
StartDate	Start date of the price list. StartDate is part of the user key.	String

Request Message Description: SWIPriceListItemUpdate

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

Node

Description

Type

SWIISSPriceListItemIO

Required. An instance of the integration object SWIISSPriceListItem.

To update an existing price list line item, price list (PriceListId), product (ProductId) and start date (StartDate) are user keys and payload must provide these fields.

Integration Object

Response Message Description: SWIPriceListItemUpdate

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

Node	Description	Type
PriceListItemID	The PriceListItemID that is updated after the update operation.	String
PriceListId	The PriceListID that is associated with PriceListItemID	String
ProductId	The Product ID that is associated to PriceListItemID.	String

Request Message Description: SWIPriceListItemUpsert

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

Node

Description

Type

SWIISSPriceListItemIO

Required. An instance of the integration object SWIISSPriceListItem.

Price List Item - Import is the parent header.

Integration Object

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

Node	Description	Type
PriceListItemID	The PriceListItemID that is created or updated after the upsert operation.	String
PriceListId	The PriceListID that is associated with PriceListItemID	String
ProductId	The Product ID that is associated to PriceListItemID.	String

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

Node

Description

Type

SWIISSPriceListItemIO

Required. An instance of the integration object SWIISSPriceListItem.

Price List Item - Import is the parent header.

Integration Object

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

Node	Description	Type
PriceListItemID	The PriceListItemID of the record that is deleted after the delete operation.	String
PriceListId	The PriceListID that is associated with PriceListItemID	String
ProductId	The Product ID that is associated to PriceListItemID.	String

SWIISSPriceListItemIO 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
SWIPriceListItem	Business 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
SWIISSPriceListItemIO	Admin Price List

Example Package for SWIISSPriceListItemIO

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

Request

See the following file to view the sample code:

...\SWIPriceListItemInsert\SWIPriceListItemInsert_request.xml
...\SWIPriceListItemUpdate\SWIPriceListItemUpdate_request.xml
...\SWIPriceListItemUpsert\SWIPriceListItemUpsert_request.xml
...\SWIPriceListItemDelete\SWIPriceListItemDelete_request.xml

Response

See the following file to view the sample code:

...\SWIPriceListItemInsert\SWIPriceListItemInsert_response.xml
...\SWIPriceListItemUpdate\SWIPriceListItemUpdate_response.xml
...\SWIPriceListItemUpsert\SWIPriceListItemUpsert_response.xml
...\SWIPriceListItemDelete\SWIPriceListItemDelete_response.xml

Interface Description (WSDL) for SWIISSPriceListItemIO

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

...\SWIISSPriceListItemIO\SWIISSPriceListItemIO.wsdl

SWIProductAttributeImport

Use this Web service to perform basic operations on attributes.

SWIProductAttributeImport Operations

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

Name	Description
SWIAttributeImportUpsert	Creates a new or updates an existing attribute.

Request Message Description: SWIProductAttributeImport

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

Node	Description	Type
SWIAttributeIntegrationIO	Required. An instance of the integration object SWIAttributeIntegration	Integration Object
SyncChild	Upsert operation behaves as Synchronize if SyncChild flag is set to Y. Note: The default value of this flag is Y.	String
UTCCanonical	A value of Y means that all date-type fields in the payload are in UTC standard format.	String

Response Message Description: SWIProductAttributeImport

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

Node	Description	Type
SWIAttributeIntegrationIO	Returns an instance of the integration object SWIAttributeIntegration. Note: Returns only those fields specified in the status key of Integration components that are part of SWI Admin ISS Attribute Definition integration object.	Integration Object.
Error Message	Error message (if any).	String

SWIProductAttributeImport 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 Attribute Import	Business Service	CSSCMUProdWebSvc

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SWIAttributeIntegrationIO	SWI Attribute Integration
SWI Admin ISS Attribute Definition	SWI Admin ISS Attribute Definition

Methods

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

Operation	Method
SWIAttributeImportUpsert	Insert or Update

Example Package for SWIProductAttributeImport

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:

...\SWIProductAttributeImport\SWIProductAttributeImport_request.xml

Response

See the following file to view the sample code:

...\SWIProductAttributeImport\SWIProductAttributeImport_response.xml

Interface Description (WSDL) for SWIProductAttributeImport

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.

...\SWIProductAttributeImport\SWIProductAttributeImport.wsdl

SWIProductClassImport

Use this Web service to perform basic operations on Product Class.

SWIProductClassImport Operations

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

Name	Description
SWIClassImportUpsert	Creates a new or updates an existing product class.

Request Message Description: SWIClassImportUpsert

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

Node	Description	Type
SWIProductClassIntegrationIO	Required. An instance of the integration object SWIProductClassIntegration.	Integration Object
SyncChild	Upsert operation behaves as Synchronize if SyncChild flag is set to Y. Note: The default value of this flag is N.	String
UTCCanonical	A value of Y means that all date-type fields in the payload are in UTC standard format.	String

Response Message Description: SWIClassImportUpsert

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

Node	Description	Type
SWIProductClassIntegrationIO	Required. An instance of the integration object SWIProductClassIntegration. Note: Returns only those fields specified in the status key of Integration components that are part of SWI Admin ISS Class VOD Definition integration object.	Integration Object.

SWIClassImportUpsert 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 Product Class Import	Business Service	CSSCMUProdWebSvc

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SWIProductClassIntegrationIO	SWI Class Integration
SWI Admin ISS Class VOD Definition	SWI Admin ISS Class VOD Definition

Methods

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

Operation	Method
SWIClassImportUpsert	Insert or Update

Example Package for SWIProductClassImport

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:

...\SWIProductClassImport\SWIProductClassImport_request.xml

Note: The following xml tags in the SwiProductStructureVbc/ container refer to the parent class instead of the product.

<ProductId/>
< ProductName/>
< ProductVendorId/> 
< ProductBusinessUnitId/>

Response

See the following file to view the sample code:

...\SWIProductClassImport\SWIProductClassImport_response.xml

Interface Description (WSDL) for SWIProductClassImport

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.

...\SWIProductClassImport\SWIProductClassImport.wsdl

SWIProductImport

Use this inbound Web service to support Insert or Update of product details which allows the import of external product information into the Siebel database. Also consider the following:

The Web service is only available with Oracle Application Integration Architecture and has been created for syncronizing Oracle products with Siebel CRM products.
This Web service supports a subset of the Siebel ISS Authoring Import Export service functionality.
This Web service uses the Siebel EAI interface.

SWIProductImport Operations

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

Name	Description
SWIProductImportUpsert	Calls the Insert or Update method of the business service SWI Product Import used for inserting new product details into the Siebel database. If the product is already present, then the product is updated with the details from the request message.

Request Message Description: SWIProductImportUpsert

Insert one or more products into the Siebel database. If the Product is already present in the Siebel database, then the Product record will be updated with the details from the request message.

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

Node	Description	Type
SWIProductIntegrationIO	Required. An instance of the integration object SWIProductIntegration.	Integration Object
SyncChild	The upsert operation behaves as a synchronize operation if the SyncChild flag is set to Y. Note: The default value of this flag is Y.	String
UTCCanonical	A value of Y means that all date-type fields in the payload are in UTC standard format.	String
ActiveFlag	Indicates whether record is active.	String
BillableFlag	Indicates whether record is billable.	String
BusinessUnitId	ID of business unit associated with product record.	String
Description	Description.	String
EffectiveEndDate	Effective end date of record.	String
EffectiveStartDate	Effective start date of record.	String
ExternalInventorySystemRef	Reference number from external inventory system.	String
IntegrationId	Integration ID.	String
InventoryFlag	Flag to indicate if product is tracked in inventory.	String
LeadTime	Lead time for product delivery.	String
ProductCost	Cost of product.	String
ProductName	Name of product.	String
ProductSerializedFlag	Serialized flag. Indicates if instances of this product are tracked as serialized assets or simply as quantities of product. Instances of a serialized product will each carry a unique serial number (or license number, policy number, and so on). Quantities of non-serialized assets are sometimes tracked as lots which may have a unique lot number.	String
ProductVersion	Version of product.	String
ReleaseFlag	Flag which indicates whether a product will be released at the time of a synchronization.	String
SalesProductFlag	Sales product flag. Sales products appear on the product picklist when a user defines products for an opportunity.	String
ServiceTerms	Service terms associated with product.	String
ShipFlag	Flag to indicate whether a product has to be shipped.	String
Status	Status of product. Active or Inactive.	String
StructureType	Depending on the product type, users are allowed to create a simple bill of materials without using Siebel Configurator.	String
UnitofMeasure	Unit of measure.	String
ListofProductInvloc	Location of product in inventory.	String

Response Message Description: SWIProductImportUpsert

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

Node	Description	Type
SWIProductIntegrationIO	Returns an instance of SWIProductIntegration. Note: Returns only those fields specified in the status key of Integration components that are part of SWI Admin ISS Product Definition integration object.	Integration Object
ErrorMessage	Error Message (if any).	String
Id	Product ID.	String
ActiveFlag	Indicates whether record is active.	String
AutoExplodeFlag	Indicates whether or not the product needs to be automatically ungrouped and enforce ungrouped quantity equal to 1.	String
BillableFlag	Indicates whether record is billable.	String
BusinessUnitId	ID of business unit associated with product record.	String
CheckEligibilityFlag	Indicates whether or not to apply eligibility and compatibility rules for this product.	String
Description	Description of product.	String
EffectiveEndTime	Effective end date of record.	String
EffectiveStartTime	Effective start date of record.	String
ExternalInventorySystemRef	Reference number from external inventory system.	String
InclusiveEligibilityFlag	Indicates whether or not to process a particular product for inclusive eligibility rules. Inclusive eligibility rules are defined in the eligibility matrix with matrix rule type code set as Inclusive.	String
IntegrationId	Integration ID.	String
InventoryFlag	Flag which indicates if a product is tracked in inventory.	String
LeadTime	Lead time for product delivery.	String
OrderableFlag	Flag which indicates whether a product is orderable.	String
PriceType	Price type, such as One-time, Recurring, Usage and so on.	String
PrimaryOrganizationId	ID of primary organization associated with product record.	String
ProductCost	Cost of product.	String
ProductId	ID of product.	String
ProductName	Name of product.	String
ProductSerializedFlag	Serialized flag. Indicates if instances of this product are tracked as serialized assets or simply as quantities of product. Instances of a serialized product will each carry a unique serial number (or license number, policy number, and so on). Quantities of non-serialized assets are sometimes tracked as lots which may have a unique lot number.	String
ProductType	Product type.	String
ProductVersion	Product version.	String
ReleaseFlag	Flag which indicates whether a product will be released at the time of a synchronization.	String
SalesProductFlag	Sales product flag. Sales products appear on the product picklist when a user defines products for an opportunity.	String
ServiceInstanceFlag	Flag to indicate whether a product requires a metering point.	String
ServiceProductFlag	Sales and Service flag. Sales service products are services that are priced based on the tangible product for which they are purchased (an extended warranty, for example). These products appear on the picklist that pops up when the user clicks the Service button for a tangible product on a quote. When you choose a sales service product from the list, a new quote item for the product is added to the quote and priced according to the value of the tangible product to which it applies.	String
ShipFlag	Flag to indicate whether a product needs to be shipped.	String
Status	Status of product order.	String
StructureType	Depending on the product type, users can create a simple bill of materials without using Siebel Configurator.	String
TrackAsAssetFlag	Flag to indicate that a product needs to be tracked as an asset.	String
Type	Product type.	String
UnitofMeasure	Unit of measure.	String
VendorId	ID of product vendor.	String
ListofProductInvLoc	Location of product in inventory.	String

SWIProductImport 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
SWIProductImport	Business Service	CSSCMUProdWebSvc

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SWIProductIntegrationIO	SWI Product Integration
SWI Admin ISS Product Definition	SWI Admin ISS Product Definition

Methods

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

Operation	Method
SWIProductImportUpsert	InsertOrUpdate

Example Package for SWIProductImport

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:

...\SWIProductImport\SWIProductImport_request.xml

Response

See the following file to view the sample code:

...\SWIProductImport\SWIProductImport_response.xml

Interface Description (WSDL) for SWIProductImport

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.

...\SWIProductImport\SWIProductIntegrationIO.wsdl

SWIProductLine

Use this Web service to create, update, and query product lines.

SWIProductLine Operations

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

Name	Description
SWIProductLine_Insert	Used to create a product line.
SWIProductLine_Update	Used to update an existing product line.
SWIProductLine_Upsert	Used to create a new product line using an upsert operation.
SWIProductLine_Synchronize	Used to synchronize a new product line, or to synchronize data to an existing product line.
SWIProductLine_QueryById	Used to perform queries for existing product lines using the Row ID.
SWIProductLine_QueryByExample	Used to query for existing product lines using the QueryBeExample method.
SWIProductLine_Delete	Used to delete a product line.

Request Message Description: SWIProductLine_Insert

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

Node	Description	Type
ListOfAdminProductLine	An instance of the integration object ListOfAdminProductLine.	Integration Object
AdminProductLine	Integration Component (XML Tag) corresponding to the Admin Product Line Business component. You can create multiple instances of AdminProductLine under ListOfAdminProductLine to process different product lines at one time.	Integration Component
Description	Description of the product line.	String
Name	Name of the product line.	String
ListofAdminProductLine_Position	Positions associated with the product line.	Integration Component
Position	Position, such as Administrator.	String
ProductLineManager	Product line manager.	String
Division	Division within the company.	String
ListofAdminProductLine_InternalProduct	Internal products associated with the product line.	Integration Component
Product	Product name.	String
IntegrationId	Integration ID of the product record.	String
Primary Organization	The primary organization for the product.	String

Response Message Description: SWIProductLine_Insert

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

Node	Description	Type
ListOfAdminProductLine	An instance of the integration object ListOfAdminProductLine.	Integration Object
AdminProductLine	Integration Component (XML Tag) corresponding to the Admin Product Line Business component. You can create multiple instances of AdminProductLine under ListOfAdminProductLine to process different product lines at one time.	String
Id	Product line ID.	String
Description	Product line description.	String
Name	Product line name.	String
PrimaryPositionId	Primary Position ID.	String
PrimaryProductId	ID of the primary product.	String

Request Message Description: SWIProductLine_Update

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

Node	Description	Type
ListOfAdminProductLine	An instance of the integration object ListOfAdminProductLine.	Integration Object
Description	Description of the product line.	String
Name	Name of the product line.	String
ListOfAdminProductLine_Position	Positions associated with the product line.	Integration Component
Position	Position, such as Administrator.	String
ProductLineManager	Product line manager.	String
Division	Division within the company.	String
ListOfAdminProductLine_ InternalProduct	Internal products associated with the product line.	Integration Component
Product	Product name.	String
IntegrationId	Integration ID of the product record.	String
PrimaryOrganization	The primary organization for the product.	String

Response Message Description: SWIProductLine_Update

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

Node	Description	Type
ListOfAdminProductLine	An instance of the integration object ListOfAdminProductLine.	Integration Object
AdminProductLine	Integration Component (XML Tag) corresponding to the Admin Product Line Business component. You can create multiple instances of AdminProductLine under ListOfAdminProductLine to process different product lines at one time.	Integration Component
Description	Description of the product line.	String
Name	Name of the product line.	String
ListOfAdminProductLine_Position	Positions associated with the product line.	Integration Component
AdminProductLine_Position IsPrimaryMVG	Admin Product Line_Position integration component instance that corresponds to a primary MVG and is denoted by the attribute IsPrimaryMVG set to Y. This attribute is a hidden integration component field and does not have a corresponding business component field.	Integration Component
Position	Position, such as Administrator.	String
ProductLineManager	Product line manager.	String
Division	Division within the company.	String
ListOfAdminProductLine_InternalProduct	Internal products associated with the product line.	Integration Component
Product	Pproduct name.	String
IntegrationId	Integration ID of the product record.	String
PrimaryOrganization	The primary organization for the product.	String

Request Message Description: SWIProductLine_Upsert

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

Node	Description	Type
ListOfAdminProductLine	An instance of the integration object ListOfAdminProductLine.	Integration Object
Description	Description of the product line.	String
Name	Name of the product line.	String
ListOfAdminProductLine_Position	Positions associated with the product line.	Integration Component
Position	Position, such as Administrator.	String
ProductLineManager	Product line manager.	String
Division	Division within the company.	String
ListOfAdminProductLine_InternalProduct	Internal products associated with the product line.	Integration Component
Product	Product name.	String
IntegrationId	Integration ID of the product record.	String
PrimaryOrganization	The primary organization for the product.	String

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

Node	Description	Type
ListOfAdminProductLine	An instance of the integration object ListOfAdminProductLine.	Integration Object
Description	Description of the product line.	String
Name	Name of the product line.	String
PrimaryPositionId	ID value of the primary position.	String
PrimaryProductId	ID value of the primary product.	String
ListOfAdminProductLine_Position	Positions associated with the product line.	Integration Component
Position	Position, such as Administrator.	String
ProductLineManager	Product line manager.	String
Division	Division within the company.	String
ListOfAdminProductLine_InternalProduct	Internal products associated with the product line.	Integration Component
Product	The product number.	String
IntegrationId	Integration ID of the product record.	String
PrimaryOrganization	The primary organization for the product.	String

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

Node	Description	Type
ListOfAdminProductLine	An instance of the integration object ListOfAdminProductLine.	Integration Object
Description	Description of the product line.	String
Name	Name of the product line.	String
ListOfAdminProductLine_Position	Positions associated with the product line.	Integration Component
Position	Position, such as Administrator.	String
ProductLineManager	Product line manager.	String
Division	Division within the company.	String
ListOfAdminProductLine_InternalProduct	Internal products associated with the product line.	Integration Component
Product	Product name.	String
IntegrationId	Integration ID of the product record.	String
PrimaryOrganization	The primary organization for the product.	String

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

Node	Description	Type
ListOfAdminProductLine	An instance of the integration object ListOfAdminProductLine.	Integration Object
Id	Product line ID.	String
Description	Description of the product line.	String
Name	Name of the product line.	String
PrimaryPostionId	ID of the primary position.	String
PrimaryProductId	ID of the primary product.	String
ListOfAdminProductLine_Position	Positions associated with the product line.	Integration Component
Position	Position, such as Administrator.	String
PositionId	Position ID.	String
PrimaryEmployeeId	ID of the primary employee.	String
ProductLineManager	Product line manager.	String
Division	Division within the company.	String
AdminProductLine_InternalProduct	Internal products associated with the product line.	String
Product	Product name.	String
Part	Part number.	String
PrimaryOrganization	The primary organization for the product.	String

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

Node	Description	Type
PrimaryRowId	The row ID of the product line.	String

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

Node	Description	Type
ListOfAdminProductLine	An instance of the integration object ListOfAdminProductLine.	Integration Object
AdminProductLine	Integration Component (XML Tag) corresponding to the Admin Product Line Business component. You can create multiple instances of AdminProductLine under ListOfAdminProductLine to process different product lines at one time.	Integration Component
Description	Description of the product line.	String
IntegrationId	Integration ID of the product record.	String
Name	Name of the product line.	String
PrimaryPositionId	ID of the primary position.	String
ListOfAdminProductLine_Position	An instance of the integration object Admin Product Line_Position.	Integration Object
AdminProductLine_PositionIsPrimaryMVG	Admin Product Line_Position integration component instance that corresponds to a primary MVG and is denoted by the attribute IsPrimaryMVG set to Y. This attribute is a hidden integration component field and does not have a corresponding business component field.	Integration Component
Position	Position, such as Administrator.	String
Position_Id	ID of the position.	String
PrimaryEmployeeId	ID of the primary employee.	String
ProductLineManager	Product line manager.	String
WorkPhoneNumber	Work phone number.	String
DivisionIntegrationId	Division integration ID.	String
Division	Division within the company.	String
ListOfAdminProductLine_InternalProduct	Internal products associated with the product line.	Integration Component
AdminProductLine_InternalProductIs PrimaryMVG	Admin Product Line_Internal Product integration component instance that corresponds to a primary MVG and is denoted by the attribute IsPrimaryMVG set to Y. This attribute is a hidden integration component field and does not have a corresponding business component field.	Integration Component
Product	Product name.	String
Part	Part number.	String
IntegrationId	Integration ID of the product record.	String
PrimaryOrganization	The primary organization for the product.	String
VendorIntegrationId	Integration ID of the vendor.	String

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

Node	Description	Type
ListofAdminProductLine	An instance of the integration object ListOfAdminProductLine.	Integration Object
AdminProductLine	Integration component (XML Tag) corresponding to the Admin Product Line Business component. You can create multiple instances of AdminProductLine under ListOfAdminProductLine to process different product lines at one time.	Integratin Component
Id	Product ID.	String
Created	System timestamp.	String
Updated	System timestamp.	String
ConflictId	Conflict ID.	String
ModId	Modification ID.	String
Description	Product description.	String
IntegrationId	Integration ID of the product record.	String
Name	Product name.	String
PrimaryPositionId	ID value of the primary position.	String
PrimaryProductId	ID value of the primary product.	String
ListofAdminProductLine_Position	Positions associated with the product line.	Integration Component
AdminProductLine_PositionIsPrimaryMVG	Admin Product Line_Position integration component instance that corresponds to a primary MVG and is denoted by the attribute IsPrimaryMVG set to Y. This attribute is a hidden integration component field and does not have a corresponding business component field.	Integration Component
Position	Position, such as Administrator.	String
Position_Id	Position ID.	String
PrimaryEmployeeId	ID of the primary employee.	String
ProductLineManager	Product line manager.	String
WorkPhoneNumber	Work phone number.	String
DivisionIntegrationId	Integration ID of the division.	String
Division	Division within the company.	String
ListOfAdminProductLine_InternalProduct	Internal products associated with the product line.	Integration Component
AdminProductLine_InternalProduct IsPrimaryMVG	Admin Product Line_Internal Product integration component instance that corresponds to a primary MVG and is denoted by the attribute IsPrimaryMVG set to Y. This attribute is a hidden integration component field and does not have a corresponding business component field.	Integration Component
Product	Product name.	String
Part	Part number.	String
IntegrationId	Integration ID of the product record.	String
PrimaryOrganization	The primary organization of the product.	String
VendorIntegrationId	Integration ID of the vendor.	String

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

Node	Description	Type
ListofAdminProductLine	An instance of the integration object ListofAdminProductLine.	Integration Object.
AdminProductLine	Integration Component (XML Tag) corresponding to the Admin Product Line Business component. You can create multiple instances of AdminProductLine under ListOfAdminProductLine to process different product lines at one time.	Integration Component
Description	Description of the product line.	String
IntegrationId	Integration ID of the product line.	String
Name	Name of the product line.	String
PrimaryPositionId	ID of the primary position.	String.
PrimaryProductId	ID of the primary product.	String
ListofAdminProductLine_Position	Positions associated with the product line.	Integration Component
AdminProductLine_PositionIsPrimaryMVG	Admin Product Line_Position integration component instance that corresponds to a primary MVG and is denoted by the attribute IsPrimaryMVG set to Y. This attribute is a hidden integration component field and does not have a corresponding business component field.	Integration Component
Position	Position, such as Administrator.	String
PrimaryEmployeeId	ID of the primary employee.	String
ProductLineManager	Product line manager.	String
WorkPhoneNumber	Work phone number.	String
DivisionIntegrationId	Integration ID of the division.	String
Division	Division within the company.	String
ListOfAdminProductLine_InternalProduct	Internal products associated with the product line.	Integration Component
Product	Product name.	String
Part	Part number.	String
IntegrationId	Integration ID of the product record.	String
PrimaryOrganization	The primary organization for the product.	String
VendorIntegrationId	Integration ID of the vendor.	String

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

Node	Description	Type
ListOfAdminProductLine	An instance of the integration object ListOfAdminProductLine.	Integration Object
Name	Product line name.	String

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

Node	Description	Type
ListofAdminProductLine	An instance of the integration object ListOfAdminProductLine.	Integration Object
Id	ID of the product line.	String
Description	Description of the product line.	String
Name	Name of the product line.	String
PrimaryPositionId	ID of the primary position.	String
PrimaryProductId	ID of the primary product.	String

SWIProductLine 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 Product Line	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
SWI Admin Product Line	SWI Admin Product Line

Example Package for SWIProductLine

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:

...\SWIProductLine\SWIProductLine_request.xml

Response

See the following file to view the sample code:

...\SWIProductLine\SWIProductLine_response.xml

Interface Description (WSDL) for SWIProductLine

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.

...\SWIProductLine\SWIProductLine.wsdl

SWIPromotionIntegration

Use this Web service to add or update product and pricing information for promotions.

SWIPromotionIntegration Operations

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

Name	Description
SWIPromotionUpsert	Creates a new promotion or updates an existing promotion.

Request Message Description: SWIPromotionUpsert

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

Node	Description	Type
SyncChild	Upsert operation behaves as Synchronize if SyncChild flag is set to Y. Note: The default value of this flag is N.	Boolean
SWIPromotionIntegrationIO	Required. An instance of the integration object SWIPromotionIntegration.	Integration Object
WorkspaceName	Workspace name.	String
WorkspaceReuseFlag	Flag which indicates whether a workspace is reused.	Boolean
ListOfSwiPromotionVbc	Container element for Promotion details which is an instance of the VBC SwiPromotion.	Integration Component
ActiveFlag	Flag which indicates whether a record is active.	Boolean
Name	Promotion name.	String
Organization	Organization name.	String
Type	Promotion type.	String
TrackAsAgreement	Flag which indicates whether a record is tracked as an agreement.	Boolean
TrackAsAsset	Flag which indicates whether a record is tracked as an asset.	Boolean
ShowInCatalog	Flag which indicates whether a record is shown in a catalog.	Boolean
ReleaseFlag	Flag which indicates whether a record is to be released.	Boolean
ListOfSwiPromotionProductComponentsVbc	Container element for Promotion Product Component details which is an instance of the VBC SwiPromotionProductComponents.	Integration Component
Default	Default value for product components.	Integer
Max	Maximum number of product components.	Integer
Min	Minimum number of product components.	Integer
ProductName	Product name.	String
Commitment	Flag which indicates whether a commitment has been made.	Boolean
DisconnectAction	The disconnect action, such as Prompt.	String
ApplyComponentChargeFlag	Flag which indicates whether a component charge is to be applied.	Boolean
GracePeriod	Grace period number.	Integer
GracePeriodUOM	Grace period unit of measure, such as days or weeks.	String
CommitmentPeriod	Period of commitment.	Integer
CommitmentPeriodUOM	Grace period unit of measure, such as days, month or years.	Integer
ProratePlanName	Name of the prorate plan.	String
TerminationCharge	Termination charge.	String
ListOfSwiPromotionPricingComponentsVbc	Container element for Promotion Pricing Component details which is an instance of the VBC SWIPromotionPricingComponents.	Integration Component
AdjustmentType	Adjustment type.	String
Value	Adjustment type value.	Integer
CurrencyCode	Currency code.	String
EndDate	Adjustment end date.	Date
ExchangeDate	Exchange date.	Date
ProductName	Product name.	String
ListOfSwiPromotionAggregateProductClassVbc	Container element for Promotion Aggregate Product Class details which is an instance of the VBC SwiPromotionAggregateProductClass.	Integration Component
ClassId	The class ID value.	String
ClassName	The class name.	String
Default	The default value.	Integer
Description	Description.	String.
DisconnectAction	Disconnect action.	String
Recommendable	Flag which indicates whether a product class can be recommended by users.	Boolean
Max	Maximum number.	Integer
Min	Minimum number.	Integer
Commitment	Flag which indicates whether there is a commitment.	Boolean
ListOfSwiPromotionAggregateProductClass DefaultProductsVbc	Container element for Promotion Aggregate Product Class Default Product details which is an instance of the VBC SwiPromotionAggregateProductClassDefaultProducts.	Integration Component
DefaultCardinality	The default cardinality.	Integer
ProductId	The product ID.	String
ProductName	The product name.	String
ListOfSwiPromotionAggregateProductLineVbc	Container element for Promotion Aggregate Product Line details which is an instance of the VBC SwiPromotionAggregateProductLine.	Integration Component
Default	Default value.	Integer
Description	Aggregate product line description.	String
Max	Maximum number.	Integer
Min	Minimum number.	Integer
ProductLine	The product line.	String
DisconnectAction	Disconnect action.	String
ProductLineId	Product line ID.	String
Commitment	Flag which indicates whether there is a commitment.	Boolean
ListOfSwiPromotionAggregateProductLine DefaultProductsVbc	Container element for Promotion Aggregate Product Line Default Products details which is an instance of the VBC SwiPromotionAggregateProductLineDefault Products.	Integration Component
DefaultCardinality	Default cardinality.	Integer
ProductId	Product ID.	String
ProductName	Product name.	String
SwiPromotionAggregateProductClass DefaultProductsVbc	Container element for Promotion Aggregate Product Class Default Product details which is an instance of the VBC SwiPromotionAggregateProductClassDefaultProducts.	Integration Component
DefaultCardinality	Default cardinality	Integer
ProductId	Product ID.	String
ProductName	Product name.	String
ListOfSwiPromotionAggregateProductLine MessagesVbc	Container element for Promotion Aggregate Product Line Message details which is an instance of the VBC SWI Promotion.	Integration Component
Description	Description.	String
LanguageCode	Language code.	String
ListOfSwiPromotionUpgradeAggregate ProductLineVbc	Container element for Promotion Upgrade Aggregate Product Line details which is an instance of the VBC SwiPromotionUpgradeAggregateProduct Line.	Integration Component
DisplayCommitment	Flag which indicates whether to display the commitment.	Boolean
DisplayProratedCharge	Flag which indicates whether to display the prorated charge.	Boolean
Penalty	Penalty.	String
ProductLine	Product line.	String
ProratePlanName	Prorate Plan Name.	String
Reason	Commitment reason.	String
ListofSwiPromotionUpgradeAggregate ProductClassVbc	Container element for Promotion Upgrade Aggregate Product Class details which is an instance of the VBC SwiPromotionUpgradeAggregateProduct Class.	Integration Component
DisplayCommitment	Flag which indicates whether to display the commitment.	Boolean
DisplayProratedCharge	Flag which indicates whether to display the prorated charge.	Boolean
Penalty	Penalty.	String
ProductClassName	Product class name.	String
ProratePlanName	Prorate plan name.	String
Reason	Reason.	String
ListofSwiPromotionUpgradeToAggregate ProductLineVbc	Container element for Promotion Upgrade To Aggregate Product Line details which is an instance of the VBC SwiPromotionUpgradeToAggregateProduct Line.	Integration Component
DisplayCommitment	Flag which indicates whether to display the commitment.	Boolean
DisplayProratedCharge	Flag which indicates whether to display the prorated charge.	Boolean
Penalty	Penalty.	String
ProductLine	Product class name.	String
ProratePlanName	Prorate plan name.	String
Reason	Reason.	String
ListOfSwiPromotionUpgradeToAggregate ProductClassVbc	Container element for Promotion Upgrade To Aggregate Product Class details which is an instance of the VBC SwiPromotionUpgradeToAggregateProduct Class.	Integration Component
DisplayCommitment	Flag which indicates whether to display the commitment.	Boolean
DisplayProratedCharge	Flag which indicates whether to display the prorated charge.	Boolean
Penalty	Penalty.	String
ProductClassName	Product class name.	String
ProratePlanName	Prorate plan name.	String
Reason	Reason.	String
ListOfSwiPromotionCharges_CreditsVbc	Container element for the Promotion Charge and Credit details which is an instance of the VBC SwiPromotionCharges_Credits.	Integration Component
Amount	Credit amount.	Integer
Type	Credit type.	String
ListOfSwiPromotionProductOverrideVbc	Container element for Promotion Product Override details which is an instance of the VBC SwiPromotionProductOverride.	Integration Component
ComponentPath	Component path.	String
PromotionName	Promotion name.	String
ApplyComponentChargeFlag	Flag which indicates whether to apply a component charge.	Boolean
GracePeriod	Grace period value.	Integer
GracePeriodUOM	Grace period unit of measure, such as days, weeks and so on.	String
CommitmentPeriod	Commitment period value.	Integer
CommitmentPeriodUOM	Commitment period unit of measure, such as weeks, years and so on.	String
ProratePlanName	Prorate plan name.	String
TerminationCharge	Termination charge.	Integer
DefaultCardinality	Default cardinality.	Integer
MaxCardinality	Optional. Maximum cardinality.	Integer
MinCardinality	Optional Minimum cardinality.	Integer
ListofSwiPromotionPricingOverride Vbc	Container element for Promotion Pricing Override details which is an instance of the VBC SwiPromotionPricingOverride.	Integration Component
AdjustmentType	Adjustment type.	String
AdjustmentValue	Adjustment value.	Integer
ComponentPath	Component path.	String
EndDate	End date.	Date
MaximumPrice	Maximum price.	Integer
MinimumPrice	Minimum price.	Integer
PromotionName	Promotion name.	String
StartDate	Start date.	Date

Response Message Description: SWIPromotionUpsert

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

Node	Description	Type
SWIPromotionIntegrationIO	Required. An instance of the integration object SWIPromotionIntegration.	Integration Object
Id	Promotion ID.	String
OverrideLockedFlag	Flag which indicates whether to override a locked record.	Boolean
ReleaseDate	Release date.	String
WorkspaceId	Workspace ID.	String
WorkspaceName	Workspace name.	String
WorkspaceReleaseFlag	Workspace release flag.	Boolean
WorkspaceReuseFlag	Workspace reuse flag.	Boolean
ListofSwiPromotionVbc	Container element for Promotion which is an instance of the VBC SwiPromotion.	Integration Component
Id	Promotion ID.	String
ActiveFlag	Flag which indicates whether to record is active or not.	Boolean
Name	Promotion name.	String
PrimaryOrganizationId	Primary organization ID.	String
PromotionId	Promotion ID.	String
Type	Promotion type.	String
VendorId	Vendor ID.	String
ReleaseFlag	Flag which indicates whether the promotion will be released.	String
Id	Promotion ID.	String
Max	Maximum value.	Integer
Min	Minimum value.	Integer
ProductId	Product ID.	String
ListOfSwiPromotionCharges_CreditsVbc	Container element for the Promotion Charge and Credit details which is an instance of the VBC SwiPromotionCharges_Credits.	Integration Component
Id	Promotion ID.	String
ChargeAmountCurrencyCode	Currency code for charge amount.	Integer
Period	Promotion period.	Date
Plan	Plan.	String
Type	Promotion type.	String
ListOfSwiPromotionPricingComponentsVbc	Container element for Promotion Pricing Component details which is an instance of the VBC SWIPromotionPricingComponents.	Integration Component
Id	Promotion ID.	String
AdjustmentType	Adjustment type.	String
Value	Value of promotion.	String
ProductId	Product ID.	String
ProductName	Product name.	String
ListOfSwiPromotionAggregate ProductLineVbc	Container element for Promotion Aggregate Product Line details which is an instance of the VBC SwiPromotionAggregateProductLine.	Integration Component
Default	Default value.	Integer
Description	Promotion description.	String
DisconnectAction	Disconnect action.	String
Id	Promotion ID.	String
Recommendable	Flag which indicates whether a product class can be recommended by users.	Boolean
Max	Maximum number.	Integer
Min	Minimum number.	Integer
ProductLine	The product line.	String
ProductLineId	Product line ID.	String
Commitment	Flag which indicates whether there is a commitment.	Boolean
ListOfSwiPromotionAggregateProductLine DefaultProductsVbc	Container element for Promotion Aggregate Product Line Default Products details which is an instance of the VBC SwiPromotionAggregateProductLineDefault Products.	Integration Component
DefaultCardinality	Default cardinality.	Integer
Id	Promotion ID.	String
ProductId	Product ID.	String
ProductName	Product name.	String
SwiPromotionAggregateProductLine DefaultProductsVbc	Container element for Promotion Aggregate Product Line Default Products details which is an instance of the VBC SwiPromotionAggregateProductLineDefault Products.	Integration Component
DefaultCardinality	Default cardinality	Integer
Id	Promotion ID.	String
ProductId	Product ID.	String
ProductName	Product name.	String
ListOfSwiPromotionAggregateProductLine MessagesVbc	Container element for Promotion Aggregate Product Line Message details which is an instance of the VBC SWI Promotion.	Integration Component
Description	Description.	String
Id	Promotion ID.	String
LanguageCode	Language code.	String
ListOfSwiPromotionAggregateProductClassVbc	Container element for Promotion Aggregate Product Class details which is an instance of the VBC SwiPromotionAggregateProductClass.	Integration Component
ClassId	The class ID value.	String
ClassName	The class name.	String
Default	The default value.	Integer
Description	Description.	String
DisconnectAction	Disconnect action.	String
Id	Promotion ID.	String
Recommendable	Flag which indicates whether a product class can be recommended by users.	Boolean
Max	Maximum number.	Integer
Min	Minimum number.	Integer
Commitment	Flag which indicates whether there is a commitment.	Boolean
ListOfSwiPromotionAggregateProductClass DefaultProductsVbc	Container element for Promotion Aggregate Product Class Default Product details which is an instance of the VBC SwiPromotionAggregateProductClassDefaultProducts.	Integration Component
ClassId	Class ID.	String
ClassName	Class name.	String
Default	Default value.	String
Description	Class description.	String
DisconnectAction	Disconnect action.	String
Id	Promotion ID.	String
Recommendable	Flag which indicates whether a product class can be recommended by users.	Boolean
Max	Maximum number.	Integer
Min	Minimum number.	Integer
Commitment	Flag which indicates whether there is a commitment.	Boolean
ListOfSwiPromotionAggregateProductClass DefaultProductsVbc	Container element for Promotion Aggregate Product Class Default Product details which is an instance of the VBC SwiPromotionAggregateProductClassDefaultProducts.	Integration Component
DefaultCardinality	Default cardinality.	Integer
Id	Promotion ID.	String
ProductId	Product ID.	String
ProductName	Product name.	String
ListOfSwiPromotionUpgradeAggregateProduct LineVbc	Container element for Promotion Upgrade Aggregate Product Line details which is an instance of the VBC SwiPromotionUpgradeAggregateProduct Line.	Integration Component
Id	Promotion ID.	String
CommitmentStart	Start of the commitment.	Date
Duration	Promotion duration.	String
ProductLineId	Product line ID.	String
ListOfSwiPromotionUpgradeAggregateProduct ClassVbc	Container element for Promotion Upgrade Aggregate Product Class details which is an instance of the VBC SwiPromotionUpgradeAggregateProduct Class.	Integration Component
Id	Promotion ID.	String
CommitmentStart	Start of commitment.	Date
Duration	Promotion duration.	String
ProductClassId	Product class ID.	String
ListOfSwiPromotionUpgradeToAggregateProduct LineVbc	Container element for Promotion Upgrade To Aggregate Product Line details which is an instance of the VBC SwiPromotionUpgradeToAggregateProduct Line.	Integration Component
Id	Promotion ID.	String
CommitmentStart	Start of commitment.	Date
Duration	Promotion duration.	String
ProductLineId	Product class ID.	String
ListOfSwiPromotionUpgradeToAggregateProduct ClassVbc	Container element for Promotion Upgrade To Aggregate Product Class details which is an instance of the VBC SwiPromotionUpgradeToAggregateProduct Class.	Integration Component
Id	Promotion ID.	String
CommitmentStart	Start of commitment.	Date
Duration	Promotion duration.	String
ProductClassId	Product class ID.	String
ListofSwiPromotionPricingOverrideVbc	Container element for Promotion Pricing Override details which is an instance of the VBC SwiPromotionPricingOverride.	Integration Component
Id	Promotion ID.	String
PromotionName	Promotion name.	String
ListOfSwiPromotionProductOverrideVbc	Container element for Promotion Product Override details which is an instance of the VBC SwiPromotionProductOverride.	Integration Component
DefaultCardinality	Default cardinality.	Integer
MaxCardinality	Optional. Maximum cardinality.	Integer
MinCardinality	Optional Minimum cardinality.	Integer

SWIPromotionIntegration 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
SWIPromotionImport	Business Service	CSSSWIPromWebSvc

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SWIPromotionIntegrationIO	SWI Promotion Integration
SWIISSPromotion	SWI ISS Promotion
SWIISSPromotionAggregateProductClass	SWI ISS Promotion Aggregate Product Class

Methods

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

Operation	Method
SWIPromotionUpsert	Insert or Update

Example Package for SWIPromotionIntegration

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:

...SWIPromotionIntegration\SWIPromotionIntegration_request.xml

The < ComponentPath/> XML tag supports the following two formats:

Root Product||Relationship Name::Class/Product Name||Domain product Name:: Domain Product Name

or

Root Product||::Class/Product Name::Domain type||Domain product Name::Product

Response

See the following file to view the sample code:

...SWIPromotionIntegration\SWIPromotionIntegration_response.xml

Interface Description (WSDL) for SWIPromotionIntegration

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.

...SWIPromotionIntegration\SWIPromotionIntegration.wsdl

SWIQuoteUpsert

Use this Web service to upsert quote details

SWIQuoteUpsert Operations

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

Name	Description
SWIQuoteUpsert	Inserts or updates quote details.

Request Message Description: SWIQuoteUpsert

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

Node	Description	Type
StatusObject	Optional	String
SiebelMessage	Required	Integration Object
UTCCanonical	A value of Y means that all date-type fields in the payload are in UTC standard format.	String

Response Message Description: SWIQuoteUpsert

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

Node	Description	Type
SiebelMessage	Required	Integration Object

SWIQuoteUpsert 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
SWIQuoteupsert	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
SWIQuoteIO	PDS Simplified Order

SWISpecialRatingList

Use this Web service to send updated or modified special rating list details to the Oracle Communications Billing and Revenue Management application for synchronizing when a user clicks the Synchronize button in the Special Rating List applet.

SWISpecialRatingList Operations

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

Name	Description
SyncSpecialRatingListItems	Synchronizes the active special rating items (for example, Phone number) with the external Oracle Communications Billing and Revenue Management application for the updated special rating list.

Request Message Description: SyncSpecialRatingListItems

This method is used to synchronize the special rating items. For a description of the request message, see the following table.

Node	Description	Type
ListOfSWISpecialRatingListIO	Required. An instance of the integration object SWISpecialRatingListIO.	Integration Object

SWISpecialRatingList 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
SWI Special Rating - Synchronize Process	Workflow	Not Applicable

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SWISpecialRatingListIO	SWI Special Rating List

Methods

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

Operation	Method
SyncSpecialRatingListItems	SyncSpecialRatingListItems

SWISubmitOrder

Use this Web service to submit an order to the queue.

SWISubmitOrder Operations

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

Name	Description
process	Submits the order request into the Oracle Communications Billing and Revenue Management Advanced Queue (AQ) facility.

Request Message Description: process

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

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
SWISubmitOrderReqMsg:ListOfSWIOrderIO	Optional	Integration Object
siebel_transport_param:JMSPriority	Optional. Sets the priority for the order processing in the JMS queue.

Response Message Description: process

There is no response message for this operation.

SWISubmitOrder 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
SWISubmitOrder	Business Service	CSSWSOutboundDispatcher
SISOMBillingSubmitOrderWebService	Workflow	Not Applicable

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SWIOrderIO	PDS Simplified Order

Methods

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

Operation	Method
Process	Process

Interface Description (WSDL) for SWISubmit Order

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\SWISubmitOrder.wsdl

SWISubmitOrder_o2c

Use this Web service to submit an order for the Order-to-Cash Process Integration Pack (O2C PIP) into the queue.

SWISubmitOrder_o2c Operations

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

Name	Description
process	Submits an order request into the Oracle Communications Billing and Revenue Management Advanced Queue (AQ) facility.

Request Message Description: process

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

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
SWISubmitOrder_o2cReqMsg:ListOfSWIOrderIO	Optional	Integration Object
siebel_transport_param:JMSPriority	Optional. Sets the priority of the order processing in the JMS queue.	String

Response Message Description: process

There is no response message with this operation.

SWISubmitOrder_o2c 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
SWISendOrder	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	PDS Simplified Order

Methods

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

Operation	Method
process	process

SWISubmitQuote_o2c

Use this Web service to submit a quote for the Order-to-Cash Process Integration Pack (O2C PIP) into the queue.

SWISubmitQuote_o2c Operations

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

Name	Description
process	Submits a quote request into the Oracle Communications Billing and Revenue Management Advanced Queue (AQ) facility.

Request Message Description: process

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

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
SWISubmitQuote_o2cReqMsg:ListOfSWIQuoteIO	Optional	Integration Object

Response Message Description: process

There is no response message with this operation.

SWISubmitQuote_o2c 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
SWISendQuote	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
SWIQuoteIO	PDS Simplified Order

Methods

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

Operation	Method
process	process

SWISyncProduct

Use this outbound Web service to submit a product to the queue.

SWISyncProduct Operations

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

Name	Description
SyncItemList	Submits the product information in the Siebel business application into the asynchronous queue of the third-party application

Request Message Description: SyncItemList

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

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
SWISyncProductReqMsg: SyncItemList	Optional	Integration Object

Response Message Description: SyncItemList

Not applicable.

SWISyncProduct 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
SWISyncProduct	Business Service	CSSWSOutboundDispatcher
SWIExternalProductRequestWF	Workflow	Not applicable

Data Object (Integration Object)

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

Siebel Repository Name	External Name
SWIAdminISSProductDefinitionIO SWI	Admin ISS Product Definition IO

Method

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

Operation	Method
SyncItemList	SyncItemList

SWITroubleTicket

Use this Web service to create trouble tickets for failed orders.

SWITroubleTicket Operations

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

Name	Description
SWITroubleTicketInsert	Creates a new trouble ticket.
SWITroubleTicketInsertOrUpdate	Inserts or updates a trouble ticket.
SWITroubleTicketQueryById	Queries for a trouble ticket by ID.
SWITroubleTicketUpdate	Updates a trouble ticket.

Request Message Description: SWITroubleTicketInsert

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

Node	Description	Type
SWITroubleTicketIO	Required	Integration Object
Status	Optional	String

Response Message Description: SWITroubleTicketInsert

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

Node	Description	Type
SWITroubleTicketIO	Required	Integration Object

Request Message Description: SWITroubleTicketInsertOrUpdate

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

Node	Description	Type
SWITroubleTicketIO	Required	Integration Object
Status	Optional	String

Response Message Description: SWITroubleTicketInsertOrUpdate

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

Node	Description	Type
SWITroubleTicketIO	Required	Integration Object

Request Message Description: SWITroubleTicketQueryById

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

Node	Description	Type
SWITroubleTicketIO	Optional	Integration Object
PrimaryRowId	Required	String

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

Node	Description	Type
SWITroubleTicketIO	Optional	Integration Object

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

Node	Description	Type
SWITroubleTicketIO	Required	Integration Object
Status	Optional	String

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

Node	Description	Type
SWITroubleTicketIO	Required	Integration Object

SWITroubleTicket 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
SWI Trouble Ticket Service	Business 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
SWITroubleTicketIO	Service Request

Methods

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

Operation	Method
Insert	Insert
InsertOrUpdate	InsertOrUpdate
QueryById	QueryById
Update	Update

SWI Update Order Line Item

Use this Web service to update the status of order line items for simple products, complex products, and nested service bundles in the Siebel CRM application when the status of the order line item changes in the billing application. The billing application makes this inbound Web service call to the Siebel CRM application to update the status of the order line item. A business service is made available in the Siebel CRM application to update the status field.

If the order line item contains a complex product or nested service bundle, then the Web service updates the statuses of the component products within that complex product or nested service bundle for the order line item ID that is passed to this Web service. If the order line item ID is the same as the root line item ID, then the Web service updates the statuses of the entire product hierarchy for the order.

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

SWI Update Order Line Item Operations

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

Name	Description
UpdateLineItems	Updates the value of the field that is passed to it for order line items in simple products, complex products, and nested service bundles.

Request Message Description: UpdateLineItems

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

Node	Description
FieldName1	The name of the field in the order line item to update.
FieldValue1	The new value of the field in the order line item to update.
RootLineItemId	The row ID of the root order in the order line item hierarchy.
OrderLineItemId	The row ID of the nested product in the order line item hierarchy.
UpdateSingleLineItem	The designation for an order with a single line item. If this node has a value of TRUE, then the order has a single line item.

SWI Update Order Line Item 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 Order Line Item Update (For simple products)	Business Service	CSSEAIDataSyncService
SIS OM UpdateOrderItem (For complex products)	Workflow	Not applicable
SIS OM NSB Update Order Line (For nested service bundles)	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
Order Entry Line Item Update	Order Entry Line Item Update

Methods

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

Operation	Method
UpdateLineItems	[BS: CMU Order Line Item Update].Update

Example Package for SWI Update Order Line Item

To view an example of messages for this Web service, navigate to the documentation library for Siebel 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:

...\SWIUpdateOrderLineItem\SWIUpdateOrderLineItem.xml

Response

See the following file to view the sample code:

...\SWIUpdateOrderLineItem\SWIUpdateOrderLineItem.xml

Interface Description (WSDL) for SWI Update Order Line Item

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.

...\SWIUpdateOrderLineItem\SWIUpdateOrderLineItem.wsdl

SyncCustomerSiebelEventAggregator

Use this outbound Web service to synchronize account, contact, address, billing profile, and statement profile details with an external system when any insert or update operation occurs for these corresponding entities in the Siebel database.

SyncCustomerSiebelEventAggregator Operations

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

Operation	Description
aggregateaccountevent	Called when an account record is inserted or updated. This operation sends the updated or inserted account details along with its child details to the external system to synchronize the account.
aggregatecontactevent	Called when a contact record is inserted or updated. This operation sends the updated or inserted contact details along with its child details to the external system to synchronize the contact.
aggregateaddressevent	Called when an address record is inserted or updated. This operation sends the updated or inserted address details along with its child details to the external system to synchronize the address.
aggregatebpevent	Synchronizes the billing profile.
aggregatespevent	Synchronizes the statement profile.

Request Message Description: aggregateaccountevent

Sends inserted or updated account details from the Siebel database to an external system to synchronize the account with the participating integrated application.

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

Node	Description	Type
ListofSwicustomerpartyIO	An instance of the integration object ListofSwicustomerpartyIO.	Integration Object
AccountNumber	The number of the account.	String
AccountStatus	The status of the account that was updated.	String
AccountTypeCode	Account class.	String
Created	The creation date of the account.	Date
CurrencyCode	Account currency code.	String
DUNSNumber	Dun and Bradstreet data universal numbering system, number.	String
HomePage	URL for account’s homepage.	String
IntegrationId	Integration ID of account record.	String
Location	Location of the account.	String
MainFaxNumber	Main fax number of the account.	String
MainPhoneNumber	Main phone number of the account.	String
Name	Account name.	String
ParentAccountId	Account ID of the parent account.	String
PrimaryAddressId	Primary address of the account.	String
PrimaryBillingProfileId	The primary billing profile ID of the account.	String
PrimaryContactId	The primary contact ID for the account.	String
PrimaryOrganizationId	The primary organization ID for the account.	String
PrimaryShipToAddressId	The primary shipping address of the account.	String
RowId	The row ID in the Siebel database table.	String
Type	The type of account.	String
ListOfCutAddress	The address details of the account.	Integration Component
ListOfCutAddressCopy	The address details of the billing profile of the account.	Integration Component
ListOfComExemptionsProfile	The exemption profile details of the account.	Integration Component
ListOfComInvoiceProfile	The billing profile details of the account.	Integration Component
ListOfComStatementProfile	The statement profile details of the account.	Integration Component
ListOfContact	The contact details for the account.	Integration Component
ListOfContactQuery	The contact associated with the billing profile of the account.	Integration Component
ListOfInternalDivision	The internal division details of the account.	Integration Component
ListOfPersonalAddress	The addresses associated with the contacts of the account.	Integration Component

Response Message Description: aggregateaccountevent

This Web service is asynchronous. There is no response message.

Request Message Description: aggregatecontactevent

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

Node	Description	Type
ListOfSwicontactio	The contact details.	Integration Object
Alias	The contact alias.	String
CellularPhone	The mobile phone number of the contact.	String
ConsumerLink	The Consumer Link of the contact.	String
ContactPersonTitle	The title of the contact.	String
CurrencyCode	The currency code for billing profile.	String
DateofBirth	The contact’s date of birth.	String
EmailAddress	The email address of the contact.	String
FaxPhone	The contact’s fax number.	String
FirstName	The contact’s first name.	String
HomePhone	The contact’s home phone number.	String
IntegrationId	The Integration ID of the contact record.	String
JobTitle	The contact’s job title.	String
LastName	The last name of the contact.	String
MM	The salutation for the contact.	String
Gender	The gender of the contact.	String
MaritalStatus	The marital status of the contact.	String
MiddleName	The middle name of the contact.	String
MotherMaidenName	The maiden name of the contact’s mother.	String
PrimaryOrganizationId	The primary organization ID of the contact.	String
PrimaryPersonalAddressId	The primary address ID of the contact.	String
RowId	The row ID in the Siebel database table.	String
SocialSecurityNumber	The Social Security number of the contact.	String
Status	The status of the contact record.	String
WorkPhone	The work phone number of the contact.	String
ListOfAccount	The account details for the contact.	Integration Component
ListofComInvoiceProfile	The billing profiles of the contact.	Integration Component
ListOfFmLocation	The fleet management (FM) locations of the contact.	Integration Component
ListOfOrganization	The organizations of the contact.	Integration Component
ListOfPersonalAddress	The addresses of the contact.	Integration Component
ListOfUcmContactPrivacy	The Universal Customer Master (UCM) contact privacy details.	Integration Component

Response Message Description: aggregatecontactevent

This Web service is asynchronous. There is no response message.

Request Message Description: aggregateaddressevent

Sends inserted or updated address details from the Siebel database to an external system to synchronize the address with the participating integrated application.

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

Node	Description	Type
ListOfSwiaddressIO	The address details.	Integration Object
AddressName	The address name.	String
BillAddressFlag	Indicates whether the account is billable.	String
City	The city name.	String
County	The county name.	String
Country	The country name.	String
DisableDataCleansing	Disables the flag for data cleansing.	String
EmailAddress	The email address.	String
IntegrationId	The integration ID of the address record.	String
MainAddressFlag	Indicates the main address.	String
PostalCode	The postal code of the address record.	String
Province	The province in the address record, if this value is valid.	String
RowId	The row ID in the Siebel database table.	String
ShipAddressFlag	Indicates the ship-to address.	String
State	The state of the address record.	String
StreetAddress	The street address of address record.	String
StreetAddress2	The secondary street address of the address record, if necessary.	String
ListOfAccount	The account details associated with the address.	Integration Component
ListofComInvoiceProfile	The billing profile associated with the address.	Integration Component
ListOfFmLocation	The fleet management locations associated with the address.	Integration Component
ListOfContact	The contacts associated with the address.	Integration Component

Response Message Description: aggregateaddressevent

This Web service is asynchronous. There is no response message.

Request Message Description: aggregatebpevent

Sends the inserted or updated billing profile from the Siebel database to an external system to synchronize the billing profile with the participating integrated application.

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

Node	Description	Type
ListOfSwibillingprofileIO	The billing profile details.	Integration Object
AccountId	The account ID of the billing profile.	String
AddressId	The address ID of the billing profile.	String
BankAccountName	The bank account name associated with the billing profile.	String
BankAccountNumber	The bank account number associated with the billing profile.	String
BankAccountType	The bank account type associated with the billing profile.	String
BankAuthorizationflag	The Bank Authorization flag associated with the billing profile.	Boolean
BankBranch	The branch details of the bank.	String
BankLanguageCode	The language code of the bank.	String
BankLanguageId	The language ID of the bank.	String
BankName	The name of the bank.	String
BillAverage	The average of the bill.	String
BillCycle	The cycle of the bill.	String
BillCycleDay	The cycle day of the bill.	String
BillFrequency	The frequency of the bill.	String
BillSequence	The sequence of the bill.	String
BillSource	The source of the bill.	String
BillVendorId	The Bill Vendor ID.	ID
BudgetBillingFlag	The Budget Billing flag.	Boolean
CPNIDate	The Customer Proprietary Network Information (CPNI) date.	String
CPNIFlag	The Customer Proprietary Network Information (CPNI) flag.	Boolean
CollectionsFlag	The Collections flag.	Boolean
ContactId	The contact ID.	ID
CreditCardBlockFlag	Indicates whether to block the credit card.	Boolean
CreditCardBlockReason	The reason for the credit card block.	String
CreditCardCategory	The category of the credit card.	String
CreditCardExpirationDate	The expiration date of the credit card.	String
CreditCardName	The name on the credit card.	String
CreditCardNumber	The number of the credit card.	String
CreditCardNumberEncryptkeyReference	The encryption key reference of the credit card number.	String
CreditCardSecurityCode	The credit card security code.	String
CreditCardType	The credit card type.	String
CreditCardVerificationNumber	The credit card verification number.	String
CreditCardVerificationNumber Encryption Key	The encryption key reference of the credit card verification number.	String
DaysToCash	The Days to Cash.	Integer
EmailBillTo	The email ID.	String
BillingProfileId	The billing profile ID.	ID
InterestatInvoiceFlag	The Interest at Invoice flag.	Boolean
LastBillAmount	The last bill amount.	String
LastBillDate	The last bill date.	String
MediaType	The media type.	String
BillType	The bill type for the billing profile.	String
ExtraCopies	The number of copies to be sent.	Integer
BillingProfileName	The billing profile name.	String
NoPayFormFlag	The No Pay Form flag.	Boolean
NumberofManualInvoices	The number of manual invoices.	Integer
PaymentMethod	The payment method.	String
ReasonforManualOutsource	The reason for the manual outsource.	String
StatementFlag	The Statement flag to distinguish the billing profile from the statement profile.	Boolean
RepeatDebtorFlag	The Repeat Debtor flag.	Boolean
RoutingNumber	The routing number of the bank.	String
StandingOrderFlag	The Standing Order flag.	Boolean
Status	The status of the billing profile.	String
YearlyAdvancePaymentFlag	The Yearly Advance Payment flag.	Flag
ListOfContact	The contacts associated with the billing profile.	Integration Component
ListOfCutAddress	The addresses associated with the billing profile.	Integration Component

Response Message Description: aggregatebpevent

This Web service is asynchronous. There is no response message.

Request Message Description: aggregatespevent

Sends an inserted or updated statement profile from the Siebel database to an external application to synchronize the statement profile with the participating integrated application.

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

Node	Description	Type
ListOfSwistatementprofileIO	The statement profile details.	Integration Object
ContactFirstName	The contact's first name.	String
ContactLastName	The contact's last name.	String
StreetAddress	The contact's street address.	String
EmailBillTo	The contact's email address.	String
LanguageCode	The language code for the statement profile.	String
ContactId	The contact's ID.	ID
MediaType	The media type for the statement profile.	String
BillType	The bill type for the statement profile.	String
ExtraCopies	The number of copies to be sent.	Integer
ContactFaxPhone	The contact's fax number.	String
ContactWorkPhone	The contact's work phone number.	String
StatementProfileId	The ID for the statement profile.	ID
AddressId	The address ID for the contact's selected address.	ID
AccountId	The account ID for the statement profile.	ID
StatementFlag	The statement flag to distinguish the billing profile from the statement profile.	Boolean
City	The city for the contact’s address.	String
State	The state for the contact's address.	String
Country	The country for the contact's address.	String
ZipCode	The ZIP code for the contact's address.	String

This Web service is asynchronous. There is no response message.

SyncCustomerSiebelEventAggregator 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
SyncCustomerSiebelEventAggregator	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
SWICustomerPartyIO	Account
SWIContactIO	SWI Contact
SWIAddressIO	SWI CUT Address
Fault	Fault
SWIStatementProfileIO	Com Statement Profile
SWIBillingProfileIO	CMU - Com Invoice Profile

Interface Description (WSDL) for SyncCustomerSiebelEventAggregator

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.

...\SyncCustomerSiebelEventAggregator\SyncCustomerSiebelEventAggregator.wsdl

TNT History Oppty Insert

Use this Web service with Siebel Hospitality to import data into history records.

TNT History Oppty Insert Operations

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

Name	Description
Insert	If a History record with the same unique key (Opportunity ID, defined in the integration object) as the input object exists, the operation will error out. If there is no duplicate record, then a new record in the Siebel database is created based on the input object.
Upsert	If an object with the same unique key (Opportunity ID, defined in the integration object) as the input object exists, the existing record is updated with the specified input object. If no duplicate record exists, a new object is created in the Siebel database based on the input object.

TNT History Oppty Insert 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
TNT History Oppty Insert	Business Service	CSSEAISiebelAdapterService

Data Object (Integration Object)

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

Siebel Repository Name	External Name
TNT History Opportunity IO	TNT History Opportunity

Methods

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

Operation	Method
Insert	If a History record with the same unique key (Opportunity ID, defined in the integration object) as the input object exists, error out. Otherwise, the operations creates a new record in the Siebel database based on the input object.
Upsert	If an object with the same unique key (Opportunity ID, defined in the integration object) as the input object exists, updates the existing record with the specified input object. Otherwise, the operations creates a new object in the Siebel database based on the input object.

Interface Description (WSDL) for TNT History Oppty Insert

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.

See the following file to view the WSDL:

...\TNT History Oppty Insert\TNT_Histories.wsdl
...\TNT History Oppty Insert\TNT_Histories.xsd

Ulnbox Contact Item

UInbox Contact Item is a Web service and business service generated to load Contact Inbox Items. These items can be filtered based any fields in the business component. For example, either approved or rejected Inbox items can be loaded by setting appropriate fields in the integration object while invoking the Web service. Page size needs to be specified to load the required number of items while invoking Web service. Based on the requirements Task Owner ID or Task Owner Login, Active Flag, Action and Context fields need to be set while invoking the Web service.

Ulnbox Contact Item Operations

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

Name	Description
UlnboxContactItemQueryPage	Uses the QueryPage method to query data in the Siebel database one page at a time.
Query Page	Uses the QueryPage method to query data in the Siebel database one page at a time.
Init	Action is initialized.
Execute	Action is executed.

Request Message Description: UlnboxContactItemQueryPage

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	LIC or LDC.	String
NamedSearchSpec	Search specification of the query.	String
PickListName	Name of the picklist (if any).	String

Response Message Description: UlnboxContactItemQueryPage

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

Node	Description	Type
SiebelMessageOut	Output argument.	Integration Object

To Specify Parameters While Invoking Ulnbox Contact Item

Use the following procedure to specify parameters while invoking the Ulnbox Contact Item Web service.

Specifying parameters while invoking Web service

Run the WSDL file through a proxy generator.

This creates a C# class that must be modified to construct Input Integration Objects.

For performance reasons, Page size can also be specified here.

Following is the sample client side code showing how page size and other input parameters can be specified.

 AccountQueryPageMSO_Input input = new AccountQueryPageMSO_Input ();
 input.ViewMode = "All";
 input.PageSize = "10";
 input.StartRowNum = "0";

 input.ListOfAccount = new Account[1];

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

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

Possible Performance and Scalability Issues

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

Possible Deployment Issues

Authentication URL can be changed during deployment to supply changed information such as user, password and so on. These changes need to be done in the WSDL file.

Error Conditions

All error conditions will be handled by Web services framework.

Ulnbox Contact Item 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
UInbox Contact Item	Not applicable	CSSEAIUIDataService

Data Object (Integration Object)

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

Siebel Repository Name	External Name
UInboxContactItem	UInbox Items

Example Package for Ulnbox Contact Item

To view an example of messages for this Web service, navigate to the documentation library for Siebel 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:

...\UlnboxContactItem\UlnboxContactItem_request.xml

Response

See the following file to view the sample code:

...\UlnboxContactItem\Response.xml

Interface Description (WSDL) for Ulnbox Contact Item

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.

...\UlnboxContactItem\UlnboxContactItem.wsdl

UnbilledUsageSiebelCommsReqABCS

Use this Web service to query for unbilled usage details in the external Oracle Communications Billing and Revenue Management application that will be displayed in a billing profile on the billing user interface.

UnbilledUsageSiebelCommsReqABCS Operations

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

Name	Description
QueryUnbilledUsage	Queries unbilled usage for the billing profile in the Siebel Communications Billing view.
QueryResourceBalance	Queries resource balance details for the billing profile in the Siebel Communications Billing view.
SearchEventDetails	Searches for unbilled event details for the billing profile in the Siebel Communications Billing view.
QueryEventDetails	Queries unbilled event details for the billing profile in the Siebel Communications Billing view.

Request Message Description: QueryUnbilledUsage

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

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

Response Message Description: QueryUnbilledUsage

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

Node	Description	Type
QueryUnbilledUsageRespMsg:ListOfCmuResponseUnbilledUsageIo	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:ListOfCmuRequestUnbilledBalanceDetailsIo	Optional	Integration Object

Response Message Description: QueryResourceBalance

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

Node	Description	Type
QueryResourceBalanceRespMsg:ListOfCmuResponseUnbilledBalanceDetailsIo	Optional	Integration Object

Request Message Description: SearchEventDetails

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

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

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

Node	Description	Type
SearchEventDetailsRespMsg:ListOfCmuResponseUnbilledDetailsIo	Optional	Integration Object

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

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

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

Node	Description	Type
QueryEventDetailsRespMsg:ListOfCmuResponseUnbilledDetailsIo	Optional	Integration Object

UnbilledUsageSiebelCommsReqABCS 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
UnbilledUsageSiebelCommsReqABCS	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 Response Unbilled Details IO	Account
CMU Request Unbilled Details IO	Account
CMU Request Unbilled Balance Details IO	Account
CMU Response Unbilled Balance Details IO	Account
CMU Request Billing Profile IO	Account
CMU Response Unbilled Usage IO	Account
CMU Request Unbilled Details Search IO	Account
CMU Response Unbilled Details IO	Account

Methods

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

Operation	Method
QueryUnbilledUsage	QueryUnbilledUsage
QueryResourceBalance	QueryResourceBalance
SearchEventDetails	SearchEventDetails
QueryEventDetails	QueryEventDetails

Example Package for UnbilledUsageSiebelCommsReqABCS

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:

...\UnbilledUsageSiebelCommsReqABCS\Request.xml

Response

See the following file to view the sample code:

...\UnbilledUsageSiebelCommsReqABCS\Response.xml

Interface Description (WSDL) for UnbilledUsageSiebelCommsReqABCS

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.

...\UnbilledUsageSiebelCommsReqABCS\WSDL

Universal Inbox

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

Universal Inbox Operations

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

Name	Description
UniversalInboxCallAction	Executes the action registered for a specific Inbox Item type.

Request Message Description: Universal Inbox CallAction

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

Node	Description	Type
InboxItemId	InboxItemId	String
ActionLIC	ActionLIC	String
InboxTypeName	InboxTypeName	String
OwnerId	OwnerId	String
ObjectId	ObjectId	String

Response Message Description: UniversalInboxCallAction

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

Node	Description	Type
Status	Call status.	String
Error message	Error message returned, if any.	String

This operation will return the following messages:

Errors such as post-approval action not configured.
User-friendly error message, for example, when the same inbox item is concurrently updated by two Siebel Self-Service users. Messages such as “This has already been approved by a different user” appear if the action has been approved. If the action has been rejected, then the message: this has already been rejected by a different user appears.
Returning the actual error message, if any, from the workflow that is being invoked. Since the Self-Service workflow is invoked synchronously, all error messages will be propagated.
CallAction business service method will detect and return error messages raised by the Action business service. Web service Infrastructure will detect that the CallAction business service method has returned an error code and create a SOAP fault.

Invalid input conditions

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

Processing errors

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

Universal Inbox Application Interface

This topic describes the application objects called by 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.

Node	Description	Type
Universal Inbox	Not applicable	CSSUInboxSvc

Data Object (Integration Object)

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

Example Package for Universal Inbox

To view an example of messages for this Web service, navigate to the documentation library for Siebel 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:

...\UniversalInbox\UniversalInbox_request.xml

Response

See the following file to view the sample code:

...\UniversalInbox\Universal_Inbox_response.xml

Interface Description (WSDL) for Universal Inbox

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.

...\UniversalInbox\UniversalInbox.wsdl

UpdateCreditAlertSiebelCommsReqABCSImpl

Use this Web service to update the credit alert status from Siebel CRM to the external Oracle Communications Billing and Revenue Management application.

UpdateCreditAlertSiebelCommsReqABCSImpl Operations

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

Name	Description
UpdateCreditAlert	Updates the credit alert.

Request Message Description: UpdateCreditAlert

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

Node	Description	Type
CustomHeaderContext	Optional	Hierarchy
UpdateCreditAlertReqMsg:UpdateCreditAlert	Optional	Integration Object

Request Message Description: UpdateCreditAlert

There is no response message for this Web service.

UpdateCreditAlertSiebelCommsReqABCSImpl 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
UpdateCreditAlertSiebelCommsReqABCSImplService	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
SWICUTCreditManagementIO	CUT Credit Management

Methods

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

Operation	Method
UpdateCreditAlert	UpdateCreditAlert

UpdateCustomerSiebelJMSProducer

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

UpdateCustomerSiebelJMSProducer Operations

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

Operation Name	Description
UpdateCustomerParty	Synchronizes account detail between the Siebel CRM application and the billing application.
UpdateCustomerPartyAddress	Synchronizes address detail for an account between the Siebel CRM application and the billing application.
UpdateCustomerPartyContact	Synchronizes contact detail for an account between the Siebel CRM application and the billing application.
UpdateCustomerPartyBillProfile	Synchronizes billing profile detail for an account between Oracle’s Siebel CRM application and the billing application.

Request Message Description: UpdateCustomerParty

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

Node	Description
Account	The details of the account.
CutAddress	The details of the address for an account.
Contact	The details of the contact for an account.

Request Message Description: UpdateCustomerPartyAddress

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

Node	Description
Account	The details of the account.
CutAddress	The details of the address for an account.
ComInvoiceProfile	The details of the billing profile for an account.

Request Message Description: UpdateCustomerPartyContact

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

Node	Description
Account	The details of the account.
Contact	The details of the contact for an account.
ComInvoiceProfile	The details of the billing profile for an account.

Request Message Description: UpdateCustomerPartyBillProfile

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

Node	Description
BillingProfileCutAddress	The details of the address for a billing profile.
BillingProfileContact	The details of the contact for a billing profile.
ComInvoiceProfile	The details of the billing profile for an account.

UpdateCustomerSiebelJMSProducer 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)
UpdateCustomerSiebelJMSProducer	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 AccSync Account Io	CMU - Account
CMU AccSync Address Io	CMU - Address
CMU AccSync Contact Io	CMU - Contact
CMU AccSync Billing Profile Io	CMU - Com Invoice Profile

Methods

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

Operation	Method
UpdateCustomerParty	[BS: UpdateCustomerSiebelJMSProducer].UpdateCustomerParty
UpdateCustomerPartyAddress	[BS: UpdateCustomerSiebelJMSProducer].UpdateCustomerPartyAddress
UpdateCustomerPartyBillProfile	[BS: UpdateCustomerSiebelJMSProducer].UpdateCustomerPartyBillProfile
UpdateCustomerPartyContact	[BS: UpdateCustomerSiebelJMSProducer].UpdateCustomerPartyContact

Example Package for UpdateCustomerSiebelJMSProducer

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:

...\UpdateCustomerSiebelJMSProducer\CmuAccSyncAccount.xml

Response

Because this Web service uses an asynchronous call, a response message does not apply.

Interface Description (WSDL) for UpdateCustomerSiebelJMSProducer

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.

...\UpdateCustomerSiebelJMSProducer\UpdateCustomerSiebelJMSProducer.xml

WC_PickList_Payment_Profile_BS

This Web service is used for creating, updating, deleting, or listing of payment wallet with payment methods.

This Web service makes available the Query and Execute methods in the WC_PickList_Payment_Profile_BS business service as Web service operations.

WC_PickList_Payment_Profile_BS Operations

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

Name	Description
WC_PickList_Payment_Profile_BSQueryPage	Performs query operations based on the query criteria.set on WC_PickList_Payment_Profile_IO integration object as the input. This operation is used to query the payment related details like the payment profile details and the account or contact information for which the payment wallet belongs to.
WC_PickList_Payment_Profile_BSExceute	Perform various operations such as creating, updating, or deleting of payment wallet with payment methods on the WC_PickList_Payment_Profile_IO integration object as the input.

Request Message Description: WC_PickList_Payment_Profile_BSQueryPage

Based on the query criteria set on the integration object. Payment related details such as payment profile details, account, and contact information can be queried. For a description of this request message, see the following table.

Node	Description	Type
WC_PickList_Payment_Profile_ BSQueryPage_Input	The container element for the QueryPage Operation request.The method arguments are Payment integration object, Language Mode (value is LDC) and viewMode (All).	Integration Object

Response Message Description: WC_PickList_Payment_Profile_BSQueryPage

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

Node	Description	Type
WC_PickList_Payment_Profile_ BSQueryPage_Output	The method arguments are Payment Integration Object, Language Mode (the value which is LDC) and viewMode (the value which is All).	Integration Object

Request Message Description: WC_PickList_Payment_Profile_BSExecute

Based on the query criteria set, creating, editing, or deleting operations on a wallet can be performed. For a description of this request message, see the following table.

Node	Description	Type
WC_PickList_Payment_Profile_ BSExecute_Input	The method arguments are Payment Integration Object, Language Mode (value is LDC), and viewMode (All).	Integration Object

Response Message Description: WC_PickList_Payment_Profile_BSExecute

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

Node	Description	Type
WC_PickList_Payment_Profile_ BSExecute_Output	The retrieved data for the update operation performed which could be the creating, editing, or deletion of a payment wallet.	Integration Object

WC_PickList_Payment_Profile_BS Application Interface

This Web service makes available the EAI UI business service WC_PickList_Payment_Profile_BS, which provides update and query operations on WC_PickList_Payment_Profile_IO integration object. For more information on application implementation, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

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

Name	Boundary Object Type	Class
WC_PickList_Payment_Profile_BS	Integration Object	CSSEAIUIDataService

Data Object (Integration Object)

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

Siebel Repository Name	External Name
WC_PickList_Payment_Profile_IO	Payment Profile

Example Package for WC_PickList_Payment_Profile_BS

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:

...\WC_PickList_Payment_Profile_BS\WC_PickList_Payment_Profile_BS_request.xml

Response

See the following file to view the sample code:

...\WC_PickList_Payment_Profile_BS\WC_PickList_Payment_Profile_BS_response.xml

Interface Description (WSDL) for WC_PickList_Payment_Profile_BS

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.

...\WC_PickList_Payment_Profile_BS\WC_PickList_Payment_Profile_BS.wsdl

WebMarketing

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

WebMarketing Operations

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

Name	Description
EmailMarketingForwardToFriend	Forwards campaign details to a list of forwardees.
EmailMarketingUpdateJobStatus	Updates the job status of the task submitted for sending email.
UpdateCampaignRecipient	Updates the information of a campaign recipient.
CheckModuleLicense	Checks whether a particular module is licensed.

Request Message Description: EmailMarketingForwardToFriend

Calls Email Marketing - Forward to Friend to forward the emails. For a description of this request message, see the following table.

Node	Description	Type
Account Id	Account ID of the forwarder of the email.	String
Campaign Id	The campaign ID of the campaign for which the information is being forwarded.	String
Forwardee Collection	List of forwardees.	Integration Object
Forwarder Camp Con Id	Campaign contact ID of the forwarder.	String
Forwarder Contact Id	Contact ID of the forwarder.	String
Forwarder Message	Message that the forwarder emails.	String
Forwarder Prospect Id	The prospect ID of the forwarder.	String
Offer Id	ID of the offer for which the email is being sent.	String
Response Type	The type of response.	String

Response Message Description: EmailMarketingForwardToFriend

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

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

Request Message Description: EmailMarketingUpdateJobStatus

This operation is called by Boldfish when a createMailing job is done. It updates the status in the marketing system task table. For a description of this request message, see the following table.

Node	Description	Type
BatchNumber	Batch number of the job.	String
ErrorCode	Error code (if any) that needs to be passed for the job.	String
OfferId	The current offer.	String
OfferName	The name of the offer.	String
TaskId	Task ID.	String
WaveId	The campaign wave ID.	String

Response Message Description: EmailMarketingUpdateJobStatus

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

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

Request Message Description: UpdateCampaignRecipient

Calls EAI Siebel Adapter service to update campaign recipients. For a description of this request message, see the following table.

Node	Description	Type
CampaignRecipientMsgIn	The campaign recipient information that needs to be updated.	Integration Object
LOVLanguageMode	The language mode.	String

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

Node	Description	Type
CampaignRecipientMsgOut	The updated campaign recipient information.	Integration Object

Calls Mktg List Export Service service to check module license and returns a value of Y (OK) or N (NOTOK) as the output. For a description of this request message, see the following table.

Node	Description	Type
ModuleName	The module name which needs to be checked.	String

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

Node	Description	Type
IsModuleLicensed	Values are Y or N which indicates whether the module licensed or not.	String

WebMarketing 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
Email Marketing - Forward to Friend	Workflow	Not applicable.
Email Marketing - Update Status	Workflow	Not applicable.
Mktg System Task Service	Business Service	CSSSystemTaskService
Server Requests	Business Service	CSSSrmService
EAI Siebel Adapter	Business Service	CSSEAISiebelAdapterService
Mktg List Export Service	Business Service	CSSListExportService

Data Object (Integration Object)

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

Siebel Repository Name	External Name
Marketing Email Forwardee	Forwardee Collection
Marketing Campaign Recipient	CampaignRecipientMsgIn
Marketing Campaign Recipient	CampaignRecipientMsgOut

Example Package for WebMarketing

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 (Email MarketingForwardToFriend)

See the following file to view the sample code:

...\WebMarketing\EmailMktgFwdToFriend_request.xml

Response (EmailMarketingForwardToFriend)

See the following file to view the sample code:

...\WebMarketing\EmailMktgFwdToFriend_response.xml

Request (EmailMarketingUpdateJobStatus)

See the following file to view the sample code:

...\WebMarketing\EmailMarketingUpdateJobStatus_request.xml

Response (EmailMarketingUpdateJobStatus)

See the following file to view the sample code:

...\WebMarketing\EmailMarketingUpdateJobStatus_request.xml

Request (UpdateCampaignRecipient)

See the following file to view the sample code:

...\WebMarketing\UpdateCampaignRecipient_request.xml

Response (UpdateCampaignRecipient)

See the following file to view the sample code:

...\WebMarketing\UpdateCampaignRecipient_response.xml

Request (CheckModuleLicense)

See the following file to view the sample code:

...\WebMarketing\CheckModuleLicense_request.xml

Response (CheckModuleLicense)

See the following file to view the sample code:

...\WebMarketing\CheckModuleLicense_response.xml

Interface Description (WSDL) for WebMarketing

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.

See the following file to view the WSDL:

...\WebMarketing\WebMarketing.wsdl