Difference between revisions of "GetMediaUrl"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description= TODO |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying ...") |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description= | + | Description=Gets the media URL for mediaroom |
| − | |||
|Parameters= | |Parameters= | ||
| Line 13: | Line 12: | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=movieId | ParamName=movieId | ||
| − | |ParamType= | + | |ParamType=int |
| − | |ParamRequired= | + | |ParamRequired=required |
| − | |ParamDescription= | + | |ParamDescription=A movie id that wants to be returned the information. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=mediaId | ParamName=mediaId | ||
| − | |ParamType= | + | |ParamType=int |
| − | |ParamRequired= | + | |ParamRequired=required |
| − | |ParamDescription= | + | |ParamDescription=A media ID that belongs to the movie wanted. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=pin | ParamName=pin | ||
| − | |ParamType= | + | |ParamType=int |
| − | |ParamRequired= | + | |ParamRequired=required |
| − | |ParamDescription= | + | |ParamDescription=The parent PIN for the current user. |
}} | }} | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing a | + | Returns a JSON object containing a [[MediaUrlResult]] object. |
'''Example:''' | '''Example:''' | ||
| Line 40: | Line 39: | ||
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>, | : <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>, | ||
: <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: #219;"> | + | : <span style="color: #a11;">"Content"</span>: <span style="color: #219;">[[MediaUrlResult ]]</span> |
} | } | ||
Latest revision as of 19:09, 10 September 2014
Description
Gets the media URL for mediaroom
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- movieId (int, required)
- A movie id that wants to be returned the information.
- mediaId (int, required)
- A media ID that belongs to the movie wanted.
- pin (int, required)
- The parent PIN for the current user.
Returns
Returns a JSON object containing a MediaUrlResult object.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": MediaUrlResult
}
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 |
