workplaces.settings.options.get

Scope: workplaces

Кто может вызывать: Авторизованный пользователь

Только вкладка «Общие настройки»: common, messages, limits, default (26 ключей).

HTTP: GET

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

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

Параметр Тип Обяз. Описание
Нет параметров

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

Объект key → value в result.result.

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

Ответ в едином конверте модуля: result, total, next, error (внутри обёртки Bitrix REST — поле result). Справочник всех кодов: error-codes.md.

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

Примеры кода

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

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/workplaces.settings.options.get.json" \
          -H "Accept: application/json"
        

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

{
          "result": {
            "result": {
              "start_time": "09:00",
              "end_time": "18:00",
              "limit_per_week": "5",
              "limit_history": "30",
              "default_map_scale": "100"
            },
            "next": null,
            "error": null
          },
          "total": 0
        }