Difference between revisions of "GetChannelCatalogItems"
| (7 intermediate revisions by 3 users not shown) | |||
| Line 4: | Line 4: | ||
The result will return a list of [[CatalogItem]] that could be one of these [[CatalogItemType]]. It can returns VoD, Live Contents and both. | The result will return a list of [[CatalogItem]] that could be one of these [[CatalogItemType]]. It can returns VoD, Live Contents and both. | ||
The result is default ordered by the Default ( 0 ) [[SortType]] or sorted by a field specified in the request using [[SortType]] enumeration. A parameter SortOrder has been implemented in a way to order ascending or descending results as well. | The result is default ordered by the Default ( 0 ) [[SortType]] or sorted by a field specified in the request using [[SortType]] enumeration. A parameter SortOrder has been implemented in a way to order ascending or descending results as well. | ||
| + | |||
| + | In case the requested SortType is 0 (Default) gvp.api.neuromancer or it is not set, will order the results depending on the Channel LiveDefaultOrder and VoDDefaultOrder properties in the Channels Page. In case the Channel is configured with ContentType equals to Live, LiveDefaultOrder will be used; otherwise, VoDDefaultOrder will be taken into consideration. Default configuration in LiveDefaultOrder/VoDDefaultOrder orders the results by their IDs. | ||
The result could be filtered by [[SubscriptionType]] and [[CatalogItemType]]. | The result could be filtered by [[SubscriptionType]] and [[CatalogItemType]]. | ||
| Line 13: | Line 15: | ||
Deprecated Parameter: | Deprecated Parameter: | ||
| − | -The parameter | + | -The parameter includeChildMovies was deprecated in the 3.2 GVP version. |
|Parameters= | |Parameters= | ||
| Line 64: | Line 66: | ||
|ParamDescription=SortTypeId to order result by the chosen field | |ParamDescription=SortTypeId to order result by the chosen field | ||
}} | }} | ||
| − | + | {{Api_Parameter| | |
| + | ParamName= sortOrder | ||
| + | |ParamType= [[SortOrder]] | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=SortOrderId to order ascending/descending. Ascending default (if not provided) | ||
| + | }} | ||
|Returns= | |Returns= | ||
Latest revision as of 12:28, 18 March 2016
Description
Get all items assigned to a Channel.
The result will return a list of CatalogItem that could be one of these CatalogItemType. It can returns VoD, Live Contents and both. The result is default ordered by the Default ( 0 ) SortType or sorted by a field specified in the request using SortType enumeration. A parameter SortOrder has been implemented in a way to order ascending or descending results as well.
In case the requested SortType is 0 (Default) gvp.api.neuromancer or it is not set, will order the results depending on the Channel LiveDefaultOrder and VoDDefaultOrder properties in the Channels Page. In case the Channel is configured with ContentType equals to Live, LiveDefaultOrder will be used; otherwise, VoDDefaultOrder will be taken into consideration. Default configuration in LiveDefaultOrder/VoDDefaultOrder orders the results by their IDs.
The result could be filtered by SubscriptionType and CatalogItemType.
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.
Deprecated Parameter:
-The parameter includeChildMovies was deprecated in the 3.2 GVP version.
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.
- subscriptionType (subscriptionType, optional)
- List of SubscriptionType separated by comma, to filter the result required.
- catalogItemTypeFilter (catalogItemType, optional)
- List of CatalogItemTypeId 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 (SortType, optional)
- SortTypeId to order result by the chosen field
- sortOrder (SortOrder, optional)
- SortOrderId to order ascending/descending. Ascending default (if not provided)
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 |
| 3.2 |
New: Deprecated:
- includeChildMovies |
Ricardo Calvo |
