Difference between revisions of "GetPersonSimpleMovies"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Get an array of simple movie that include the person id sent in the personId field. |Parameters= {{Api_Parameter| ParamName=token |ParamType=S...") |
|||
Line 1: | Line 1: | ||
+ | {{Deprecated|Message=This method has been deprecated in GVP 3.2.}} | ||
+ | |||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
Description=Get an array of simple movie that include the person id sent in the personId field. | Description=Get an array of simple movie that include the person id sent in the personId field. |
Latest revision as of 09:19, 24 February 2016
Description
Get an array of simple movie that include the person id sent in the personId field.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- offset (int, optional)
- The offset number of the returned values for this request
- limit (int, optional)
- The limit number of values for this request
- personId (int, required)
- The number (ID) of one person that wants to be returned on the request.
- role (int, optional)
- Set a filter to return only product that the person has the role defined.
- typeFilter (String, optional)
- List of numbers separated by comma with the MovieType to filter the result. Default set to Movie and Season (1, 3).
- adultFilter (adultFilterType, optional)
- 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.
- sort (movieSortType, optional)
- SortTypeId to order result by the chosen field. Default ordered by Title property.
Returns
Returns a JSON object containing an array of SimpleMovie.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 6,
- "List":
- [ Array of SimpleMovie objects ]
}
Exceptions
- None
Caching
This method is not cached.
Known issues
- None
Version history
API Version Number | Change description | Changes author |
---|---|---|
1.0 | Initial method design | Harley Cabral |