NGOGetAddressLists

This call gets all the Address Lists for the logged in userUser.

 

Input Parameter description

View sample InputXml

Output Parameter description

View sample OutputXml

Errors and Warnings

 

 

Input Parameters description

Name

Parent Tag

Description

Valid Values

Default

Values

Option

Root

Unique option for the call.

NGOGet

AddressLists

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

OrderBy

Root

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

Root

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

‘A’- Ascending

‘D’- Descending

‘A’

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

Unique option for the call.

Status

Root

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

NoOfRecords Fetched

Root

Total number of records fetched.

AddressLists

Root

Outer tag for Containing information about all the Address Lists of the logged in User.

AddressList

AddressLists

Contains information about a single Address List.

ListName

AddressList

Name of the Address List.

ListIndex

AddressList

Index of the Address List.

 

Errors returned from call

Code

Message

Comments

-50074

Invalid parameters.

If some invalid value is passed in input for Orderby or Sortorder tags.