editor
725
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=Returns the list of SimpleMovie object with all Season in the Series searched. Used to show, on the device client, a list of all seasons ava..."
{{Api_Method_Spec|
Description=Returns the list of [[SimpleMovie]] object with all Season in the Series searched. Used to show, on the device client, a list of all seasons available in Series.
The result is default ordered by the Title field and default filtered by NonAdultOnly. The method can be used by logged or anonymous user.
|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=movieId
|ParamType=int
|ParamRequired=required
|ParamDescription=The id of the Series that wants to retrieve the list of Seasons.
}}
{{Api_Parameter|
ParamName=adultFilter
|ParamType=int
|ParamRequired=optional
|ParamDescription=String separated by comma with the [[AdultFilterType]] to filter the result.
}}
{{Api_Parameter|
ParamName=sort
|ParamType=int
|ParamRequired=optional
|ParamDescription=Id of a [[MovieSortType]] to order the result. The default is 2 (title).
}}
|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;">6</span>,
: <span style="color: #a11;">"List"</span>:
:: [ <span style="color: #219;">Array of [[SimpleMovie]] objects</span> ]
}
|Exceptions=
None
|Cache=
This method is not 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 [[SimpleMovie]] object with all Season in the Series searched. Used to show, on the device client, a list of all seasons available in Series.
The result is default ordered by the Title field and default filtered by NonAdultOnly. The method can be used by logged or anonymous user.
|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=movieId
|ParamType=int
|ParamRequired=required
|ParamDescription=The id of the Series that wants to retrieve the list of Seasons.
}}
{{Api_Parameter|
ParamName=adultFilter
|ParamType=int
|ParamRequired=optional
|ParamDescription=String separated by comma with the [[AdultFilterType]] to filter the result.
}}
{{Api_Parameter|
ParamName=sort
|ParamType=int
|ParamRequired=optional
|ParamDescription=Id of a [[MovieSortType]] to order the result. The default is 2 (title).
}}
|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;">6</span>,
: <span style="color: #a11;">"List"</span>:
:: [ <span style="color: #219;">Array of [[SimpleMovie]] objects</span> ]
}
|Exceptions=
None
|Cache=
This method is not 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=
}}
