DisableUser

From Gvp-public
Revision as of 19:50, 16 July 2014 by Rcalvo (talk | contribs) (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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Description

Set the user to disable status.

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


See also