Bookshelf Home | Contents | Index | PDF     

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

GetCampaigns Web Service

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

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

GetCampaigns Web Service Operations

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

Table 140. GetCampaigns Web Service Operations
Name
Description

GetCampaigns

Returns a list of campaigns based on provide input parameters.

Request Message Description: GetCampaigns

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

Table 141. Request Message Description: GetCampaigns
Node
Description
Type

Campaign Name

Optional. The campaign name. Restricts results by campaign name. For example, passing a value of 2002 will return all campaigns that have 2002 in the name.

String

Start Date

Optional. Returns a list of campaigns having a start date greater or equal to a given value.

String

End Date

Optional. Returns a list of campaigns having a start date less than or equal to a given value.

String

Page Number

Required. Determines the number of records retrieved by a response. It must be a value greater than zero.

String

Row Number

Optional. Retrieves the Page Number value of campaigns. It must be a value greater than zero.

String

Source Code

The row ID of the campaign you want to retrieve.

String

Response Message Description: GetCampaigns

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

Table 142. Response Message Description: GetCampaigns
Node
Description
Type

MKTG campaign IO

Determines what fields of campaign records are retrieved and added to a response.

Integration Object

GetCampaigns Web Service Application Interface

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

Service Object (Business Service or Workflow)

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

Table 143. GetCampaigns Service Object
Name
Boundary Object Type
Class (If Business Service)

SocialMedia Service

Business Service

CSSSocialService

Data Object (Integration Object)

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

Table 144. GetCampaigns Web Service Data Object
Siebel Repository Name
External Name

MKTG Campaign IO

LeadofLeadIO

Methods

For a description of the methods for this Web service, see Table 145.

Table 145. Get Campaigns List Web Service Methods
Operation
Method

GetCampaigns

GetCampaigns

Example Package for GetCampaigns Web Service

To view an example of messages for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link 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:

...\GetCampaigns\GetCampaigns_req.xml

Response

See the following file to view the sample code:

...\GetCampaigns\GetCampaigns_resp.xml

Interface Description (WSDL) for GetCampaigns Web Service

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

...\GetCampaigns\GetCampaigns.wsdl

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