Get Address List

Function Name: getGetAddressListsXml

 

Class: com.newgen.dmsapi.DMSInputXml

 

Description: This function is used to retrieve the Property / details of the address Lists.

 

Input Parameters                                                   Sample InputXML

Output Parameters                                                Sample OutputXML

View xml API::NGOGetAddressLists

 

Prototype:

public String getGetAddressListsXml (String cabinetName, String userDBId,

                                                                            String orderBy, String sortOrder);

 

Input Parameters:

 

Name

Description

Valid Values

Default Behavior

CabinetName

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

 

N/A

UserDBId

UserDatabase ID, which is returned in the ConnectCabinet call.

 

N/A

orderBy

Indicates the field on which the results will be sorted.  For example, Name of Address List or Index of Address List.

1- ListId

2 -ListName

2

sortOrder

Indicates whether results are to be sorted in Ascending order or Descending order.

‘A’- Ascending

‘D’- Descending

A

 

Output Parameters:

 

An inputXml string of the NGOGetAddressLists call.