Apsis Newsletter Pro v3 API


Click here for a complete list of operations.

GetReportLink

Get linkid for access to a single report from external systems by either SendQueueID or NewsletterID (latest mailing). Example of usage old report: http://www.anpdm.com/reports/view-report.aspx?id=xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
strUsername:
strPassword:
strSendQueueID:
strNewsletterID:

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.anpdm.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.anpdm.com/GetReportLink"

<?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>
    <GetReportLink xmlns="http://api.anpdm.com/">
      <strUsername>string</strUsername>
      <strPassword>string</strPassword>
      <strSendQueueID>string</strSendQueueID>
      <strNewsletterID>string</strNewsletterID>
    </GetReportLink>
  </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>
    <GetReportLinkResponse xmlns="http://api.anpdm.com/">
      <GetReportLinkResult>string</GetReportLinkResult>
    </GetReportLinkResponse>
  </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.anpdm.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>
    <GetReportLink xmlns="http://api.anpdm.com/">
      <strUsername>string</strUsername>
      <strPassword>string</strPassword>
      <strSendQueueID>string</strSendQueueID>
      <strNewsletterID>string</strNewsletterID>
    </GetReportLink>
  </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>
    <GetReportLinkResponse xmlns="http://api.anpdm.com/">
      <GetReportLinkResult>string</GetReportLinkResult>
    </GetReportLinkResponse>
  </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 /externalapiservice.asmx/GetReportLink?strUsername=string&strPassword=string&strSendQueueID=string&strNewsletterID=string HTTP/1.1
Host: api.anpdm.com

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

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://api.anpdm.com/">string</string>

HTTP POST

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

POST /externalapiservice.asmx/GetReportLink HTTP/1.1
Host: api.anpdm.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

strUsername=string&strPassword=string&strSendQueueID=string&strNewsletterID=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://api.anpdm.com/">string</string>