KAkareadita
Annotation

Returns a list of annotations for browsing

Changed on
post/api/Annotation/all-filtered

Request

  • Base URL
    http://localhost:5000
  • URL
    http://localhost:5000/api/Annotation/all-filtered
  • Auth
    API key in header x-api-key

Query parameters

PageNumberinteger
PageSizeinteger

Request body

idinteger
namestring nullable
combination0 | 1

Members:

  • 0 — Or
  • 1 — And
entityType0 | 1 | 2 | 3

Members:

  • 0 — Series
  • 1 — Reading List (ReadingList)
  • 2 — Person
  • 3 — Annotation
limitTointeger

Response

OK

idinteger
xPathstring nullable required
endingXPathstring nullable
selectedTextstring nullable
commentstring nullable
commentHtmlstring nullable
commentPlainTextstring nullable
chapterTitlestring nullable
contextstring nullable
highlightCountinteger
containsSpoilerboolean
pageNumberinteger
selectedSlotIndexinteger
likesinteger[] nullable
seriesNamestring nullable
libraryNamestring nullable
chapterIdinteger required
volumeIdinteger required
seriesIdinteger required
libraryIdinteger required
ownerUserIdinteger required
ownerUsernamestring nullable
ageRating0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | -1

Members:

  • 0 — Unknown
  • 1 — Rating Pending (RatingPending)
  • 2 — Early Childhood (EarlyChildhood)
  • 3 — Everyone
  • 4 — G
  • 5 — Everyone 10+ (Everyone10Plus)
  • 6 — PG
  • 7 — Kids to Adults (KidsToAdults)
  • 8 — Teen
  • 9 — MA15+ (Mature15Plus)
  • 10 — Mature 17+ (Mature17Plus)
  • 11 — M (Mature)
  • 12 — R18+ (R18Plus)
  • 13 — Adults Only 18+ (AdultsOnly)
  • 14 — X18+ (X18Plus)
  • -1 — Not Applicable (NotApplicable)
createdUtcstring date-time
lastModifiedUtcstring date-time

Changes

  • 58caf8bfeda1Revision changes
    • info

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

    • info

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

    • info

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

  • 62d7d023d949Revision changes
    • info

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

    • info

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

    • info

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