Difference between revisions of "GetPersonProducts"

From Gvp-public
Jump to navigation Jump to search
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
Description=
+
Description=Get all products that has as Staff the person sent in the personId parameter.
 +
 
  
 
|Parameters=
 
|Parameters=

Revision as of 14:37, 16 July 2014

Description

Get all products that has as Staff the person sent in the personId parameter.

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).
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.
SortTypeId to order result by the chosen field. Default ordered by Title property.


Returns

Returns a JSON object containing an array of Products.

Example:

{

"Offset": 0,
"Limit": 100,
"Count": 6,
"List":
[ Array of Product 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


See also