Function
Name:
getUserListExtXml
Class:
com.newgen.dmsapi.DMSInputXml
Description: This function is used to get the List of the Users
available in the specified Group or the entire Cabinet. The Users can be
fetched and sorted on Name or Index. Sorting can be done either in ascending or
descending order. The fetched User Lists are in batches. User has to specify
the Previous Index value and Previous sort field value. This 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.
|
Prototype:
public String getUserListExtXml( String cabinetName, String
userDBId,
String
groupIndex, String orderBy,
String
sortOrder, String prevIndex,
String
lastSortField, String noOfRecordsToFetch
String
excludeGroupList,
String
gpIdsToExclude);
Overloaded functions
public String getUserListExtXml( String cabinetName, String
userDBId,
String
groupIndex, String orderBy,
String
sortOrder, String prevIndex,
String
lastSortField, String noOfRecordsToFetch,
String
gpIdsToExclude);
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. |
|
|
groupIndex |
Index of the Group
whose User List is to be fetched. |
Integer > 0 |
N/A |
orderBy |
Indicates the field
on which the User List will be sorted. For example, Name of the User, Index
of User etc. |
1 – UserIndex 2 - UserName |
N/A |
sortOrder |
Indicates whether
the User List will be sorted in ascending or descending order. |
‘A’ – Ascending ‘D’ – Descending |
‘A’ |
prevIndex |
This parameter is
meant for the last Index of the User received in the previous batch. This
parameter should be 0 for the first batch. |
Integer > = 0 |
N/A |
lastSortField |
This parameter is
meant for the value of the sorted column of the last User received in the
previous batch. This parameter should be blank for the first batch. |
|
|
noOfRecordsToFetch |
Number of Records
to be fetched in the current batch. |
Integer > 0 |
|
excludeGroupList |
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 |
An inputXml string of
the NGOGetUserListExt call.