API для работы с авторами

/api/Author/ListAuthors

Получить список авторов

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Параметр настройки выборки данных - пагинация, сортировка, фильтр по жанру
(по умолчанию - взять 50, пропустить 0)

Название поля	Тип поля	Описание	Обязательное	Возможные значения
skip	integer (int32)	Пропускаемое количество элементов	нет
take	integer (int32)	Получаемое количество элементов	нет
orderParam	Order
genreParam	Genre

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	AuthorWithBookResponse[]	Данные результата метода API.	да
error	Info		да
typeInfo	TypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/libraryservice public AuthorController ListAuthors(LibraryService.Models.SettingsRequest)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	library:action:execute

/components/securitySchemes/libraryservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	library:action:execute

/api/Author/AuthorsCount

Получить количество всех авторов

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Название поля	Тип поля	Описание	Обязательное	Возможные значения
name	string	Имя автора	нет
surname	string	Фамилия автора	нет
patronymic	string	Отчество автора	нет
birthdate	string (date-time)	Дата рождения автора	нет
deathdate	string (date-time)	Дата смерти автора	нет
pagination	SettingsRequest

Возвращаемые результаты

Код 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

Схемы авторизации

/components/securitySchemes/libraryservice public AuthorController AuthorsCount(LibraryService.Models.FilterModel.AuthorFilter)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	library:action:execute

/components/securitySchemes/libraryservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	library:action:execute

/api/Author/GetAuthorInfo

Получить автора и его книги

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

ИД автора

Название поля	Тип поля	Описание	Обязательное	Возможные значения
id	string (uuid)	Идентификатор	нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	AuthorWithBookResponse		да
error	Info		да
typeInfo	TypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/libraryservice public AuthorController GetAuthorInfo(LibraryService.Models.IdModel)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	library:action:execute

/components/securitySchemes/libraryservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	library:action:execute

/api/Author/FindAuthors

Получить авторов по фильтру

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Фильтр для поиска авторов

Название поля	Тип поля	Описание	Обязательное	Возможные значения
name	string	Имя автора	нет
surname	string	Фамилия автора	нет
patronymic	string	Отчество автора	нет
birthdate	string (date-time)	Дата рождения автора	нет
deathdate	string (date-time)	Дата смерти автора	нет
pagination	SettingsRequest

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	AuthorWithBookResponse[]	Данные результата метода API.	да
error	Info		да
typeInfo	TypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/libraryservice public AuthorController FindAuthors(LibraryService.Models.FilterModel.AuthorFilter)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	library:action:execute

/components/securitySchemes/libraryservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	library:action:execute

/api/Author/AddAuthor

Добавить автора

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Данные для добавления автора

Название поля	Тип поля	Описание	Обязательное	Возможные значения
name	string	Имя	да
surname	string	Фамилия	да
patronymic	string	Отчество	да
photo	string	Фото	нет
birthdate	string (date-time)	Дата рождения	нет
deathdate	string (date-time)	Дата смерти	нет
booksIds	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

Схемы авторизации

/components/securitySchemes/libraryservice public AuthorController AddAuthor(LibraryService.Models.AddAuthorRequest)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	library:action:execute

/components/securitySchemes/libraryservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	library:action:execute

/api/Author/UpdateAuthor

Обновить автора

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Данные для обновления автора

Название поля	Тип поля	Описание	Обязательное	Возможные значения
id	string (uuid)	Идентификатор автора	да
name	string	Имя	да
surname	string	Фамилия	да
patronymic	string	Отчество	да
photo	string	Фото	нет
birthdate	string (date-time)	Дата рождения	нет
deathdate	string (date-time)	Дата смерти	нет
booksIds	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

Схемы авторизации

/components/securitySchemes/libraryservice public AuthorController UpdateAuthor(LibraryService.Models.UpdateAuthorRequest)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	library:action:execute

/components/securitySchemes/libraryservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	library:action:execute

/api/Author/DeleteAuthor

Удалить автора

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

ИД, по которому надо удалить автора

Название поля	Тип поля	Описание	Обязательное	Возможные значения
id	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

Схемы авторизации

/components/securitySchemes/libraryservice public AuthorController DeleteAuthor(LibraryService.Models.IdModel)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	library:action:execute

/components/securitySchemes/libraryservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	library:action:execute

/api/Author/DemoError

Получить ошибку

Тип HTTP запроса: post

Отсылаемый запрос

Возвращаемые результаты

Код 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

Схемы авторизации

/components/securitySchemes/libraryservice public AuthorController DemoError()

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	library:action:execute

/components/securitySchemes/libraryservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	library:action:execute