ApiMainDataDescriptionIfForm » История » Версия 4
Артем, 08.12.2017 16:57
| 1 | 1 | Артем | h1. Формат данных ifForm |
|---|---|---|---|
| 2 | |||
| 3 | ifTable содержит в себе элементы для создания формы выбора или ввода каких-данных посетителем сайта |
||
| 4 | |||
| 5 | --- |
||
| 6 | |||
| 7 | h2. Пример вывода |
||
| 8 | |||
| 9 | --- |
||
| 10 | |||
| 11 | 2 | Артем | !https://static.ilcats.ru/images/helpsystem/catalogsApi/apiHelpExampleIfFormFieldsHtml.png! |
| 12 | 1 | Артем | |
| 13 | --- |
||
| 14 | |||
| 15 | h2. Описание возвращаемых данных |
||
| 16 | |||
| 17 | --- |
||
| 18 | |||
| 19 | 3 | Артем | Массив *ifForm* состоит из четырех элементов: |
| 20 | 1 | Артем | |
| 21 | 4 | Артем | p(. 1) *format = ifForm* |
| 22 | |||
| 23 | p(. 2) Массив значений *fields*, который содержит элементы формы. Каждый элемент, в свою очередь, массив из 4 элементов: |
||
| 24 | |||
| 25 | p((. 2.1) *id* - ID поля формы |
||
| 26 | |||
| 27 | p((. 2.2) *name* - заголовок поля формы |
||
| 28 | |||
| 29 | p((. 2.3) *type* - тип поля формы. На данный момент поддерживается два типа: *selectable* - выборка из нескольких значений и *inputable* - вводимое значение. |
||
| 30 | |||
| 31 | p((. 2.4) *values* - массив возможных значений. Каждый элемент массива - массив из двух или трех элементов: обязательных *value* - значение, *name* - название в локали каталога, и необязательного *isSelected* - маркера выбранного в текущий момент элемента (*true* или *1* - элемент выбран). Если поле типа *inputable*, то массив *values* содержит единственный элемент. |
||
| 32 | 1 | Артем | |
| 33 | 4 | Артем | p(. 3) Массив *parameters* - одномерный массив, содержащий описание правил передачи в API данных из формы. Линейный массив, описывающий параметры формы. Состоит из элементов: |
| 34 | |||
| 35 | p((. *fpMethod* - метод передачи параметров формы. На данный момент поддерживается только метод *get* |
||
| 36 | |||
| 37 | p((. *fpFormFieldsDelimeter* - разделитель полей формы[1] |
||
| 38 | |||
| 39 | p((. *fpFormValuesDelimeter* - разделитель названия параметра и его значения[1] |
||
| 40 | |||
| 41 | p((. *fpEncodeMethod* - метод кодирования параметров формы при передаче[2] |
||
| 42 | |||
| 43 | p((. *formDataUrlParamName* - имя параметра, через который передаются данные формы |
||
| 44 | |||
| 45 | |||
| 46 | 1 | Артем | 4) Массив *tableItemFormat*, содержащий описание данных каждой из ячеек столбца таблицы. Каждый его элемент это массив, содержащий перечень _*рекомендуемых*_ к отображению данных. В свою очередь состоит их двух элементов: *type[1]* - тип и *caption[2]*. |
| 47 | |||
| 48 | fn1. Для *ifTable* на данный момент доступны 3 типа данных: *ifText* - простое текстовое поле, *ifLink[3]* - ссылка и *ifPartLink[4]* - номер з/ч, который необходимо преобразовать в ссылку на поисковую форму сайта. |
||
| 49 | |||
| 50 | fn2. Поле *caption* содержит html шаблон, в котором поля из *values* в шаблоне заключены в символы "{" и "}". |
||
| 51 | |||
| 52 | fn3. GET параметры для ссылки *ifLink* перечислены в поле *urlParams* массива *values*. |
||
| 53 | |||
| 54 | fn4. Поле *caption* для типа *ifPartLink* может содержать значения {number}, {newNumber}, {oldNumber}, {alternativeNumber}, {replaceNumber} |
||
| 55 | |||
| 56 | --- |
||
| 57 | |||
| 58 | h2. Пример возвращаемых данных |
||
| 59 | |||
| 60 | --- |
||
| 61 | |||
| 62 | |||
| 63 | 2 | Артем | !https://static.ilcats.ru/images/helpsystem/catalogsApi/apiHelpExampleIfFormFields.png! |