workplaces.workplace.type.list
Scope:
workplacesКто может вызывать: Авторизованный пользователь
Enum TYPE_OF_WORKPLACE: id, xmlId, value, sort, isDefault.
HTTP: GET
Побочные эффекты: none
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
| — | — | — | Нет параметров |
Возвращаемые данные
Массив типов в result.result.
Обработка ошибок
Ответ в едином конверте модуля: result, total, next, error (внутри обёртки Bitrix REST — поле result). Справочник всех кодов: error-codes.md.
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
INTERNAL_ERROR |
Внутренняя ошибка |
Примеры кода
Пример запроса (GET)
curl -G "https://{портал}/rest/{user_id}/{webhook_code}/workplaces.workplace.type.list.json" \
-H "Accept: application/json"
Пример ответа
{
"result": {
"result": [
{
"id": 168,
"xmlId": "with_PC",
"value": "С ПК",
"sort": 10,
"isDefault": false
},
{
"id": 169,
"xmlId": "without_PC",
"value": "Без ПК",
"sort": 20,
"isDefault": false
}
],
"next": null,
"error": null
},
"total": 2
}
Предыдущая
Следующая