Работа с формами

Получение списка шаблонов

Общее описание

Функция GET /v6/api/formManagement/templates?type={integer} позволяет получить список шаблонов форм и дополнительных полей задач.

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

В запросе используется параметр type — тип шаблона (существуют следующие значения: 0 — шаблон форм; 1 — шаблон дополнительных полей задачи).

Результат выполнения

Функция возвращает массив структур со следующими параметрами шаблонов:

Параметр	Описание
templateID	ИД шаблона.
externalID	Внешний идентификатор шаблона.
name	Название шаблона.
isArchived	Является ли форма архивной. Существуют следующие значения: true — форма архивная; false — форма активная.
urn	URN шаблона.
creationDate	Дата создания шаблона.
type	Тип формы. Существуют следующие значения: 0 — шаблон форм; 1 — шаблон дополнительных полей задачи.

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

GET /v6/api/formManagement/templates?type=\{integer} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/formManagement/templates?type=1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

[
    \{
        "templateID": integer,
        "externalID": "1",
        "name": "string",
        "isArchived": boolean,
        "urn": "string",
        "creationDate": "dateTime",
        "type": integer
    }
]

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

[
    \{
        "templateID": 1,
        "externalID": "1",
        "name": "Шаблон",
        "isArchived": false,
        "urn": "qdtRBo",
        "creationDate": "2021-01-07T00:00:00+03:00",
        "type": 0
    }
]

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

Общее описание

Функция GET /v6/api/formManagement/templates/{templateID} позволяет получить шаблон форм или дополнительных полей задач по его идентификатору.

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

В запросе используется обязательный параметр templateID — ИД шаблона.

Результат выполнения

Функция возвращает массив структур со следующими параметрами шаблонов:

Параметр	Описание
templateID	ИД шаблона.
externalID	Внешний идентификатор шаблона.
name	Название шаблона.
isArchived	Является ли форма архивной. Существуют следующие значения: true — форма архивная; false — форма активная.
urn	URN шаблона.
creationDate	Дата создания шаблона.
type	Тип формы. Существуют следующие значения: 0 — шаблон форм; 1 — шаблон дополнительных полей задачи.

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

GET /v6/api/formManagement/templates/\{templateID} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/formManagement/templates/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

\{
    "templateID": integer,
    "externalID": "string",
    "name": "string",
    "isArchived": false,
    "urn": "string",
    "creationDate": "dateTime",
    "type": integer
}

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

\{
    "templateID": 1,
    "externalID": "1",
    "name": "Информация о доставке",
    "isArchived": false,
    "urn": "fzqdV",
    "creationDate": "2018-01-17T13:58:13.217+03:00",
    "type": 0
}

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

Общее описание

Функция GET /v6/api/formManagement/templates/urn/{urn}позволяет получить шаблон формы или дополнительных полей задач по его URN.

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

В запросе используется обязательный параметр urn — URN шаблона.

Результат выполнения

Функция возвращает массив структур со следующими параметрами шаблонов:

Параметр	Описание
templateID	ИД шаблона.
externalID	Внешний идентификатор шаблона.
name	Название шаблона.
isArchived	Является ли форма архивной. Существуют следующие значения: true — форма архивная; false — форма активная.
urn	URN шаблона.
creationDate	Дата создания шаблона.
type	Тип формы. Существуют следующие значения: 0 — шаблон форм; 1 — шаблон дополнительных полей задачи.

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

GET /v6/api/formManagement/templates/urn/\{urn} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/formManagement/templates/urn/fzqdV HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

\{
    "templateID": integer,
    "externalID": "string",
    "name": "string",
    "isArchived": false,
    "urn": "string",
    "creationDate": "dateTime",
    "type": integer
}

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

\{
    "templateID": 1,
    "externalID": "1",
    "name": "Информация о доставке",
    "isArchived": false,
    "urn": "fzqdV",
    "creationDate": "2018-01-17T13:58:13.217+03:00",
    "type": 0
}

Получение шаблона по внешнему идентификатору

Общее описание

Функция GET /v6/api/formManagement/templates/externalID/{externalD}позволяет получить шаблон формы или дополнительных полей задач по его внешнему идентификатору.

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

В запросе используется обязательный параметр externalD — внешний идентификатор шаблона.

Результат выполнения

Функция возвращает массив структур со следующими параметрами шаблонов:

Параметр	Описание
templateID	ИД шаблона.
externalID	Внешний идентификатор шаблона.
name	Название шаблона.
isArchived	Является ли форма архивной. Существуют следующие значения: true — форма архивная; false — форма активная.
urn	URN шаблона.
creationDate	Дата создания шаблона.
type	Тип формы. Существуют следующие значения: 0 — шаблон форм; 1 — шаблон дополнительных полей задачи.

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

GET /v6/api/formManagement/templates/externalID/\{externalD} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/formManagement/templates/externalID/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

\{
    "templateID": integer,
    "externalID": "string",
    "name": "string",
    "isArchived": false,
    "urn": "string",
    "creationDate": "dateTime",
    "type": integer
}

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

\{
    "templateID": 1,
    "externalID": "1",
    "name": "Информация о доставке",
    "isArchived": false,
    "urn": "fzqdV",
    "creationDate": "2018-01-17T13:58:13.217+03:00",
    "type": 0
}

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

Общее описание

Функция GET /v6/api/formManagement/templates/{templateID}/items позволяет получить поля шаблона формы или дополнительных полей задачи.

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

В запросе используется обязательный параметр templateID — ИД шаблона.

Результат выполнения

Функция возвращает массив структур со следующими параметрами полей шаблона:

Параметр	Описание
templateItemID	ИД поля шаблона.
externalID	Внешний ИД поля шаблона.
orderNumber	Порядковый номер поля в шаблоне.
Name	Название поля шаблона.
itemType	Тип поля шаблона. Существуют следующие значения: 0 — строка; 1 — текст; 2 — дата; 3 — время; 4 — целое число; 5 — вещественное число; 6 — галочка; 7 — список; 8 — изображение; 9 — файл; 10 — информация; 11 — таблица.
optionList	Пункты в типе поля «Список».
placeholder	Подсказка для заполнения поля шаблона.
validationMinValue	Минимальное значение валидации поля шаблона.
validationMaxValue	Максимальное значение валидации поля шаблона.
validationRegex	Регексп валидации поля шаблона.
validationErrorMessage	Сообщение об ошибке валидации.
isRequired	Является ли поле обязательным для заполнения. Существуют следующие значения: true — поле обязательное для заполнения; false — поле необязательное для заполнения.
isArchived	Является ли поле формы архивным. Существуют следующие значения: true — поле формы архивное; false — поле формы активное.
subType	Подтип поля «Строка». Существуют следующие значения: 0 — ввод текста; 1 — сканирование QR-кода; 2 — сканирование NFC-метки; 3 — ввод номера телефона; 4 — ввод электронной почты; 5 — ввод ссылки; 6 — ввод номера договора. Подтип поля «Целое число». Существуют следующие значения: 0 — ввод целого числа; 1 — распознавание текста с помощью камеры. Подтип поля «Вещественное число». Существуют следующие значения: 0 — ввод целого числа; 1 — распознавание текста с помощью камеры. Подтип поля «Изображение». Существуют следующие значения: 0 — любое изображение; 1 — только изображение, сделанное на камеру устройства; 2 — подпись; 3 — изображение с водяным знаком. Подтип поля «Информация». Существуют следующие значения: 0 — ввод текста; 1 — загрузка файла; 2 — загрузка картинки; 3 — загрузка видеофайла; 4 — загрузка аудиофайла; 5 — ввод заголовка; 6 — ввод подзаголовка; 7 — добавление разделителя; 8 — ввод ссылки.
nestedItems	Вложенные элементы для поля типа «Таблица»
Условия показа зависимых полей (conditions)
formTemplateConditionID	ИД условия шаблона формы.
formTemplateConditionType	Тип условия шаблона формы. Существуют следующие значения: 0 — видимое; 1 — обязательное; 2 — включено.
parentFormTemplateItemID	ИД родительского поля шаблона формы, от выбора значения в котором зависит отображение этого поля.
operation	Тип операции. Существуют следующие значения: 0 — равно; 1 — не равно.
value	Значение родительского поля шаблона формы, при выборе которого становится доступным для заполнения это поле.
Техническое описание полей (techDescription)
isKeyField	Является ли поле ключевым. Существуют следующие значения: true — является; false — не является.
Описание поля «Строка» (string)
color	Цвет текста (для подтипа «Ссылка»)
backgroundColor	Цвет фона (для подтипа «Ссылка»)
isButton	Отображать ли ссылку в виде кнопки (для подтипа «Ссылка»). Существуют следующие значения: true — отображать; false — не отображать.
Title	Название ссылки/кнопки (для подтипа «Ссылка»).
Описание поля «Информация» (label)
color	Цвет текста (для подтипа «Ссылка»)
backgroundColor	Цвет фона (для подтипа «Ссылка»)
contentType	Тип контента (для подтипов «Файл», «Видеофайл», «Аудиофайл», «Изображение»)
contentLength	Размер файла (для подтипов «Файл», «Видеофайл», «Аудиофайл», «Изображение»)
thickness	Толщина разделителя в пикселях (для подтипа «Разделитель»)
isButton	Отображать ли ссылку в виде кнопки (для подтипа «Ссылка»). Существуют следующие значения: true — отображать; false — не отображать.
url	URL (для подтипа «Ссылка»)
urn	URN файла, прикрепленного к шаблону (для подтипов «Файл», «Видеофайл», «Аудиофайл», «Изображение»). Подробнее о скачивании файла
Информация поля «Список» (select)
optionListFormExternalID	Внешний ИД справочника, который используется для заполнения поля «Список»
optionListFormKeyItemExternalID	Внешний ИД ключевого поля справочника, который используется для заполнения поля «Список»

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

GET /v6/api/formManagement/templates/\{templateID}/items HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/formManagement/templates/1/items HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

[
    \{
        "templateItemID": integer,
        "externalID": "string",
        "orderNumber": integer,
        "name": "string",
        "itemType": integer,
        "optionList": [
            "string"
        ],
        "placeholder": "string",
        "validationMinValue": integer,
        "validationMaxValue": integer,
        "validationRegex": "string",
        "validationErrorMessage": "string",
        "isRequired": boolean,
        "isArchived": boolean,
        "conditions": [
            \{
                "formTemplateConditionID": integer,
                "formTemplateConditionType": integer,
                "parentFormTemplateItemID": integer,
                "operation": integer,
                "value": "string"
            }
        ],
        "subType": integer
        "techDescription": \{
            "isKeyField": boolean,
            "string": \{
                "color": "string",
                "backgroundColor": "string",
                "isButton": boolean,
                "title": "string"
            },
            "label": \{
                "color": "string",
                "backgroundColor": "string",
                "contentType": "string",
                "contentLength": integer,
                "thickness": integer,
                "isButton": true,
                "url": "string",
                "urn": "string"
            },
            "select": \{
                "optionListFormExternalID": "string",
                "optionListFormKeyItemExternalID": "string"
            }
        },
        "nestedItems": [
            \{
                "templateItemID": integer,
                "externalID": "string",
                "orderNumber": integer,
                "name": "string",
                "itemType": integer,
                "optionList": [
                    "string"
                ],
                "placeholder": "string",
                "validationMinValue": integer,
                "validationMaxValue": integer,
                "validationRegex": "string",
                "validationErrorMessage": "string",
                "isRequired": boolean,
                "isArchived": boolean,
                "conditions": [
                    \{
                        "formTemplateConditionID": integer,
                        "formTemplateConditionType": integer,
                        "parentFormTemplateItemID": integer,
                        "operation": integer,
                        "value": "string"
                    }
                ],
                "subType": integer,
                "techDescription": \{
                    "isKeyField": boolean,
                    "string": \{
                        "color": "string",
                        "backgroundColor": "string",
                        "isButton": boolean,
                        "title": "string"
                    },
                    "label": \{
                        "color": "string",
                        "backgroundColor": "string",
                        "contentType": "string",
                        "contentLength": integer,
                        "thickness": integer,
                        "isButton": boolean,
                        "url": "string",
                        "urn": "string"
                    },
                    "select": \{
                        "optionListFormExternalID": "string",
                        "optionListFormKeyItemExternalID": "string"
                    }
                }
            }
        ]
    }
]

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

[
    \{
        "templateItemID": 969095,
        "externalID": "969067",
        "orderNumber": 0,
        "name": "Нужно проверить наличие товара на складе, в торговом зале",
        "itemType": 10,
        "isRequired": false,
        "isArchived": false,
        "conditions": [],
        "subType": 0
    },
    \{
        "templateItemID": 969096,
        "externalID": "967503",
        "orderNumber": 1,
        "name": "Склад",
        "itemType": 10,
        "isRequired": false,
        "isArchived": false,
        "conditions": [],
        "subType": 5
    },
    \{
        "templateItemID": 969097,
        "externalID": "967509",
        "orderNumber": 2,
        "name": "Какой товар нужно доставить",
        "itemType": 0,
        "isRequired": false,
        "isArchived": false,
        "conditions": [],
        "subType": 0
    },
    \{
        "templateItemID": 969098,
        "externalID": "967506",
        "orderNumber": 3,
        "name": "Посмотреть пример",
        "itemType": 10,
        "isRequired": false,
        "isArchived": false,
        "conditions": [],
        "subType": 8,
        "techDescription": \{
            "label": \{
                "color": "#128fe2",
                "isButton": false,
                "url": "https://ya.ru/"
            }
        }
    },
    \{
        "templateItemID": 969099,
        "externalID": "967510",
        "orderNumber": 4,
        "name": "Отсканируйте NFC-метку на складе",
        "itemType": 0,
        "isRequired": false,
        "isArchived": false,
        "conditions": [],
        "subType": 2
    },
    \{
        "templateItemID": 969100,
        "externalID": "967511",
        "orderNumber": 5,
        "name": "Отсканируйте QR-код на полке",
        "itemType": 0,
        "isRequired": false,
        "isArchived": false,
        "conditions": [],
        "subType": 1
    },
    \{
        "templateItemID": 969101,
        "externalID": "967512",
        "orderNumber": 6,
        "name": "Номер телефона ответственного",
        "itemType": 0,
        "isRequired": false,
        "isArchived": false,
        "conditions": [],
        "subType": 3
    },
    \{
        "templateItemID": 969108,
        "externalID": "969108",
        "orderNumber": 7,
        "name": "Посмотреть образец",
        "itemType": 10,
        "isRequired": false,
        "isArchived": false,
        "conditions": [],
        "subType": 8,
        "techDescription": \{
            "label": \{
                "color": "#ffffff",
                "backgroundColor": "#3498db",
                "isButton": true,
                "url": "https://site.ru/"
            }
        }
    }
]

Получение полей шаблона по URN шаблона

Общее описание

Функция GET /v6/api/formManagement/templates/urn/{urn}/items позволяет получить поля шаблона формы или дополнительных полей задачи.

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

В запросе используется обязательный параметр urn —urn шаблона.

Результат выполнения

Функция возвращает массив структур со следующими параметрами полей шаблона:

Параметр	Описание
templateItemID	ИД поля шаблона.
externalID	Внешний ИД поля шаблона.
orderNumber	Порядковый номер поля в шаблоне.
Name	Название поля шаблона.
itemType	Тип поля шаблона. Существуют следующие значения: 0 — строка; 1 — текст; 2 — дата; 3 — время; 4 — целое число; 5 — вещественное число; 6 — галочка; 7 — список; 8 — изображение; 9 — файл; 10 — информация; 11 — таблица.
optionList	Пункты в типе поля «Список».
placeholder	Подсказка для заполнения поля шаблона.
validationMinValue	Минимальное значение валидации поля шаблона.
validationMaxValue	Максимальное значение валидации поля шаблона.
validationRegex	Регексп валидации поля шаблона.
validationErrorMessage	Сообщение об ошибке валидации.
isRequired	Является ли поле обязательным для заполнения. Существуют следующие значения: true — поле обязательное для заполнения; false — поле необязательное для заполнения.
isArchived	Является ли поле формы архивным. Существуют следующие значения: true — поле формы архивное; false — поле формы активное.
subType	Подтип поля «Строка». Существуют следующие значения: 0 — ввод текста; 1 — сканирование QR-кода; 2 — сканирование NFC-метки; 3 — ввод номера телефона; 4 — ввод электронной почты; 5 — ввод ссылки; 6 — ввод номера договора. Подтип поля «Целое число». Существуют следующие значения: 0 — ввод целого числа; 1 — распознавание текста с помощью камеры. Подтип поля «Вещественное число». Существуют следующие значения: 0 — ввод целого числа; 1 — распознавание текста с помощью камеры. Подтип поля «Изображение». Существуют следующие значения: 0 — любое изображение; 1 — только изображение, сделанное на камеру устройства; 2 — подпись; 3 — изображение с водяным знаком. Подтип поля «Информация». Существуют следующие значения: 0 — ввод текста; 1 — загрузка файла; 2 — загрузка картинки; 3 — загрузка видеофайла; 4 — загрузка аудиофайла; 5 — ввод заголовка; 6 — ввод подзаголовка; 7 — добавление разделителя; 8 — ввод ссылки.
nestedItems	Вложенные элементы для поля типа «Таблица»
Условия показа зависимых полей (conditions)
formTemplateConditionID	ИД условия шаблона формы.
formTemplateConditionType	Тип условия шаблона формы. Существуют следующие значения: 0 — видимое; 1 — обязательное; 2 — включено.
parentFormTemplateItemID	ИД родительского поля шаблона формы, от выбора значения в котором зависит отображение этого поля.
operation	Тип операции. Существуют следующие значения: 0 — равно; 1 — не равно.
value	Значение родительского поля шаблона формы, при выборе которого становится доступным для заполнения это поле.
Техническое описание полей (techDescription)
isKeyField	Является ли поле ключевым. Существуют следующие значения: true — является; false — не является.
Описание поля «Строка» (string)
color	Цвет текста (для подтипа «Ссылка»)
backgroundColor	Цвет фона (для подтипа «Ссылка»)
isButton	Отображать ли ссылку в виде кнопки (для подтипа «Ссылка»). Существуют следующие значения: true — отображать; false — не отображать.
Title	Название ссылки/кнопки (для подтипа «Ссылка»).
Описание поля «Информация» (label)
color	Цвет текста (для подтипа «Ссылка»)
backgroundColor	Цвет фона (для подтипа «Ссылка»)
contentType	Тип контента (для подтипов «Файл», «Видеофайл», «Аудиофайл», «Изображение»)
contentLength	Размер файла (для подтипов «Файл», «Видеофайл», «Аудиофайл», «Изображение»)
thickness	Толщина разделителя в пикселях (для подтипа «Разделитель»)
isButton	Отображать ли ссылку в виде кнопки (для подтипа «Ссылка»). Существуют следующие значения: true — отображать; false — не отображать.
url	URL (для подтипа «Ссылка»)
urn	URN файла, прикрепленного к шаблону (для подтипов «Файл», «Видеофайл», «Аудиофайл», «Изображение»). Подробнее о скачивании файла
Информация поля «Список» (select)
optionListFormExternalID	Внешний ИД справочника, который используется для заполнения поля «Список»
optionListFormKeyItemExternalID	Внешний ИД ключевого поля справочника, который используется для заполнения поля «Список»

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

GET /v6/api/formManagement/templates/urn/\{urn}/items HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/formManagement/templates/urn/fzqdV/items HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

[
    \{
        "templateItemID": integer,
        "externalID": "string",
        "orderNumber": integer,
        "name": "string",
        "itemType": integer,
        "optionList": [
            "string"
        ],
        "placeholder": "string",
        "validationMinValue": integer,
        "validationMaxValue": integer,
        "validationRegex": "string",
        "validationErrorMessage": "string",
        "isRequired": boolean,
        "isArchived": boolean,
        "conditions": [
            \{
                "formTemplateConditionID": integer,
                "formTemplateConditionType": integer,
                "parentFormTemplateItemID": integer,
                "operation": integer,
                "value": "string"
            }
        ],
        "subType": integer
        "techDescription": \{
            "isKeyField": boolean,
            "string": \{
                "color": "string",
                "backgroundColor": "string",
                "isButton": boolean,
                "title": "string"
            },
            "label": \{
                "color": "string",
                "backgroundColor": "string",
                "contentType": "string",
                "contentLength": integer,
                "thickness": integer,
                "isButton": true,
                "url": "string",
                "urn": "string"
            },
            "select": \{
                "optionListFormExternalID": "string",
                "optionListFormKeyItemExternalID": "string"
            }
        },
        "nestedItems": [
            \{
                "templateItemID": integer,
                "externalID": "string",
                "orderNumber": integer,
                "name": "string",
                "itemType": integer,
                "optionList": [
                    "string"
                ],
                "placeholder": "string",
                "validationMinValue": integer,
                "validationMaxValue": integer,
                "validationRegex": "string",
                "validationErrorMessage": "string",
                "isRequired": boolean,
                "isArchived": boolean,
                "conditions": [
                    \{
                        "formTemplateConditionID": integer,
                        "formTemplateConditionType": integer,
                        "parentFormTemplateItemID": integer,
                        "operation": integer,
                        "value": "string"
                    }
                ],
                "subType": integer,
                "techDescription": \{
                    "isKeyField": boolean,
                    "string": \{
                        "color": "string",
                        "backgroundColor": "string",
                        "isButton": boolean,
                        "title": "string"
                    },
                    "label": \{
                        "color": "string",
                        "backgroundColor": "string",
                        "contentType": "string",
                        "contentLength": integer,
                        "thickness": integer,
                        "isButton": boolean,
                        "url": "string",
                        "urn": "string"
                    },
                    "select": \{
                        "optionListFormExternalID": "string",
                        "optionListFormKeyItemExternalID": "string"
                    }
                }
            }
        ]
    }
]

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

[
    \{
        "templateItemID": 969095,
        "externalID": "969067",
        "orderNumber": 0,
        "name": "Нужно проверить наличие товара на складе, в торговом зале",
        "itemType": 10,
        "isRequired": false,
        "isArchived": false,
        "conditions": [],
        "subType": 0
    },
    \{
        "templateItemID": 969096,
        "externalID": "967503",
        "orderNumber": 1,
        "name": "Склад",
        "itemType": 10,
        "isRequired": false,
        "isArchived": false,
        "conditions": [],
        "subType": 5
    },
    \{
        "templateItemID": 969097,
        "externalID": "967509",
        "orderNumber": 2,
        "name": "Какой товар нужно доставить",
        "itemType": 0,
        "isRequired": false,
        "isArchived": false,
        "conditions": [],
        "subType": 0
    },
    \{
        "templateItemID": 969098,
        "externalID": "967506",
        "orderNumber": 3,
        "name": "Посмотреть пример",
        "itemType": 10,
        "isRequired": false,
        "isArchived": false,
        "conditions": [],
        "subType": 8,
        "techDescription": \{
            "label": \{
                "color": "#128fe2",
                "isButton": false,
                "url": "https://ya.ru/"
            }
        }
    },
    \{
        "templateItemID": 969099,
        "externalID": "967510",
        "orderNumber": 4,
        "name": "Отсканируйте NFC-метку на складе",
        "itemType": 0,
        "isRequired": false,
        "isArchived": false,
        "conditions": [],
        "subType": 2
    },
    \{
        "templateItemID": 969100,
        "externalID": "967511",
        "orderNumber": 5,
        "name": "Отсканируйте QR-код на полке",
        "itemType": 0,
        "isRequired": false,
        "isArchived": false,
        "conditions": [],
        "subType": 1
    },
    \{
        "templateItemID": 969101,
        "externalID": "967512",
        "orderNumber": 6,
        "name": "Номер телефона ответственного",
        "itemType": 0,
        "isRequired": false,
        "isArchived": false,
        "conditions": [],
        "subType": 3
    },
    \{
        "templateItemID": 969108,
        "externalID": "969108",
        "orderNumber": 7,
        "name": "Посмотреть образец",
        "itemType": 10,
        "isRequired": false,
        "isArchived": false,
        "conditions": [],
        "subType": 8,
        "techDescription": \{
            "label": \{
                "color": "#ffffff",
                "backgroundColor": "#3498db",
                "isButton": true,
                "url": "https://site.ru/"
            }
        }
    }
]

Получение заполненных форм

Общее описание

Функция GET /v6/api/formManagement/forms?dateFrom={dateTime}&dateTo={dateTime}&subscriberIDs={integer}&taskIDs={integer} позволяет получить заполненные формы за период по нужным Сотрудникам.

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

Функция имеет следующие параметры:

Параметр	Описание
dateFrom	Дата, время начала периода для получения заполненных форм (подробнее о формате времени).
dateTo	Дата, время окончания для получения заполненных форм (подробнее о формате времени).
subscriberIDs	ИД Сотрудников (необязательное поле). Подробнее о передаче нескольких идентификаторов
taskIDs	ИД задач (необязательное поле). Подробнее о передаче нескольких идентификаторов

Результат выполнения

Функция возвращает массив структур со следующими параметрами заполненных форм:

Параметр	Описание
formID	ИД формы
urn	URN формы
isArchived	Является ли форма архивной. Существуют следующие значения: true — форма архивная; false — форма активная.
creationDate	Дата и время заполнения формы
subscriberID	ИД Сотрудника
taskID	ИД задачи
formTemplateID	ИД шаблона формы
Заполненные поля формы (items)
externalID	Внешний ИД поля шаблона
name	Название поля шаблона
value	Значение поля шаблона
type	Тип поля шаблона. Существуют следующие значения: string – строка; text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

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

GET /v6/api/formManagement/forms?dateFrom=\{dateTime}&dateTo=\{dateTime}&subscriberIDs=\{integer}&taslIDs=\{integer} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/formManagement/forms?dateFrom=2021-07-01T15:45:13+03&dateTo=2021-07-10T15:45:13+037&subscriberIDs=1&taskIDs=1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

[
    \{
        "formID": integer,
        "urn": "string",
        "isArchived": boolean,
        "items": [
            \{
                "externalID": "string",
                "name": "string",
                "value": "string",
                "type": "string"
            }
        ],
        "creationDate": "dateTime",
        "subscriberID": integer,
        "taskID": integer,
        "formTemplateID": integer
    }
]

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

[
    \{
        "formID": 1,
        "urn": "rYgTsp",
        "isArchived": false,
        "items": [
            \{
                "externalID": "1",
                "name": "Доставка",
                "value": "Клиент принял заказ",
                "type": "Select"
            },
            \{
                "externalID": "2",
                "name": "Претензий нет",
                "value": "True",
                "type": "Boolean"
            },
            \{
                "externalID": "3",
                "name": "Заказ оплачен",
                "value": "True",
                "type": "Boolean"
                        }
        ],
        "creationDate": "2021-07-02T11:03:24.343+03:00",
        "subscriberID": 1
        "taskID": 1,
        "formTemplateID": 1
    },
    \{
        "formID": 17629,
        "urn": "rYgUZp",
        "isArchived": false,
        "items": [
            \{
                "externalID": "1",
                "name": "Доставка",
                "value": "Клиент принял заказ",
                "type": "Select"
            },
                        \{
                "externalID": "3",
                "name": "Заказ оплачен",
                "value": "True",
                "type": "Boolean"
            }
        ],
        "creationDate": "2021-07-06T10:36:53.51+03:00",
        "subscriberID": 2
        "taskID": 2,
        "formTemplateID": 2
    }
]

Получение заполненной формы

Общее описание

Функция GET /v6/api/formManagement/forms/{formID} позволяет получить заполненную форму по ее идентификатору.

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

В запросе используется обязательный параметр formID — ИД формы.

Результат выполнения

Функция возвращает массив структур со следующими параметрами заполненных форм:

Параметр	Описание
formID	ИД формы
urn	URN формы
isArchived	Является ли форма архивной. Существуют следующие значения: true — форма архивная; false — форма активная.
creationDate	Дата и время заполнения формы
subscriberID	ИД Сотрудника
taskID	ИД задачи
formTemplateID	ИД шаблона формы
Заполненные поля формы (items)
externalID	Внешний ИД поля шаблона
name	Название поля шаблона
value	Значение поля шаблона
type	Тип поля шаблона. Существуют следующие значения: string – строка; text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

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

GET /v6/api/formManagement/forms/\{formID} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/formManagement/forms/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

\{
    "formID": integer,
    "urn": "string",
    "isArchived": boolean,
    "items": [
        \{
            "externalID": "string",
            "name": "string",
            "value": "string",
            "type": "string"
        }
    ],
    "creationDate": "dateTime",
    "subscriberID": integer,
    "taskID": integer,
    "formTemplateID": integer
}

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

\{
    "formID": 1,
    "urn": "r3R9hp",
    "isArchived": false,
    "items": [
        \{
            "externalID": "1",
            "name": "Причина возврата",
            "value": "Трещина ",
            "type": "Text"
        },
        \{
            "externalID": "2",
            "name": "Вид возрата",
            "value": "Отказ от заказа",
            "type": "Select"
        },
        \{
            "externalID": "3",
            "name": "Фото брака (если возможно)",
            "value": "m4Zxk",
            "type": "Picture"
        }
    ],
    "creationDate": "2021-02-16T12:04:42.713+03:00",
    "subscriberID": 1,
    "taskID": 1,
    "formTemplateID": 1
}

Работа с формами

Содержание