API - Service | Flexmail Email Marketing

Service: GetCampaignTrackingLinks

The GetCampaignTrackingLinks service allows you to recall all links for which link tracking has been enabled, for a specified campaign.

Service Details

SOAP Action: GetCampaignTrackingLinks
SOAP Return Object: GetCampaignTrackingLinksResp

Input

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

Table: instance of GetCampaignTrackingLinksReq

Parameter	Mandatory	Type	Description
header	Y	APIRequestHeader	Header for authentication
campaignId	Y	Integer	Campaign id

Output

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

Table: instance of GetCampaignTrackingLinksResp

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
trackingLinkTypeItems	/	Array of TrackingLinkType	Array of trackingLinkType items

Table: response codes of GetCampaignTrackingLinksResp.

0	No error
220	Authentication error, see header object for detailed information
221	Invalid campaign id

Example

This examples show the request of all tracking links for campaign 222.

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

$getCampaignTrackingLinksReq->header = $header;
$getCampaignTrackingLinksReq->campaignId = 222;

$getCampaignTrackingLinksResp = $SoapClient->__soapCall("GetCampaignTrackingLinks", array($getCampaignTrackingLinksReq));

if ($getCampaignTrackingLinksResp->ErrorCode == 0) {
	// Handle return list of unsubscriptions.
} else {
	echo "Profile updates failed: " . $getCampaignTrackingLinksResp->errorMessage;
}
?>