Bookshelf Home | Contents | Index | PDF     

Siebel CRM Web Services Reference > Siebel CRM Primary Web Services >

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

Table 1353. WebMarketing Operations
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 Table 1354.

Table 1354. Request Message Description: EmailMarketingForwardToFriend
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 Table 1355.

Table 1355. Response Message Description: EmailMarketingForwardToFriend
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 Table 1356.

Table 1356. Request Message Description: EmailMarketingUpdateJobStatus
Node
Description
Type

BatchNumber

Batch number of the job.

String

ErrorCode

Error code (if any) that needs to be passed for the job.

String

OfferId

The current offer.

String

OfferName

The name of the offer.

String

TaskId

Task ID.

String

WaveId

The campaign wave ID.

String

Response Message Description: EmailMarketingUpdateJobStatus

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

Table 1357. Response Message Description: EmailMarketingUpdateJobStatus
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 Table 1358.

Table 1358. Request Message Description: UpdateCampaignRecipient
Node
Description
Type

CampaignRecipientMsgIn

The campaign recipient information that needs to be updated.

Integration Object

LOVLanguageMode

The language mode.

String

Response Message Description: UpdateCampaignRecipient

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

Table 1359. Response Message Description: UpdateCampaignRecipient
Node
Description
Type

CampaignRecipientMsgOut

The updated campaign recipient information.

Integration Object

Request Message Description: CheckModuleLicense

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

Table 1360. Request Message Description: CheckModuleLicense
Node
Description
Type

ModuleName

The module name which needs to be checked.

String

Response Message Description: CheckModuleLicense

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

Table 1361. Response Message Description: CheckModuleLicense
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 Table 1362.

Table 1362. WebMarketing Service Objects
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 Table 1363.

Table 1363. WebMarketing Data Objects
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 for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

Request (EmailMarketingForwardToFriend)

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

...\WebMarketing\WebMarketing.wsdl

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