workplaces.reservation.get

Scope: workplaces

Кто может вызывать: Владелец, админ или секретарь офиса

Объект бронирования:

  • id, userId, workplaceId, dateFrom, dateTo, active
  • typeOfReservationId, reservationType (xmlId)
  • dateConfirmed, dateCanceled, cancelTypeId, createdBy, workplaceName

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
RESERVATION_NOT_FOUND Бронирование не найдено
ACCESS_DENIED Нет прав на операцию или объект

Примеры кода

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

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

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

{
          "result": {
            "result": {
              "id": 10,
              "userId": 1,
              "workplaceId": 1234,
              "dateFrom": "2026-06-09 10:00:00",
              "dateTo": "2026-06-09 18:00:00",
              "active": true,
              "typeOfReservationId": 60,
              "reservationType": "workDay",
              "dateConfirmed": null,
              "dateCanceled": null,
              "cancelTypeId": null,
              "createdBy": 1,
              "workplaceName": "Место 1"
            },
            "next": null,
            "error": null
          },
          "total": 0
        }
        
Предыдущая
Следующая