API для работы с книгами
/api/Book/ListBooks
Получить все книги
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметр пагинации (по умолчанию - пропустить 0 взять 50)
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| skip | integer (int32) | Пропускаемое количество элементов | нет | |
| take | integer (int32) | Получаемое количество элементов | нет | |
| orderParam | Order | |||
| genreParam | Genre |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | BookResponse[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Book/BooksCount
Получить колич ество всех книг
Тип HTTP запроса: post
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | integer (int32) | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Book/ListBooksWithAuthors
Получить все книги с их авторами
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Параметр пагинации (по умолчанию - пропустить 0 взять 50)
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| skip | integer (int32) | Пропускаемое количество элементов | нет | |
| take | integer (int32) | Получаемое количество элементов | нет | |
| orderParam | Order | |||
| genreParam | Genre |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | BookWithAuthorsResponse[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Book/FindBooksWithAuthors
Получить все книги с авторами по фильтру
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Фильтр для книг с авторами
| Назв ание поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| authorFilter | AuthorFilter | |||
| name | string | Название книги | нет | |
| keywords | string | Ключевые слова | нет | |
| annotation | string | Аннотация | нет | |
| rating | number (double) | Рейтинг | нет | |
| genre | Genre | |||
| status | Status | |||
| publicationYear | integer (int32) | Год публикации | нет | |
| pagination | SettingsRequest |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | BookWithAuthorsResponse[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Book/FindBooks
Получить все книги по фильтру
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Фильтр для книг
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Название книги | нет | |
| keywords | string | Ключевые слова | нет | |
| annotation | string | Аннотация | нет | |
| rating | number (double) | Рейтинг | нет | |
| genre | Genre | |||
| status | Status | |||
| publicationYear | integer (int32) | Год публикации | нет | |
| pagination | SettingsRequest |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | BookResponse[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Book/GetBookInfo
Получить книгу с авторами по идентификатору
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор книги
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Идентификатор | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | BookWithAuthorsResponse | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Book/GetArtBookInfo
Получить книгу жанра Художественная литература с авторами по идентификатору
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор книги
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Идентификатор | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ArtResponse | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Book/GetChildrenBookInfo
Получить детскую книгу с авторами по идентификатору
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор книги
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Идентификатор | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ChildrenBookResponse | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Book/GetScienceBookInfo
Получить научную книгу с авторами по ид ентификатору
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор книги
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Идентификатор | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ScienceResponse | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/api/Book/AddBook
Добавить книгу
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Сущность книги
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Название | нет | |
| file | string (uuid) | Идентификатор файла | нет | |
| image | string | Обложка | нет | |
| keywords | string | Ключевые слова | нет | |
| annotation | string | Аннотация | нет | |
| rating | number (double) | Рейтинг | нет | |
| genre | Genre | |||
| status | Status | |||
| publicationYear | integer (int32) | Год публикации | нет | |
| authorIds | 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/Book/AddArtBook
Добавить книгу жанра Художественная литература
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Сущность книги
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| series | string | Серия | нет | |
| name | string | Название | нет | |
| file | string (uuid) | Идентификатор файла | нет | |
| image | string | Обложка | нет | |
| keywords | string | Ключевые слова | нет | |
| annotation | string | Аннотация | нет | |
| rating | number (double) | Рейтинг | нет | |
| genre | Genre | |||
| status | Status | |||
| publicationYear | integer (int32) | Год публикации | нет | |
| authorIds | 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/Book/AddChildrenBook
Добавить детскую книгу
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Сущность книги
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| recommendedAge | integer (int32) | Рекомендованный возраст для прочтения | нет | |
| name | string | Название | нет | |
| file | string (uuid) | Идентификатор файла | нет | |
| image | string | Обложка | нет | |
| keywords | string | Ключевые слова | нет | |
| annotation | string | Аннотация | нет | |
| rating | number (double) | Рейтинг | нет | |
| genre | Genre | |||
| status | Status | |||
| publicationYear | integer (int32) | Год публикации | нет | |
| authorIds | 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/Book/AddScienceBook
Добавить научную книгу
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Сущность книги
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| discipline | string | Дисциплина | нет | |
| specialization | string | Специализация литературы | нет | |
| course | string | Курс | нет | |
| name | string | Название | нет | |
| file | string (uuid) | Идентификатор файла | нет | |
| image | string | Обложка | нет | |
| keywords | string | Ключевые слова | нет | |
| annotation | string | Аннотация | нет | |
| rating | number (double) | Рейтинг | нет | |
| genre | Genre | |||
| status | Status | |||
| publicationYear | integer (int32) | Год публикации | нет | |
| authorIds | 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/Book/UpdateBook
Обновить книгу
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Сущность книги
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Иденитфтикатор книги | да | |
| name | string | Название | нет | |
| file | string (uuid) | Идентификатор файла | нет | |
| image | string | Обложка | нет | |
| keywords | string | Ключевые слова | нет | |
| annotation | string | Аннотация | нет | |
| rating | number (double) | Рейтинг | нет | |
| genre | Genre | |||
| status | Status | |||
| publicationYear | integer (int32) | Год публикации | нет | |
| authorIds | 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/Book/UpdateArtBook
Обновить книгу жанра Художественная литература
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Сущность книги
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Иденитфтикатор книги | да | |
| series | string | Серия | нет | |
| name | string | Название | нет | |
| file | string (uuid) | Идентификатор файла | нет | |
| image | string | Обложка | нет | |
| keywords | string | Ключевые слова | нет | |
| annotation | string | Аннотация | нет | |
| rating | number (double) | Рейтинг | нет | |
| genre | Genre | |||
| status | Status | |||
| publicationYear | integer (int32) | Год публикации | нет | |
| authorIds | 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/Book/UpdateChildrenBook
Обновить детскую книгу
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Сущность книги
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Иденитфтикатор книги | да | |
| recommendedAge | integer (int32) | Рекомендованный возраст для прочтения | нет | |
| name | string | Название | нет | |
| file | string (uuid) | Идентификатор файла | нет | |
| image | string | Обложка | нет | |
| keywords | string | Ключевые слова | нет | |
| annotation | string | Аннотация | нет | |
| rating | number (double) | Рейтинг | нет | |
| genre | Genre | |||
| status | Status | |||
| publicationYear | integer (int32) | Год публикации | нет | |
| authorIds | 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/Book/UpdateScienceBook
Обновить научную книгу
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Сущность книги
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Иденитфтикатор книги | да | |
| discipline | string | Дисциплина | нет | |
| specialization | string | Специализация литературы | нет | |
| course | string | Курс | нет | |
| name | string | Название | нет | |
| file | string (uuid) | Идентификатор файла | нет | |
| image | string | Обложка | нет | |
| keywords | string | Ключевые слова | нет | |
| annotation | string | Аннотация | нет | |
| rating | number (double) | Рейтинг | нет | |
| genre | Genre | |||
| status | Status | |||
| publicationYear | integer (int32) | Год публикации | нет | |
| authorIds | 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/Book/DeleteBook
Удалить книгу
Т ип 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