editor
725
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=This method has to return an ordered list of EditorialContent. This method will take into account the Start and End Date of the Content, to..."
{{Api_Method_Spec|
Description=This method has to return an ordered list of [[EditorialContent]].
This method will take into account the Start and End Date of the Content, to filter out everything. Also will take into account the ordering of the elements defined in the MIB Channel Editorial Contents block.
'''Important: It won't filter by Adult property, as adult contents must only be linked to adult channels.'''
It will return ALL the EditorialContents (either they have catalog item associated or not; or either the editorial content has an image linked or not).
|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=The channel id that want to return the editorial content registered inside then.
}}
|Returns=
Returns a JSON object containing an array of [[EditorialContent]].
'''Example:'''
{
: "Offset": 0,
: "Limit": 100,
: "Count": 6,
: "List":
:: [ Array of [[EditorialContent]] List ]
}
|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"
! 3.0
{{!}} Initial method design
{{!}} Ricardo Calvo
{{!}}}
|SeeAlso=
* [[GetChannelSimpleMovies]]
}}
Description=This method has to return an ordered list of [[EditorialContent]].
This method will take into account the Start and End Date of the Content, to filter out everything. Also will take into account the ordering of the elements defined in the MIB Channel Editorial Contents block.
'''Important: It won't filter by Adult property, as adult contents must only be linked to adult channels.'''
It will return ALL the EditorialContents (either they have catalog item associated or not; or either the editorial content has an image linked or not).
|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=The channel id that want to return the editorial content registered inside then.
}}
|Returns=
Returns a JSON object containing an array of [[EditorialContent]].
'''Example:'''
{
: "Offset": 0,
: "Limit": 100,
: "Count": 6,
: "List":
:: [ Array of [[EditorialContent]] List ]
}
|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"
! 3.0
{{!}} Initial method design
{{!}} Ricardo Calvo
{{!}}}
|SeeAlso=
* [[GetChannelSimpleMovies]]
}}
