API для работы с отзывами
/api/Comment/ListCommentsByBook
Получить отзывы по идентификатору книги
Тип HTTP запроса: post
Отсылаемы й запрос
MIME-тип HTTP запроса: application/json
Идентификатор книги
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Идентификатор | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | CommentResponse[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Comment/ApproveComment
Подтвердить отзыв
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор отзыва
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Идентификатор | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | boolean | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Comment/AddComment
Добавить отзыв
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Сущность отзыва
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| rating | integer (int32) | Рейтинг | нет | |
| text | string | Текст отзыва | нет | |
| title | string | Заголовок | нет | |
| userId | string (uuid) | Идентификатор пользователя, оставившего отзыв | нет | |
| bookId | string (uuid) | Идентификатор книги, на которую оставлен отзыв | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string (uuid) | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Comment/UpdateComment
Обновить отзыв
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Сущность отзыва
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Идентификатор отзыва | да | |
| rating | integer (int32) | Рейтинг | нет | |
| text | string | Текст отзыва | нет | |
| title | string | Заголовок | нет | |
| userId | string (uuid) | Идентификатор пользователя, оставившего отзыв | нет | |
| bookId | string (uuid) | Идентификатор книги, на которую оставлен отзыв | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Comment/DeleteComment
Удалить отзыв
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор отзыва
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Идентификатор | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | boolean | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden