/v2/Api/Templates GET

Метод позволяет получить список доступных шаблонов: шапок (header) и подвалов (footer) письма с помощью GET запроса. Эта информация может быть использована для создания и отправки стандартного письма

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

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

ПараметрТипОписание
apiKeystringВаш необходимый для авторизация API-key. Обязательный параметр
typestringВозвращаемый тип шаблона. Если не указан, возвращаются все типы. Доступные типы шаблонов:
  • Header
  • Footer

Примеры:

https://api.esv2.com/v2/Api/Templates?apiKey=ВАШ_API_KEY_ЗДЕСЬ
https://api.esv2.com/v2/Api/Templates?apiKey=Ваш_API-ключ?type=Footer

Ответ

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

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

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

Элемент/атрибутТипОписание
IdintId шаблона
TypestringТип шаблона. Может быть:
NamestringИмя шаблона

Запрос:

GET https://api.esv2.com/v2/Api/Templates?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)

Ответ:

TTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 5.1
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 05 Mar 2014 13:19:51 GMT
Content-Length: 345

<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Data>
    <Templates>
      <Template>
        <Id>1</Id>
        <Type>Footer</Type>
        <Name>Default EN footer</Name>
      </Template>
      <Template>
        <Id>2</Id>
        <Type>Footer</Type>
        <Name>Default PL footer</Name>
      </Template>
      <Template>
        <Id>3</Id>
        <Type>Header</Type>
        <Name>My custom header</Name>
      </Template>
      <Template>
        <Id>4</Id>
        <Type>Header</Type>
        <Name>Some other header</Name>
      </Template>
    </Templates>
  </Data>
</ApiResponse>