Tsarr Documentation - v2.16.0
    Preparing search index...

    Type Alias GetSeasonsData

    type GetSeasonsData = {
        body?: never;
        path: { seriesId: string };
        query?: {
            userId?: string;
            fields?: ItemFields[];
            isSpecialSeason?: boolean;
            isMissing?: boolean;
            adjacentTo?: string;
            enableImages?: boolean;
            imageTypeLimit?: number;
            enableImageTypes?: ImageType[];
            enableUserData?: boolean;
        };
        url: "/Shows/{seriesId}/Seasons";
    }
    Index
    body? path query? url

    Optionalbody

    body?: never
    path: { seriesId: string }

    Type Declaration

    • seriesId: string

      The series id.

    query?: {
        userId?: string;
        fields?: ItemFields[];
        isSpecialSeason?: boolean;
        isMissing?: boolean;
        adjacentTo?: string;
        enableImages?: boolean;
        imageTypeLimit?: number;
        enableImageTypes?: ImageType[];
        enableUserData?: boolean;
    }

    Type Declaration

    • OptionaluserId?: string

      The user id.

    • Optionalfields?: ItemFields[]

      Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.

    • OptionalisSpecialSeason?: boolean

      Optional. Filter by special season.

    • OptionalisMissing?: boolean

      Optional. Filter by items that are missing episodes or not.

    • OptionaladjacentTo?: string

      Optional. Return items that are siblings of a supplied item.

    • OptionalenableImages?: boolean

      Optional. Include image information in output.

    • OptionalimageTypeLimit?: number

      Optional. The max number of images to return, per image type.

    • OptionalenableImageTypes?: ImageType[]

      Optional. The image types to include in the output.

    • OptionalenableUserData?: boolean

      Optional. Include user data.

    url: "/Shows/{seriesId}/Seasons"

    Settings
    Member Visibility

    On This Page
    Properties