Difference between revisions of "GetMovies"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Return a list of movies from a list of id movies. |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |Par...") |
|||
| (8 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
Description=Return a list of movies from a list of id movies. | 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= | |Parameters= | ||
| Line 11: | Line 15: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=movieIds |
|ParamType=int | |ParamType=int | ||
| − | |ParamRequired= | + | |ParamRequired=required |
| − | |ParamDescription= | + | |ParamDescription=List of Movie Ids separated by comma. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName= deviceTypes |
| − | |ParamType= | + | |ParamType=List of [[deviceType]] |
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription= | + | |ParamDescription=List of deviceTypes separated by comma, to return the info of [[PlaybackInfo]]. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName= playType |
| − | |ParamType= | + | |ParamType=[[PlayType]] |
| − | |ParamRequired= | + | |ParamRequired=optional |
| − | |ParamDescription= | + | |ParamDescription=PlayType of the media associated with the movie. |
}} | }} | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing an array of [[ | + | Returns a JSON object containing an array of [[Movie]] object. |
'''Example:''' | '''Example:''' | ||
{ | { | ||
| − | : <span style="color: #a11;">" | + | : <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>, |
| − | : <span style="color: #a11;">" | + | : <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>, |
| − | : <span style="color: #a11;">" | + | : <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>, |
| − | : <span style="color: #a11;">" | + | : <span style="color: #a11;">"Content"</span>: |
| − | :: [ <span style="color: #219;">Array of [[ | + | :: [ <span style="color: #219;">Array of [[Movie]] objects</span> ] |
} | } | ||
|Exceptions= | |Exceptions= | ||
| − | + | None | |
|Cache= | |Cache= | ||
| Line 61: | Line 65: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- valign="top" | ||
| + | ! 3.0 | ||
| + | {{!}} Added deviceTypes filter | ||
| + | {{!}} 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.
- 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 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 |
