Получение шаблона

method: POST

url: https://test.ninjalender.online/template/get

Заголовки:

header_key

content

Content-Type:

application/json;

Authorization

Bearer {{Token}}

Ninja-Lang

Локаль, используя язык которой будут переведены все заголовки

Где {{Token}} -токен полученый при авторизации

Тело запроса:

Ключ

Тип

Обязательный

Описание

params

JSON.object

+

Параметры запроса (в данном случае пустой объект)

Params:

Ключ

Тип

Обязательный

Описание

id

int

+

Ид шаблона

Ответ:

Ключ

Тип

Описание

code

int

Код ответа

message

string

Сообщение

data

JSON.object

Возвращаемые данные

data:

Ключ

Тип

Описание

id

int

Ид шаблона

label

string

Название шаблона

description

string

Описание шаблона

title

string

заголовок шаблона

body

json.object

список реквизитов участвующих в шаблоне где ключем является название реквизита, а в значениях параметры реквизита

Пример реквизита из body

Ключ

Тип

Описание

id

int

Ид реквизита

kind

int

Вид реквизита, описывает какой тип данных ожидается как значение реквизита:

0 - строка

1 - текст

2 - число

3 - дата

4 - булевое

5 - Справочник - в случае с данным видом система будет ожидать в значении самого реквизита один из элементов из массива variants 6 - телефон в международном формате 7 - валидный адресс электронной почты

label

string

название реквизита

required

boolean

является ли реквизит обязательным

variants

JSON.array

список вариантов для реквизатов вида "справочник"

description

string

описание реквизита

title

string

Заголовок реквизита

Пример варианта из реквизита

Ключ

Тип

Описание

label

string

название варианта

title

string

заголовок варианта

Пример запроса:

{
	"params":{
		"id": 20
	}
}

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

Успех:

{
    "code": 0,
    "message": "ok",
    "data": {
        "body": {
            "one": {
                "id": "4",
                "kind": 2,
                "label": "one",
                "required": false,
                "variants": null,
                "description": null,
                "title": "one"
            },
            "two": {
                "id": "5",
                "kind": 5,
                "label": "two",
                "required": false,
                "variants": [
                    {
                        "label": "one",
                        "title": "One"
                    },
                    {
                        "label": "tow",
                        "title": "Two"
                    }
                ],
                "description": null,
                "title": "two"
            },
           
        },
        "id": 20,
        "label": "NOT_1-8test",
        "description": null,
        "title": "NOT_1-8test"
    },
    "log_key": 731
}

Ошибка:

{
    "code": -1,
    "message": "error",
    "log_key": 749,
    "errors": [
        {
            "code": -1020201,
            "message": "Params is required"
        }
    ]
}

Список ошибок:

Ключ

Сообщение

-96

invalid key

-97

invalid token

-98

expired token

-99

system error

-100

access denied

-1020201

Params is required

-1020202

Id is blank

-1020203

Template not found

Last updated

Was this helpful?