ApiMainDataDescriptionIfForm » История » Редакция 4
Редакция 3 (Артем, 08.12.2017 16:21) → Редакция 4/7 (Артем, 08.12.2017 16:57)
h1. Формат данных ifForm ifTable содержит в себе элементы для создания формы выбора или ввода каких-данных посетителем сайта --- h2. Пример вывода --- !https://static.ilcats.ru/images/helpsystem/catalogsApi/apiHelpExampleIfFormFieldsHtml.png! --- h2. Описание возвращаемых данных --- Массив *ifForm* состоит из четырех элементов: p(. 1) *format = ifForm* p(. 2) Массив значений *fields*, который содержит элементы формы. Каждый элемент, в свою очередь, массив из 4 элементов: p((. 2.1) p(.2.1) *id* - ID поля формы p((. 2.2) *name* - заголовок поля формы p((. 2.3) *type* - тип поля формы. На данный момент поддерживается два типа: *selectable* - выборка из нескольких значений и *inputable* - вводимое значение. p((. 2.4) *values* - массив возможных значений. Каждый элемент массива - массив из двух или трех элементов: обязательных *value* - значение, *name* - название в локали каталога, и необязательного *isSelected* - маркера выбранного в текущий момент элемента (*true* или *1* - элемент выбран). Если поле типа *inputable*, то массив *values* содержит единственный элемент. p(. 3) Массив *parameters* *tableColumnHeaders* - одномерный массив, содержащий описание правил передачи названия столбцов таблицы в API данных из формы. Линейный массив, описывающий параметры формы. Состоит из элементов: p((. *fpMethod* - метод передачи параметров формы. На данный момент поддерживается только метод *get* p((. *fpFormFieldsDelimeter* - разделитель полей формы[1] p((. *fpFormValuesDelimeter* - разделитель названия параметра и его значения[1] p((. *fpEncodeMethod* - метод кодирования параметров формы при передаче[2] p((. *formDataUrlParamName* - имя параметра, через который передаются данные формы локали запроса. 4) Массив *tableItemFormat*, содержащий описание данных каждой из ячеек столбца таблицы. Каждый его элемент это массив, содержащий перечень _*рекомендуемых*_ к отображению данных. В свою очередь состоит их двух элементов: *type[1]* - тип и *caption[2]*. fn1. Для *ifTable* на данный момент доступны 3 типа данных: *ifText* - простое текстовое поле, *ifLink[3]* - ссылка и *ifPartLink[4]* - номер з/ч, который необходимо преобразовать в ссылку на поисковую форму сайта. fn2. Поле *caption* содержит html шаблон, в котором поля из *values* в шаблоне заключены в символы "{" и "}". fn3. GET параметры для ссылки *ifLink* перечислены в поле *urlParams* массива *values*. fn4. Поле *caption* для типа *ifPartLink* может содержать значения {number}, {newNumber}, {oldNumber}, {alternativeNumber}, {replaceNumber} --- h2. Пример возвращаемых данных --- !https://static.ilcats.ru/images/helpsystem/catalogsApi/apiHelpExampleIfFormFields.png!