Методы ресурса Makets

Метод:index

url: /mailer/makets

http-method: GET

Используется для получения списка макетов пользователя.

Опциональные параметры

fields - значение по умолнчанию: ["id","title"]. Список доступных полей: id, title, body. Если переданы неправильные параметры, вернётся значение по умолчанию.
filter - доступные поля: title .
sort_field - значение по умолчанию: id. Доступные поля для сортировки: id, title.

Структура ответа

HTTP status code: 200.

При успешном выполнении запроса метод возвращает запрашиваемые данные в формате json.

Пример успешного ответа:

{
  "makets": [
    {
      "id": 1,
      "title": "title",
      "body": ""
    },
    {
      "id": 2,
      "title": "title",
      "body": ""
    },
    {
    ...
    }
  ]
}
Название параметра Тип Описание
id int Идентификатор макета.
title string Название макета.
body string Тело макета.

Метод:view

url: /mailer/makets/[id]

http-method: GET

Используется для получения макета по уникальному идентификатору (id).

Опциональные параметры

fields - значение по умолчанию: ["id","title"]. Список доступных полей: id, title, body.

Структура ответа

HTTP status code: 200.

При успешном выполнении запроса метод возвращает запрашиваемые данные в формате json.

Пример успешного ответа:

{
  "id": 1,
  "title": "title",
  "body": ""
}
Название параметра Тип Описание
id int Идентификатор макета.
title string Название макета.
body string Тело макета.

Ошибки

Код ответа Код ошибки Текст ответа Описание
400 20220 Invalid fields. Wrong parameters of string fields Переданны неправильные параметры строки fields.
404 Not found Макета по переданому идентификатору не найдено.

Метод: add

url: /mailer/makets

http-method: POST

Используется для создания нового макета.

Обязательные параметры

Название Тип Описание
title string Название макета.

Опциональные параметры

Название Тип Значение по умолчанию Описание
body string Тело макета.

Структура ответа

HTTP status code: 201.

При успешном выполнении запроса возвращается идентификатор (id) созданного макета.

Пример успешного ответа:

{
  "id": 1
}
Название параметра Тип Описание
id int Идентификатор макета.

Ошибки

Код ответа Код ошибки Текст ответа Описание
400 20240 Invalid title. Title can not be empty Название не может быть пустым.

Метод: edit

url: /mailer/makets/[id]

http-method: PUT

Используется для редактирования макета.

Опциональные параметры

Название Тип Значение по умолчанию Описание
title string Новое название макета.
body string Новое тело макета.

Структура ответа

HTTP status code: 204.

Ошибки

Код ответа Код ошибки Текст ответа Описание
400 20260 Invalid title. Title can not be empty Название не может быть пустым.
404 Not Found Макета по переданому идентификатору не найдено.

Метод:delete

url: /mailer/makets/[id]

http-method: DELETE

Удаление макета.

Структура ответа

HTTP status code: 204.

Ошибки

Код ответа Текст ответа Описание
404 Not found Макета по переданому идентификатору не найдено.