Difference between revisions of "GetChannelTopHighlights"
Jump to navigation
Jump to search
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{Deprecated|Message=This method has been deprecated in GVP 3.0. Please use [[GetChannelEditorialContents]] and [[GetCatalogItems]] instead}} | ||
| + | |||
| + | |||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description=Get the assigned contents of a channel in the specified position on the MIB tool. The content set in the MIB should be available for the device that request the content to be returned. | + | Description= |
| − | + | It will ONLY return EditorialContent that have associated GVP_MOVIES. | |
| − | + | ||
| + | * Only movies (Serie, season, episode or movie type) with availability | ||
| + | * If there is no editorial content in the selected channel, a recursive call is executed to the parent channel. | ||
| + | |||
| + | <br> | ||
| + | <span style="text-decoration:line-through">Get the assigned contents of a channel in the specified position on the MIB tool. The content set in the MIB should be available for the device that request the content to be returned.</span> | ||
| − | The maximum number of result is 10 because until the present date the MIB tool has only 10 position to set the editorials content. | + | <span style="text-decoration:line-through">This method can be used by logged or anonymous login.</span> |
| + | <span style="text-decoration:line-through">The result is default ordered by the ID field.</span> | ||
| + | |||
| + | <span style="text-decoration:line-through">The maximum number of result is 10 because until the present date the MIB tool has only 10 position to set the editorials content.</span> | ||
|Parameters= | |Parameters= | ||
| Line 35: | Line 46: | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing an array of | + | Returns a JSON object containing an array of TopHighlight object. |
'''Example:''' | '''Example:''' | ||
| Line 44: | Line 55: | ||
: <span style="color: #a11;">"Count"</span>: <span style="color: #164;">10</span>, | : <span style="color: #a11;">"Count"</span>: <span style="color: #164;">10</span>, | ||
: <span style="color: #a11;">"List"</span>: | : <span style="color: #a11;">"List"</span>: | ||
| − | :: [ <span style="color: #219;">Array of | + | :: [ <span style="color: #219;">Array of TopHighlight objects</span> ] |
} | } | ||
| Line 66: | Line 77: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- | ||
| + | ! 3.0 | ||
| + | {{!}} Method deprecated | ||
| + | {{!}} Francisco Milagro | ||
{{!}}} | {{!}}} | ||
| + | |||
|SeeAlso= | |SeeAlso= | ||
| + | *[[GetChannelEditorialContents]] | ||
| + | *[[EditorialContent]] Object | ||
| + | *[[GetCatalogItems]] | ||
}} | }} | ||
Latest revision as of 06:41, 21 August 2015
This method has been deprecated in GVP 3.0. Please use GetChannelEditorialContents and GetCatalogItems instead
Description
It will ONLY return EditorialContent that have associated GVP_MOVIES.
- Only movies (Serie, season, episode or movie type) with availability
- If there is no editorial content in the selected channel, a recursive call is executed to the parent channel.
Get the assigned contents of a channel in the specified position on the MIB tool. The content set in the MIB should be available for the device that request the content to be returned.
This method can be used by logged or anonymous login. The result is default ordered by the ID field.
The maximum number of result is 10 because until the present date the MIB tool has only 10 position to set the editorials content.
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
Returns
Returns a JSON object containing an array of TopHighlight object.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 10,
- "List":
- [ Array of TopHighlight 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 |
| 3.0 | Method deprecated | Francisco Milagro |
