ApiService

Click here for a complete list of operations.

GetOpenCountsForPeriod

Test

The test form is only available for requests from the local machine.

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 /apiservice.asmx HTTP/1.1
Host: ea-api.litmus.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ea-api.litmus.com/GetOpenCountsForPeriod"

<?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>
    <GetOpenCountsForPeriod xmlns="http://ea-api.litmus.com/">
      <user>string</user>
      <password>string</password>
      <campaignGuids>
        <string>string</string>
        <string>string</string>
      </campaignGuids>
      <start>dateTime</start>
      <end>dateTime</end>
    </GetOpenCountsForPeriod>
  </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>
    <GetOpenCountsForPeriodResponse xmlns="http://ea-api.litmus.com/">
      <GetOpenCountsForPeriodResult>
        <OpenCounts>
          <OpenCountByMonth>
            <TotalOpens>int</TotalOpens>
            <Month>int</Month>
            <Year>int</Year>
          </OpenCountByMonth>
          <OpenCountByMonth>
            <TotalOpens>int</TotalOpens>
            <Month>int</Month>
            <Year>int</Year>
          </OpenCountByMonth>
        </OpenCounts>
      </GetOpenCountsForPeriodResult>
    </GetOpenCountsForPeriodResponse>
  </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 /apiservice.asmx HTTP/1.1
Host: ea-api.litmus.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>
    <GetOpenCountsForPeriod xmlns="http://ea-api.litmus.com/">
      <user>string</user>
      <password>string</password>
      <campaignGuids>
        <string>string</string>
        <string>string</string>
      </campaignGuids>
      <start>dateTime</start>
      <end>dateTime</end>
    </GetOpenCountsForPeriod>
  </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>
    <GetOpenCountsForPeriodResponse xmlns="http://ea-api.litmus.com/">
      <GetOpenCountsForPeriodResult>
        <OpenCounts>
          <OpenCountByMonth>
            <TotalOpens>int</TotalOpens>
            <Month>int</Month>
            <Year>int</Year>
          </OpenCountByMonth>
          <OpenCountByMonth>
            <TotalOpens>int</TotalOpens>
            <Month>int</Month>
            <Year>int</Year>
          </OpenCountByMonth>
        </OpenCounts>
      </GetOpenCountsForPeriodResult>
    </GetOpenCountsForPeriodResponse>
  </soap12:Body>
</soap12:Envelope>