Apsis Newsletter Pro v3 API


Click here for a complete list of operations.

InsertActiveTemplateModule

Insert a module into an active template newsletter. strModuleId is the ID of the module you wish to use in the newsletter and must be specified. strModuleCode (default: original module code), strModuleIndex (default: 0), strFilterID, strHolderID (default: 0) are optional parameters.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
strUsername:
strPassword:
strNewsletterID:
strModuleID:
strModuleCode:
strModuleIndex:
strFilterID:
strHolderID:

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/InsertActiveTemplateModule"

<?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>
    <InsertActiveTemplateModule xmlns="http://api.anpdm.com/">
      <strUsername>string</strUsername>
      <strPassword>string</strPassword>
      <strNewsletterID>string</strNewsletterID>
      <strModuleID>string</strModuleID>
      <strModuleCode>string</strModuleCode>
      <strModuleIndex>string</strModuleIndex>
      <strFilterID>string</strFilterID>
      <strHolderID>string</strHolderID>
    </InsertActiveTemplateModule>
  </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>
    <InsertActiveTemplateModuleResponse xmlns="http://api.anpdm.com/">
      <InsertActiveTemplateModuleResult>int</InsertActiveTemplateModuleResult>
    </InsertActiveTemplateModuleResponse>
  </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>
    <InsertActiveTemplateModule xmlns="http://api.anpdm.com/">
      <strUsername>string</strUsername>
      <strPassword>string</strPassword>
      <strNewsletterID>string</strNewsletterID>
      <strModuleID>string</strModuleID>
      <strModuleCode>string</strModuleCode>
      <strModuleIndex>string</strModuleIndex>
      <strFilterID>string</strFilterID>
      <strHolderID>string</strHolderID>
    </InsertActiveTemplateModule>
  </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>
    <InsertActiveTemplateModuleResponse xmlns="http://api.anpdm.com/">
      <InsertActiveTemplateModuleResult>int</InsertActiveTemplateModuleResult>
    </InsertActiveTemplateModuleResponse>
  </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/InsertActiveTemplateModule?strUsername=string&strPassword=string&strNewsletterID=string&strModuleID=string&strModuleCode=string&strModuleIndex=string&strFilterID=string&strHolderID=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"?>
<int xmlns="http://api.anpdm.com/">int</int>

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/InsertActiveTemplateModule HTTP/1.1
Host: api.anpdm.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

strUsername=string&strPassword=string&strNewsletterID=string&strModuleID=string&strModuleCode=string&strModuleIndex=string&strFilterID=string&strHolderID=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

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