Apsis Newsletter Pro v3 API


Click here for a complete list of operations.

GetDetailedNewsletters

Get a list of detailed newsletters. If parameter IntervalFrom is NULL, the current date minus 30 days will be used. If parameter IntervalTo is NULL, the current date will be used.

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 /ExternalAPIService.asmx HTTP/1.1
Host: api.anpasia.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.anpdm.com/GetDetailedNewsletters"

<?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>
    <GetDetailedNewsletters xmlns="http://api.anpdm.com/">
      <strUsername>string</strUsername>
      <strPassword>string</strPassword>
      <datIntervalFrom>dateTime</datIntervalFrom>
      <datIntervalTo>dateTime</datIntervalTo>
    </GetDetailedNewsletters>
  </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>
    <GetDetailedNewslettersResponse xmlns="http://api.anpdm.com/">
      <GetDetailedNewslettersResult>
        <DetailedNewsletterResult>
          <Id>int</Id>
          <Name>string</Name>
          <Subject>string</Subject>
          <Updated>dateTime</Updated>
          <Created>dateTime</Created>
          <HasNewsletterBeenSent>boolean</HasNewsletterBeenSent>
          <HasNewsletterBeenSentIntegral>int</HasNewsletterBeenSentIntegral>
        </DetailedNewsletterResult>
        <DetailedNewsletterResult>
          <Id>int</Id>
          <Name>string</Name>
          <Subject>string</Subject>
          <Updated>dateTime</Updated>
          <Created>dateTime</Created>
          <HasNewsletterBeenSent>boolean</HasNewsletterBeenSent>
          <HasNewsletterBeenSentIntegral>int</HasNewsletterBeenSentIntegral>
        </DetailedNewsletterResult>
      </GetDetailedNewslettersResult>
    </GetDetailedNewslettersResponse>
  </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 /ExternalAPIService.asmx HTTP/1.1
Host: api.anpasia.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>
    <GetDetailedNewsletters xmlns="http://api.anpdm.com/">
      <strUsername>string</strUsername>
      <strPassword>string</strPassword>
      <datIntervalFrom>dateTime</datIntervalFrom>
      <datIntervalTo>dateTime</datIntervalTo>
    </GetDetailedNewsletters>
  </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>
    <GetDetailedNewslettersResponse xmlns="http://api.anpdm.com/">
      <GetDetailedNewslettersResult>
        <DetailedNewsletterResult>
          <Id>int</Id>
          <Name>string</Name>
          <Subject>string</Subject>
          <Updated>dateTime</Updated>
          <Created>dateTime</Created>
          <HasNewsletterBeenSent>boolean</HasNewsletterBeenSent>
          <HasNewsletterBeenSentIntegral>int</HasNewsletterBeenSentIntegral>
        </DetailedNewsletterResult>
        <DetailedNewsletterResult>
          <Id>int</Id>
          <Name>string</Name>
          <Subject>string</Subject>
          <Updated>dateTime</Updated>
          <Created>dateTime</Created>
          <HasNewsletterBeenSent>boolean</HasNewsletterBeenSent>
          <HasNewsletterBeenSentIntegral>int</HasNewsletterBeenSentIntegral>
        </DetailedNewsletterResult>
      </GetDetailedNewslettersResult>
    </GetDetailedNewslettersResponse>
  </soap12:Body>
</soap12:Envelope>