KAkareadita
ReadingProfile

Update the implicit reading profile for a series, creates one if none exists

Changed on

Any modification to the reader settings during reading will create an implicit profile. Use "update-parent" to save to the bound series profile.

post/api/reading-profile/series

Request

  • Base URL
    http://localhost:5000
  • URL
    http://localhost:5000/api/reading-profile/series
  • Auth
    API key in header x-api-key

Query parameters

libraryIdinteger
seriesIdinteger
deviceIdinteger

Defaults to the currently active device

Request body

idinteger
userIdinteger
namestring nullable
kind0 | 1 | 2

Members:

  • 0 — Default
  • 1 — User
  • 2 — Implicit
deviceIdsinteger[] nullable
seriesIdsinteger[] nullable
libraryIdsinteger[] nullable
readingDirection0 | 1 required

Members:

  • 0 — LeftToRight
  • 1 — RightToLeft
scalingOption0 | 1 | 2 | 3 required

Members:

  • 0 — FitToHeight
  • 1 — FitToWidth
  • 2 — Original
  • 3 — Automatic
pageSplitOption0 | 1 | 2 | 3 required

Members:

  • 0 — SplitLeftToRight
  • 1 — SplitRightToLeft
  • 2 — NoSplit
  • 3 — FitSplit
readerMode0 | 1 | 2 required

Members:

  • 0 — Left and Right (LeftRight)
  • 1 — Up and Down (UpDown)
  • 2 — Webtoon
autoCloseMenuboolean required
showScreenHintsboolean required
emulateBookboolean required
layoutMode1 | 2 | 3 required

Members:

  • 1 — Single
  • 2 — Double
  • 3 — Double (manga) (DoubleReversed)
backgroundColorstring required
swipeToPaginateboolean required
allowAutomaticWebtoonReaderDetectionboolean required
widthOverrideinteger nullable
disableWidthOverride0 | 768 | 1280 | 1440

Members:

  • 0 — Never
  • 768 — Mobile
  • 1280 — Tablet
  • 1440 — Desktop
bookReaderMargininteger required
bookReaderLineSpacinginteger required
bookReaderFontSizeinteger required
bookReaderFontFamilystring required
bookReaderTapToPaginateboolean required
bookReaderReadingDirection0 | 1 required

Members:

  • 0 — LeftToRight
  • 1 — RightToLeft
bookReaderWritingStyle0 | 1 required

Members:

  • 0 — Horizontal
  • 1 — Vertical
bookReaderThemeNamestring required
bookReaderLayoutMode0 | 1 | 2 required

Members:

  • 0 — Default
  • 1 — 1 Column (Column1)
  • 2 — 2 Column (Column2)
bookReaderImmersiveModeboolean required
bookReaderDisableBookmarkIconboolean required
pdfTheme0 | 1 required

Members:

  • 0 — Dark
  • 1 — Light
pdfScrollMode0 | 1 | 3 required

Members:

  • 0 — Vertical
  • 1 — Horizontal
  • 3 — Page
pdfSpreadMode0 | 1 | 2 required

Members:

  • 0 — None
  • 1 — Odd
  • 2 — Even

Response

OK

idinteger
userIdinteger
namestring nullable
kind0 | 1 | 2

Members:

  • 0 — Default
  • 1 — User
  • 2 — Implicit
deviceIdsinteger[] nullable
seriesIdsinteger[] nullable
libraryIdsinteger[] nullable
readingDirection0 | 1 required

Members:

  • 0 — LeftToRight
  • 1 — RightToLeft
scalingOption0 | 1 | 2 | 3 required

Members:

  • 0 — FitToHeight
  • 1 — FitToWidth
  • 2 — Original
  • 3 — Automatic
pageSplitOption0 | 1 | 2 | 3 required

Members:

  • 0 — SplitLeftToRight
  • 1 — SplitRightToLeft
  • 2 — NoSplit
  • 3 — FitSplit
readerMode0 | 1 | 2 required

Members:

  • 0 — Left and Right (LeftRight)
  • 1 — Up and Down (UpDown)
  • 2 — Webtoon
autoCloseMenuboolean required
showScreenHintsboolean required
emulateBookboolean required
layoutMode1 | 2 | 3 required

Members:

  • 1 — Single
  • 2 — Double
  • 3 — Double (manga) (DoubleReversed)
backgroundColorstring required
swipeToPaginateboolean required
allowAutomaticWebtoonReaderDetectionboolean required
widthOverrideinteger nullable
disableWidthOverride0 | 768 | 1280 | 1440

Members:

  • 0 — Never
  • 768 — Mobile
  • 1280 — Tablet
  • 1440 — Desktop
bookReaderMargininteger required
bookReaderLineSpacinginteger required
bookReaderFontSizeinteger required
bookReaderFontFamilystring required
bookReaderTapToPaginateboolean required
bookReaderReadingDirection0 | 1 required

Members:

  • 0 — LeftToRight
  • 1 — RightToLeft
bookReaderWritingStyle0 | 1 required

Members:

  • 0 — Horizontal
  • 1 — Vertical
bookReaderThemeNamestring required
bookReaderLayoutMode0 | 1 | 2 required

Members:

  • 0 — Default
  • 1 — 1 Column (Column1)
  • 2 — 2 Column (Column2)
bookReaderImmersiveModeboolean required
bookReaderDisableBookmarkIconboolean required
pdfTheme0 | 1 required

Members:

  • 0 — Dark
  • 1 — Light
pdfScrollMode0 | 1 | 3 required

Members:

  • 0 — Vertical
  • 1 — Horizontal
  • 3 — Page
pdfSpreadMode0 | 1 | 2 required

Members:

  • 0 — None
  • 1 — Odd
  • 2 — Even

Changes

  • e7ced995b077Revision changes
    • breaking

      removed the enum value 1.00 of the request property (media type: application/json)

    • breaking

      removed the enum value 1.00 of the request property (media type: text/json)

    • breaking

      removed the enum value 1.00 of the request property (media type: application/*+json)

    • breaking

      removed the enum value 2.00 of the request property (media type: application/json)

    • breaking

      removed the enum value 2.00 of the request property (media type: text/json)

    • breaking

      removed the enum value 2.00 of the request property (media type: application/*+json)

    • breaking

      removed the enum value 3.00 of the request property (media type: application/json)

    • breaking

      removed the enum value 3.00 of the request property (media type: text/json)

    • breaking

      removed the enum value 3.00 of the request property (media type: application/*+json)

    • warning

      added the new 1280.00 enum value to the response property for the response status (media type: text/plain)

    • warning

      added the new 1280.00 enum value to the response property for the response status (media type: application/json)

    • warning

      added the new 1280.00 enum value to the response property for the response status (media type: text/json)

    • warning

      added the new 1440.00 enum value to the response property for the response status (media type: text/plain)

    • warning

      added the new 1440.00 enum value to the response property for the response status (media type: application/json)

    • warning

      added the new 1440.00 enum value to the response property for the response status (media type: text/json)

    • warning

      added the new 768.00 enum value to the response property for the response status (media type: text/plain)

    • warning

      added the new 768.00 enum value to the response property for the response status (media type: application/json)

    • warning

      added the new 768.00 enum value to the response property for the response status (media type: text/json)

    • info

      added the new 1280.00 enum value to the request property (media type: application/json)

    • info

      added the new 1280.00 enum value to the request property (media type: text/json)

    • info

      added the new 1280.00 enum value to the request property (media type: application/*+json)

    • info

      added the new 1440.00 enum value to the request property (media type: application/json)

    • info

      added the new 1440.00 enum value to the request property (media type: text/json)

    • info

      added the new 1440.00 enum value to the request property (media type: application/*+json)

    • info

      added the new 768.00 enum value to the request property (media type: application/json)

    • info

      added the new 768.00 enum value to the request property (media type: text/json)

    • info

      added the new 768.00 enum value to the request property (media type: application/*+json)

    • info

      removed the 1.00 enum value from the response property for the response status (media type: text/plain)

    • info

      removed the 1.00 enum value from the response property for the response status (media type: application/json)

    • info

      removed the 1.00 enum value from the response property for the response status (media type: text/json)

    • info

      removed the 2.00 enum value from the response property for the response status (media type: text/plain)

    • info

      removed the 2.00 enum value from the response property for the response status (media type: application/json)

    • info

      removed the 2.00 enum value from the response property for the response status (media type: text/json)

    • info

      removed the 3.00 enum value from the response property for the response status (media type: text/plain)

    • info

      removed the 3.00 enum value from the response property for the response status (media type: application/json)

    • info

      removed the 3.00 enum value from the response property for the response status (media type: text/json)

  • 3dfbcae62b15Revision changes
    • breaking

      added the new required request property (media type: application/json)

    • breaking

      added the new required request property (media type: text/json)

    • breaking

      added the new required request property (media type: application/*+json)

    • info

      added the required property to the response with the status (media type: text/plain)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: text/json)