NGOModifyAddressLists

This call modifies the Address List of the logged in userUser by removing the previous members and adding the new members specified. Either the ListName or ListIndex of the Address List is essential. In the member information also either of object index or object name is essential. If the outer Member tag is specified, then the values of all its inner tag ObjectType, ObjectIndex, ObjectName must also be specified.

 

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.

NGOModify

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

AddressListMembers

Root

Container tag for a single Address List for the logged in User.

 

 

ListIndex

Address

List

Members

Index of the Address List.

 

 

ListName

Address

List

Members

Name of the Address List.

 

 

MembersUser

Address

List

Members

Container tag for various members to be added in the Address List for the logged in User.

 

 

ObjectType

MemberUser

Indicates whether object being added is a User or a Group.

‘U’ – User

‘G’- Group

 

ObjectIndex

MemberUser

Index of the object being added as a member of Address List.

Integer >= 0

 

ObjectName

MemberUser

Name of the object being added as a member of Address List.

 

 

ObjectType

User

Type of Object

‘U’ – User

‘G’ – Group

 

 

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.

 

Errors returned from call

Code

Message

Comments

-50180

 

Address List not exists.

Address List that is to be modified does not exist.