Returns all the groups in a list that can be viewed by the user who performed a Login via accessKey.
Method parameters
- string GetGroups(stringaccessKey, int listID)
- accessKey: access key obtained using the LoginFromId method
- listID: ID of the desired list
SOAP Examples
SOAP Response
<GetGroupResult> <errorCode>0</errorCode> <errorDescription></errorDescription> <list> <listID>1</listID> <listName>Demo</listName> </list> <groups> <group> <groupID>1</groupID> <groupName>Demo</groupName> </group> </groups> </GetGroupResult>
Code Examples
Ruby
# Refer to https://mailup.atlassian.net/wiki/display/mailupapi/MailUp+RubyGem for gem information.
require 'mailup'
m = MailUp::Manage.new('api-username', 'api-password')
m.get_groups(:listID => 1)
# Returns XML response
# => "<GetGroupResult><errorCode>0</errorCode><errorDescription></errorDescription><list> ... </list><groups> ... </groups></GetGroupResult>"