API - Service | Flexmail Email Marketing

Service: GetCampaignSummary

The GetCampaignSummary service allows you to retrieve a summary of the campaign settings before sending the campaign

Service Details

SOAP Action: GetCampaignSummary
SOAP Return Object: GetCampaignSummaryResp

Input

The following table describes the parameters used for calling the GetCampaignSummary service.

Table: instance of GetCampaignSummaryReq

Parameter	Mandatory	Type	Description
header	Y	APIRequestHeader	Header for authentication
campaignId	Y	Integer	Campaign id to get summary from

Output

The following table describes the parameters returned from the GetCampaignSummary service.

Table: instance of GetCampaignSummaryResp

Parameter	Mandatory	Type	Description
header	/	APIResponseHeader	Header containing authentication information
errorCode	/	Integer	Numerical value of the error
errorMessage	/	String	Short literal description of the error
campaignSummaryType	/	CampaignSummaryType	The campaign summary

Table: response codes of GetCampaignSummaryResp.

0	No error
220	Authentication error, see header object for detailed information
221	Campaign not found

Example

This example shows you how to retrieve a campaign summary.

<?php
$header->userId = USER_ID;
$header->userToken = USER_TOKEN;

$getCampaignSummaryReq->header = $header;
$getCampaignSummaryReq->campaignId = 1234;

$getCampaignSummaryResp = $SoapClient->__soapCall("GetCampaignSummary",array( $getCampaignSummaryReq ));

if ($getCampaignSummartResp->errorCode == 0) {
	echo "Campaign: " . $getCampaignSummary->campaignSummaryType->campaignName ;
	echo "Send by: " .  $getCampaignSummary->campaignSummaryType->campaignSendeRName;
} else {
	echo "Get campaigns failed: " . $getCampaignSummaryResp->errorMessage;
}
?>