NGOChangeUserProperty

This call is used to modify the Properties of an existing User. Tags for only those values should be sent which are to be changed and remaining values are retained.

 

Input Parameter description

View sample InputXml

Output Parameter description

View sample OutputXml

Errors and Warnings

 

 

Input Parameters description

Name

Parent Tag

Description

Valid Values

Default

Values

Option

Root

Unique option for the call.

NGOChange

UserProperty

N/A

CabinetName

Root

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

 

N/A

UserDBId

Root

UserDatabase ID that is returned in the NGOConnect

Cabinet call.

 

N/A

CreationDate

Time

Root

Date and time of the creation of the user.

 

 

UserIndex

Root

Index of the User whose Properties are to be changed.

Integer > 0

N/A

Name

Root

New Name of the User.

 

 

Password

Root

New Password of the User. 

Char 22 should be sent to remove the password.

 

PersonalName

Root

New first name of the User.

Char 22 should be sent to remove the first name.

 

FamilyName

Root

New last name of the User.

Char 22 should be sent to remove the family name.

 

Privileges

Root

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

Root

New comments to be associated with the User.

Char 22 should be sent to remove the comments.

 

Account

Root

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

0 – normal account

1 – Super account

 

 

ExpiryDateTime

Root

Date and Time of expiry of the User’s account.

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

 

UserAlive

Root

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

'Y' - Alive

'N' - Not Alive.

 

MailId

Root

Email id of the given user.

 

 

Fax

Root

Fax number of the given user.

 

 

NoteColor

Root

Color preference of the user.

 

 

OldPassword

Root

Old Password of the User.

 

 

SuperiorIndex

Root

Index of the superior.

 

 

SuperiorFlag

Root

Flag indicates whether superior is a User or a Role of a group.

 

 

ParentGroupIndex

Root

Parent Group Index

 

 

DeletePrevMembership

Root

Delete previous membership flag.

 

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

Unique option for the call.

Status

Root

Status of the call. If the Status is 0, then the call is successful.

User

Root

Contains information about User.

UserIndex

User

Index of the User.

Name

User

Name of the User.

CreationDateTime

User

Date and Time of creation of the User.

ExpiryDateTime

User

Date and Time of expiry of the User.

Privileges

User

Privileges of the User.

Comment

User

Any comment associated with the User.

Account

User

Specifies the type of account of the User.

0 – Normal Account

1 – Super Account

DeletedDateTime

User

Date and Time of deletion of the User.

UserAlive

User

Specifies whether the User is alive or not.

'Y' - Alive

'N' - Not Alive.

By default, the value is 'Y' for every User, but the Users account can be temporarily suspended by making UserAlive 'N'.

UserInbox

User

Index of Inbox Folder of the User.

UserSentItem

User

Index of SentItem Folder of the User.

UserTrash

User

Index of Trash Folder of the User.

PersonalName

User

First Name of the User.

FamilyName

User

Last Name of the User.

Password

User

Password of the User.

ParentGroupIndex

User

Parent Group Index.

SuperiorFlag

User

Superior Flag.

SuperiorIndex

User

Index of the Superior.

GroupRoleIndex

User

Returned only when SuperiorFlag = ‘G’.

 

Errors returned from call

Code

Message

Comments

-50058

Specified User does not exist.

User whose Property is to be changed does not exist.

-50064

Specified User is not alive.

Specified User’s account has been temporarily suspended. 

-50078

User is not Administrator.

This exception arises when Properties of the Supervisor User are to be changed and the logged in User is not a member of the Supervisor Group.

-50062

Logged in User cannot perform operation on self.

Logged in User cannot perform operation on themselves.

-50139

Expiry date cannot be less than current date.

This exception occurs when the Expiry Date of the User is changed and the User specifies the Date greater than the Current Date.

-50063

Specified User has expired.

User whose Property is to be changed has expired.

-50009

User with the same name already exists.

User with the Name provided in the input already exists.

-50116 

Insufficient privileges for the current operation.

Logged in User does not have Privilege for changing the Property of a User.

-50202

The Role does not Exist.

Role does not exist for the user whose properties are being modified.