NGOGetAllKeyWordFromDictExt

This call is used to fetch all ~~the~~ Keywords from the dictionary, i.e. all the Keywords added by User based on queryOnName. User can also specify whether this List 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 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, If the specified criteria is auth*, then all the keywords that begins with ‘auth’ are fetched.		All Keywords will be fetched.
Authorization Flag	Root	Flag that specifies the kind of Keywords 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 Field on which sorting is to be done.	1 – Index 2 – Name	1
SortOrder	Root	Order in which the Keywords are to be sorted.	A – Ascending D – Descending	A
PreviousIndex	Root	It is used for fetching the Objects in batches. It specifies the Index of the last Keyword 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 to be fetched in call.		Batch size set at Server.

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 Keywords 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.
Keywords	Root	Specifies the List of Keywords that are obtained
KeywordProperty	Keywords	It contains various parameters attached with a particular Keyword.
KeywordIndex	KeywordProperty	Specifies the Index of the Keyword obtained.
GroupaId	KeywordProperty	Reserved. By default, Keywords are added in Group Index 0.
KeywordValue	KeywordProperty	Specifies the Name of the Keyword.
AuthorizationFlag	KeywordProperty	Specifies whether the Keyword can be deleted. A – Authorized, cannot be deleted. U – Unauthorized, can be deleted.
Aliases	KeywordProperty	It contains the List of all the Aliases of a Keyword.
Alias	Aliases	It specifies the Name of the Alias of a Keyword.

Errors returned from call

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