workplaces.office.get

Scope: workplaces

Кто может вызывать: Авторизованный пользователь с правом чтения (R) на раздел

Возвращает один раздел по id.

Объект раздела (город / офис / комната):

• id, name, active, sort, depthLevel, parentId
• code, color, iconSize, departmentIds, sizeSvg, patternSvg
• freeLimitGroupId, importSvgFileId, importSvgUrl, timeZone (id, xmlId, value)

HTTP: GET

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

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

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

Объект раздела в result.result.

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

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

Примеры кодаПримеры кода

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

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/workplaces.office.get.json?id=101" \
          -H "Accept: application/json"
        

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

{
          "result": {
            "result": {
              "id": 108,
              "name": "Офис K1",
              "active": true,
              "sort": 500,
              "depthLevel": 2,
              "parentId": 101,
              "code": "office_sample"
            },
            "next": null,
            "error": null
          },
          "total": 0
        }