API для маркетинг-плана

Список пунктов плана

Возвращает список разделов, пунктов и информацию об отметках плана.

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

GET /checklist/{site_id}

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

ИмяОбязательныйОписание
site_idДаID сайта

Результат

В случае успеха сервер возвращает список разделов, пунктов и информацию об отметках плана.

Пример

[
{
“title”: “Шаг 1. Анализ и подбор ключевых слов”,
“items”: [
{
“id”: “analyze_competitors”,
“title”: “Изучите ключевые слова конкурентов”,
“checked”: true
},
{
“id”: “makeup_final_list”,
“title”: “Сформируйте семантическое ядро сайта”,
“checked”: true
},

],
“id”: “keywords_research”,
“items_count”: 3,
“items_checked”: 3
},

]

Параметры ответа

ИмяОписание
idID раздела
titleНазвание раздела
items_count Количество задач в разделе
items_checkedКоличество выполненных задач
itemsЗадачи раздела

Задачи раздела

ИмяОписание
idID задачи
titleНазвание задачи
checkedСтатус задачи

Добавление задачи

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

POST /checklist/{site_id}/task
{
“title”: “text”,
“text”: “text description”,
“for_all” : false
}

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

ИмяОбязательныйОписание
titleДаНазвание
textДаОписание
for_allНетДля всех проектов

Результат

В случае успеха сервер возвращает id созданного таска.

Пример ответа

{
“id”: 1
}

Ошибки

HTTP-кодСообщение об ошибке
400Empty title
400Empty text

Изменение задачи

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

PUT /checklist/{site_id}/task/
{
“task_id” : “makeup_final_list”,
“title”: “text”,
“text”: “text description”,
}

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

ИмяОбязательныйОписание
task_idДаID Задачи
titleДаНазвание
textДаОписание

Результат

В случае успеха сервер возвращает HTTP 200.

Ошибки

HTTP-кодСообщение об ошибке
400Empty title
400Empty text

Удаление задачи

Удалить можно только задачи, созданные методом (POST /checklist/{site_id}/task)

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

DELETE /checklist/{site_id}/task/{task_id}

Результат

В случае успеха сервер возвращает HTTP 204.

Установка статуса задачи

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

PUT /checklist/{site_id}/task/
{
“task_id” : “makeup_final_list”,
“checked”: true
}

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

ИмяОбязательныйОписание
task_idДаID задачи
checkedДаtrue-выполнен

Результат

В случае успеха сервер возвращает HTTP 200.