editor
725
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=Returns the list of Product objects available in the instance under an specific Channel. It can include all sub channels (any levels) or jus..."
{{Api_Method_Spec|
Description=Returns the list of [[Product]] objects available in the instance under an specific Channel. It can include all sub channels (any levels) or just the first level of sub channel.
The result is default ordered by the property Title in the object [[SimpleMovie]]. This method can be used by logged or anonymous login.
|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=includeChildMovies
|ParamType=bool
|ParamRequired=optional
|ParamDescription=Flag to set if the result should be contain all Movies in all sub channels from the specified in the channelId parameter. The default value is false.
}}
{{Api_Parameter|
ParamName=typeFilter
|ParamType=String
|ParamRequired=optional
|ParamDescription=List of numbers separated by comma with the [[MovieType]] to filter the result.
}}
{{Api_Parameter|
ParamName= adultFilter
|ParamType= [[adultFilterType]]
|ParamRequired=optional
|ParamDescription=Type to represent Unknown, All, AdultOnly or NonAdultOnly. If the content is for adult and/or not adult or both. The default value is NonAdultOnly.
}}
{{Api_Parameter|
ParamName= sort
|ParamType= [[movieSortType]]
|ParamRequired=optional
|ParamDescription=SortTypeId to order result by the chosen field.
}}
{{Api_Parameter|
ParamName= productTypeFilter
|ParamType= [[productTypeFilter]]
|ParamRequired=optional
|ParamDescription=List of productTypeFilter separated by comma to filter the result.
}}
|Returns=
Returns a JSON object containing an array of [[SimpleMovie]].
'''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;">14</span>,
: <span style="color: #a11;">"List"</span>:
:: [ <span style="color: #219;">Array of [[Product]] 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=
}}
Description=Returns the list of [[Product]] objects available in the instance under an specific Channel. It can include all sub channels (any levels) or just the first level of sub channel.
The result is default ordered by the property Title in the object [[SimpleMovie]]. This method can be used by logged or anonymous login.
|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=includeChildMovies
|ParamType=bool
|ParamRequired=optional
|ParamDescription=Flag to set if the result should be contain all Movies in all sub channels from the specified in the channelId parameter. The default value is false.
}}
{{Api_Parameter|
ParamName=typeFilter
|ParamType=String
|ParamRequired=optional
|ParamDescription=List of numbers separated by comma with the [[MovieType]] to filter the result.
}}
{{Api_Parameter|
ParamName= adultFilter
|ParamType= [[adultFilterType]]
|ParamRequired=optional
|ParamDescription=Type to represent Unknown, All, AdultOnly or NonAdultOnly. If the content is for adult and/or not adult or both. The default value is NonAdultOnly.
}}
{{Api_Parameter|
ParamName= sort
|ParamType= [[movieSortType]]
|ParamRequired=optional
|ParamDescription=SortTypeId to order result by the chosen field.
}}
{{Api_Parameter|
ParamName= productTypeFilter
|ParamType= [[productTypeFilter]]
|ParamRequired=optional
|ParamDescription=List of productTypeFilter separated by comma to filter the result.
}}
|Returns=
Returns a JSON object containing an array of [[SimpleMovie]].
'''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;">14</span>,
: <span style="color: #a11;">"List"</span>:
:: [ <span style="color: #219;">Array of [[Product]] 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=
}}
