REST Email Marketing API Documentation

OfflineEvents — Retrieve

Gets basic details for all offline events, or specifics for one offline event.

HTTP VERB

Get

URL

/API/Rest/OfflineEvents

ARGUMENTS

name (Optional)

Required permission

ViewOfflineEvent

ERRORS

No Permission
Invalid name
Too many API calls
Database error
Unknown error

RETURNS

One of two data structures. For the case where no name is provided:

[{"name":"Whitepaper download","description":"A simple event with two fields, name and subject area"},
{"name":"Shopping cart abandonment","description":"Including SKU, price, quantity, and a link to the web page"}]


For the case where a name is provided:
[{"columnName":"Whitepaper name","description":"The name of the downloaded whitepaper","dataType":"String100","allowNull":false},
{"columnName":"Subject area","description":"Subject area the whitepaper relates to","dataType":"String100","allowNull":false}]


EXAMPLE

Get all the offline events.

string url = "http://example.com/api/rest/OfflineEvents?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/OfflineEvents/?accountName=acme &login=ApiUser'
response = RestClient.get(url, "", {:Password => "sfhdf6df5fdy"})
puts response						
						
import requests

url = "http://www.example.com/api/rest/OfflineEvents/?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/OfflineEvents/?accountName=acme &login=ApiUser &password=sdff34fg34s

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.