Difference between revisions of "GetChannelTopHighlights"

From Gvp-public
Jump to navigation Jump to search
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
 
Description=
 
Description=
<div style="background-color:red; padding:10px;">GVP 3.0 - DEPRECATED in next versions: This method will be migrated to GetChannelEditorialContents</div>
+
<div style="background-color:red; padding:10px;">
 +
GVP 3.0 - DEPRECATED in next versions: This method will be migrated to GetChannelEditorialContents.
 +
 
 +
'''Since the GVP 3.0 this method will use the GetChannelEditorialContent to return the desired content against broken old legacy devices.'''
 +
</div>
  
 
It will ONLY return EditorialContent that have associated GVP_MOVIES.
 
It will ONLY return EditorialContent that have associated GVP_MOVIES.
  
Only movies (Serie, season, episode or movie type) with availability
+
* 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.
+
* If there is no editorial content in the selected channel, a recursive call is executed to the parent channel.
  
 
<br>
 
<br>

Revision as of 20:41, 23 March 2015

Description

GVP 3.0 - DEPRECATED in next versions: This method will be migrated to GetChannelEditorialContents.

Since the GVP 3.0 this method will use the GetChannelEditorialContent to return the desired content against broken old legacy devices.

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


See also