1. Home / Web Services API Version 8.x / ChangeUserStatus

ChangeUserStatus

Changes the status of the specified user account.

Syntax

Visual Basic (declaration) 
Public Function ChangeUserStatus( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal UserName as String, _ 
	ByVal StatusCode as  Integer) as XmlNode

C# (declaration) 
public XmlNode ChangeUserStatus( 
	string AuthenticationTicket,
	string UserName,
	int StatusCode)

Parameters

AuthenticationTicket
    string inforouter ticket
UserName
    string The UserName of the user
StatusCode
    int New user staus code - See the remarks section

Return Value

returns xml fragment.
<response success="true" error="">
if success attribute is "true", the User status has been changed successfully.
if success attribute is "false", the error attribute indicates the encountered error.

Remarks

The caller must be the system administrator or the domain manager of the user.

The Status might be the following values:
0: DISABLED USER
1: ENABLED USER
2: READONLY USER

See Also