Client.GetCampaigns
Gets a list of all campaigns that have been sent for a client.
Samples
While we don't have any samples for this particular method, we do have a number of samples in .NET, PHP, Classic ASP, Flash, Perl and Cold Fusion that can be easily adapted to use this method.
Parameters and required information
Here's a list of all the parameters you'll need to pass to the Client.GetCampaigns method. All of the parameters are required unless otherwise noted.
ApiKey- Your API application key. See here for more details.
ClientID- The ID of the client whose campaigns should be returned. See here for more details.
Return Codes
Success
Upon a successful call, this method will return a collection of Campaign objects, each of which consists of the CampaignID, subject, sentdate and number of recipients for each campaign.
Error
100: Invalid API Key- The API key passed was not valid or has expired.
102: Invalid ClientID- The ClientID value passed in was not valid.
SOAP 1.1
The following is a sample SOAP request and response. The placeholders shown need to be replaced with actual values.
POST /api/api.asmx HTTP/1.1 Host: app.campaignmonitor.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://app.campaignmonitor.com/api/Client.GetCampaigns" <?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> <Client.GetCampaigns xmlns="http://app.campaignmonitor.com/api/"> <ApiKey>string</ApiKey> <ClientID>int</ClientID> </Client.GetCampaigns> </soap:Body> </soap:Envelope>
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>
<Client.GetCampaignsResponse xmlns="http://app.campaignmonitor.com/api/">
<Client.GetCampaignsResult />
</Client.GetCampaignsResponse>
</soap:Body>
</soap:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /api/api.asmx/Client.GetCampaigns?ApiKey=string&ClientID=string HTTP/1.1 Host: app.campaignmonitor.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<anyType d1p1:type="ArrayOfCampaign">
<Campaign>
<CampaignID>209694</CampaignID>
<Subject>April Newsletter</Subject>
<SentDate>2007-04-15 09:35:00</SentDate>
<TotalRecipients>265</TotalRecipients>
</Campaign>
<Campaign>
<CampaignID>209688</CampaignID>
<Subject>March Newsletter</Subject>
<SentDate>2007-03-15 11:20:00</SentDate>
<TotalRecipients>242</TotalRecipients>
</Campaign>
</anyType>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /api/api.asmx/Client.GetCampaigns HTTP/1.1 Host: app.campaignmonitor.com Content-Type: application/x-www-form-urlencoded Content-Length: length ApiKey=string&ClientID=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<anyType d1p1:type="ArrayOfCampaign">
<Campaign>
<CampaignID>209694</CampaignID>
<Subject>April Newsletter</Subject>
<SentDate>2007-04-15 09:35:00</SentDate>
<TotalRecipients>265</TotalRecipients>
</Campaign>
<Campaign>
<CampaignID>209688</CampaignID>
<Subject>March Newsletter</Subject>
<SentDate>2007-03-15 11:20:00</SentDate>
<TotalRecipients>242</TotalRecipients>
</Campaign>
</anyType>
