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...") |
|||
| Line 11: | Line 11: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=movieIds |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|ParamType=int | |ParamType=int | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=List of Movie Ids separated by comma. |
}} | }} | ||
|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= | ||
Revision as of 19:26, 16 June 2014
Description
Return a list of movies from a list of id movies.
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.
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 |
