editor
725
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description= <div style="background-color:red; padding:10px;">GVP 3.0 - DEPRECATED in next versions: This method will be migrated to GetChannelEditorialCont..."
{{Api_Method_Spec|
Description=
<div style="background-color:red; padding:10px;">GVP 3.0 - DEPRECATED in next versions: This method will be migrated to GetChannelEditorialContents</div>
This method will return all the EditorialContents in a CatalogItem format if have GVP_MOVIES, GVP_SUBSCRIPTIONS, etc associated, returning the catalog item ID and Type filled. In case there is not any media type associated, the method will return 0/0 as catalog item id and type; but the other properties fulfilled, i.e. the "external links" as ExtraMetadata and/or the image (banner) linked to the EditorialContent as in:
<br>
<span style="text-decoration:line-through">Return the top recommended from a channel (Editorial content from 1-10)</span>
|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=Id of a channel that wants the result
}}
{{Api_Parameter|
ParamName=adultFilter
|ParamType=[[AdultFilterType]]
|ParamRequired=optional
|ParamDescription=Type to filter the result using adult filter
}}
|Returns=
Returns a JSON object containing an array of [[CatalogItem]] object.
'''Example:'''
{
: <span style="color: #a11;">"Offset"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Limit"</span>: <span style="color: #164;">100</span>,
: <span style="color: #a11;">"Count"</span>: <span style="color: #164;">10</span>,
: <span style="color: #a11;">"List"</span>:
:: [ <span style="color: #219;">Array of [[CatalogItem]] objects</span> ]
}
|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=
*[[GetChannelEditorialContents]]
*[[EditorialContent]] Object
}}
Description=
<div style="background-color:red; padding:10px;">GVP 3.0 - DEPRECATED in next versions: This method will be migrated to GetChannelEditorialContents</div>
This method will return all the EditorialContents in a CatalogItem format if have GVP_MOVIES, GVP_SUBSCRIPTIONS, etc associated, returning the catalog item ID and Type filled. In case there is not any media type associated, the method will return 0/0 as catalog item id and type; but the other properties fulfilled, i.e. the "external links" as ExtraMetadata and/or the image (banner) linked to the EditorialContent as in:
<br>
<span style="text-decoration:line-through">Return the top recommended from a channel (Editorial content from 1-10)</span>
|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=Id of a channel that wants the result
}}
{{Api_Parameter|
ParamName=adultFilter
|ParamType=[[AdultFilterType]]
|ParamRequired=optional
|ParamDescription=Type to filter the result using adult filter
}}
|Returns=
Returns a JSON object containing an array of [[CatalogItem]] object.
'''Example:'''
{
: <span style="color: #a11;">"Offset"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Limit"</span>: <span style="color: #164;">100</span>,
: <span style="color: #a11;">"Count"</span>: <span style="color: #164;">10</span>,
: <span style="color: #a11;">"List"</span>:
:: [ <span style="color: #219;">Array of [[CatalogItem]] objects</span> ]
}
|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=
*[[GetChannelEditorialContents]]
*[[EditorialContent]] Object
}}
