workplaces.currentUser

Scope: workplaces

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

id, login, name, флаги isSystemAdmin/isAdmin/isSecretary, offices[] с role (admin|secretary|user). Метод workplaces.me удалён.

HTTP: GET

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

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

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

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

Объект пользователя в 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.currentUser.json" \
          -H "Accept: application/json"
        

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

{
          "result": {
            "result": {
              "id": 1,
              "login": "admin",
              "name": "Администратор",
              "isSystemAdmin": true,
              "isAdmin": true,
              "isSecretary": true,
              "offices": [
                {
                  "officeId": 108,
                  "name": "Офис K1",
                  "cityId": 101,
                  "role": "admin"
                }
              ]
            },
            "next": null,
            "error": null
          },
          "total": 0
        }
        

См. также

Предыдущая
Следующая