Difference between revisions of "GetMovie"

From Gvp-public
Jump to navigation Jump to search
Line 17: Line 17:
 
|ParamRequired=required
 
|ParamRequired=required
 
|ParamDescription=The ID number of the movie that wants the data.
 
|ParamDescription=The ID number of the movie that wants the data.
 +
}}
 +
{{Api_Parameter|
 +
ParamName= deviceTypes
 +
|ParamType=List of int
 +
|ParamRequired=optional
 +
|ParamDescription=List of deviceTypes to return the info of playbackInfo.
 
}}
 
}}
  
 
|Returns=
 
|Returns=
Returns a JSON object containing an array of [[Movie]].
+
Returns a JSON object containing a [[Movie]].
  
 
'''Example:'''
 
'''Example:'''
Line 51: Line 57:
 
{{!}} Initial method design
 
{{!}} Initial method design
 
{{!}} Harley Cabral
 
{{!}} Harley Cabral
 +
{{!}}}
 +
 +
! 3.0
 +
{{!}} Added deviceTypes filter
 +
{{!}} Alberto Los Santos
 
{{!}}}
 
{{!}}}
  
 
|SeeAlso=
 
|SeeAlso=
 
}}
 
}}

Revision as of 11:26, 6 March 2015

Description

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

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.
  • deviceTypes (List of int, optional)
List of deviceTypes 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