Типы данных
ASE.MD.Platform.Base.Error.ErrorTypes
Базовый тип перечисления: string Возможные значения: None, Error, Auth, Exception
ASE.MD.Platform.Base.Error.Info
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
ASE.MD.Platform.Base.Error.InnerInfo
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| exceptionType | string | Тип исключения. | нет | |
| message | string | Сообщение исключения. | нет |
ASE.MD.Platform.Utils.ModelsBase.ApiResults.ApiResult`1[LibraryService.Models.OutputModel.ArtResponse]
Тип: object
| Название поля | Тип п оля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ArtResponse | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Utils.ModelsBase.ApiResults.ApiResult`1[LibraryService.Models.OutputModel.AuthorWithBookResponse]
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | AuthorWithBookResponse | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Utils.ModelsBase.ApiResults.ApiResult`1[LibraryService.Models.OutputModel.BookWithAuthorsResponse]
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | BookWithAuthorsResponse | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Utils.ModelsBase.ApiResults.ApiResult`1[LibraryService.Models.OutputModel.ChildrenBookResponse]
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ChildrenBookResponse | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Utils.ModelsBase.ApiResults.ApiResult`1[LibraryService.Models.OutputModel.ScienceResponse]
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ScienceResponse | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Utils.ModelsBase.ApiResults.ApiResult`1[System.Boolean]
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | boolean | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Utils.ModelsBase.ApiResults.ApiResult1[System.Collections.Generic.List1[LibraryService.Models.OutputModel.AuthorWithBookResponse]]
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | AuthorWithBookResponse[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Utils.ModelsBase.ApiResults.ApiResult1[System.Collections.Generic.List1[LibraryService.Models.OutputModel.BookResponse]]
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | BookResponse[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Utils.ModelsBase.ApiResults.ApiResult1[System.Collections.Generic.List1[LibraryService.Models.OutputModel.BookWithAuthorsResponse]]
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | BookWithAuthorsResponse[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Utils.ModelsBase.ApiResults.ApiResult1[System.Collections.Generic.List1[LibraryService.Models.OutputModel.CommentResponse]]
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | CommentResponse[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Utils.ModelsBase.ApiResults.ApiResult1[System.Collections.Generic.List1[LibraryService.Models.OutputModel.UserResponse]]
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | UserResponse[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Utils.ModelsBase.ApiResults.ApiResult1[System.Collections.Generic.List1[LibraryService.Models.SubInfo]]
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | SubInfo[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Utils.ModelsBase.ApiResults.ApiResult`1[System.Guid]
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string (uuid) | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Utils.ModelsBase.ApiResults.ApiResult`1[System.Int32]
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | integer (int32) | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Utils.ModelsBase.ApiResults.ApiResult`1[System.String]
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Utils.ModelsBase.ApiResults.TypeInfo
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Имя типа. | нет |
LibraryRepository.Enums.Genre
Базовый тип перечисления: integer (int32) Возможные значения: 1, 2, 3
LibraryRepository.Enums.Status
Базовый тип перечисления: integer (int32) Возможные значения: 0, 1, 2
LibraryService.Models.AddArtRequest
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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)[] | Список авторов книги | нет |
LibraryService.Models.AddAuthorRequest
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Имя | да | |
| surname | string | Фамилия | да | |
| patronymic | string | Отчество | да | |
| photo | string | Ф ото | нет | |
| birthdate | string (date-time) | Дата рождения | нет | |
| deathdate | string (date-time) | Дата смерти | нет | |
| booksIds | string(uuid)[] | Список индентификаторов книг | нет |
LibraryService.Models.AddBookRequest
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Название | нет | |
| file | string (uuid) | Идентификатор файла | нет | |
| image | string | Обложка | нет | |
| keywords | string | Ключевые слова | нет | |
| annotation | string | Аннотация | нет | |
| rating | number (double) | Рейтинг | нет | |
| genre | Genre | |||
| status | Status | |||
| publicationYear | integer (int32) | Год публикации | нет | |
| authorIds | string(uuid)[] | Список авторов книги | нет |
LibraryService.Models.AddChildrenBookRequest
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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)[] | Список авторов книги | нет |
LibraryService.Models.AddCommentRequest
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| rating | integer (int32) | Рейтинг | нет | |
| text | string | Текст отзыва | нет | |
| title | string | Заголовок | нет | |
| userId | string (uuid) | Идентификатор пользователя, оставившего отзыв | нет | |
| bookId | string (uuid) | Идентификатор книги, на которую оставлен отзыв | нет |
LibraryService.Models.AddScienceRequest
Тип: object
| Название поля | Тип поля | Описание | Обязатель ное | Возможные значения |
|---|---|---|---|---|
| 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)[] | Список авторов книги | нет |
LibraryService.Models.AddSubscriptionRequest
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| authorId | string (uuid) | Идентификатор автора | нет | |
| userId | string (uuid) | Идентификатор пользователя | нет |
LibraryService.Models.AddUserRequest
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| login | string | Логин | нет | |
| name | string | Имя | нет | |
| string | Электроная почта | нет |
LibraryService.Models.FilterModel.AuthorFilter
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Имя автора | нет | |
| surname | string | Фамилия автора | нет | |
| patronymic | string | Отчество автора | нет | |
| birthdate | string (date-time) | Дата рождения автора | нет | |
| deathdate | string (date-time) | Дата смерти автора | нет | |
| pagination | SettingsRequest |
LibraryService.Models.FilterModel.BookFilter
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Название книги | нет | |
| keywords | string | Ключевые слова | нет | |
| annotation | string | Аннотация | нет | |
| rating | number (double) | Рейтинг | нет | |
| genre | Genre | |||
| status | Status | |||
| publicationYear | integer (int32) | Год публикации | нет | |
| pagination | SettingsRequest |
LibraryService.Models.FilterModel.BookWithAuthorFilter
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| authorFilter | AuthorFilter | |||
| name | string | Название книги | нет | |
| keywords | string | Ключевые слова | нет | |
| annotation | string | Аннотация | нет | |
| rating | number (double) | Рейтинг | нет | |
| genre | Genre | |||
| status | Status | |||
| publicationYear | integer (int32) | Год публикации | нет | |
| pagination | SettingsRequest |
LibraryService.Models.IdModel
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Идентификатор | нет |
LibraryService.Models.Order
Базовый тип перечисления: integer (int32) Возможные значения: 0, 1
LibraryService.Models.OutputModel.ArtResponse
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| series | string | Серия | нет | |
| authors | AuthorResponse[] | Список авторов книги | нет | |
| id | string (uuid) | Идентификатор книги | нет | |
| name | string | Название книги | нет | |
| file | string (uuid) | Идентификатор книги | нет | |
| image | string | Обложка книги | нет | |
| keywords | string | Ключевые слова | нет | |
| annotation | string | Аннотация | нет | |
| rating | number (double) | Рейтинг | нет | |
| genre | Genre | |||
| status | Status | |||
| publicationYear | integer (int32) | Год публикации | нет | |
| dateAdded | string (date-time) | Дата добавления | нет |
LibraryService.Models.OutputModel.AuthorResponse
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Идентификатор автора | нет | |
| name | string | Имя автора | нет | |
| surname | string | Фамилия автора | нет | |
| patronymic | string | Отчество автора | нет | |
| photo | string | Фото автора | нет | |
| birthdate | string (date-time) | Дата рождения автора | нет | |
| deathdate | string (date-time) | Дата смерти автора | нет |
LibraryService.Models.OutputModel.AuthorWithBookResponse
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| books | BookResponse[] | Список книг автора | нет | |
| bookCount | integer (int32) | Количество книг автора | нет | |
| id | string (uuid) | Идентификатор автора | нет | |
| name | string | Имя автора | нет | |
| surname | string | Фамилия автора | нет | |
| patronymic | string | Отчество автора | нет | |
| photo | string | Фото автора | нет | |
| birthdate | string (date-time) | Дата рождения автора | нет | |
| deathdate | string (date-time) | Дата смерти автора | нет |
LibraryService.Models.OutputModel.BookResponse
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Идентификатор книги | нет | |
| name | string | Название книги | нет | |
| file | string (uuid) | Идент ификатор книги | нет | |
| image | string | Обложка книги | нет | |
| keywords | string | Ключевые слова | нет | |
| annotation | string | Аннотация | нет | |
| rating | number (double) | Рейтинг | нет | |
| genre | Genre | |||
| status | Status | |||
| publicationYear | integer (int32) | Год публикации | нет | |
| dateAdded | string (date-time) | Дата добавления | нет |
LibraryService.Models.OutputModel.BookWithAuthorsResponse
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| authors | AuthorResponse[] | Список авторов книги | нет | |
| id | string (uuid) | Идентификатор книги | нет | |
| name | string | Название книги | нет | |
| file | string (uuid) | Идентификатор книги | нет | |
| image | string | Обложка книги | нет | |
| keywords | string | Ключевые слова | нет | |
| annotation | string | Аннотация | нет | |
| rating | number (double) | Рейтинг | нет | |
| genre | Genre | |||
| status | Status | |||
| publicationYear | integer (int32) | Год публикации | нет | |
| dateAdded | string (date-time) | Дата добавления | нет |
LibraryService.Models.OutputModel.ChildrenBookResponse
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| recommendedAge | integer (int32) | Рекомендованный возраст для прочтения | нет | |
| authors | AuthorResponse[] | Список авторов книги | нет | |
| id | string (uuid) | Идентификатор книги | нет | |
| name | string | Название книги | нет | |
| file | string (uuid) | Идентификатор книги | нет | |
| image | string | Обложка книги | нет | |
| keywords | string | Ключевые слова | нет | |
| annotation | string | Аннотация | нет | |
| rating | number (double) | Рейтинг | нет | |
| genre | Genre | |||
| status | Status | |||
| publicationYear | integer (int32) | Год публикации | нет | |
| dateAdded | string (date-time) | Дата добавления | нет |
LibraryService.Models.OutputModel.CommentResponse
Ти п: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Идентификатор отзыва | нет | |
| rating | integer (int32) | Рейтинг | нет | |
| text | string | Текст отзыва | нет | |
| title | string | Заголовок | нет | |
| isApproved | boolean | Факт подтвержения отзыва | нет | |
| bookId | string (uuid) | Идентификатор книги, на которую оставлен отзыв | нет | |
| userId | string (uuid) | Идентификатор пользователя, оставившего отзыв | нет |
LibraryService.Models.OutputModel.ScienceResponse
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| discipline | string | Дисциплина | нет | |
| specialization | string | Специализация литературы | нет | |
| course | string | Курс | нет | |
| authors | AuthorResponse[] | Список авторов книги | нет | |
| id | string (uuid) | Идентификатор книги | нет | |
| name | string | Название книги | нет | |
| file | string (uuid) | Идентификатор книги | нет | |
| image | string | Обложка книги | нет | |
| keywords | string | Ключевые слова | нет | |
| annotation | string | Аннотация | нет | |
| rating | number (double) | Рейтинг | нет | |
| genre | Genre | |||
| status | Status | |||
| publicationYear | integer (int32) | Год публикации | нет | |
| dateAdded | string (date-time) | Дата добавления | нет |
LibraryService.Models.OutputModel.UserResponse
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Идентификатор пользователя | нет | |
| login | string | Логин | нет | |
| name | string | Имя | нет | |
| string | Электронная почта | нет |
LibraryService.Models.SettingsRequest
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| skip | integer (int32) | Пропускаемое количество элементов | нет | |
| take | integer (int32) | Получаемое количество элементов | нет | |
| orderParam | Order | |||
| genreParam | Genre |
LibraryService.Models.SubInfo
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Идентификатор подписки | нет | |
| author | AuthorResponse | |||
| user | UserResponse |
LibraryService.Models.UpdateArtRequest
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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)[] | Список авторов книги | нет |
LibraryService.Models.UpdateAuthorRequest
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Идентификатор автора | да | |
| name | string | Имя | да | |
| surname | string | Фамилия | да | |
| patronymic | string | Отчество | да | |
| photo | string | Фото | нет | |
| birthdate | string (date-time) | Дата рождения | нет | |
| deathdate | string (date-time) | Дата смерти | нет | |
| booksIds | string(uuid)[] | Список индентификаторов книг | нет |
LibraryService.Models.UpdateBookRequest
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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)[] | Список авторов книги | нет |
LibraryService.Models.UpdateChildrenBookRequest
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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)[] | Список авторов книги | нет |
LibraryService.Models.UpdateCommentRequest
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | Идентификатор отзыва | да | |
| rating | integer (int32) | Рейтинг | нет | |
| text | string | Текст отзыва | нет | |
| title | string | Заголовок | нет | |
| userId | string (uuid) | Идентификатор пользователя, оставившего отзыв | нет | |
| bookId | string (uuid) | Идентификатор книги, на которую оставлен отзыв | нет |
LibraryService.Models.UpdateScienceRequest
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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)[] | Список авторов книги | нет |