/v2/Api/Fields GET

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

Параметры запроса:

ПараметрТипОписание
apiKeystringВаш API-ключ, необходимый для авторизации. Обязательный.

Пример:

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

Ответ

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

Элемент/атрибутТипОписание
Fieldsarray[complex]Массив элементов Fields

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

Элемент/атрибутТипОписание
IdintID дополнительного поля.
NamestringНазвание дополнительного поля.
FriendlyNamestringПолное имя дополнительного поля.
TypestringТип дополнительного поля: Text, Number, Money, Date, Datetime, SingleSelect, Boolean, Url.
DefaultValuemixedЗначение по умолчанию для дополнительного поля. Содержимое зависит от типа поля. Необязательный.
DescriptionstringТекст описания дополнительного поля. Необязательный.
VisiblebooleanОтображение дополнительного поля для подписчика, например, в Менеджере подписки. Если true, подписчик видит поле.
RequiredbooleanЕсли true, дополнительное поле подписчика обязательно при добавлении данных подписчика в лист.

Примеры:

Запрос:

GET https://api.esv2.com/v2/Api/Fields?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: 5.2
X-AspNet-Version: 4.0.30319
Set-Cookie: TEMP_DATA=c0d53e6c-d043-474f-b899-c7bc080f637d; path=/
X-Powered-By: ASP.NET
Date: Mon, 02 Feb 2015 17:06:10 GMT
Content-Length: 1877

<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Data>
    <Fields>
      <Field>
        <Id>1</Id>
        <Name>booltest</Name>
        <FriendlyName>Тестовое поле логического типа</FriendlyName>
        <Type>Boolean</Type>
        <DefaultValue>1</DefaultValue>
        <Description>Тестовое поле логического типа со значением по умолчанию</Description>
        <Visible>True</Visible>
        <Required>False</Required>
      </Field>
      <Field>
        <Id>2</Id>
        <Name>reqtext</Name>
        <FriendlyName>Обязательное текстовое поле</FriendlyName>
        <Type>Text</Type>
        <DefaultValue />
        <Description>Обязательное тестовое текстовое поле</Description>
        <Visible>False</Visible>
        <Required>True</Required>
      </Field>
      <Field>
        <Id>3</Id>
        <Name>numtest</Name>
        <FriendlyName>Тестовое числовое поле</FriendlyName>
        <Type>Number</Type>
        <Description>Тестовое числовое поле</Description>
        <Visible>False</Visible>
        <Required>False</Required>
      </Field>
    </Fields>
  </Data>
</ApiResponse>