NGOGetAliasList

This call is used to get the list List of all the aliases Aliases for a keywordKeyword. This list List can be fetched in batches.

 

Input Parameter description

View sample InputXml

Output Parameter description

View sample OutputXml

 

Input Parameters description

Name

Parent Tag

Description

Valid Values

Default

Values

Option

Root

Unique option for the call.

NGOGetAlias

List

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

Keyword

Root

Name of the kKeyword for which the lList of aAliases are to be fetched.

 

N/A

StartPos

Root

It is used for fetching aAliases in batches. It is an integer that which specifies the number starting from which the next batch of aAliases are to be taken from the rRecords in the rResult Sset.

 

1

NoOfRecordsTo

Fetch

Root

Total number of rRecords to be fetched by the in call.

 

Batch size at sServer.

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

Unique option for the call.

Status

Root

Status of the call. If Status is 0, then the call is successful.

NoOfRecordsFetched

Root

Total number of rRecords fetched in the call.

TotalNoOfRecords

Root

It is used for the Bbatching ppurpose. If the value returned by TotalNoOfRecords is one greater than If the next batch exists then its value is one more than thethe value returned by the  tag NoOfRecordsFetched, then the Next Batch exists. otherwise it is sent equal to the tag NoOfRecordsFetched

Keywords

Root

Parent Tag that contains all the related keywords and aliases.

KeywordProperty

Keywords

Information regarding a single Keyword.

Keyword

KeywordProperty

Keyword with which the Aliases are associated.

Aliases

KeywordPropertyRoot

It is an outer tag which that contains a lList of aliases Aliases of the keywordKeyword.

Alias

AliasesRoot

It specifies the Nname of an alias Alias attached with the Kkeyword.