Difference between revisions of "GetChannelSimpleProducts"
Jump to navigation
Jump to search
| Line 2: | Line 2: | ||
Description=Returns the list of [[Product]] objects available in the instance under an specific Channel. It can include all sub channels (any levels) or just the first level of sub channel. | Description=Returns the list of [[Product]] objects available in the instance under an specific Channel. It can include all sub channels (any levels) or just the first level of sub channel. | ||
| − | The result is default ordered by the property Title in the object. The result is default filtered by [[AdultFilterType]].NonAdultOnly and [[ | + | The result is default ordered by the property Title in the object. The result is default filtered by [[AdultFilterType]].NonAdultOnly and [[MovieType]].(Movie and Season). |
| + | |||
| + | This method can be used by logged or anonymous login. | ||
|Parameters= | |Parameters= | ||
| Line 40: | Line 42: | ||
|ParamType=String | |ParamType=String | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription=List of numbers separated by comma with the [[MovieType]] to filter the result. | + | |ParamDescription=List of numbers separated by comma with the [[MovieType]] to filter the result. Default set to Movie and Season (1, 3). |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 52: | Line 54: | ||
|ParamType= [[movieSortType]] | |ParamType= [[movieSortType]] | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription=SortTypeId to order result by the chosen field. | + | |ParamDescription=SortTypeId to order result by the chosen field. Default ordered by Title property. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 62: | Line 64: | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing an array of [[ | + | Returns a JSON object containing an array of [[Product]]. |
'''Example:''' | '''Example:''' | ||
Revision as of 13:48, 14 July 2014
Description
Returns the list of Product objects available in the instance under an specific Channel. It can include all sub channels (any levels) or just the first level of sub channel.
The result is default ordered by the property Title in the object. The result is default filtered by AdultFilterType.NonAdultOnly and MovieType.(Movie and Season).
This method can be used by logged or anonymous login.
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)
- Id of a channel that wants the result
- includeChildMovies (bool, optional)
- Flag to set if the result should be contain all Movies in all sub channels from the specified in the channelId parameter. The default value is false.
- typeFilter (String, optional)
- List of numbers separated by comma with the MovieType to filter the result. Default set to Movie and Season (1, 3).
- adultFilter (adultFilterType, optional)
- Type to represent Unknown, All, AdultOnly or NonAdultOnly. If the content is for adult and/or not adult or both. The default value is NonAdultOnly.
- sort (movieSortType, optional)
- SortTypeId to order result by the chosen field. Default ordered by Title property.
- productTypeFilter (productTypeFilter, optional)
- List of productTypeFilter separated by comma to filter the result.
Returns
Returns a JSON object containing an array of Product.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 14,
- "List":
- [ Array of Product objects ]
}
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 |
