Apsis Newsletter Pro v3 API
Click here for a complete list of operations.
GetRoiResults
Retrieve ROI results for a specific sending.
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/GetRoiResults" <?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> <GetRoiResults xmlns="http://api.anpdm.com/"> <strUsername>string</strUsername> <strPassword>string</strPassword> <strSendQueueId>string</strSendQueueId> </GetRoiResults> </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> <GetRoiResultsResponse xmlns="http://api.anpdm.com/"> <GetRoiResultsResult> <RoiResult> <Url>string</Url> <Clicks>int</Clicks> <Closures>int</Closures> <Value>double</Value> </RoiResult> <RoiResult> <Url>string</Url> <Clicks>int</Clicks> <Closures>int</Closures> <Value>double</Value> </RoiResult> </GetRoiResultsResult> </GetRoiResultsResponse> </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> <GetRoiResults xmlns="http://api.anpdm.com/"> <strUsername>string</strUsername> <strPassword>string</strPassword> <strSendQueueId>string</strSendQueueId> </GetRoiResults> </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> <GetRoiResultsResponse xmlns="http://api.anpdm.com/"> <GetRoiResultsResult> <RoiResult> <Url>string</Url> <Clicks>int</Clicks> <Closures>int</Closures> <Value>double</Value> </RoiResult> <RoiResult> <Url>string</Url> <Clicks>int</Clicks> <Closures>int</Closures> <Value>double</Value> </RoiResult> </GetRoiResultsResult> </GetRoiResultsResponse> </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/GetRoiResults?strUsername=string&strPassword=string&strSendQueueId=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"?> <ArrayOfRoiResult xmlns="http://api.anpdm.com/"> <RoiResult> <Url>string</Url> <Clicks>int</Clicks> <Closures>int</Closures> <Value>double</Value> </RoiResult> <RoiResult> <Url>string</Url> <Clicks>int</Clicks> <Closures>int</Closures> <Value>double</Value> </RoiResult> </ArrayOfRoiResult>
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/GetRoiResults HTTP/1.1 Host: api.anpdm.com Content-Type: application/x-www-form-urlencoded Content-Length: length strUsername=string&strPassword=string&strSendQueueId=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <ArrayOfRoiResult xmlns="http://api.anpdm.com/"> <RoiResult> <Url>string</Url> <Clicks>int</Clicks> <Closures>int</Closures> <Value>double</Value> </RoiResult> <RoiResult> <Url>string</Url> <Clicks>int</Clicks> <Closures>int</Closures> <Value>double</Value> </RoiResult> </ArrayOfRoiResult>