editor
725
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=Get all movies that contains in a specific genre by one genreId. |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=r..."
{{Api_Method_Spec|
Description=Get all movies that contains in a specific genre by one genreId.
|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=genreId
|ParamType=int
|ParamRequired=required
|ParamDescription=Id of the Genre would to request the data.
}}
{{Api_Parameter|
ParamName=includeChildMovies
|ParamType=bool
|ParamRequired=optional
|ParamDescription=Include or not all channel children movies.
}}
{{Api_Parameter|
ParamName= typeFilter
|ParamType=String
|ParamRequired=optional
|ParamDescription=[[MovieType]] enum to filter the result required.
}}
{{Api_Parameter|
ParamName= adultFilter
|ParamType=String
|ParamRequired=optional
|ParamDescription=[[AdultFilterType]] enum to filter the result required. The default value to Adult filter is All.
}}
{{Api_Parameter|
ParamName= sort
|ParamType=int
|ParamRequired=optional
|ParamDescription=[[MovieSortType]] enum to order the result required. the default sort type is ReleaseDate.
}}
|Returns=
Returns a JSON object containing an array of Simplified [[Movie]] list.
'''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 [[Movie]] 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=Get all movies that contains in a specific genre by one genreId.
|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=genreId
|ParamType=int
|ParamRequired=required
|ParamDescription=Id of the Genre would to request the data.
}}
{{Api_Parameter|
ParamName=includeChildMovies
|ParamType=bool
|ParamRequired=optional
|ParamDescription=Include or not all channel children movies.
}}
{{Api_Parameter|
ParamName= typeFilter
|ParamType=String
|ParamRequired=optional
|ParamDescription=[[MovieType]] enum to filter the result required.
}}
{{Api_Parameter|
ParamName= adultFilter
|ParamType=String
|ParamRequired=optional
|ParamDescription=[[AdultFilterType]] enum to filter the result required. The default value to Adult filter is All.
}}
{{Api_Parameter|
ParamName= sort
|ParamType=int
|ParamRequired=optional
|ParamDescription=[[MovieSortType]] enum to order the result required. the default sort type is ReleaseDate.
}}
|Returns=
Returns a JSON object containing an array of Simplified [[Movie]] list.
'''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 [[Movie]] 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=
}}
