Отримати список полів шаблону

URI: /templates/:code?edrpou={{edrpou}}

Використовується для отримання списку полів шаблону.

Запит виконується методом GET у json форматі з даними.

Параметри URI

Метод дозволяє передати наступні параметри:

/templates/:code?edrpou={{edrpou}}, де:

• code - код шаблону, отриманий методом /templates;
• edrpou — код ЄДРПОУ компанії.

Приклад запиту

⚠️ Запит повинен містити заголовок api_token_key: api_token та Accept: application/json

/templates/311131113__MULTIDOC?edrpou=123123

Параметри відповіді

Ім'я	Тип	Опис
fields	list[object]	Містить параметри полів шаблону
fields.name	string	Назва поля шаблону
fields.description	string	Опис поля шаблону
fields.data_type	integer	Тип даних поля шаблону
fields.group	string	Група поля шаблону
fields.path	string	Шлях до поля шаблону
data_types	list[object]	Містить перелік типів даних шаблону
data_types.code	integer	Код типа даних шаблону
data_types.name	string	Назва типа даних шаблону
error	string	Текст помилки

Приклад успішної відповіді

200 OK

Відповідь: /templates/311131113__MULTIDOC?edrpou=123123

{
    "fields": [
        {
            "name": "DOCDATE",
            "description": "Дата документа",
            "data_type": 5,
            "group": "MAIN",
            "path": "0.0.DOCDATE"
        },
        {
            "name": "DOCSUM",
            "description": "Сума по документа",
            "data_type": 2,
            "group": "MAIN",
            "path": "0.0.DOCSUM"
        },
        {
            "name": "DOC_NAME",
            "description": "Найменування документа",
            "data_type": 3,
            "group": "MAIN",
            "path": "0.0.DOC_NAME"
        },
        {
            "name": "EMAIL",
            "description": "Електронна пошта",
            "data_type": 3,
            "max_length": 100,
            "group": "MAIN",
            "path": "0.0.EMAIL"
        },
        {
            "name": "FIRM_DEPT",
            "description": "Код філії",
            "data_type": 3,
            "group": "MAIN",
            "path": "0.0.FIRM_DEPT"
        },
        {
            "name": "FIRM_EDRPOU",
            "description": "ЄДРПОУ/ДРФО",
            "data_type": 3,
            "group": "MAIN",
            "path": "0.0.FIRM_EDRPOU"
        },
        {
            "name": "FIRM_NAME",
            "description": "Найменування",
            "data_type": 3,
            "group": "MAIN",
            "path": "0.0.FIRM_NAME"
        },
        {
            "name": "NUM",
            "description": "Номер документа",
            "data_type": 3,
            "max_length": 100,
            "group": "MAIN",
            "path": "0.0.NUM"
        },
        {
            "name": "ORDER_NUM",
            "description": "Номер замовлення ",
            "data_type": 3,
            "max_length": 30,
            "group": "MAIN",
            "path": "0.0.ORDER_NUM"
        },
        {
            "name": "SIDE_DEPT_K",
            "description": "Код філії",
            "data_type": 3,
            "max_length": 4,
            "group": "MAIN",
            "path": "0.0.SIDE_DEPT_K"
        },
        {
            "name": "SIDE_EDRPOU_K",
            "description": "ЄДРПОУ/ДРФО",
            "data_type": 3,
            "max_length": 10,
            "group": "MAIN",
            "path": "0.0.SIDE_EDRPOU_K"
        },
        {
            "name": "SIDE_SHORTNAME_K",
            "description": "Коротке найменування",
            "data_type": 3,
            "max_length": 200,
            "group": "MAIN",
            "path": "0.0.SIDE_SHORTNAME_K"
        },
        {
            "name": "SIGNERINFO",
            "description": "Інформація про підписантів",
            "data_type": 3,
            "group": "MAIN",
            "path": "0.0.SIGNERINFO"
        },
        {
            "name": "TEXT",
            "description": "Текст",
            "data_type": 3,
            "max_length": 500,
            "group": "MAIN",
            "path": "0.0.TEXT"
        },
        {
            "name": "VO_NAME",
            "description": "Особа, яка склала документ",
            "data_type": 3,
            "max_length": 250,
            "group": "MAIN",
            "path": "0.0.VO_NAME"
        }
    ],
    "data_types": [
        {
            "code": 1,
            "name": "Long"
        },
        {
            "code": 2,
            "name": "Float"
        },
        {
            "code": 3,
            "name": "Text"
        },
        {
            "code": 4,
            "name": "Bool"
        },
        {
            "code": 5,
            "name": "Date",
            "format": "d.m.Y",
            "sample": "21.07.2023"
        },
        {
            "code": 6,
            "name": "Time",
            "format": "H:i",
            "sample": "20:35",
            "placeholder": "дд.мм.рррр"
        },
        {
            "code": 7,
            "name": "DateTime",
            "format": "d.m.Y H:i",
            "sample": "21.07.2023 20:35"
        }
    ]
}

Приклад неуспішної відповіді

400 Bad Request

Відповідь: /templates/311131113__MULTIDOC?edrpou=123123

{
    "error": "Текст помилки"
}