Получение списка шаблонов
method: POST
url: https://test.ninjalender.online/template/list
Заголовки:
header_key
content
Content-Type:
application/json;
Authorization
Bearer {{Token}}
Ninja-Lang
Локаль, используя язык которой будут переведены все title
Где {{Token}} -токен полученый при авторизации
Тело запроса:
Ключ
Тип
Обязательный
Описание
params
JSON.object
+
Параметры запроса (в данном случае возможен пустой объект)
Params:
Ключ
Тип
Обязательный
Описание
fields
JSON.array
-
Список полей для сериализации (какие данные каждого шаблона будут возвращены при ответе). Весь список предоставлен в таблице с разбором ответа. В случае отсутствия будут возвращены только id, label, description
Ответ:
Ключ
Тип
Описание
code
int
Код ответа
message
string
Сообщение
data
JSON.object
Возвращаемые данные
log_key
int
Ид лога для данного запроса
data:
Ключ
Тип
Описание
id
int
Ид шаблона
label
string
Название шаблона
description
string
Описание шаблона
title
string
заголовок шаблона
body
json.object
список реквизитов участвующих в шаблоне
Пример запроса:
{
"params" : {}
}
Пример ответа:
Успех:
{
"code": 0,
"message": "ok",
"data": [
{
"id": 3,
"label": "1_8_test",
"description": null
},
{
"id": 1,
"label": "first_template",
"description": null
}
],
"log_key": 730
}
Ошибка:
{
"code": -1,
"message": "error",
"log_key": 748,
"errors": [
{
"code": -1020101,
"message": "Params is required"
}
]
}
Список ошибок:
Ключ
Сообщение
-96
invalid key
-97
invalid token
-98
expired token
-99
system error
-100
access denied
-1020101
Params is required
Last updated
Was this helpful?