AddressBookGroupList
Schema used to obtain the GroupName, GroupID and AccessLevel values from a user's address book.
This method is used to obtain GroupID values for use with method codes:
0110,
0120,
0160,
0170,
0180,
0330 and
0410
The 'UserID' and 'Password' elements identify the account.
The 'ServiceName' element must be set to 'AddressBookGroupList'.
The 'SoftwareVersion' element is for internal 2SMS use only and should not be set.
There should be an empty 'ServiceDetail' element.
This method returns a succesful "00/OK" response if a list of groups was successfully obtained from the user's address book.
The 'Result' element confirms this.
The 'Detail' element contains a single 'GroupList' element with a set 'Group' children, one for each group in the
user's address book, which provide:
- A 'GroupName' element with the name of the group.
- A 'GroupID' element with the 2SMS ID value for the group (which will be unchanged even if the group is renamed).
- An 'AccessLevel' element which reports the access level for the particular group.
The access level will be one of the following:
- 'high': allows the user to send messages to the group;
to view all entries in the group;
to add any entries in their own or inherited address book to the group;
to delete any entries from the group no matter who added them;
and to rename or delete the group (affects all people who have access to the group).
- 'medium': allows the user to send messages to the group;
to view all entries in the group;
to add any entries from their own address book only to the group;
to delete entries from the group that are taken from their own address book.
They may not rename or delete the group.
- 'low': allows the user to send messages to the group but provides no other permissions
(i.e. they may not even view the entries in the group).
Any group created by a user will have 'high' access level. Access levels for other groups are set by
the user who has given access to the group.