NGOGetAllKeyWordFromDictExt

This call is used to fetch all the kKeywords from the dictionary, i.e. all the kKeywords added by userUser based on queryOnName. UserUser can also specify whether this lList is to be fetched in batches. It can also be sorted on Name or Index, in ascending or descending order.

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.	NGOGetAll KeyWordFrom DictExt	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
GroupIndex	Root	Reserved. User can pass the default value for it.		0
QueryOnName	Root	Keywords that match the specified criteria are fetched. For example, Specifies that the keywords whose names are like the name given here are to be fetched only. Eg If the specified criteria is auth*, then all the keywords that begins with ‘auth’ are fetched. which means all keywords which begins with ‘auth’ are to be fetched		All keywords Keywords will be fetched.
Authorization Flag	Root	Flag that, which specifies the kind of kKeywords that are required i.e. only authorized or unauthorized or both kinds are required.	A - Only Authorized keywords U - Only Unauthorized keywords * - Both kind	*
OrderBy	Root	Specifies the fField on which sorting is to be done.	1 – Index 2 – Name	1
SortOrder	Root	Order in which the kKeywords are to be sorted. required	A – Ascending D – Descending	A
PreviousIndex	Root	It is used for fetching othe Objects in batches. It specifies the iIndex of the last kKeyword in the previous batch. For the first batch, the value of the field is 0.		0
LastSortField	Root	It specifies the last value of the field in the previous batch on which sorting was performed. It is sent blank for the first batch.		Blank
NoOfRecordsTo Fetch	Root	Total number of keywords Keywords to be fetched in call.		Batch size set at serverServer.

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	Total number of kKeywords fetched from the call.
TotalNoOfRecords	Root	It is used for the Batching purpose. If the value returned by TotalNoOfRecords is one greater than the value returned by the tag NoOfRecordsFetched, then the Next Batch exists.It is used for batches. If the next batch exists then its value is one more than the tag NoOfRecordsFetched otherwise it is sent equal to the tag <NoOfRecordsFetched
Keywords	Root	Specifies the lList of kKeywords that are obtained
KeywordProperty	Keywords	It contains the various parameters attached with a particular kKeyword.
KeywordIndex	KeywordProperty	Specifies the iIndex of the kKeyword obtained.
GroupIndex	KeywordProperty	Resereved. bBy default, kKeywords are added in gGroup iIndex 0.
KeywordValue	KeywordProperty	Specifies the nName of the kKeyword.
AuthorizationFlag	KeywordProperty	Specifies whether the kKeyword can be deleted. A – Authorized, cannot be deleted. U – Unauthorized, can be deleted.
Aliases	KeywordProperty	It contains the lList of all the aAliases of a kKeyword.
Alias	Aliases	It specifies the nName of the aAlias of a kKeyword.

Errors returned from call

Code	Message	Comments
-50016	Group not found	Group specified in the iInput does not exist.