Published — v. 18

WS_MailUpSend.GetGroups

Owned by Massimo Arrigoni (Unlicensed)
Last updated: Nov 15, 2012 by MailUp Dev Team (Unlicensed)Version comment

 

Returns all the groups which have been created within a list

Method parameters

  • string GetGroups(string accessKey, intlistID)
    • accessKey: access key obtained using the LoginFromId method
    • listID: ID of the list within which the newsletter has to be created. Lists and corresponding IDs can be obtained calling the WS_MailUpSend.GetLists

If error code=0, the message will contain the IDs of all the groups in the specified list.

SOAP Examples

SOAP Response
<GetGroupsResult>
<errorCode>0</errorCode>
<errorDescription></errorDescription>
<list>
<listID>1</listID>
<listName>Lista nr.1</listName>
<groups>
<group>
<groupID>1</groupID>
<groupName>Gruppo nr.1</groupName>
</group>
<group>
<groupID>2</groupID>
<groupName>Gruppo nr.2</groupName>
</group>
</groups>
</list>
</GetGroupsResult>

Code Examples

Ruby
# Refer to https://mailup.atlassian.net/wiki/display/mailupapi/MailUp+RubyGem for gem information.
require 'mailup'
m = MailUp::Send.new('username', 'password')
m.get_groups(:listId => 1)
# => "<GetGroupsResult><errorCode>0</errorCode><errorDescription></errorDescription><list><listID>0</listID><listName></listName><groups></groups></list></GetGroupsResult>"