workplaces.workplace.get

Scope: workplaces

Кто может вызывать: Право чтения на элемент

Объект рабочего места:

  • id, active, name, roomId, typeId, type (xmlId)
  • linkedUserId, info (массив xmlId иконок), size, previewText
  • pathSvg, pathSvgPc

HTTP: GET

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

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

Параметр Тип Обяз. Описание
id int да ID места

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

Объект места в result.result.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка
VALIDATION_ERROR Параметр id не передан или ≤ 0
WORKPLACE_NOT_FOUND Рабочее место не найдено
ACCESS_DENIED Нет прав на операцию или объект

Примеры кода

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

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

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

{
          "result": {
            "result": {
              "id": 1234,
              "active": true,
              "name": "Место 1",
              "roomId": 110,
              "typeId": 168,
              "type": "with_PC",
              "linkedUserId": 1,
              "info": [
                "1",
                "3"
              ],
              "size": "800x600",
              "previewText": "",
              "pathSvg": "<path d=\"M331 346H367V368H331V346Z\"/>",
              "pathSvgPc": ""
            },
            "next": null,
            "error": null
          },
          "total": 0
        }
Предыдущая
workplaces.workplace.list
Следующая
workplaces.workplace.add