Difference between revisions of "CanWatchMedia"
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=Checks if a user can watch the media |
| − | |||
|Parameters= | |Parameters= | ||
| Line 13: | Line 12: | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=assetId | ParamName=assetId | ||
| − | |ParamType= | + | |ParamType=int |
| − | |ParamRequired= | + | |ParamRequired=optional |
|ParamDescription= | |ParamDescription= | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=drmKeyId | ParamName=drmKeyId | ||
| − | |ParamType= | + | |ParamType=String |
| − | |ParamRequired= | + | |ParamRequired=optional |
| − | |ParamDescription= | + | |ParamDescription=Media DRM key Id |
}} | }} | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing a number | + | Returns a JSON object containing a number Id of media. |
'''Example:''' | '''Example:''' | ||
| Line 34: | Line 33: | ||
: <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;">1</span> |
} | } | ||
Latest revision as of 14:58, 31 July 2014
Description
Checks if a user can watch the media
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- assetId (int, optional)
- drmKeyId (String, optional)
- Media DRM key Id
Returns
Returns a JSON object containing a number Id of media.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": 1
}
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 |
