Get GroupList

Function Name: getGetGroupListExtXml

Class: com.newgen.dmsapi.DMSInputXml

Description: This call is used to get the List of Sub-Groups of the specified User Group of the System.

Input Parameters	Sample InputXML
Output Parameters	Sample OutputXML
View xml API::NGOGetGroupListExt

Prototype:

public String getGetGroupListExtXml( String cabinetName, String userDbId,

String userIndex, String orderBy,

String sortOrder, String previousIndex,

String lastSortField, String noOfRecordsToFetch,

String mainGroupIndex, String groupType);

OverLoaded:

public String getGetGroupListExtXml( String cabinetName, String userDbId,

String userIndex, String orderBy,

String sortOrder, String previousIndex,

String lastSortField, String noOfRecordsToFetch,

String mainGroupIndex,GroupType, String groupType);

Input Parameters:

Name	Description	Valid Values	Default Behaviour
cabinetName	Name of the Database Cabinet to which the User wants to connect.		N/A
userDBId	UserDatabase ID, which is returned in the ConnectCabinet call.		N/A
userIndex	UserIndex can be specified to get the Groups for that particular User (that is, the Groups of which the User is a Member).		Not considered
orderBy	Indicates the field based on which the Group List will be sorted. For example, Name of Group, Index of Group etc.	1 – GroupIndex 2 - GroupName	N/A
sortOrder	Indicates whether Group List is to be sorted in Ascending or Descending order.	‘A’ – Ascending ‘D’ – Descending	‘A’
previousIndex	This tag is meant for the last Index of the Group received in the previous batch. For the first batch, 0 is to be sent.	Integer >= 0	N/A
lastSortField	This tag is meant for the value of the sorted column of the last Group received in the previous batch.		Blank
NoOfRecordsToFetch	Specifies the Number of Records to be fetched in the current batch.	Integer > 0	N/A
mainGroupIndex	This parameter is Reserved. The default value can be sent.	Integer >= 0	0
GroupType	Type of group A-for reserved and G- for general

Output Parameters:

An inputXml string of the NGOGetGroupListExt call.