NGOGetGroupListExt

This call is used to get the List of Groups available in the Cabinet. The Groups can be fetched and sorted on Name or Index. Sorting can be done on ascending or descending order. The Group 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 Groups in the System and the number of Groups fetched in the current batch.

All Groups, of which a particular User is a member, can also be fetched through the call. UserIndex can be specified to get the Groups for that particular User (i.e., the Groups of which the User is a member).

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.	NGOGetGroupList Ext	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
UserIndex	Root	UserIndex can be specified to get the Groups for that particular User (i.e., the Groups of which the User is member).		Not considered
GroupType	Root	Type of the ~~group~~s that are to be fetched in the Group List.	‘G’ – General ‘A’ – Reserved ‘B’ - Both	‘G’
OrderBy	Root	Indicates the field on which the Group List will be sorted. For example, Name of the ~~Group~~, Index of Group etc.	1 – GroupIndex 2 - GroupName	N/A
SortOrder	Root	Indicates whether Group List is to be sorted in Ascending order or Descending order.	‘A’ – Ascending ‘D’ - Descending	‘A’
PreviousIndex	Root	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
NoOfRecords ToFetch	Root	Specifies the Number of Records to be fetched in the current batch.	Integer > 0	N/A
LastSortField	Root	This tag is meant for the value of the sorted column of the last Group received in the previous batch.		Blank
MainGroup Index	Root	This parameter is Reserved . The default value can be sent.	Integer >= 0	0

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.
NoOfRecordsFetched	Root	Number of Records fetched in the current batch.
TotalNoOfRecords	Root	Used for getting Group 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 the same.
Groups	Root	Contains information about the Groups fetched in the current batch.
Group	Groups	Contains information about one Group of the current batch.
GroupIndex	Group	Index of the Group.
MainGroupIndex	Group	This parameter is Reserved.
GroupName	Group	Name of the Group.
CreationDateTime	Group	Date and Time of creation of the Group.
ExpiryDateTime	Group	Date and Time of expiry of the Group.
Privileges	Group	Privileges of the Group.
OwnerIndex	Group	Index of the Owner of the Group.
OwnerName	Group	Name of Owner of the Group.
Comment	Group	Any comment associated with the Group.
GroupType	Group	Type of the Group, namely ‘G’ for General, ‘A’ is Reserved.
ParentGroupIndex	Group	Indicates the parent Group index of the Group

Errors returned from call

Code	Message	Comments
-50074	Invalid parameters.	Some parameters passed to the call are invalid. For example, GroupType specified is not valid. It can be either “G”,”A”,”B”.