Difference between revisions of "ProtectRecording"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Protect or unprotect recording This method only can be used by logged user. |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |...") |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 16: | Line 16: | ||
|ParamType=int | |ParamType=int | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription=The ID of the | + | |ParamDescription=The ID of the recording to protect/unprotect |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 37: | Line 37: | ||
: "Severity": 1, | : "Severity": 1, | ||
: "StatusMessage": "OK", | : "StatusMessage": "OK", | ||
| − | : "Content": | + | : "Content": [[ProtectionStateObject]] |
} | } | ||
|Exceptions= | |Exceptions= | ||
| − | * [[AuthenticationRequiredException]] | + | * [[AuthenticationRequiredException]] - i.e.:With anonymous token |
| − | * [[RecordingNotFoundException]] | + | * [[RecordingNotFoundException]] - i.e.: With RecordingID not existent |
| − | |||
| − | |||
|Cache= | |Cache= | ||
Latest revision as of 07:10, 4 September 2019
Description
Protect or unprotect recording
This method only can be used by logged user.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- RecordingId (int, required)
- The ID of the recording to protect/unprotect
- Protected (Boolean, required)
- Sets protection to true or false
Returns
Returns a statuscode 0 if the protection/unprotection is done properly
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": ProtectionStateObject
}
Exceptions
- AuthenticationRequiredException - i.e.:With anonymous token
- RecordingNotFoundException - i.e.: With RecordingID not existent
Caching
This method is not cached.
Known issues
- None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 7.0 | Initial method design | José Manuel Escartín |
