Service Web Service

Service

Click here for a complete list of operations.

getCampaignReport

Get the Report of an Email Campaign.
Arguments:

loginEmail: Login Email of Spread.
password: Login Password of Spread.
CampaignID

return CampaignReport.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /service.asmx HTTP/1.1
Host: service.rspread.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://service.reasonablespread.com/getCampaignReport"

<?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>
    <getCampaignReport xmlns="http://service.reasonablespread.com/">
      <loginEmail>string</loginEmail>
      <password>string</password>
      <campaignID>int</campaignID>
    </getCampaignReport>
  </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>
    <getCampaignReportResponse xmlns="http://service.reasonablespread.com/">
      <getCampaignReportResult>
        <CampaignId>int</CampaignId>
        <CampaignName>string</CampaignName>
        <SentCount>int</SentCount>
        <FailCount>int</FailCount>
        <OpenCount>int</OpenCount>
        <AllClickCount>int</AllClickCount>
        <UniqueClicksCount>int</UniqueClicksCount>
        <ConversionCount>int</ConversionCount>
        <BounceCount>int</BounceCount>
        <SpamCount>int</SpamCount>
        <UnsubscribeCount>int</UnsubscribeCount>
        <UndeliverableCount>int</UndeliverableCount>
        <Status>Deleted or Sent or Draft or Pause or Sending or Waiting or EngineSending or PreApproval or DisApproval or Approved or NRTriggering or Preparing or UploadWaiting or Inexistent</Status>
        <DateSent>dateTime</DateSent>
        <CreateDate>dateTime</CreateDate>
        <Schedule>dateTime</Schedule>
      </getCampaignReportResult>
    </getCampaignReportResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /service.asmx HTTP/1.1
Host: service.rspread.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getCampaignReport xmlns="http://service.reasonablespread.com/">
      <loginEmail>string</loginEmail>
      <password>string</password>
      <campaignID>int</campaignID>
    </getCampaignReport>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getCampaignReportResponse xmlns="http://service.reasonablespread.com/">
      <getCampaignReportResult>
        <CampaignId>int</CampaignId>
        <CampaignName>string</CampaignName>
        <SentCount>int</SentCount>
        <FailCount>int</FailCount>
        <OpenCount>int</OpenCount>
        <AllClickCount>int</AllClickCount>
        <UniqueClicksCount>int</UniqueClicksCount>
        <ConversionCount>int</ConversionCount>
        <BounceCount>int</BounceCount>
        <SpamCount>int</SpamCount>
        <UnsubscribeCount>int</UnsubscribeCount>
        <UndeliverableCount>int</UndeliverableCount>
        <Status>Deleted or Sent or Draft or Pause or Sending or Waiting or EngineSending or PreApproval or DisApproval or Approved or NRTriggering or Preparing or UploadWaiting or Inexistent</Status>
        <DateSent>dateTime</DateSent>
        <CreateDate>dateTime</CreateDate>
        <Schedule>dateTime</Schedule>
      </getCampaignReportResult>
    </getCampaignReportResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /service.asmx/getCampaignReport?loginEmail=string&password=string&campaignID=string HTTP/1.1
Host: service.rspread.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<CampaignReport xmlns="http://service.reasonablespread.com/">
  <CampaignId>int</CampaignId>
  <CampaignName>string</CampaignName>
  <SentCount>int</SentCount>
  <FailCount>int</FailCount>
  <OpenCount>int</OpenCount>
  <AllClickCount>int</AllClickCount>
  <UniqueClicksCount>int</UniqueClicksCount>
  <ConversionCount>int</ConversionCount>
  <BounceCount>int</BounceCount>
  <SpamCount>int</SpamCount>
  <UnsubscribeCount>int</UnsubscribeCount>
  <UndeliverableCount>int</UndeliverableCount>
  <Status>Deleted or Sent or Draft or Pause or Sending or Waiting or EngineSending or PreApproval or DisApproval or Approved or NRTriggering or Preparing or UploadWaiting or Inexistent</Status>
  <DateSent>dateTime</DateSent>
  <CreateDate>dateTime</CreateDate>
  <Schedule>dateTime</Schedule>
</CampaignReport>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /service.asmx/getCampaignReport HTTP/1.1
Host: service.rspread.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

loginEmail=string&password=string&campaignID=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<CampaignReport xmlns="http://service.reasonablespread.com/">
  <CampaignId>int</CampaignId>
  <CampaignName>string</CampaignName>
  <SentCount>int</SentCount>
  <FailCount>int</FailCount>
  <OpenCount>int</OpenCount>
  <AllClickCount>int</AllClickCount>
  <UniqueClicksCount>int</UniqueClicksCount>
  <ConversionCount>int</ConversionCount>
  <BounceCount>int</BounceCount>
  <SpamCount>int</SpamCount>
  <UnsubscribeCount>int</UnsubscribeCount>
  <UndeliverableCount>int</UndeliverableCount>
  <Status>Deleted or Sent or Draft or Pause or Sending or Waiting or EngineSending or PreApproval or DisApproval or Approved or NRTriggering or Preparing or UploadWaiting or Inexistent</Status>
  <DateSent>dateTime</DateSent>
  <CreateDate>dateTime</CreateDate>
  <Schedule>dateTime</Schedule>
</CampaignReport>

Parameter	Value
loginEmail:
password:
campaignID: