Apsis Newsletter Pro v3 API
Click here for a complete list of operations.
GetPagedSubscribers
Get a list of subscribers in a specific mailinglist as a paged result. PageIndex is the index of the page to fetch (the first page has index 1) and PageSize is the size of each page (number of subscribers to fetch)
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.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/GetPagedSubscribers" <?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> <GetPagedSubscribers xmlns="http://api.anpdm.com/"> <strUsername>string</strUsername> <strPassword>string</strPassword> <strMailingListId>string</strMailingListId> <pageIndex>int</pageIndex> <pageSize>int</pageSize> </GetPagedSubscribers> </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> <GetPagedSubscribersResponse xmlns="http://api.anpdm.com/"> <GetPagedSubscribersResult> <xsd:schema>schema</xsd:schema>xml</GetPagedSubscribersResult> </GetPagedSubscribersResponse> </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> <GetPagedSubscribers xmlns="http://api.anpdm.com/"> <strUsername>string</strUsername> <strPassword>string</strPassword> <strMailingListId>string</strMailingListId> <pageIndex>int</pageIndex> <pageSize>int</pageSize> </GetPagedSubscribers> </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> <GetPagedSubscribersResponse xmlns="http://api.anpdm.com/"> <GetPagedSubscribersResult> <xsd:schema>schema</xsd:schema>xml</GetPagedSubscribersResult> </GetPagedSubscribersResponse> </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/GetPagedSubscribers?strUsername=string&strPassword=string&strMailingListId=string&pageIndex=string&pageSize=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"?> <DataSet xmlns="http://api.anpdm.com/"> <schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</DataSet>
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/GetPagedSubscribers HTTP/1.1 Host: api.anpdm.com Content-Type: application/x-www-form-urlencoded Content-Length: length strUsername=string&strPassword=string&strMailingListId=string&pageIndex=string&pageSize=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <DataSet xmlns="http://api.anpdm.com/"> <schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</DataSet>