GetAliasList

Function Name: getGetAliasListXml

 

Class: com.newgen.dmsapi.DMSInputXml

 

Description: This function is used to get list of Keywords aliases.

 

Input Parameters                                               Sample InputXML

Output Parameters                                           Sample OutputXML

View xml API::NGOGetAliasList

 

Prototype:

public String getGetAliasListXml (

                                                               String cabinetName,

                                                               String userDbId,

                                                               String groupIndex,

                                                               String keyword,

                                                               String startFrom,

                                                               String noOfRecordsToFetch

                                                          )

 

Prototype:

public String getGetAliasListXml (

                                                                String cabinetName,

                                                                String userDbId,

                                                                String keyword,

                                                                String startFrom,

                                                                String noOfRecordsToFetch

                                                           )

 

Input Parameters:

 

Name

Description

Valid Values

Default Behavior

cabinetName

Name of the Database Cabinet to which the User wants to connect.

The name of the Cabinet.

N/A

userDbId

UserDatabase ID, which is returned in the NGOConnectCabinet call.

 

N/A

groupIndex

Reserved. User can send default value for it.

 

0

Keyword

Name of the Keyword for which the List of Aliases are to be fetched.

 

N/A

startFrom

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

noOfRecordsToFetch

Total number of Records to be fetched by the call.

 

Batch size at Server.

 

Output Parameters:

 

An inputXml string of the NGOGetAliasList call.