Skip to main content

SeriesDto

Series data transfer object

bookCountinteger<int64>required
Example: 4
createdAtstring<date-time>required
Example: 2024-01-01T00:00:00Z
hasCustomCoverboolean | nullnullable
Example: false
idstring<uuid>required
Example: 550e8400-e29b-41d4-a716-446655440002
libraryIdstring<uuid>required
Example: 550e8400-e29b-41d4-a716-446655440000
libraryNamestringrequired

Name of the library this series belongs to

Example: Comics
pathstring | nullnullable
Example: /media/comics/Batman - Year One
publisherstring | nullnullable
Example: DC Comics
selectedCoverSourcestring | nullnullable
Example: first_book
summarystring | nullnullable

Summary/description from series_metadata

Example: The definitive origin story of Batman, following Bruce Wayne's first year as a vigilante.
titlestringrequired

Series title from series_metadata

Example: Batman: Year One
titleSortstring | nullnullable

Sort title from series_metadata (for ordering)

Example: batman year one
unreadCountinteger,null<int64>nullable
Example: 2
updatedAtstring<date-time>required
Example: 2024-01-15T10:30:00Z
yearinteger,null<int32>nullable
Example: 1987
SeriesDto
{
  "bookCount": 4,
  "createdAt": "2024-01-01T00:00:00Z",
  "hasCustomCover": false,
  "id": "550e8400-e29b-41d4-a716-446655440002",
  "libraryId": "550e8400-e29b-41d4-a716-446655440000",
  "libraryName": "Comics",
  "path": "/media/comics/Batman - Year One",
  "publisher": "DC Comics",
  "selectedCoverSource": "first_book",
  "summary": "The definitive origin story of Batman, following Bruce Wayne's first year as a vigilante.",
  "title": "Batman: Year One",
  "titleSort": "batman year one",
  "unreadCount": 2,
  "updatedAt": "2024-01-15T10:30:00Z",
  "year": 1987
}