Interface TvShowsApiGetSeasonsRequest

Request parameters for getSeasons operation in TvShowsApi.

Export

TvShowsApiGetSeasonsRequest

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

Properties

adjacentTo? enableImages? enableImageTypes? enableUserData? fields? imageTypeLimit? isMissing? isSpecialSeason? seriesId userId?

Properties

Optional ReadonlyadjacentTo

adjacentTo?: string

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

Memberof

TvShowsApiGetSeasons

Optional ReadonlyenableImages

enableImages?: boolean

Optional. Include image information in output.

Memberof

TvShowsApiGetSeasons

Optional ReadonlyenableImageTypes

enableImageTypes?: ImageType[]

Optional. The image types to include in the output.

Memberof

TvShowsApiGetSeasons

Optional ReadonlyenableUserData

enableUserData?: boolean

Optional. Include user data.

Memberof

TvShowsApiGetSeasons

Optional Readonlyfields

fields?: 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.

Memberof

TvShowsApiGetSeasons

Optional ReadonlyimageTypeLimit

imageTypeLimit?: number

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

Memberof

TvShowsApiGetSeasons

Optional ReadonlyisMissing

isMissing?: boolean

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

Memberof

TvShowsApiGetSeasons

Optional ReadonlyisSpecialSeason

isSpecialSeason?: boolean

Optional. Filter by special season.

Memberof

TvShowsApiGetSeasons

ReadonlyseriesId

seriesId: string

The series id.

Memberof

TvShowsApiGetSeasons

Optional ReadonlyuserId

userId?: string

The user id.

Memberof

TvShowsApiGetSeasons

Settings

Member Visibility

On This Page

Properties