/v2/Api/ImportToListTasks/{ID} GET
Вместо {ID} в URL нужно подставить ID импорта, который возвращается в ответе POST-запроса.
Формат данных
Параметры запроса:
| Parameter | Type | Notes |
|---|---|---|
| apiKey | string | Ваш API-ключ, необходимый для авторизации. Обязательный |
| ID | integer | ID импорта. Обязательная часть адреса (не GET-параметр). Смотрите примеры |
Пример:
https://api.esv2.com/v2/Api/ImportToListTasks/19?apiKey=Ваш_API_ключ
Ответ
Возвращает описание объекта, запланированного импорта и историю его выполнения.
Элементы тега Data в ответе:
| Элемент/атрибут | Тип | Описание |
|---|---|---|
| Name | string | Имя импорта |
| List | string | Имя листа подписчиков, в который производится импорт |
| Url | string | URL-адрес файла с подписчиками |
| History | array[complex] | Массив элементов Import* |
*Тег History может быть пустым, если импорт еще не запущен.
Элементы тега Import:
| Элемент/атрибут | Тип | Описание |
|---|---|---|
| StartedAt | dateTime | Дата и время начала импорта (по UTC) |
| UpdatedAt | dateTime | Дата и время последней смены статуса импорта (по UTC) |
| Status | string | Статус импорта. Один из: «Queued», «InProgress», «Completed», «Error», «Warning» |
| Details | string | Дополнительная информация, например, информация об ошибке при неудачном импорте |
Примеры
Запрос:
GET https://api.esv2.com/v2/Api/ImportToListTasks/19?apiKey=Ваш_API_ключ HTTP/1.1 Accept-Encoding: gzip,deflate User-Agent: Jakarta Commons-HttpClient/3.1 Host: api.esv2.com
Ответ:
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</Name>
<List>Тестовый лист для импорта по API</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>