Versions Compared

Old Version 4

changes.mady.by.user Stefano Mantegazza

Saved on

compared with

New Version Current

changes.mady.by.user MailUp Dev Team

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Overview

GetNlLists()

Returns a message containing all the available lists and groups (e.g. three lists: "Technical Support Subscribers", "Company News Subscribers", "Product News Subscribers"; each list might contain one or more groups).

 

...

This method returns the following information (see the sample response code below):

  1. Lists
    For each list, it includes:
    1. List ID
    2. List GUID
    3. List Name
  2. Groups
    For each list, it returns all groups within the list, if any:
    1. Group ID

    2. Group Name

       

Note
titleKNOWN RESTRICTION

Characters & and " are not escaped in returned response, so please avoid these characters in names of lists and groups otherwise you will experience some problems due to an invalid returned XML

 

Sample GetNlLists request

Code Block
languagehtml/xml
linenumberstrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.mailupnet.it/">
   <soapenv:Header>
      <ws:Authentication>
         <ws:User>myUser</ws:User>
         <ws:Password>OXEX2CQ5</ws:Password><ws:encType>UTF-8</ws:encType>
      </ws:Authentication>
   </soapenv:Header>
   <soapenv:Body>
      <ws:GetNlLists/>
   </soapenv:Body>
</soapenv:Envelope>

Sample GetNlLists response

Code Block
languagehtml/xml
linenumberstrue
<?xml version="1.0" encoding="windows-1252" ?>
<mailupMessage>
	<mailupBody>
		<ReturnCode>0</ReturnCode>
		<Lists>
			<List idList="1" listGUID="F9168C5E66af9900-CEB27dd7-4FAA4cca-B6BF-329BF39FA1E49125-beadaf345659" listName="News">
				<Groups>
					<Group idGroup="3" groupName="1"MY FIRST IMPORT" />
					<Group idGroup="6" groupName="TEST" />
					<Group idGroup="8" groupName="AUTOMATICALLY UPDATED ADDRESSES" />
					<Group idGroup="9" groupName="Change your email" />
					<Group idGroup="10" groupName="Receive our SMS" />
					<Group idGroup="11" groupName="Update your personal data" />
					<Group idGroup="12" groupName="Subscribed using a social networks account" />
					<Group idGroup="22" groupName="FirstPreferred GroupCustomers" />
					<Group idGroup="23" groupName="Resellers" />
				</Groups>
			</List>
			<List idList="2" groupName="Second GrouplistGUID="0e591119-cd77-4157-9379-6ac75335664" listName="SMS">
				<Groups>
					<Group idGroup="13" groupName="TEST" />
					<Group idGroup="14" groupName="Subscribed using social login" />
					<Group idGroup="15" groupName="UPDATED VIA AUTOPROFILE FEATURE" />
					<Group idGroup="19" groupName="March Promotion" />
					<Group idGroup="20" groupName="April Promotion" />
					<Group idGroup="21" groupName="May Promotion" />
				</Groups>
			</List>
			<List idList="4" listGUID="2c8d028c-e614-4ab2-81fc-0ef13b34560a" listName="test">
				<Groups></Groups>
			</List>
		</Lists>
	</mailupBody>
</mailupMessage>

...

Error codes

Error codeDescription
0

...

request execution succeeded
-200

...

unrecognized error

Ruby Example

Code Block
languageruby
# Refer to https://mailup.atlassian.net/wiki/display/mailupapi/MailUp+RubyGem for gem information.
require 'mailup'
m = MailUp::Import.new('username', 'password', 'console_url')
m.get_nl_lists
# => <?xml version=\"1.0\" encoding=\"windows-1252\" ?><mailupMessage><mailupBody><ReturnCode>0</ReturnCode><Lists>...</Lists></mailupBody></mailupMessage>