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

    Type Alias GetEpisodesData

    type GetEpisodesData = {
        body?: never;
        path: { seriesId: string };
        query?: {
            userId?: string;
            fields?: ItemFields[];
            season?: number;
            seasonId?: string;
            isMissing?: boolean;
            adjacentTo?: string;
            startItemId?: string;
            startIndex?: number;
            limit?: number;
            enableImages?: boolean;
            imageTypeLimit?: number;
            enableImageTypes?: ImageType[];
            enableUserData?: boolean;
            sortBy?:
                | "Default"
                | "AiredEpisodeOrder"
                | "Album"
                | "AlbumArtist"
                | "Artist"
                | "DateCreated"
                | "OfficialRating"
                | "DatePlayed"
                | "PremiereDate"
                | "StartDate"
                | "SortName"
                | "Name"
                | "Random"
                | "Runtime"
                | "CommunityRating"
                | "ProductionYear"
                | "PlayCount"
                | "CriticRating"
                | "IsFolder"
                | "IsUnplayed"
                | "IsPlayed"
                | "SeriesSortName"
                | "VideoBitRate"
                | "AirTime"
                | "Studio"
                | "IsFavoriteOrLiked"
                | "DateLastContentAdded"
                | "SeriesDatePlayed"
                | "ParentIndexNumber"
                | "IndexNumber";
        };
        url: "/Shows/{seriesId}/Episodes";
    }
    Index
    body? path query? url

    Optionalbody

    body?: never
    path: { seriesId: string }

    Type Declaration

    • seriesId: string

      The series id.

    query?: {
        userId?: string;
        fields?: ItemFields[];
        season?: number;
        seasonId?: string;
        isMissing?: boolean;
        adjacentTo?: string;
        startItemId?: string;
        startIndex?: number;
        limit?: number;
        enableImages?: boolean;
        imageTypeLimit?: number;
        enableImageTypes?: ImageType[];
        enableUserData?: boolean;
        sortBy?:
            | "Default"
            | "AiredEpisodeOrder"
            | "Album"
            | "AlbumArtist"
            | "Artist"
            | "DateCreated"
            | "OfficialRating"
            | "DatePlayed"
            | "PremiereDate"
            | "StartDate"
            | "SortName"
            | "Name"
            | "Random"
            | "Runtime"
            | "CommunityRating"
            | "ProductionYear"
            | "PlayCount"
            | "CriticRating"
            | "IsFolder"
            | "IsUnplayed"
            | "IsPlayed"
            | "SeriesSortName"
            | "VideoBitRate"
            | "AirTime"
            | "Studio"
            | "IsFavoriteOrLiked"
            | "DateLastContentAdded"
            | "SeriesDatePlayed"
            | "ParentIndexNumber"
            | "IndexNumber";
    }

    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.

    • Optionalseason?: number

      Optional filter by season number.

    • OptionalseasonId?: string

      Optional. Filter by season id.

    • OptionalisMissing?: boolean

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

    • OptionaladjacentTo?: string

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

    • OptionalstartItemId?: string

      Optional. Skip through the list until a given item is found.

    • OptionalstartIndex?: number

      Optional. The record index to start at. All items with a lower index will be dropped from the results.

    • Optionallimit?: number

      Optional. The maximum number of records to return.

    • 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.

    • OptionalsortBy?:
          | "Default"
          | "AiredEpisodeOrder"
          | "Album"
          | "AlbumArtist"
          | "Artist"
          | "DateCreated"
          | "OfficialRating"
          | "DatePlayed"
          | "PremiereDate"
          | "StartDate"
          | "SortName"
          | "Name"
          | "Random"
          | "Runtime"
          | "CommunityRating"
          | "ProductionYear"
          | "PlayCount"
          | "CriticRating"
          | "IsFolder"
          | "IsUnplayed"
          | "IsPlayed"
          | "SeriesSortName"
          | "VideoBitRate"
          | "AirTime"
          | "Studio"
          | "IsFavoriteOrLiked"
          | "DateLastContentAdded"
          | "SeriesDatePlayed"
          | "ParentIndexNumber"
          | "IndexNumber"

      Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.

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

    Settings
    Member Visibility

    On This Page
    Properties