This call fetches the list of keywords. A user can retrieve the list of keywords on the criteria of keywordname, authorizationflag and/or maingroupid. It returns the status for the call along with the properties of the keywords fetched.
|
|
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for the call |
NGOGetKeywords ListExt |
N/A |
|
CabinetName |
Root |
Name of the cabinet to which the User wants to connect. |
|
N/A |
|
UserDBId |
Root |
UserDatabase ID, which is returned in the NGOConnectCabinet call. |
|
N/A |
|
GroupIndex |
Root |
Group index of which the keywordlist is to be retrieved. |
Integer >= 0 |
0 |
|
Authorization Flag |
Root |
Can have values A or U. |
A or U |
N/A |
|
QueryOn Name |
Root |
Keyword name on which the search is to be made. |
|
N/A |
|
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 |
|
NoOfRecordsToFetch |
Root |
Number of records to retrieve. |
|
N/A |
|
Name |
Parent Tag |
Description |
|
Option |
Root |
NGOGetKeywordsListExt |
|
Status |
Root |
Status of the call. If the Status is 0, then the call is successful. |
|
NoOfRecordsFetched |
Root |
Number of records fetched. |
|
TotalNoOfRecords |
Root |
Total number of records existing for the given search criteria. |
|
KeywordProperty |
Root |
Contains the properties of a particular keyword. |
|
KeywordIndex |
Keyword Property |
Index of the keyword. |
|
GroupIndex |
Keyword Property |
Group Index of the keyword list. |
|
Keyword |
Keyword Property |
Name of the keyword. |
|
AuthorizationFlag |
Keyword Property |
Value of the Authorization flag associated with the keyword. |
|
Aliases |
Keywords |
Contains all the aliases. Aliases are associated with keywords that have AuthorizationFlag as A. |
|
Alias |
Aliases |
Name of the alias. |
|
Code |
Message |
Comments |
|
-50146 |
Invalid session. |
The specified UserDBId is incorrect. |
|
-50006 |
User account has expired. |
The user’s account has expired. |
|
-50010 |
User not alive. |
The user is not alive. |
|
-50125 |
Cabinet has been locked for Administrative purposes. |
The cabinet has been locked by some other user for Administrative purposes. |
|
-50016 |
Group not found. |
The specified group index does not exist. |