Difference between revisions of "GetMovie"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the A...") |
|||
| (10 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description= | + | 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= | |Parameters= | ||
| Line 15: | Line 24: | ||
|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 [[deviceType]] | ||
| + | |ParamRequired=optional | ||
| + | |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. | ||
}} | }} | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing | + | Returns a JSON object containing a [[Movie]]. |
'''Example:''' | '''Example:''' | ||
| Line 27: | Line 48: | ||
: <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;">[[Movie]] object</span> } |
} | } | ||
| Line 49: | Line 70: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- valign="top" | ||
| + | ! 3.0 | ||
| + | {{!}} Added deviceTypes filter | ||
| + | {{!}} Alberto Los Santos | ||
| + | {{!}}- valign="top" | ||
| + | ! 3.2 | ||
| + | {{!}} Added playType | ||
| + | {{!}} Pedro Caamaño | ||
{{!}}} | {{!}}} | ||
|SeeAlso= | |SeeAlso= | ||
}} | }} | ||
Latest revision as of 16:46, 10 February 2016
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.
- deviceTypes (List of deviceType, optional)
- List of deviceTypes separated by comma, to return the info of PlaybackInfo.
- playType (PlayType, optional)
- PlayType of the media associated with the movie.
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 |
| 3.2 | Added playType | Pedro Caamaño |
