workplaces.city.add

Scope: workplaces

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

Создаёт раздел города (DEPTH_LEVEL=1).

HTTP: POST

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

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

Параметр Тип Обяз. Описание
name string да Название
active bool нет Активность раздела
sort int нет Сортировка, по умолчанию 500
code string нет Символьный код
color string нет Цвет (UF_COLOR)
iconSize string нет
departmentIds int[] нет UF_DEPARTMENT
sizeSvg string нет
patternSvg string нет
freeLimitGroupId int нет 0 — сброс
timeZoneId int нет Enum UF_TIME_ZONE
timeZoneXmlId string нет
importSvgBase64 string нет SVG base64, до 5 МБ
importSvgData string нет Сырой SVG или data URL
importSvgFileId int нет Привязать существующий файл

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

result.result: { "id": 101 }

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка
ACCESS_DENIED Нет прав на операцию или объект
VALIDATION_ERROR Пустое name; не указан или некорректен cityId / officeId
NOT_FOUND Родительский раздел (город/офис) не найден
INVALID_SVG SVG не прошёл проверку
FILE_TOO_LARGE Файл превышает лимит размера

Примеры кода

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/workplaces.city.add.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"name": "Москва", "active": true}'

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

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