Change User Property

 

Function Name: getChangeUserPropertyXml

 

Class: com.newgen.dmsapi.DMSInputXml

 

Description: This function is used to retrieve the Property / details of the specified User of the System.

 

Input Parameters

Sample InputXML

Output Parameters

Sample OutputXML

View xml API::NGOChangeUserProperty

 

 

Prototype:

public String getChangeUserPropertyXml(String cabinetName, String userDBId,

String userIndex, String userName,

String password, String personalName,

String familyName, String privileges,

String comment, String account,

String deletedDateTime, String userAlive,

String userMailId, String UserFax)

Overloaded:

 

public String getChangeUserPropertyXml(String cabinetName, String userDBId,                                                                                                                               String creationDateTime, String userIndex,String userName, String password,

                                String personalName,String familyName,String expiryDateTime,String privileges,String account,

                                String userAlive,String comment,String mailId,String fax,String noteColor,String oldPassword,String superiorIndex,String superiorFlag,String parentGroupIndex,String deletePrevMembership)

               

 

 

Input Parameters:

Name

Description

Valid Values

Default Behaviour

cabinetName

Name of the Database Cabinet to which the User wants to connect.

 

 

userDBId

UserDatabase ID, which is returned in the ConnectCabinet call.

 

 

userIndex

Index of the Group to which Users are to be added.

 Integer > 0

N/A

username

New Name of the User.

 

 

password

New Password of the User. 

‘µ’ (char 181) should be sent to remove the Password.

 

personalName

New first Name of the User.

‘µ’ (char 181) should be sent to remove the First Name.

 

familyName

New last Name of the User.

‘µ’ (char 181) should be sent to remove the Family Name.

 

privileges

Specifies the various Privileges assigned to the User.

String of seven bits, each 0 or 1 depending upon whether that particular Privilege is to be given to the User or not.

 

comment

New comments to be associated with the User.

‘µ’ (char 181) should be sent to remove the comments.

 

account

Specifies the type of Account of the User. Only the Supervisor User can change a User Account to Super Account.

0 – Normal Account

1- Super account

 

 

deletedDateTime

Date and Time of deletion of the User.

Valid Date in the format yyyy-mm-dd hh:mm:ss

 

userAlive

Specifies whether the User is alive or not. User can also be temporarily suspended from the System, when User is not alive.

'Y' - Alive

'N' - Not Alive.

 

userMailId

Mail Id of the User.

 

 

userFax

Fax Number of the User.

 

 

SuperiorIndex

Index of the superior

 

 

ParentGroupIndex

Index of the parent group

 

 

 

Output Parameters:

An inputXml string of the NGOChangeUserProperty call.