# changeportaldefaultheme.theme.get

Scope: changeportaldefaultheme

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

Получить текущие настройки темы для сайта (группы опций, файлы, флаги модуля)

HTTP: GET

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

Пустые группы OPTION_GROUPS сериализуются как JSON-массив [] (не объект). Непустые группы — объект {ключ: значение}. Ключ files присутствует только если загружены изображения.

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

Параметр Тип Обяз. Описание
siteId string нет ID сайта. По умолчанию — сайт по умолчанию (CSite::GetDefSite())

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

Ответ в конверте модуля: result.result — объект настроек:

Ключ Описание
module_mode, module_admin, module_forbid_theme Флаги модуля (Y / N). Допустимые значения module_modemode.list
auth, noauth, auth_zephir, noauth_zephir, auth_main Группы LESS-опций: [] если пусто, иначе объект ключ → значение (input-@…, settings-@…, instruction-*)
files Опционально: объект file-@… / favicon-@…fileId (int)

result.error. Ключи total/next для методов, не возвращающих список, в сериализации отсутствуют.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
SITE_NOT_FOUND Сайт с указанным siteId не найден
INTERNAL_ERROR Внутренняя ошибка сервера

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

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

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/changeportaldefaultheme.theme.get.json" \
          -H "Accept: application/json" \
          --data-urlencode "siteId=s1"
        

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

{
          "result": {
            "result": {
              "auth": [],
              "noauth": [],
              "auth_zephir": [],
              "noauth_zephir": [],
              "auth_main": [],
              "module_mode": "N",
              "module_admin": "Y",
              "module_forbid_theme": "N"
            },
            "error": null
          }
        }
        

После загрузки изображений в ответе появляется files, например:

"files": {
          "file-@client_logo": 1218
        }
        

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

siteId=invalid_site_xyz:

{
          "result": {
            "result": null,
            "error": {
              "code": "SITE_NOT_FOUND",
              "message": "Сайт не найден.",
              "details": {
                "siteId": "invalid_site_xyz"
              }
            }
          }
        }
        

См. также