Bureaucrats, editor
349
edits
Changes
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 |..."
{{Api_Method_Spec|
Description=Protect or unprotect recording
This method only can be used by logged user.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=RecordingId
|ParamType=int
|ParamRequired=required
|ParamDescription=The ID of the item that wants to untag.
}}
{{Api_Parameter|
ParamName=Protected
|ParamType=Boolean
|ParamRequired=required
|ParamDescription=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": true
}
|Exceptions=
* [[AuthenticationRequiredException]]
* [[RecordingNotFoundException]]
* [[AlreadyProtectedException]]
* [[AlreadyUnprotectedException]]
|Cache=
This method is not cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 7.0
{{!}} Initial method design
{{!}} José Manuel Escartín
{{!}}}
|SeeAlso=
}}
Description=Protect or unprotect recording
This method only can be used by logged user.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=RecordingId
|ParamType=int
|ParamRequired=required
|ParamDescription=The ID of the item that wants to untag.
}}
{{Api_Parameter|
ParamName=Protected
|ParamType=Boolean
|ParamRequired=required
|ParamDescription=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": true
}
|Exceptions=
* [[AuthenticationRequiredException]]
* [[RecordingNotFoundException]]
* [[AlreadyProtectedException]]
* [[AlreadyUnprotectedException]]
|Cache=
This method is not cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 7.0
{{!}} Initial method design
{{!}} José Manuel Escartín
{{!}}}
|SeeAlso=
}}
