NGOGetMembersOfLists

This call is used for getting members of a specific Address List of the logged in userUser. Either of ListIndex or ListName should be provided essentially.

 

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

MembersOf

Lists

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 objects of Address Lists will be sorted. For example, Index of Object, Name of Object etc.

1- ObjectIndex

2-

ObjectName

3- ObjectType

4-

ObjectOrder

No

2

SortOrder

Root

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

‘A’- Ascending

‘D’-

Descending

‘A’

AddressLists

Root

Contains information about all the Address Lists for which members are to be retrieved.

 

 

AddressList

Address

Lists

Contains information about a single Address List for which members are to be retrieved.

 

 

ListName

Address

List

Name of the Address List.

 

 

ListIndex

Address

List

Index of the Address List.

 

 

 

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.

AddressListMembers

Root

Outer tag for Containing information about all the Address Lists for which members were to be found.

ListName

AddressListMembersAddress

List

Name of the Address List.

ListIndex

AddressListMembersAddress

List

Index of the Address List.

NoOfRecordsFetched

AddressListMembers

Number of records retrieved in the list.

Members

AddressListMembersAddress

List

Contains information about all the members of the Address List.

Member

Members

Contains information a single member of the Address List.

ObjectType

Member

Type of the member object – ‘U’ for User, ‘G’ for Group

ObjectIndex

Member

Index of the member object.

ObjectName

Member

Name of the member object.

ObjectOrderNo

Member

Order of addition of the member in 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.

-50180

 

Address List not exists.

Address list whose members are to be obtained does not exist.