Difference between revisions of "GetMovies"

From Gvp-public
Jump to navigation Jump to search
 
(4 intermediate revisions by 2 users not shown)
Line 3: Line 3:
  
 
The method can be used logged or anonymous user. There is no default order defined to return the content.
 
The method can be used logged or anonymous user. There is no default order defined to return the content.
 +
 +
Since GVP 3.2 version, this method doesn't take into account movie device availability, returning all the movies independently of their device availability, in the same way as [[GetMovie]] object.
  
 
|Parameters=
 
|Parameters=
Line 23: Line 25:
 
|ParamRequired=optional
 
|ParamRequired=optional
 
|ParamDescription=List of deviceTypes separated by comma, to return the info of [[PlaybackInfo]].
 
|ParamDescription=List of deviceTypes separated by comma, to return the info of [[PlaybackInfo]].
 +
}}
 +
{{Api_Parameter|
 +
ParamName= playType
 +
|ParamType=[[PlayType]]
 +
|ParamRequired=optional
 +
|ParamDescription=PlayType of the media associated with the movie.
 
}}
 
}}
  
Line 61: Line 69:
 
{{!}} Added deviceTypes filter
 
{{!}} Added deviceTypes filter
 
{{!}} Alberto Los Santos
 
{{!}} Alberto Los Santos
 +
{{!}}- valign="top"
 +
! 3.2
 +
{{!}} Device availability filtering has been removed
 +
{{!}} Francisco Milagro
 +
{{!}}- valign="top"
 +
! 3.2
 +
{{!}} Added playType
 +
{{!}} Pedro Caamaño
 
{{!}}}
 
{{!}}}
  
 
|SeeAlso=
 
|SeeAlso=
 
}}
 
}}

Latest revision as of 16:46, 10 February 2016

Description

Return a list of movies from a list of id movies.

The method can be used logged or anonymous user. There is no default order defined to return the content.

Since GVP 3.2 version, this method doesn't take into account movie device availability, returning all the movies independently of their device availability, in the same way as GetMovie object.

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
  • movieIds (int, required)
List of Movie Ids separated by comma.
List of deviceTypes separated by comma, to return the info of PlaybackInfo.
PlayType of the media associated with the movie.


Returns

Returns a JSON object containing an array of Movie object.

Example:

{

"StatusCode": 0,
"Severity": 1,
"StatusMessage": "OK",
"Content":
[ Array of Movie 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
3.0 Added deviceTypes filter Alberto Los Santos
3.2 Device availability filtering has been removed Francisco Milagro
3.2 Added playType Pedro Caamaño


See also