Difference between revisions of "GetMovie"

From Gvp-public
Jump to navigation Jump to search
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
 
Description=Return the Movie object with the complete information about a specific movie.
 
Description=Return the Movie object with the complete information about a specific movie.
 +
 +
The behaviour of method GetMovie about Medias and Trailers is the following.
 +
Inside  Medias:
 +
  All medias of type Movie(1) are returned for each requested playType
 +
  Best media of type Trailer(2) is returned for each requested playType
 +
Inside Trailers:
 +
  All Medias of type Trailers(2) is returned for everyPlayType (even if not specific playtype is requested)
  
 
The method can be used logged or anonymous user.
 
The method can be used logged or anonymous user.

Revision as of 13:01, 14 September 2015

Description

Return the Movie object with the complete information about a specific movie.

The behaviour of method GetMovie about Medias and Trailers is the following.

Inside  Medias:
 All medias of type Movie(1) are returned for each requested playType
 Best media of type Trailer(2) is returned for each requested playType
Inside Trailers:
 All Medias of type Trailers(2) is returned for everyPlayType (even if not specific playtype is requested)

The method can be used logged or anonymous user.

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
  • movieId (int, required)
The ID number of the movie that wants the data.
List of deviceTypes separated by comma, to return the info of PlaybackInfo.


Returns

Returns a JSON object containing a Movie.

Example:

{

"StatusCode": 0,
"Severity": 1,
"StatusMessage": "OK",
"Content":
{ Movie 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
3.0 Added deviceTypes filter Alberto Los Santos


See also