workplaces.city.list

Scope: workplaces

Кто может вызывать: Авторизованный пользователь с правом чтения (R) на раздел

Возвращает список разделов уровня 1 (DEPTH_LEVEL=1). После выборки фильтруется по правам чтения на каждый раздел.

Объект раздела (город / офис / комната):

id, name, active, sort, depthLevel, parentId
code, color, iconSize, departmentIds, sizeSvg, patternSvg
freeLimitGroupId, importSvgFileId, importSvgUrl, timeZone (id, xmlId, value)

HTTP: GET

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

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

Параметр	Тип	Обяз.	Описание
`limit`	`int`	нет	Размер страницы, по умолчанию 50, максимум 500
`offset`	`int`	нет	Смещение, по умолчанию 0
`fetchAll`	`bool`	нет	Если `true` — вернуть все записи (лимит `rest_fetch_all_max`, по умолчанию 5000)
`filter`	`object`	нет	Mongo-фильтр: `$eq`, `$gte`, `$in` и др. (см. Обзор)
`filter`	`object`	нет	Поля: ID, NAME, ACTIVE

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

Массив объектов раздела в result.result, total, next.

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

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

Код	Описание
`UNAUTHORIZED`	Пользователь не авторизован
`INVALID_LIMIT`	limit < 1 или > 500
`INVALID_OFFSET`	offset < 0
`INVALID_FILTER`	Некорректный filter
`INVALID_FILTER_OPERATOR`	Неизвестный оператор в filter
`FETCH_ALL_LIMIT_EXCEEDED`	Слишком много записей для fetchAll
`INTERNAL_ERROR`	Внутренняя ошибка

Примеры кода

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

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/workplaces.city.list.json?limit=50" \
          -H "Accept: application/json"

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

{
          "result": {
            "result": [
              {
                "id": 101,
                "name": "Москва",
                "active": true,
                "sort": 500,
                "depthLevel": 1,
                "parentId": null,
                "code": "city_sample"
              }
            ],
            "next": null,
            "error": null
          },
          "total": 1
        }