Bureaucrats, editor, Administrators
470
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| 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..."
{{Api_Method_Spec|
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=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=offset
|ParamType=int
|ParamRequired=optional
|ParamDescription=The offset number of the returned values for this request
}}
{{Api_Parameter|
ParamName=limit
|ParamType=int
|ParamRequired=optional
|ParamDescription=The limit number of values for this request
}}
{{Api_Parameter|
ParamName=channelId
|ParamType=int
|ParamRequired=required
|ParamDescription=The channel id that want to return the content registered inside then.
}}
{{Api_Parameter|
ParamName=includeChildMovies
|ParamType=boolean
|ParamRequired=optional
|ParamDescription=Define if the method should return all contents hierarchy instead inside any sub channels under this channel.
}}
{{Api_Parameter|
ParamName= movieType
|ParamType=[[movieType]]
|ParamRequired=optional
|ParamDescription=Filter the result by one type: Movies, Episodes, Series, Season.
}}
{{Api_Parameter|
ParamName= subscriptionType
|ParamType= [[subscriptionType]]
|ParamRequired=optional
|ParamDescription=List of SubscriptionType separated by comma, to filter the result required.
}}
{{Api_Parameter|
ParamName= productTypeFilter
|ParamType= [[productType]]
|ParamRequired=optional
|ParamDescription=List of ProductTypeId separated by comma to filter the result required.
}}
{{Api_Parameter|
ParamName= adultFilter
|ParamType= [[adultFilterType]]
|ParamRequired=optional
|ParamDescription=Type to represent Unknown, All, AdultOnly or NonAdultOnly. If the content is for adult and/or not adult or both.
}}
{{Api_Parameter|
ParamName= sort
|ParamType= [[movieSortType]]
|ParamRequired=optional
|ParamDescription=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
|Cache=
This method is cached.
|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
* [[GetChannelSimpleMovies]]
* [[Movie]]
* [[Subscription]]
}}
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=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=offset
|ParamType=int
|ParamRequired=optional
|ParamDescription=The offset number of the returned values for this request
}}
{{Api_Parameter|
ParamName=limit
|ParamType=int
|ParamRequired=optional
|ParamDescription=The limit number of values for this request
}}
{{Api_Parameter|
ParamName=channelId
|ParamType=int
|ParamRequired=required
|ParamDescription=The channel id that want to return the content registered inside then.
}}
{{Api_Parameter|
ParamName=includeChildMovies
|ParamType=boolean
|ParamRequired=optional
|ParamDescription=Define if the method should return all contents hierarchy instead inside any sub channels under this channel.
}}
{{Api_Parameter|
ParamName= movieType
|ParamType=[[movieType]]
|ParamRequired=optional
|ParamDescription=Filter the result by one type: Movies, Episodes, Series, Season.
}}
{{Api_Parameter|
ParamName= subscriptionType
|ParamType= [[subscriptionType]]
|ParamRequired=optional
|ParamDescription=List of SubscriptionType separated by comma, to filter the result required.
}}
{{Api_Parameter|
ParamName= productTypeFilter
|ParamType= [[productType]]
|ParamRequired=optional
|ParamDescription=List of ProductTypeId separated by comma to filter the result required.
}}
{{Api_Parameter|
ParamName= adultFilter
|ParamType= [[adultFilterType]]
|ParamRequired=optional
|ParamDescription=Type to represent Unknown, All, AdultOnly or NonAdultOnly. If the content is for adult and/or not adult or both.
}}
{{Api_Parameter|
ParamName= sort
|ParamType= [[movieSortType]]
|ParamRequired=optional
|ParamDescription=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
|Cache=
This method is cached.
|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
* [[GetChannelSimpleMovies]]
* [[Movie]]
* [[Subscription]]
}}
