homepage.config.get

Scope: homepage

Кто может вызывать: Авторизованный пользователь
Описание метода см. в разделе соответствующей подсистемы.
HTTP: GET
Побочные эффекты: нет

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

Параметр Тип Обяз. Описание
siteId string нет Код сайта.

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

  • result - результат операции (object или true).
  • total, next - null.
  • error - null при успехе.

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
ACCESS_DENIED Недостаточно прав для вызова метода
VALIDATION_ERROR Некорректные или отсутствующие параметры запроса
INTERNAL_ERROR Внутренняя ошибка сервиса

Примеры кода

Пример запроса

curl -G "https://{portal}/rest/{user_id}/{webhook_code}/homepage.config.get.json" \
          -H "Accept: application/json"

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

{
          "result": {
            "result": {
              "id": 123,
              "name": "Entity"
            },
            "next": null,
            "error": null
          },
          "total": null
        }

См. также

Предыдущая
Обзор раздела
Следующая
homepage.config.update