GetChannelCatalogItems

Description

Get all items assigned to a Channel. If the parameter includeChild were true, all movie contents assigned under all sub-channel will be included in the result.

The result will return a list of CatalogItem that could be one of these CatalogItemType. The result is default ordered by the Title or sorted by a field specified in the request using MovieSortType enumeration. The result could be filtered by MovieType, SubscriptionType and ProductType.

The result also can be filtered by the adult content. Using the AdultFilterType options: All, AdultOnly and NonAdultOnly.

Similar to GetChannelSimpleMovies but it has better performance.

Parameters

• token (String, required)

A valid token for identifying the API session context. The token can be anonymous or logged.

• offset (int, optional)

The offset number of the returned values for this request

• limit (int, optional)

The limit number of values for this request

• channelId (int, required)

The channel id that want to return the content registered inside then.

• includeChildMovies (boolean, optional)

Define if the method should return all contents hierarchy instead inside any sub channels under this channel.

• movieType (movieType, optional)

Filter the result by one type: Movies, Episodes, Series, Season.

• subscriptionType (subscriptionType, optional)

List of SubscriptionType separated by comma, to filter the result required.

• productTypeFilter (productType, optional)

List of ProductTypeId separated by comma to filter the result required.

• adultFilter (adultFilterType, optional)

Type to represent Unknown, All, AdultOnly or NonAdultOnly. If the content is for adult and/or not adult or both.

• sort (movieSortType, optional)

SortTypeId to order result by the chosen field

Returns

Returns a JSON object containing an array of CatalogItem.

Example:

{

"Offset": 0,

"Limit": 100,

"Count": 6,

"List":

[ Array of CatalogItem List ]

}

Exceptions

None

Caching

This method is cached.

Known issues

None

Version history

API Version Number	Change description	Changes author
1.0	Initial method design	Harley Cabral

See also

• GetChannelSimpleMovies
• Movie
• Subscription