NGOAddAddressLists

This call adds an Address List for a userUser. UserUser can add multiple lists at a time. Members of a list can be among the userUsers or Groups existing in the System. If information about the Member is not supplied, then an Address List will be added without any Members in it. But if the outer Member tag is specified, then the values of all its inner tags, 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.

NGOAdd

Address

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

AddressList

Members

Root

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

 

 

ListIndex

AddressList

Members

Index of the Address List.

 

N/A

ListName

AddressList

Members

Name of the Address List.

 

N/A

User

AddressList

Members

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

 

 

ObjectType

User

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

‘U’ – User

‘G’- Group

 

ObjectIndex

User

Index of the object being added as a member of AddressList.

Integer >= 0

 

ObjectName

User

Name of the object being added as a member of 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.

AddressLists

Root

Contains information about the AddressLists being added.

AddressList

Address

Lists

Contains information about a single Address List added.

ListName

Address

List

Name of the Address List being added.

ListIndex

Address

List

Index of the Address List being added.

 

Errors returned from call

Code

Message

Comments

-50179

Address List already exists.

If Address List of the same name as given by the logged in User, exists for the same User.