Skip to main content
GET
List accessible book names.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Response

Returns accessible book-name records; an empty list is valid.

Accessible book identifiers, names, and source classifications.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Book.ApiGetBookNamesResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.

book_names
object[] | null

Accessible books with numeric identifier, display name, and portfolio source; an empty collection is valid.