Difference between revisions of "DisableUser"

From Gvp-public
Jump to navigation Jump to search
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
Description=Disable the currently user.
+
Description=Disable the currently user. Only the UserID is necessary.
  
 
|Parameters=
 
|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|
 
{{Api_Parameter|
 
ParamName=userId
 
ParamName=userId

Latest revision as of 20:20, 16 July 2014

Description

Disable the currently user. Only the UserID is necessary.

Parameters

  • userId (int, required)
The user ID to be disabled.


Returns

Returns a JSON object containing a status true or false if the change was a successfully

Example:

{

"StatusCode": 0,
"Severity": 1,
"StatusMessage": "OK",
"Content": true

}


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


See also