This call is
used to get the List of the Users available in the specified Group or entire Cabinet.
The Users can be fetched and sorted on Name or Index. Sorting can be done
either on ascending or descending order. The User Lists fetched are in batches.
User has to specify the Previous Index
value and Previous Sort field value.
The call returns the total number of Users in the System and the number of Users
fetched in the current batch. Specifying GroupIndex
can fetch Users for that particular Group
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for the call. |
NGOGetUser ListExt |
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 NGOConnectCabinet
call. |
|
N/A |
|
GroupIndex |
Root |
Index of the Group whose User List is to be fetched. |
Integer > 0 |
N/A |
|
ExcludeGroup List |
Root |
If a User wants to find the Users of
a Group excluding the users belonging to the Excluded Group(s), then the
Groups to be excluded should be provided in the tag. For example, If there are two Groups –
A and B. If it is required to have a List of Users of A which are not there
in B. Then in <GroupIndex> tag, A is to be sent and in
<ExcludeGroupList> tag, B is to be sent. |
Comma-separated List of Group Indexes. |
Not considered. |
|
OrderBy |
Root |
Indicates the Field on which the User List will be sorted.
For example, Name of User, Index of User etc |
1 – UserIndex 2 - UserName |
N/A |
|
SortOrder |
Root |
Indicates whether User List will be sorted in ascending or descending order. |
‘A’ – Ascending ‘D’ – Descending |
‘A’ |
|
PreviousIndex |
Root |
This tag is meant for the Last Index
of the User received in the previous batch. This tag should be 0 for the
first batch. |
Integer > = 0 |
N/A |
|
LastSortField |
Root |
This tag is meant for the value of
the sorted column of the last User received in the previous batch. This tag
should be blank for the first batch. |
|
Blank |
|
NoOfRecordsTo Fetch |
Root |
Number of Records to be fetched in the current batch. |
Integer > 0 |
N/A |
|
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. |
|
NoOfRecordsFetched |
Root |
Number of Records fetched in the
current batch. |
|
TotalNoOfRecords |
Root |
Used for getting User List in
batches. The value for the TotalNoOfRecords fetched in output will be one
greater than the NoOfRecordsFetched; if more Records exist in the database
otherwise both the values will be same. |
|
Users |
Root |
Contains information about all the
Users fetched in the current batch. |
|
User |
Users |
Contains information about a single
User of the current batch. |
|
UserIndex |
User |
Index of the User. |
|
Name |
User |
Name of the User. |
|
CreationDateTime |
User |
Date and Time when the User was
created. |
|
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 By default all Users in the system
have a Normal account and only the 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 '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. |
|
NoteColor |
User |
Color of the note for the user. |
|
MailId |
User |
Email id of the given user. |
|
Fax |
User |
Fax number of the given user. |
|
ParentGroupIndex |
User |
Parent Group index of the user. |
|
SuperiorFlag |
User |
Flag indicating whether superior is a User or a Role of a
group. |
|
SuperiorIndex |
User |
Superior index of the user. |
|
GroupRoleIndex |
User |
GroupRole index of the user.
Returned only when the SuperiorFlag = ‘G’. |