The HCL Campaign SOAP API specification defines version 3.0 of the Application Programming Interface, also referred to as CampaignServices. This specification is delivered as part of the CampaignServices Software Developer's Tookit (devkits) installed with HCL Campaign.
The HCL Campaign Services SOAP API uses the following methods.
The HCL Campaign SOAP API supports the following operations related to offers.
To use the HCL 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.
The HCL Campaign Services SOAP API uses the following public data types.
The HCL Campaign SOAP API provides a way to obtain identifying information about the service itself.
Most component instance data can be exposed by the HCL Campaign SOAP API as attributes or attribute metadata.
The HCL Campaign SOAP API supports the following operations on campaigns and flowcharts (subject to security permissions).
Target cells are an abstraction for some known subsets of campaign results that are managed by HCL Campaign as a Target Cell Spreadsheet (TCS). Target cells may be global to a campaign or may be associated with a particular campaign flowchart.
The HCL Campaign SOAP API supports the retrieval of simple metrics from HCL Campaign.
The HCL Campaign SOAP API may throw the following common exceptions. All exception localized messages are in the requested locale if available to HCL Campaign. The usual Java™ locale fallback policies apply.
InvalidFolderException
InvalidExecutionContextException, AuthorizationException
Help Center