NGOGetDataDefListExt

This call is used to get the List of all the Data Definitions available in the Cabinet. The Data Definitions can be fetched and sorted on Name or Index. Sorting can be done on ascending or descending order. The Data Class lLists fetched are in batches. User has to specify the Previous index value and Previous sort field value. The call returns the total number of dData dDefinitions in the sSystem and the number of data definitionData Definitions fetched in the current batch.

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.	NGOGetData DefListExt	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
OrderBy	Root	Index on which iIndexing should be done.	Sorted on column 1 On Index, 2 On Name
SortOrder	Root	Sorting Order of the indexed field.	Ascending or Descending	A
PreviousIndex	Root	The index of last record in previous fetch.	Integer >= 0	0
LastSortField	Root	The value of the sorted column of the last Data Class received in the previous batch.	Depends upon the index field type.
NoOfRecordsTo Fetch	Root	No of Records to be fetched.	Integer >= 1	500
Type	Root	Type of Data Class.
GroupId	Root	Group iId for which the User wants to fetch Data Class. It is reserved and the User can pass default value.	Integer >= 1	0
Flag	Root	Flag indicates whether to , get the Data Class associated with document, folder or both.	F, D, B, *	*(Fetch all)

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. Else if less than zero, error is reported. Else warning is reported.
DataDefinitions	Root	It contains Information about the DataDefinitions fetched.
NoOfRecordsFetched	DataDefinitionsRoot	Number of records to be fetched is given in the input.
TotalNoOfRecords	DataDefinitionsRoot	Total numbers of records are there for the given criterion.
DataDefinition	Data Definitions	It contains Information for a particular DataDefinition.
DataDefIndex	Data Definitions	Index of the Data Class.
DataDefName	Data Definitions	Name of the Data Class.
LoginUserRights	Data Definitions	Rights of currently logged in User.
Comment	Data Definitions	Any comment added to the Data Class.
EnableLogFlag	Data Definitions	Enabled log flag info about the Data Class.
Type	Data Definitions	Type of Data Class.
GroupId	Data Definitions	Group index associated with Data Class.
Extra	Data Definitions	Extra info associated with Data Class.
Fields	Data Definition	Starting tag of the field’s details.
Field	Fields	Starting tag of the field details.
IndexAttribute	Field	Attribute of the associated field.
IndexId	Field	Index of the associated field.
IndexName	Field	Name of the associated field.
IndexType	Field	Type of the associated field.
IndexLength	Field	Size of the associated field.
IndexFlag	Field	Whether global or Data Class Level field info.
UsefilInfoFlag	Field	Usefulinfoflag of the associated field.
UsefulInfoSize	Field	UsefulInfoSize of the associated field.

Errors returned from call

Code	Message	Comments
-50016	Group not found.	Group iIndex specified in the iInput does not exist in the sSystem.
-50074	Invalid parameters.	This exception will come when User has specified some invalid value in <Flag> Tag. Some Invalid value for this Flag is the value other thaen ‘F’,’D’ or ‘B’.