List campaigns 2

The ListCampaigns2 method lists all the campaigns within the your dotMailer account.

This method will return up to 1000 campaigns in one go. You should use the select and skip parameters to iterate through the whole data set.

This method does not return the HTML content. If you then need to get a specific campaigns content use GetCampaign to get the single 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
select	int	This is a number which indicates the number of records you wish to select. This argument must no greater than 1000.	required
skip	int	This is a number which is the number of records you want to skip; to select all records from 1001 to 2000: set this number to 1000.	required

Return values

The result is an array of APICampaign objects, each consisting of the following:

fromName	string	The name the email will be set to be from.
htmlContent	string	The contents of the HTML campaign.
id	int	The campaign ID.
name	string	The name of the campaign.
plaintextContent	string	The contents of the Plain Text version of the campaign.
replyAction		Unset or WebMailForward or Webmail or Delete.
replyToAddress		The email address replies should be forwarded to.
status		NotSet or Unsent or Sending or Sent or Paused or Cancelled or RequiresApproval or Requires SMSApproval or Triggered.
subject	string	The subject line of the email.

Error responses

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/ListCampaigns2"

Example of use in C# .NET

/// <summary>
/// List the campaigns, with the option to skip and select, or page the 
/// returned results
/// </summary>
public void ListCampaigns2() 
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
 
    Console.WriteLine("ListCampaigns2");
    Console.WriteLine("--------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        int currentPage = 0;   // what page are we on
        const int itemsPerPage = 5;  // the number of campaigns we want to be returned for each page
 
        // execute the first get from the server
        // the select parameter is the itemsperPage, 
        // the skip is the itemsPerPage * the currentPage
        com.apiconnector.APICampaign[] campaigns = api.ListCampaigns2(username, password, itemsPerPage, currentPage  * itemsPerPage);
 
        while (campaigns != null && campaigns.Length > 0)
        {
            // output the current page
            Console.WriteLine("CurrentPage: {0}", currentPage + 1);
 
            // display the items we have
            foreach (com.apiconnector.APICampaign campaign in campaigns)
            {
                Console.WriteLine("Campaign: {0}", campaign.Id);
                Console.WriteLine("FromName: {0}", campaign.FromName);
                Console.WriteLine("Name: {0}", campaign.Name);
                Console.WriteLine("ReplyAction: {0}", campaign.ReplyAction.ToString());
                Console.WriteLine("ReplyToAddress: {0}", campaign.ReplyToAddress);
                Console.WriteLine("Status: {0}", campaign.Status.ToString());
                Console.WriteLine("Subject: {0}", campaign.Subject);
 
                //
                // * ListCampaigns doesn't return the content of the campaign, so the following
                // fields will contain no data, and can be ignored. Use GetCampaign() to retrieve this
                // information
                //
                //Console.WriteLine("HTMLContent: {0}", campaign.HTMLContent);
                //Console.WriteLine("PlaintextContent: {0}", campaign.PlaintextContent);
 
                // write out blank line, so the output is easier to read
                Console.WriteLine();
            }
 
            // increment the page
            currentPage++;
 
            // execute the next get - see above
            campaigns = api.ListCampaigns2(username, password, itemsPerPage, currentPage  * itemsPerPage);
        }
 
        // output some stats
        Console.WriteLine("Total Pages {0}, {1} per page", currentPage, itemsPerPage);
        Console.WriteLine();
    }
    catch (SoapException ex)  // catch any soap issues/errors from the web service
    {
        Console.WriteLine("Error -> {0}", ex.Message);                
    }
 
    Console.WriteLine();
}

Sample request

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>
    <ListCampaigns2Response xmlns="http://apiconnector.com">
      <ListCampaigns2Result>
        <APICampaign>
          <FromName>string</FromName>
          <HTMLContent>string</HTMLContent>
          <Id>int</Id>
          <Name>string</Name>
          <PlaintextContent>string</PlaintextContent>
          <ReplyAction>Unset or WebMailForward or Webmail or Delete</ReplyAction>
          <ReplyToAddress>string</ReplyToAddress>
          <Status>NotSet or Unsent or Sending or Sent or Paused or Cancelled or RequiresApproval or RequiresSMSApproval or Triggered</Status>
          <Subject>string</Subject>
        </APICampaign>
        <APICampaign>
          <FromName>string</FromName>
          <HTMLContent>string</HTMLContent>
          <Id>int</Id>
          <Name>string</Name>
          <PlaintextContent>string</PlaintextContent>
          <ReplyAction>Unset or WebMailForward or Webmail or Delete</ReplyAction>
          <ReplyToAddress>string</ReplyToAddress>
          <Status>NotSet or Unsent or Sending or Sent or Paused or Cancelled or RequiresApproval or RequiresSMSApproval or Triggered</Status>
          <Subject>string</Subject>
        </APICampaign>
      </ListCampaigns2Result>
    </ListCampaigns2Response>
  </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>
    <ListCampaigns2Response xmlns="http://apiconnector.com">
      <ListCampaigns2Result>
        <APICampaign>
          <FromName>string</FromName>
          <HTMLContent>string</HTMLContent>
          <Id>int</Id>
          <Name>string</Name>
          <PlaintextContent>string</PlaintextContent>
          <ReplyAction>Unset or WebMailForward or Webmail or Delete</ReplyAction>
          <ReplyToAddress>string</ReplyToAddress>
          <Status>NotSet or Unsent or Sending or Sent or Paused or Cancelled or RequiresApproval or RequiresSMSApproval or Triggered</Status>
          <Subject>string</Subject>
        </APICampaign>
        <APICampaign>
          <FromName>string</FromName>
          <HTMLContent>string</HTMLContent>
          <Id>int</Id>
          <Name>string</Name>
          <PlaintextContent>string</PlaintextContent>
          <ReplyAction>Unset or WebMailForward or Webmail or Delete</ReplyAction>
          <ReplyToAddress>string</ReplyToAddress>
          <Status>NotSet or Unsent or Sending or Sent or Paused or Cancelled or RequiresApproval or RequiresSMSApproval or Triggered</Status>
          <Subject>string</Subject>
        </APICampaign>
      </ListCampaigns2Result>
    </ListCampaigns2Response>
  </soap:Body>
</soap:Envelope>

About the API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates