NGOGetUserProperty

This call is used to get the properties Properties of an existing UserUser in the cabinetCabinet.

 

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.

NGOGetUser

Property

N/A

CabinetName

Root

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

 

N/A

UserDBId

Root

UserDatabase ID, which that is returned in the NGOConnect

Cabinet call.

 

N/A

UserIndex

Root

Index of the User whose Pproperty is to be fetched.

Integer > 0

N/A

DataAlsoFlag

Root

Specifies whether information about the groups and roles ,related to that user, should be retrived or not.

‘Y’ – Yes

‘N’- No

‘N’

 

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 the 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.

Password

User

Password of the User.

Comment

User

Any comment associated with the User.

Account

User

Specifies the tType of account of the User.

0 - Normal Account

1 - Super Account

By default, all the Users in the system System have a Normal account and only the supervisor Supervisor User has System 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 as 'N'.

UserInbox

User

Index of the Inbox Folder of the User.

UserSentItem

User

Index of the SentItem Folder of the User.

UserTrash

User

Index of the 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.

NoteColor

User

Color of the note for the user.

Mail

User

Email id of the given user.

Fax

User

Fax number of the given user.

 

 

 

 

Errors returned from call

Code

Message

Comments

-50058

Specified User does not exist.

User whose property Property needs to be fetched does not exist.

-50063

 

Specified User has expired.

User whose property Property is to be fetched has expired.

-50064

 

Specified User is not alive.

Account of User whose property Property is to be fetched has been temporarily suspended.