workplaces.schema
Scope:
workplacesКто может вызывать: Авторизованный пользователь
Машиночитаемый список методов: scope, prefix, batchMaxCalls, methods[].
HTTP: GET
Побочные эффекты: none
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
| — | — | — | Нет параметров |
Возвращаемые данные
scope, prefix, batchMaxCalls, methods: method, http, controller, action
Обработка ошибок
Ответ в едином конверте модуля: result, total, next, error (внутри обёртки Bitrix REST — поле result). Справочник всех кодов: error-codes.md.
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
INTERNAL_ERROR |
Внутренняя ошибка |
Примеры кода
Пример запроса (GET)
curl -G "https://{портал}/rest/{user_id}/{webhook_code}/workplaces.schema.json" \
-H "Accept: application/json"
Пример ответа
{
"result": {
"result": {
"scope": "workplaces",
"prefix": "workplaces.",
"batchMaxCalls": 50,
"methods": [
{
"method": "workplaces.workplace.list",
"http": "GET",
"controller": "Workplace",
"action": "listAction"
}
]
},
"next": null,
"error": null
},
"total": 0
}
Предыдущая
Следующая