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
• страница: 6 из 8

Добавление раздела ИБ

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

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

IBLOCK_ID/IBLOCK_CODE	ID ИБ или код
FIELDS	Массив полей для добавления раздела

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

FIELDS – Массив полей для создания раздела в выбранном инфоблоке. Могут быть следующие поля:

CODE – строка.

NAME – строка. Обязательное поле

DESCRIPTION – текст

DESCRIPTION_TYPE –html/text

IBLOCK_SECTION_ID – число. ID родительского раздела

ACTIVE – Y/N

SORT - число

Так же могут быть добавлены пользовательские поля, если они есть у разделов выбранного инфоблока

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

{

ID – ID созданного раздела

}

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

Запрос:

/ symmetron.iblock.section. add /?IBLOCK_ID=4&FIELDS[NAME]=Тестовый раздел&FIELDS[CODE]=test-section&FIELDS[IBLOCK_SECTION_ID]=16&FIELDS[ACTIVE]=Y

{

ID: 25

}

Изменение разделов ИБ

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

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

ID	ID раздела для изменения
FIELDS	Массив полей для добавления раздела

FIELDS – Массив полей для изменения раздела в выбранном ИБ. Могут быть следующие поля:

CODE – строка.

NAME – строка. Обязательное поле

DESCRIPTION – текст

DESCRIPTION_TYPE –html/text

IBLOCK_SECTION_ID – число. ID родительского раздела

ACTIVE – Y/N

SORT - число

Так же могут быть добавлены пользовательские поля, если они есть у разделов выбранного ИБ

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

{

True – успех изменения

}

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

Запрос:

/ symmetron.iblock.section. update /?ID=4&FIELDS[NAME]=Тестовый раздел&FIELDS[CODE]=test-section&FIELDS[IBLOCK_SECTION_ID]=16&FIELDS[ACTIVE]=Y

{

true

}

Удаление раздела ИБ

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

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

ID	ID раздела для изменения

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

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

Запрос:

/ symmetron.iblock.section.delete /?ID=4

{

true

}

Деактивация разделов каталога с подсчетом количества элементов

Эндпоинт метода: symmetron.iblock.section.deactivation

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

IBLOCK_ID/IBLOCK_CODE	ID ИБ или код
ID	ID раздела ИБ
CHECK_AMOUNT	True/false

CHECK_AMOUNT – если передается true, то необходимо проверить количество элементов в указанном разделе и если оно равно 0, то деактивировать раздел

Если CHECK_AMOUNT не передается или равно false, то раздел просто деактивируется по ID

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

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

Запрос:

/ symmetron.iblock.section.deactivation /?IBLOCK_ID=4&ID=123&CHECK_AMOUNT=true