/v2/Api/Lists GET

Позволяет получить список листов подписчиков.

Формат запроса

ПараметрТипОписание
apiKeystringВаш API-ключ, необходимый для авторизации. Обязательный.
seedListsbooleanЕсли установлен в «true», будут возвращены только тестовые списки. Если установлен в «false», будут возвращены только обычные списки. Необязательный. По умолчанию «false».

Примеры:

https://api.esv2.com/v2/Api/Lists?apiKey=Ваш_API_ключ
https://api.esv2.com/v2/Api/Lists?apiKey=Ваш_API_ключ&seedLists=true

Ответ

Элементы тега Data в ответе:

Элемент/АтрибутТипОписание
Listsarray[complex]Массив элементов списков.

Элементы тега List:

Элемент/АтрибутТипОписание
IdintId списка.
NamestringНазвание списка.
FriendlyNamestringПолное название списка.
LanguagestringЯзык списка, например ru-RU.
OptInModestringРежим подписки. Может быть:
  • SingleOptIn*
  • DoubleOptIn
*SingleOptIn - режим без подтверждения подписки.

Примеры

Запрос

GET https://api.esv2.com/v2/Api/Lists?apiKey=Ваш_API_ключ HTTP/1.1
Accept-Encoding: gzip,deflate
Host: api.esv2.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Ответ

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: Wed, 26 Jun 2013 13:35:54 GMT
Content-Length: 320

<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Data>
    <Lists>
      <List>
        <Id>1</Id>
        <Name>Клиенты</Name>
        <FriendlyName>Мои клиенты</FriendlyName>
        <Language>en-US</Language>
        <OptInMode>DoubleOptIn</OptInMode>
      </List>
      <List>
        <Id>2</Id>
        <Name>Друзья</Name>
        <FriendlyName>Мои друзья</FriendlyName>
        <Language>ru-RU</Language>
        <OptInMode>SingleOptIn</OptInMode>
      </List>
    </Lists>
  </Data>
</ApiResponse>