knowledgebase.section.get
Scope:
knowledgebaseКто может вызывать: авторизованный пользователь; данные из
Post::getSectionInfo(). Подробнее: Права доступа
Раздел базы знаний по id
HTTP: GET
Побочные эффекты: none
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
id |
int |
да | ID раздела (алиас: sectionId) |
Возвращаемые данные
Ответ в конверте модуля: result.result — объект раздела; result.error.
Поля: id, name, parentId, left, right, depth, count.
Обработка ошибок
Справочник кодов: error-codes.md.
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
VALIDATION_ERROR |
Некорректные или неполные параметры |
SECTION_NOT_FOUND |
Раздел не найден |
INTERNAL_ERROR |
Внутренняя ошибка сервера |
Пример запроса (GET)
curl -G "https://{портал}/rest/{user_id}/{webhook_code}/knowledgebase.section.get.json" \
-H "Accept: application/json" \
--data-urlencode "id=12"
Пример ответа
{
"result": {
"result": {
"id": 96,
"name": "Регламенты и инструкции",
"parentId": 0,
"left": 1,
"right": 12,
"depth": 1,
"count": 0
},
"error": null
}
}
Пример ошибки
{
"result": {
"result": null,
"error": {
"code": "SECTION_NOT_FOUND",
"message": "Раздел не найден.",
"details": {
"id": 999999
}
}
}
}
См. также
Предыдущая
Следующая