library.review.get
Scope:
libraryКто может вызывать: Сотрудник.
Отзыв по ID: HL-запись и текст из сообщения форума (id, bookId, userId, rating, text).
HTTP: GET
Побочные эффекты: none
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
id |
int |
да | ID отзыва |
Возвращаемые данные
Объект отзыва в result.result:
| Поле | Тип | Описание |
|---|---|---|
id |
int |
ID записи HL |
bookId |
int |
ID книги |
userId |
int |
ID автора отзыва |
rating |
float |
Оценка |
text |
string |
Текст (HTML, whitelist) |
Обработка ошибок
Справочник кодов: error-codes.md.
| Код | Описание |
|---|---|
NOT_FOUND |
Отзыв не найден или книга не из каталога библиотеки (details.id) |
VALIDATION_ERROR |
Не указан или некорректен id (details.field) |
UNAUTHORIZED |
Пользователь не авторизован |
ACCESS_DENIED |
Нет доступа к библиотеке |
Пример запроса (GET)
curl -G "https://76590.dev.wehive.digital/rest/1/{webhook_code}/library.review.get.json" --data-urlencode "id=12"
Пример ответа
{
"result": {
"result": {
"id": 12,
"bookId": 1177,
"userId": 1,
"rating": 5,
"text": "<p>Отзыв REST docs</p>"
},
"error": null
}
}
См. также
Предыдущая
Следующая