Difference between revisions of "GetUserRentedSimpleMovies"
Jump to navigation
Jump to search
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description=Return a list of products that the user has been rented but different of [[ | + | Description=Return a list of products that the user has been rented but different of [[GetUserRentedProducts]], the return from this method is a [[SimpleMovie]]. |
This method has a adultFilter, to filter the content by Adult or Non-Adult movies, TypeFilter to filter the type of the product wants to return and a sort field. | This method has a adultFilter, to filter the content by Adult or Non-Adult movies, TypeFilter to filter the type of the product wants to return and a sort field. | ||
| Line 55: | Line 55: | ||
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>, | : <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>, | ||
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>, | : <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>, | ||
| − | : <span style="color: #a11;">"Content"</span>: | + | : <span style="color: #a11;">"Content"</span>: [ |
:: <span style="color: #219;">Array of [[SimpleMovie]] object</span> | :: <span style="color: #219;">Array of [[SimpleMovie]] object</span> | ||
| − | : | + | : ] |
} | } | ||
Latest revision as of 19:26, 18 September 2014
Description
Return a list of products that the user has been rented but different of GetUserRentedProducts, the return from this method is a SimpleMovie. This method has a adultFilter, to filter the content by Adult or Non-Adult movies, TypeFilter to filter the type of the product wants to return and a sort field.
The result is default ordered by the Title field.
This method only can be used by logged user.
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
- typeFilter (String, optional)
- Comma separated list of SubscriptionType enumeration values (example "1,2,4") used to filter the result to return only the desired subscription types. If not provided it will return only Normal and AllPlaylist subscription types (default value = "1,4")
- adultFilter (adultFilterType, optional)
- Type to represent Unknown, All, AdultOnly or NonAdultOnly. If the content is for adult and/or not adult or both.
- sort ((movieSortType, optional)
- SortTypeId to order result by the chosen field
Returns
Returns a JSON object containing an array of SimpleMovie object.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": [
- Array of SimpleMovie object
- ]
}
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 |
