Is split test campaign

The IsSplitTestCampaign method tells you whether a campaign is a split test campaign or just a normal campaign.

Parameters

username	string	This is the username from your API key. It is in the format of an email address and will look similar to apiuser‑908709770324@apiconnector.com	required
password	string	This is the password from your API key.	required
campaignID	int	This is the ID of the campaign you wish to query against.	required

Return values

result

boolean

TRUE if the campaign is a split test campaign, FALSE if it is not.

Error responses

ERROR_CAMPAIGN_NOT_FOUND
ERROR_APIUSAGE_EXCEEDED
ERROR_INVALID_LOGIN
ERROR_PARAMETER_INVALID
ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE
ERROR_UNKNOWN

Request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/IsSplitTestCampaign"

Example of use in C# .NET

/// <summary>
/// 
/// </summary>
public void IsSplitTestCampaign()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
    const int campaignId = 1;
 
    Console.WriteLine("GetContactImportReportFaults");
    Console.WriteLine("----------------------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        // get and display the status of the campaign
        Console.WriteLine(
            api.IsSplitTestCampaign(username, password, campaignId)
                ? "Campaign {0} is a split test campaign."
                : "Campaign {0} is a normal campaign.", campaignId);
    }
    catch (SoapException ex)  // catch any soap issues/errors from the web service
    {
        Console.WriteLine("Error -> {0}", ex.Message);                
    }
 
    Console.WriteLine();
}

Sample request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/IsSplitTestCampaign"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <IsSplitTestCampaign xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <campaignId>int</campaignId>
    </IsSplitTestCampaign>
  </soap:Body>
</soap:Envelope>

Sample response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <IsSplitTestCampaignResponse xmlns="http://apiconnector.com">
      <IsSplitTestCampaignResult>boolean</IsSplitTestCampaignResult>
    </IsSplitTestCampaignResponse>
  </soap:Body>
</soap:Envelope>

About the API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates

Is split test campaign

The IsSplitTestCampaign method tells you whether a campaign is a split test campaign or just a normal campaign.

Parameters

Return values

Error responses

Request

Example of use in C# .NET

Sample request

Sample response

Get started with dotMailer: