MEP APIs

Get Subscription Collections

This operation enables you to retrieve a list of the subscription collections that you have access to. This includes both enabled and disabled collections.

Quick facts

Method	GET
Returns	Accepted response: XML Rejected response: plain text
Available	All regions
Prerequisites	You must have MEP provisioned with OpenMarket, and the following roles set in the user account: Main Roles: Subscription Manager/User Other Roles: View and download user details, HTTP Subscription API user
More information	See MEP Operations and Making Subscription Requests.

Try It Out

If you'd like to try out this call using cURL, see Making Subscription Requests, which will take you through tasks such as creating and disabling subscriptions, and adding or removing end users.

Making a Request

Definition

GET https://cmx2api.openmarket.com/subscriptionapi/getsubscriptioncollections

URL example

https://cmx2api.openmarket.com/subscriptionapi/getsubscriptioncollections?username=MyUsername&password=P4S5W0Rd

Query parameters

Parameters must be URL encoded.

Parameter	Description
username	The username used to access MEP. Required: yes Type: string
password	The password associated with the MEP username. Required: yes Type: string

Parameter

Description

username

The username used to access MEP.

Required: yes

Type: string

password

The password associated with the MEP username.

Required: yes

Type: string

Header fields

There is no data required in the header.

Response from OpenMarket

Accepted requests

OpenMarket responds to a successful request with a status code of 200 and the details of available subscription collections in the response body.

HTTP/1.1 200 OK
Date: Tue, 15 Mar 2016 17:32:14 GMT
Server: Apache-Coyote/1.1
Transfer-Encoding: chunked
Content-Type: text/plain

<?xml version="1.0" encoding="ISO-8859-1"?>
<collections>
   <collection>
      <id>1A2B3C4D5E6F</id>
      <name>ACME collection</name>
      <description>All subscriptions for ACME messaging</description>
      <enabled>true</enabled>
      </collection>
      <collection>
      <id>C4D5E1A2B3F4</id>
      <name>BRAVO collection</name>
      <description/>
      <enabled>true</enabled>
   </collection>
</collections>

Response body

The XML response body will include following data.

Element	Description
collections	Root element. Contains one or more of the element: collection. Returned: Always
collection	Element containing information about a specific collection. Returned: Always
id	The unique identifier of the subscription collection. Type: string Returned: Always
name	The name of the subscription collection. Type: string Returned: Always
description	The description of the subscription collection. Type: string Returned: Always
enabled	Whether the subscription collection is enabled or disabled. For information about disabled collections, see Creating, Disabling, and Re-enabling Subscriptions. Type: Boolean Returned: Always

Rejected requests

If your request is rejected then the body of the response will contain a plain text description of the error. For example:

HTTP/1.1 401 Unauthorized
Date: Tue, 15 Mar 2016 11:48:56 GMT
Server: Apache-Coyote/1.1
Connection: close
Transfer-Encoding: chunked
Content-Type: text/plain
			
Your username and/or password is incorrect. Check and try again.

See Response error messages below for a list of the possible error messages.

Testing your integration

As subscription operations do not send messages, the best way to test your integration is directly with MEP. We recommend that you test regularly as you build your campaigns and services in MEP, so that you can troubleshoot any issues faster.

For more information on using each operation, see Making Subscription Requests.

Troubleshooting

Response error messages

These error messages are returned in the response body when there was a problem with receiving the request.

Message	Description
Your username and/or password is incorrect. Check and try again.	Either the username or the password parameter has not been correctly specified. Both parameters are mandatory. Check that both parameters are specified, and that you have entered the correct values for each parameter.
You do not have the necessary roles or permissions to perform the action: <description>	Your access rights in MEP do not allow you use the operation. The information in the <description> part of the response will tell you the role or permission that you are missing.