NGOGetAliasList

This call is used to get the List of all the Aliases for a Keyword. This 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 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 Keyword for which the List of Aliases are to be fetched.

 

N/A

StartPos

Root

It is used for fetching Aliases in batches. It is an integer that specifies the number starting from which the next batch of Aliases are to be taken from the Records in the Result Set.

 

1

NoOfRecordsTo

Fetch

Root

Total number of Records to be fetched by the call.

 

Batch size at Server.

 

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 Records fetched in 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 

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

KeywordProperty

It is an outer tag that contains alList of Aliases of the Keyword.

Alias

Aliases

It specifies the Name of an Alias attached with the Keyword.