Home
API Guides
SOAP API Specification
SOAP API methods
The Unica Campaign Services SOAP API uses the following methods.
Offer, offer list, and offer template methods
The Unica Campaign SOAP API supports the following operations related to offers.
getOffersByQuery

API Guides
- SOAP API Specification
  - Unica Campaign Rest APIs
  - Unica Campaign Services API Overview
    The Unica Campaign SOAP API specification defines version 3.0 of the Application Programming Interface, also referred to as Unica CampaignServices. This specification is delivered as part of the Unica CampaignServices Software Developer's Tookit (devkits) installed with Unica Campaign.
  - Using the Unica Campaign SOAP API
    To use the Unica Campaign Web Services SOAP API, you can use the client API .jar file or use the WSDL directly. An example shows how to use the .jar file method to create an offer.
  - SOAP API data types
    The Unica Campaign Services SOAP API uses the following public data types.
  - SOAP API methods
    The Unica Campaign Services SOAP API uses the following methods.
    - SOAP API methods: Service
      The Unica Campaign SOAP API provides a way to obtain identifying information about the service itself.
    - SOAP API methods: Attributes
      Most component instance data can be exposed by the Unica Campaign SOAP API as attributes or attribute metadata.
    - SOAP API methods: Campaigns and flowcharts
      The Unica Campaign SOAP API supports the following operations on campaigns and flowcharts (subject to security permissions).
    - Target Cell methods
      Target cells are an abstraction for some known subsets of campaign results that are managed by Unica Campaign as a Target Cell Spreadsheet (TCS). Target cells may be global to a campaign or may be associated with a particular campaign flowchart.
    - Analytics
      The Unica Campaign SOAP API supports the retrieval of simple metrics from Unica Campaign.
    - Offer, offer list, and offer template methods
      The Unica Campaign SOAP API supports the following operations related to offers.
  - The Unica Campaign SOAP API may throw the following common exceptions. All exception localized messages are in the requested locale if available to Unica Campaign. The usual Java™ locale fallback policies apply.
- REST API Guide
  Use the Unica Campaign REST API to manipulate campaigns, offers, offer lists, attributes, and target cell objects.

getOffersByQuery

public WSGetOffersByQueryResponse getOffersByQuery(String user_credential,
 String partition_name, Locale locale, String query, Integer maxSize,
Boolean includeSubFolder, WSReference[] scopeFolders)
 throws CampaignServicesException

Lists offers matching provided offers.

Parameters

userCredential: the client user credential.

partitionName: optional name of the campaign partition to use.

requestedLocale: optional locale to use for this request.

query: query to find offers. Format of query is the same as used in smart offerlist.

maxSize: maximum records to list.

includeSubFolder: flag that indicates whether a subfolder must be included in search.

scopeFolders: list of folder references to be searched in for offers.

Returns

Returns object of type WSGetOffersByQueryResponse.

Errors

Throws CampaignServicesException if folder references are invalid.

Have feedback?
Google Analytics is used to store comments and ratings. To provide a comment or rating for a topic, click Accept All Cookies or Allow All in Cookie Preferences in the footer of this page.