Difference between revisions of "ProtectRecording"

From Gvp-public
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 |...")
 
Line 37: Line 37:
 
:  "Severity": 1,
 
:  "Severity": 1,
 
:  "StatusMessage": "OK",
 
:  "StatusMessage": "OK",
:  "Content": true
+
:  "Content": [[ProtectionStateObject]]
 
}
 
}
  

Revision as of 13:54, 11 April 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 item that wants to untag.
  • 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


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


See also