ApiMainDataDescriptionIfForm » История » Редакция 4
« Предыдущее |
Редакция 4/7
(Разница(diff))
| Следующее »
Артем, 08.12.2017 16:57
Формат данных ifForm¶
ifTable содержит в себе элементы для создания формы выбора или ввода каких-данных посетителем сайта
Пример вывода¶
Описание возвращаемых данных¶
Массив ifForm состоит из четырех элементов:
1) format = ifForm
2) Массив значений fields, который содержит элементы формы. Каждый элемент, в свою очередь, массив из 4 элементов:
2.1) id - ID поля формы
2.2) name - заголовок поля формы
2.3) type - тип поля формы. На данный момент поддерживается два типа: selectable - выборка из нескольких значений и inputable - вводимое значение.
2.4) values - массив возможных значений. Каждый элемент массива - массив из двух или трех элементов: обязательных value - значение, name - название в локали каталога, и необязательного isSelected - маркера выбранного в текущий момент элемента (true или 1 - элемент выбран). Если поле типа inputable, то массив values содержит единственный элемент.
3) Массив parameters - одномерный массив, содержащий описание правил передачи в API данных из формы. Линейный массив, описывающий параметры формы. Состоит из элементов:
fpMethod - метод передачи параметров формы. На данный момент поддерживается только метод get
fpFormFieldsDelimeter - разделитель полей формы1
fpFormValuesDelimeter - разделитель названия параметра и его значения1
fpEncodeMethod - метод кодирования параметров формы при передаче2
formDataUrlParamName - имя параметра, через который передаются данные формы
4) Массив tableItemFormat, содержащий описание данных каждой из ячеек столбца таблицы. Каждый его элемент это массив, содержащий перечень рекомендуемых к отображению данных. В свою очередь состоит их двух элементов: type1 - тип и caption2.
1 Для ifTable на данный момент доступны 3 типа данных: ifText - простое текстовое поле, ifLink3 - ссылка и ifPartLink4 - номер з/ч, который необходимо преобразовать в ссылку на поисковую форму сайта.
2 Поле caption содержит html шаблон, в котором поля из values в шаблоне заключены в символы "{" и "}".
3 GET параметры для ссылки ifLink перечислены в поле urlParams массива values.
4 Поле caption для типа ifPartLink может содержать значения {number}, {newNumber}, {oldNumber}, {alternativeNumber}, {replaceNumber}
Пример возвращаемых данных¶
Обновлено Артем около 7 лет назад · 4 изменени(я, ий)