Skip to main content

SeriesAccessDto

Whether the previewed user can see one series, and why

allowedBy object[]required

Every group (or personal grant) whose allow rules let it through

  • Array [
  • groupId(string | null)<uuid>nullable

    Group ID (only present for group sources)

    Example: 550e8400-e29b-41d4-a716-446655440000
    groupNamestring | nullnullable

    Group name (only present for group sources)

    Example: Manga Readers
    kindstringrequired

    Source kind: "user" or "group"

    Example: group
  • ]
  • decisionAccessDecisionrequired

    The outcome for one series, and the reason for it.

    Possible values: [unrestricted, open, allowed, notAllowed, denied]

    deniedBy object[]required

    Every deny rule that matches this series

  • Array [
  • ruleTypeRuleTypeLabelrequired

    The kind of value a rule names.

    Possible values: [sharingTag, tag, genre, library]

    source objectrequired

    Source of a grant (user or group)

    groupId(string | null)<uuid>nullable

    Group ID (only present for group sources)

    Example: 550e8400-e29b-41d4-a716-446655440000
    groupNamestring | nullnullable

    Group name (only present for group sources)

    Example: Manga Readers
    kindstringrequired

    Source kind: "user" or "group"

    Example: group
    valuestringrequired

    The tag or genre name, or the sharing tag or library name

  • ]
  • seriesIdstring<uuid>required
    titlestringrequired
    visiblebooleanrequired
    SeriesAccessDto
    {
    "allowedBy": [
    {
    "groupId": "550e8400-e29b-41d4-a716-446655440000",
    "groupName": "Manga Readers",
    "kind": "group"
    }
    ],
    "decision": "unrestricted",
    "deniedBy": [
    {
    "ruleType": "sharingTag",
    "source": {
    "groupId": "550e8400-e29b-41d4-a716-446655440000",
    "groupName": "Manga Readers",
    "kind": "group"
    },
    "value": "string"
    }
    ],
    "seriesId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "title": "string",
    "visible": true
    }