REST Email Marketing API Documentation

Topics — List

Provide the basic details for the topics.

HTTP VERB

Get

URL

/API/Rest/Topics

ARGUMENTS

(none)

Required permission

ViewTopic

ERRORS

No Permission
Too many API calls
Database error
Unknown error

RETURNS

An array of rows with name, description, and id for each topic.

[{"name":"Acme Corporate Mailings","description":"Corporate Mailings, Event Invites etc.","id":5},
{"name":"Acme Newsletter","description":"Newsletter","id":1},
{"name":"API Email","description":"Those who wish to get email about the APIs","id":2}]


EXAMPLE

List the topics.

string url = "http://example.com/api/rest/Topics/?accountName=acme&login=ApiUser";
							
try
{
	System.Net.HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
	request.Headers.Add("Password", "34teh6i6j565ydw4h");
	using (System.Net.WebResponse response = request.GetResponse())
		using (Stream responseStream = response.GetResponseStream())
			using (StreamReader reader = new StreamReader(responseStream, Encoding.UTF8))
				System.Console.WriteLine(reader.ReadToEnd());
}
catch (System.Net.WebException ex)
{
	System.Diagnostics.Debug.Fail(ex.Message);
}
							
# encoding: utf-8
require 'rest-client'
require 'json'
							
url = 'http://example.com/api/rest/Topics?accountName=acme &login=ApiUser'
response = RestClient.get(url, "", {:Password => "sfhdf6df5fdy"})
puts response						
							
import requests
url = "http://www.example.com/api/rest/Topics?accountName=acme&login=ApiUser";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print resp.text
							

http://example.com/api/rest/Topics?accountName=acme &login=ApiUser &password=324t35g345g

As a user of Goolara Symphonie, the REST API is free and included in the latest version of the software. If you have any questions about using Symphonie’s REST API, feel free to contact us.