homepage.schema

Scope: homepage

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

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

Параметры не требуются.

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

  • 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.schema.json" \
          -H "Accept: application/json"

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

{
          "result": {
            "result": {
              "version": "1.0",
              "module": "ithive.homepage",
              "methods": [
                {
                  "method": "homepage.content.list",
                  "http": "GET"
                }
              ]
            },
            "next": null,
            "error": null
          },
          "total": null
        }

См. также

Предыдущая
homepage.currentUser
Следующая
homepage.batch