//[[restapi:start|RESTful API]]//

====== List Distribution List ======

==== Previous Versions ====
<wrap button>[[restapi:lists_distribution_lists_3_34|Tag 34]]</wrap>

==== Overview ====

List the distribution list by instance

==== URL ====
Http access method: <wrap notice>GET</wrap>

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/distributionList/{instanceId}/{userName}/{mobileNumber}/{publicKey}/{signature}

^ Parameter Name ^ Description ^
| instanceId | An **instance id** is the workspace identification number, //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| userName | The user name that owns the lists. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] |
| mobileNumber \\ <wrap notice>OPTIONAL</wrap> | If used the result will also indicates if the given mobile number is already present on each distribution list listed \\ <wrap info>Use **null** to ignore this parameter</wrap> |
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|Java Example]] |

==== Response ====

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<input>getDistributionList</input>
<status>OK</status>
<description>Completed</description>
<result>
	<distributionLists>
		<distributionlist>
			<id>1</id>
			<name> Distribution List 1</name>
			<subscribed>yes</subscribed>
		</distributionlist>

                ...

		<distributionlist>
			<id>2</id>
			<name>Distribution List 3</name>
			<subscribed>no</subscribed>
		</distributionlist>
	</distributionLists>
</result>

</code>

== Result parameters ==

^ Parameter Name ^ Description ^ Possible Values ^
| distributionlist.id | Distribution list ID | Number |
| distributionlist.name | Distribution list name | Text |
| distributionlist.subscribed | If the mobile parameter was used it shows if the list contain that user | **Yes** or **No** |