workplaces.city.delete

Scope: workplaces

Кто может вызывать: Администратор модуля / портала

Удаляет город, если нет дочерних офисов.

HTTP: POST

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

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

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

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

result.result: { "id": 101 }

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка
VALIDATION_ERROR Параметр id не передан или ≤ 0
NOT_FOUND Раздел не найден или неверный уровень
CITY_HAS_OFFICES Есть дочерние офисы (details.officesCount)

Примеры кода

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/workplaces.city.delete.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"id": 101}'
        

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

{
          "result": {
            "result": {
              "id": 101
            },
            "next": null,
            "error": null
          },
          "total": 0
        }
        
Предыдущая
Следующая