workplaces.batch
Scope:
workplacesКто может вызывать: Авторизованный пользователь
До 50 вызовов за запрос. Вложенный batch запрещён. Ошибка одного call не отменяет остальные.
HTTP: POST
Побочные эффекты: Выполнение переданных методов
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
calls |
array |
да | [{ method, params }] — полное имя workplaces.* |
Возвращаемые данные
Массив ответов ApiResponse в result.result.
Обработка ошибок
Ответ в едином конверте модуля: result, total, next, error (внутри обёртки Bitrix REST — поле result). Справочник всех кодов: error-codes.md.
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
BATCH_LIMIT_EXCEEDED |
> 50 calls |
BATCH_INVALID_CALL |
Некорректный элемент calls |
BATCH_NESTED_NOT_ALLOWED |
Вложенный batch |
METHOD_NOT_FOUND |
Неизвестный method (в т.ч. workplaces.me) |
INTERNAL_ERROR |
Внутренняя ошибка |
Примеры кода
Пример запроса (POST)
curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/workplaces.batch.json" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"calls": [{"method": "workplaces.currentUser", "params": {}}, {"method": "workplaces.workplace.get", "params": {"id": 1234}}]}'
Пример ответа
{
"result": {
"result": [
{
"result": {
"id": 1,
"login": "admin",
"name": "Администратор",
"isSystemAdmin": true,
"isAdmin": true,
"isSecretary": true,
"offices": []
},
"total": 0,
"next": null,
"error": null
},
{
"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": ""
},
"total": 0,
"next": null,
"error": null
}
],
"next": null,
"error": null
},
"total": 2
}
Предыдущая
Следующая