Формат данных 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 - разделитель полей формы¹

fpFormValuesDelimeter - разделитель названия параметра и его значения¹

fpEncodeMethod - метод кодирования параметров формы при передаче²

formDataUrlParamName - имя параметра, через который передаются данные формы

4) Массив tableItemFormat, содержащий описание данных каждой из ячеек столбца таблицы. Каждый его элемент это массив, содержащий перечень рекомендуемых к отображению данных. В свою очередь состоит их двух элементов: type¹ - тип и caption².

¹ Для ifTable на данный момент доступны 3 типа данных: ifText - простое текстовое поле, ifLink³ - ссылка и ifPartLink⁴ - номер з/ч, который необходимо преобразовать в ссылку на поисковую форму сайта.

² Поле caption содержит html шаблон, в котором поля из values в шаблоне заключены в символы "{" и "}".

³ GET параметры для ссылки ifLink перечислены в поле urlParams массива values.

⁴ Поле caption для типа ifPartLink может содержать значения {number}, {newNumber}, {oldNumber}, {alternativeNumber}, {replaceNumber}

Пример возвращаемых данных¶