DAX-БУС. Обмен. V2.0. Техническое задание на расширения RestApi в Битрикс Управление Сайтом. 4 Общая информация 4 Модуль symmetron restapi 5

• Название: Техническое задание на расширения RestApi в Битрикс Управление Сайтом. 4 Общая информация 4 Модуль symmetron restapi 5
• Дата: 29.01.2022
• Размер: 74.23 Kb.
• Имя файла: DAX-БУС. Обмен. V2.0.docx
• Тип: Техническое задание; #345558
• страница: 8 из 8

Получение элементов ИБ

Эндпоинт метода: symmetron.iblock.element.list

Входные параметры:

IBLOCK_ID/IBLOCK_CODE	ID ИБ или код
FILTER	Массив полей с значениями для фильтрации
SELECT	Массив полей для возвращаемых данных

В случае если в разделе есть свойства, то они так же должны быть возвращены в ответе. Если передается PROPERTY_* в массиве SELECT, то должны быть возвращены все поля. Если указаны коды конкретных или свойств полей, то только указанные поля.

В случае, если ИБ является товарным каталогом, то дополнительно должны выводится следующие поля:

Возвращаемые данные:

{

0:{

FIELDS:{

NAME: ЗНАЧЕНИ

PREVIEW_TEXT: ЗНАЧЕНИЕ

PREVIEW_TEXT_TYPE: ЗНАЧЕНИЕ

См струткуру полей Элемента ИБ

},

PROPERTIES:{

КОД_СВОЙСТВА: ЗНАЧЕНИЕ

},

CATALOG_FIELDS: {

См структуру полей для ИБ с возможностью торгового каталога

}

PRICE:{

Массив данных о цене

}
}

}

Пример для сайта symmetron.ru

Запрос:

/ symmetron.iblock.element.list/?IBLOCK_ ID=4

{

0:{

FIELDS:{

ID: 123456

NAME: PCF8571P NXP

PREVIEW_TEXT: Микросхема PCF8571P NXP

PREVIEW_TEXT_TYPE: text

PREVIEW_TEXT _TYPE: text

DETAIL_TEXT:

DETAIL_TEXT _TYPE: text

IBLOCK_SECTION_I: 182

ACTIVE: Y

SORT: 500

CREATED_BY: 0

DATE_CREATE: 14.07.2018 21:53:20

},

PROPERTIES:{

ARTICLE: PCF8571P

PRODUCERID : 332313

ACTIVE_STATUS: Нет в наличии

},

CATALOG_FIELDS: {

QUANTITY: 0

QUANTITY_RESERVED: 0

}

PRICE:{

ID: 123456,

PRODUCT_ID:123456,

CATALOG_GROUP_ID: 1,

PRICE:168.86,

CURRENCY:RUB,

QUANTITY_FROM:1,

QUANTITY_TO:0,

BASE:Y,

SORT:100,

CATALOG_GROUP_NAME:Цена,

CAN_ACCESS:Y,

CAN_BUY:Y

}

},

}

Получение элемента ИБ

Эндпоинт метода: symmetron.iblock.element.get

IBLOCK_ID/IBLOCK_CODE	ID ИБ или код
ID/CODE	ID элемента инфоблока/Код элемента Инфоблока

В данном случае может применяться любой из двух параметров для определения элемента ИБ (CODE или ID). В случае, если в запросе указаны оба параметра, то в приоритете ID

В случае если в элементе есть свойства, то они так же должны быть возвращены в ответе

Возвращаемые данные:

{

FIELDS:{

NAME: ЗНАЧЕНИЕ

PREVIEW_TEXT: ЗНАЧЕНИЕ

PREVIEW_TEXT_TYPE: ЗНАЧЕНИЕ

См структуру полей Элемента ИБ

},

PROPERTIES:{

КОД_СВОЙСТВА: ЗНАЧЕНИЕ

},

CATALOG_FIELDS: {

См структуру полей для ИБ с возможностью торгового каталога

}

PRICE:{

См структуру полей о цене

}

}

Пример для сайта symmetron.ru

Запрос:

/symmetron.iblock.element.get/?IBLOCK_ ID=4&ID=123456

{
FIELDS:{

ID: 123456

NAME: PCF8571P NXP

PREVIEW_TEXT: Микросхема PCF8571P NXP

PREVIEW_TEXT_TYPE: text

PREVIEW_TEXT _TYPE: text

DETAIL_TEXT:

DETAIL_TEXT _TYPE: text

IBLOCK_SECTION_ID: 182

ACTIVE: Y

SORT: 500

CREATED_BY: 0

DATE_CREATE: 14.07.2018 21:53:20

},

PROPERTIES:{

ARTICLE: PCF8571P

PRODUCERID : 332313

ACTIVE_STATUS: Нет в наличии

},

CATALOG_FIELDS: {

QUANTITY: 0

QUANTITY_RESERVED: 0

}

PRICE:{

{

ID: 123456,

PRODUCT_ID:123456,

CATALOG_GROUP_ID: 1,

PRICE:168.86,

CURRENCY:RUB,

QUANTITY_FROM:1,

QUANTITY_TO:0,

BASE:Y,

SORT:100,

CATALOG_GROUP_NAME:Цена,

CAN_ACCESS:Y,

CAN_BUY:Y

},

}

}

Добавление элемента ИБ

Эндпоинт метода: symmetron.iblock.element.add

Входные параметры:

IBLOCK_ID/IBLOCK_CODE	ID ИБ или код
FIELDS	Массив полей для добавления элемента ИБ.
PROPERTIES	Массив свойств для элемента ИБ.
CATALOG_FIELDS	Массив свойств, если ИБ является каталогом
PRICE	Массив цен

В случае, если при создании элемента инфоблока в массиве полей не передаются данные для поля «символьный код», то данное поле должно быть заполнено в соответствии с настройками ИБ в системе

Возвращаемые данные:

{

ID – ID созданного элемента ИБ

}
Пример для сайта symmetron.ru

Запрос:

/symmetron.iblock.element.add/?IBLOCK_ ID=4& FIELDS[NAME]= PCF8571P NXP&PROPERTIES[ARTICLE]= PCF8571P& PROPERTIES[PRODUCERID]=332313&CATALOG_FIELDS[QUANTITY]=25&PRICE[0][PRICE]=168.76 PRICE[0][CURRENCY]=RUB

{

ID:123456

}

Изменение элемента ИБ

Эндпоинт метода: symmetron.iblock.element.update

Входные параметры:

IBLOCK_ID/IBLOCK_CODE	ID ИБ или код
ID	ID элемента ИБ
FIELDS	Массив полей для добавления элемента ИБ.
PROPERTIES	Массив свойств для элемента ИБ.
CATALOG_FIELDS	Массив свойств, если ИБ является каталогом
PRICE	Массив цен

В массиве полей передаются только те данные, которые нужно изменить

Возвращаемые данные:

{

true

}
Пример для сайта symmetron.ru

Запрос:

/symmetron.iblock.element.update/? ID=123456

{

true

}

Удаление элемента ИБ

Эндпоинт метода: symmetron.iblock.element.delete

Входные параметры:

ID	ID элемента ИБ для удаления

Возвращаемые данные: true

Пример для сайта symmetron.ru

Запрос:

/ symmetron.iblock.element. delete /?ID=123456

{

true

}

Обновление элементов инфоблока по коду из учетной системы

Эндпоинт метода: symmetron.iblock.element.renew

Входные параметры:

ELEMENTS	Массив объектов для обновления данных
IBLOCK_ID/IBLOCK_CODE	ID ИБ или код
UNIQUE_FIELD_CODE	Код поля для поиска объектов для обновления из учетной системы.

Массив ELEMENTS содержит набор полей аналогичный методу symmetron.iblock.element.update.

Код поля, по которому будет производится поиск дубликатов передается в параметре запроса UNIQUE_FIELD_CODE.

Если совпадения найдены, то данные элементы должны быть обновлены данными из соответствующего объекта в массиве ELEMENTS.

Если совладения не найдены, то необходимо создать соответствующие элементы.

Возвращаемые данные:

ADDED:{

0: {

Код поля уникального идентификатора из УС: значение,

ID: значение,

},

1: {

Код поля уникального идентификатора из УС: значение,

ID: значение,

},

},

UPDATED:{

0: {

Код поля уникального идентификатора из УС: значение,

ID: значение,

UPDATE_STATUS: true

},

1: {

Код поля уникального идентификатора из УС: значение,

ID: значение,

,

UPDATE_STATUS: false

},

},
}