Difference between revisions of "DisableUser"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Set the user to disable status. |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A va...") |
|||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description= | + | Description=Disable the currently user. |
|Parameters= | |Parameters= | ||
Revision as of 20:03, 16 July 2014
Description
Disable the currently user.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- 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 |
