Apsis Newsletter Pro v3 API


Click here for a complete list of operations.

AddSubscribersFromXmlToQueue

Import subscribers using XML-data. After successfully reading the data, the import will be placed in queue for processing. Returned value is queue identity, this can be used for querying the queue for the import status. Everything between strXmlData tags must be html encoded

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
strUsername:
strPassword:
intMailingListId:
strXmlData:
boolDemographicNameMapping:

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

<?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>
    <AddSubscribersFromXmlToQueue xmlns="http://api.anpdm.com/">
      <strUsername>string</strUsername>
      <strPassword>string</strPassword>
      <intMailingListId>int</intMailingListId>
      <strXmlData>string</strXmlData>
      <boolDemographicNameMapping>boolean</boolDemographicNameMapping>
    </AddSubscribersFromXmlToQueue>
  </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>
    <AddSubscribersFromXmlToQueueResponse xmlns="http://api.anpdm.com/">
      <AddSubscribersFromXmlToQueueResult>int</AddSubscribersFromXmlToQueueResult>
    </AddSubscribersFromXmlToQueueResponse>
  </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>
    <AddSubscribersFromXmlToQueue xmlns="http://api.anpdm.com/">
      <strUsername>string</strUsername>
      <strPassword>string</strPassword>
      <intMailingListId>int</intMailingListId>
      <strXmlData>string</strXmlData>
      <boolDemographicNameMapping>boolean</boolDemographicNameMapping>
    </AddSubscribersFromXmlToQueue>
  </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>
    <AddSubscribersFromXmlToQueueResponse xmlns="http://api.anpdm.com/">
      <AddSubscribersFromXmlToQueueResult>int</AddSubscribersFromXmlToQueueResult>
    </AddSubscribersFromXmlToQueueResponse>
  </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/AddSubscribersFromXmlToQueue?strUsername=string&strPassword=string&intMailingListId=string&strXmlData=string&boolDemographicNameMapping=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/AddSubscribersFromXmlToQueue HTTP/1.1
Host: api.anpdm.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

strUsername=string&strPassword=string&intMailingListId=string&strXmlData=string&boolDemographicNameMapping=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>