Get suppression list import progress

Request data format

Request URL parameters:

Element/attribute	Type	Notes
apiKey	string	Your API key, required for authentication. Required.
ID	integer	Import ID. Required as a part of address (not GET parameter). See example below.

Example URL:

https://api.esv2.com/v2/Api/ImportToSuppressionListTasks/19?apiKey=test_api_key1

Response

Method returns an object describing the scheduled import and its execution history.

Response Data element:

Element/attribute	Type	Notes
Name	string	Import task name.
List	string	Name of suppression list for imported records.
Url	string	URL address of file containing records to import.
History	array[complex]	Array of Import elements describing import executions.*

*History may be empty if import was never executed.

Import element children:

Element/attribute	Type	Notes
StartedAt	dateTime	Date of import start.
UpdatedAt	dateTime	Date of last import status change.
Status	string	Import status. One of: “Queued”, “InProgress”, “Completed”, “Error”, “Warning”.
Details	string	Additional information, e.g. error info if import failed.

Examples

Request:

GET https://api.esv2.com/v2/Api/ImportToSuppressionListTasks/19?apiKey=test_api_key1 HTTP/1.1 
Accept-Encoding: gzip,deflate 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com

Response:

HTTP/1.1 200 OK 
Cache-Control: private 
Content-Type: text/xml; charset=utf-8 
Server: Microsoft-IIS/7.5 
X-AspNetMvc-Version: 3.0 
X-AspNet-Version: 4.0.30319 
X-Powered-By: ASP.NET 
Date: Thu, 05 Apr 2012 15:50:13 GMT 
Content-Length: 559   

 <ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <Data>
     <Name>API test import</Name>
     <List>API test suppression list</List>
     <Url>ftp://ftp.expertsender.com/Lists/test.csv</Url>
     <History>
       <Import>
         <StartedAt>2012-03-27T11:01:18</StartedAt>
         <UpdatedAt>2012-03-27T11:01:27</UpdatedAt>
         <Status>Completed</Status>
         <Details>ftp://ftp.expertsender.com/Lists/test.csv</Details>
       </Import>
     </History>
   </Data>
 </ApiResponse>