4.6.20 Получение списка пользовательских полей
POST /vpbx/custom-type/list
Метод позволяет получить список пользовательских полей кампании ИО на продукте.
Параметры запроса: пустой json.
Примечание. Согласно модели взаимодействия, в POST-запросах отправляются обязательные поля vpbx_api_key и sign.
Пример запроса:
POST https://app.mango-office.ru/vpbx/custom-type/list
vpbx_api_key = 1234567890qwerty,
sign = 1234567890qwerty,
json =
{}
В результате обработки запроса, формируются и передаются JSON-данные, содержащие следующие параметры:
| № | Параметры с уровнями вложенности | Параметры с уровнями вложенности | Параметры с уровнями вложенности | Тип | Обяза-тель-ный | Описание |
|---|---|---|---|---|---|---|
| № | 1 | 2 | 3 | Тип | Обяза-тель-ный | Описание |
| 1 | status | Число | Да | Код результата | ||
| 2 | result [] | Массив объектов | Да | |||
| 2.1 | id | Число | Да | ID пользовательского поля | ||
| 2.2 | order | Число | Да | Порядковый номер пользовательского поля | ||
| 2.3 | name | Строка | Да | Наименование пользовательского поля | ||
| 2.4 | field_type | Строка | Да | Тип пользовательского поля (input_field, enum, multi_enum, address, int, money,,date, check_box, url, text, point_member) | ||
| 2.5 | props | Строка | Нет | Дополнительные параметры пользовательских полей | ||
| show_master_io | Булево | Нет | Показывать в карточке обращения | |||
| show_member | Булево | Нет | Показывать в мастере создания компании |
Пример ответа:
[
{
"result": {
"id": 5908,
"order": 1,
"name": "Город",
"field_type": "text",
"props": {
"show_master_io": true,
"show_member": true
}
}
},
{
"id": 5915,
"order": 3,
"name": "Должность",
"field_type": "text",
"props": {
"show_master_io": false,
"show_member": false
}
},
"status",
": 200"
]