Home
API Guides
SOAP API Specification
SOAP API methods
The Unica Campaign Services SOAP API uses the following methods.
SOAP API methods: Campaigns and flowcharts
The Unica Campaign SOAP API supports the following operations on campaigns and flowcharts (subject to security permissions).
listCampaignsByPage
Parameters

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).
      - generateCampaignCode
      - deleteCampaigns
      - createCampaign
      - listCampaignsByPage
        Parameters
        Returns
        Errors
      - stopFlowchart
        stopFlowchart(int pid, int runid)
    - 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.

Parameters

userCredential: the client user credential.

requestedLocale: optional locale to use for this request.

partitionName: optional name of the campaign partition to use.

attributes: optional array of attributes to match; the attribute's name, data type, and values are used to determine the match; if the attribute supports arrays, then all values that are specified must match. The implied match operator is an AND, so only campaigns that match all the supplied attribute values are returned.

Throws AttributeNotFoundException if an attribute name does not exist or InvalidAttributeException if one or more of the supplied attributes is invalid.

pageOffset: the starting offset of all possible campaigns to begin the enumeration (zero-valued). For example, if the enumeration matches 1000 campaigns and this value is set to 10, then the page would start at the 11th component. A RangeException is thrown if the supplied offset is out of range.

pageSize: the maximum number of matched campaigns to return for the page (cannot exceed 500).

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.