# changeportaldefaultheme.mode.list

Scope: changeportaldefaultheme

Кто может вызывать: Любой авторизованный пользователь. Подробнее: Права доступа

Справочник значений режима управления модулем (module_mode)

HTTP: GET

Побочные эффекты: none

Параметр filter не поддерживается — только пагинация. Значение value используйте в theme.update / theme.reset для параметра module_mode.

Параметры методаПараметры метода

ПагинацияПагинация

limit (по умолчанию 50, максимум 500), offset, fetchAll (защитный лимит 5000, иначе FETCH_ALL_LIMIT_EXCEEDED).

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

Ответ в конверте модуля: result.result — массив {value, label}:

result.error; поле next в конверте ответа не возвращается, если следующей страницы нет. Общее число записей — в верхнеуровневом Bitrix total.

Обработка ошибокОбработка ошибок

Справочник кодов ошибок.

Пример запроса (GET)Пример запроса (GET)

Прогон на портале 76593.dev.wehive.digital, пользователь вебхука 1.

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/changeportaldefaultheme.mode.list.json" \
          -H "Accept: application/json" \
          --data-urlencode "limit=50" \
          --data-urlencode "offset=0"
        

Пример ответаПример ответа

{
          "result": {
            "result": [
              {
                "value": "N",
                "label": "Модуль включён"
              },
              {
                "value": "Y",
                "label": "Модуль выключен"
              }
            ],
            "error": null
          },
          "total": 2
        }
        

Пример ответа (ошибка)Пример ответа (ошибка)

limit=0:

{
          "result": {
            "result": null,
            "error": {
              "code": "INVALID_LIMIT",
              "message": "Параметр limit должен быть больше 0.",
              "details": null
            }
          }
        }
        

См. такжеСм. также

• changeportaldefaultheme.theme.update
• changeportaldefaultheme.version.list
• Коды ошибок