Group
This web service provides methods that allow you to create, manage and report upon address book groups.
The following operations are supported. For a formal definition, please review the Service Description.
-
Add
Creates a group.Parameter
Notes
Username: Password: GroupName: Provide a name for your new group. PersonNumber: Provide a semi-colon delimited string of valid person numbers. Person numbers can be found by running the List or ListSelected method in the contacts web service. ResultText: E.g. Group MyNewGroup created successfully for account your.address@your.company. Code: -
AddContact
Adds contacts to a specified group.Parameter
Notes
Username: Password: GroupName: Provide the name of the group to which you wish to add contacts. PersonNumber: Provide a semi-colon delimited string of person numbers which you wish to add to the group. ResultText: E.g. 2 contacts added to group. Code: -
Delete
Deletes a group.Parameter
Notes
Username: Password: GroupName: Provide a semi-colon delimited string of group names that you wish to delete. ResultText: E.g. 2 groups removed from account your.address@your.company. Code: -
List
Lists a users groups.Parameter
Notes
Username: Password: ReportCSV: Provide a string data type output parameter. This will be populated with a CSV standard format string of records containing information about all of your groups. ResultText: E.g. Address book groups detail for your.address@your.company. Code: -
ListContact
Lists all contacts inside a specific group.Parameter
Notes
Username: Password: GroupName: Provide a semi-colon delimited string of group names from your address book. ReportCSV: Provide a string data type output parameter. This will be populated with a CSV standard format string of records containing information about all the contacts contained in the groups specified in the GroupName parameter. ResultText: E.g. Group MyGroup has 3 entries, of which 2 are your own. Code: -
Modify
Modify a group.Parameter
Notes
Username: Password: GroupName: Provide the group name which you wish to change. NewGroupName: Provide a new name for your group. ResultText: E.g. Group name changed to RenamedGroupOne. Code: -
RemoveContact
Removes contacts from a group but not an address book.Parameter
Notes
Username: Password: GroupName: Provide the name of the group from which you wish to remove contacts. PersonNumber: Provide a semi-colon delimited string of person numbers which you wish to remove from the group. ResultText: E.g. 2 contacts removed from group. Code: