workplaces.workplace.list

Scope: workplaces

Кто может вызывать: Авторизованный пользователь; после выборки — фильтр по правам чтения на элемент

Список элементов инфоблока (рабочие места).

Объект рабочего места:

id, active, name, roomId, typeId, type (xmlId)
linkedUserId, info (массив xmlId иконок), size, previewText
pathSvg, pathSvgPc

filter (Mongo): ID, NAME, TYPE_OF_WORKPLACE, LINKED_USER, ROOM_ID

Ярлыки: roomId, type (xmlId), linkedUser, active

HTTP: GET

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

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

Параметр	Тип	Обяз.	Описание
`limit`	`int`	нет	Размер страницы, по умолчанию 50, максимум 500
`offset`	`int`	нет	Смещение, по умолчанию 0
`fetchAll`	`bool`	нет	Если `true` — вернуть все записи (лимит `rest_fetch_all_max`, по умолчанию 5000)
`filter`	`object`	нет	Mongo-фильтр: `$eq`, `$gte`, `$in` и др. (см. Обзор)
`roomId`	`int`	нет	Раздел комнаты
`type`	`string`	нет	xmlId типа (with_PC, meeting, …)
`linkedUser`	`int`	нет	Закреплённый пользователь
`active`	`bool`	нет	true — только ACTIVE=Y

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

Массив мест в 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`	Внутренняя ошибка
`USER_NOT_FOUND`	linkedUser не найден

Примеры кода

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

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

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

{
          "result": {
            "result": [
              {
                "id": 1234,
                "active": true,
                "name": "Место 1",
                "roomId": 110,
                "typeId": 168,
                "type": "with_PC",
                "linkedUserId": 1,
                "info": [
                  "1",
                  "3"
                ],
                "size": "800x600",
                "previewText": "",
                "pathSvg": "<path d=\"M331 346H367V368H331V346Z\"/>",
                "pathSvgPc": ""
              }
            ],
            "next": null,
            "error": null
          },
          "total": 1
        }