workplaces.reservation.cancel

Scope: workplaces

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

Деактивация (UF_ACTIVE=0), тип и причина отмены.

HTTP: POST

Побочные эффекты: Смена статуса брони, запись причины отмены

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

Параметр Тип Обяз. Описание
id int да
cancelType string нет xmlId: employee, manager, unlimited, auto; по умолчанию auto
type string нет Синоним cancelType
reasonId int нет
otherReason string нет

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

result.result: { "id": 10 }

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

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

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

Примеры кода

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/workplaces.reservation.cancel.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"id": 10, "cancelType": "employee"}'
        

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

{
          "result": {
            "result": true,
            "next": null,
            "error": null
          },
          "total": 0
        }