Bookshelf v8.0: WebMarketing

Siebel CRM Web Services Reference > Primary Web Services for Siebel CRM 8.0 >

WebMarketing

Use this Web service to retrieve personalized content from Web offers, and details based on the offer treatment Id and Contact Id. Additionally, you can get subscription list information, and create responses for tracking click events.

WebMarketing Operations

For a list of operations associated with this Web service, see Table 187.

Table 187. WebMarketing operations
Name	Description
CreateWebMarketingResponse	Creates response records to track click events.
GetActiveLists	Retrieves a list of all active subscription lists.
GetListMembers	Retrieves a list of subscription lists that the contact or prospect is subscribed to.
GetWebTreatment	Retrieves Web offer treatment and related Web surveys, products, events, URLs and templates. If the context information is provided, personalized Web content will also be returned.

Request Message Description: CreateWebMarketingResponse

For a description of this request message, see Table 188.

Table 188. Request Message Description: CreateWebMarketingResponse
Node	Description
Response	Required.
ACCNT_ID	Row Id of account.
Delivery Method	Required. Delivery method.
Description	Required. Description of the response.
Destination Name	Hyperlink name of response URL.
Destination URL	Response URL.
Event Id	Row Id of event.
Event Reg Id	Event registration Id.
Id	Response row Id.
PRSP_CON_ID	Row Id of prospect. Either PRSP_CON_ID or PR_CON_ID must be filled in.
PR_CON_ID	Row Id of contact. Either PRSP_CON_ID or PR_CON_ID must be filled in.
Response Method	Response method.
Response Type	Required. Response type.
SRC_ID	Row Id of Campaign.
S_CAMP_CON_ID	Row Id of campaign contact.
Status	Status code.
Sub_DMail_Cd	Subscribe to direct mail action code.
Sub_Email_Cd	Subscribe to email action code.
Sub_Fax_Cd	Subscribe to fax action code.
Sub_Phone_Cd	Subscribe to phone action code.
Subscription List Id	Row Id of subscription list.
Summary	Summary.
Treatment Id	Required. Row Id of offer treatment.

Response Message Description: CreateWebMarketingResponse

For a description of this response message, see Table 189.

Table 189. Response Message Description: CreateWebMarketingResponse
Node	Description
Same as request message	Not applicable

Request Message Description: GetActiveLists

For a description of this request message, see Table 190.

Table 190. Request Message Description: GetActiveLists
Node	Description
List	Required.
Description	Description of the response.
Id	Row Id of subscription list.
Name	Name of subscription list.
ViewMode	Visibility algorithm used to determine which records will be retrieved.

Response Message Description: GetActiveLists

For a description of this response message, see Table 191.

Table 191. Response Message Description: GetActiveLists
Node	Description
Same as request message	Not applicable

Request Message Description: GetListMembers

For a description of this request message, see Table 192.

Table 192. Request Message Description: GetListMembers
Node	Description
List Members	Required
Contact Id	Row Id of Contact
List Id	Row Id of Subscription List
List Name	Name of Subscription List
Prospect Id	Row Id of Prospect

Response Message Description: GetListMembers

For a description of this response message, see Table 193.

Table 193. Response Message Description: GetListMembers
Node	Description
Same as request message	Not applicable

Request Message Description: GetWebTreatment

For a description of this request message, see Table 194.

Table 194. Request Message Description: GetWebTreatment
Node	Description
WebTreatment	Required.
Id	Required. Row Id of Web treatment.
Context	An instance of integration object PDS Catalog Context. Must contain either SiebelContext or ExternalContext. Optional only if ContextMode is not provided. If ContextMode is provided it is required.
ContactId	Row Id of contact.
ProspectId	Row Id of prospect.
CampConId	Row Id of campaign contact.
CampaignId	Row Id of campaign.
WebServer	Web server URL to be substituted in response forms.

Response Message Description: GetWebTreatment

For a description of this response message, see Table 195.

Table 195. Response Message Description: GetWebTreatment
Node	Description
WebTreatment	Required.
Active For Inbound Flag	Flag to indicate if the Web treatment is inbound.
Description	Description of the response.
Id	Row Id of Web treatment.
Language Code	Language code.
Locale Code	Locale code.
Name	Name of Web treatment.
PriceList Id	Row Id of PriceList Id.
Valid End Date	Valid end date.
Valid Start Date	Valid start date.
Template	Template type.
Lit Id	Row Id of treatment template.
Personalized Content	Personalized content of Web treatment.
Related Web Surveys	Web survey to associate.
Id	Row Id of Web survey.
Name	Name of Web survey.
Related Products	Related product to retrieve.
Product Id	Row Id of product.
Product	Name of product.
Related Events	Related events to retrieve.
Id	Row Id of the event.
Name	Name of the event.

WebMarketing Application Interface

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

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see Table 196.

Table 196. WebMarketing Service Object
Name	Boundary Object Type	Class (if BusService)
WebMarketingService	Business Service	CSSWebMarketingService

Data Object (Integration Object)

For a description of data objects for this Web service, see Table 197.

Table 197. WebMarketing Data Object
Siebel Repository Name	External Name
Response	Response
SubscriptionList	Subscription
SubscriptionListMember	Subscription
GetWebTreatment	No external name
GetWebTreatmentResponse	Offer

Methods

For a description of the methods for this Web services, see Table 198.

Table 198. WebMarketing Methods
Operation	Method
CreateWebMarketingResponse	[BS: WebMarketingService].[CreateResponse]
GetActiveLists	[BS: WebMarketingService].[GetActiveLists]
GetListMembers	[BS: WebMarketingService].[GetListMembers]
GetWebTreatment	[BS: WebMarketingService].[GetWebTreatment]

Example Package for WebMarketing

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:

...\WebMarketing\WebMarketing_request.xml

Response

See the following file to view the sample code:

...\WebMarketing\WebMarketing_response.xml

Message Schema (WSDL) for WebMarketing

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

...\WebMarketing\WebMarketing.wsdl

Siebel CRM Web Services Reference		Copyright © 2009, Oracle and/or its affiliates. All rights reserved. Legal Notices.