REST Email Marketing API Documentation

DEMOGRAPHICS — RETRIEVE

Get data about all the demographics.

HTTP VERB

Get

URL

/API/Rest/Demographics

ARGUMENTS

(none)

Required permission

ViewDemographic

ERRORS

No Permission
Database error
Unknown error

RETURNS

A structure with the demographic fields:

[{"ColumnName":"Company","DataType":"String100","DisplayInSearchResults":false,"ExportWithReports":false},
{"ColumnName":"FirstName","DataType":"String100","DisplayInSearchResults":false,"ExportWithReports":true},
{"ColumnName":"id","DataType":"String25","DisplayInSearchResults":true,"ExportWithReports":true},
{"ColumnName":"Language","DataType":"String50","DisplayInSearchResults":false,"ExportWithReports":true},
{"ColumnName":"LastName","DataType":"String100","DisplayInSearchResults":false,"ExportWithReports":true},
{"ColumnName":"Mailing_Country","DataType":"String50","DisplayInSearchResults":false,"ExportWithReports":true},
{"ColumnName":"Salutation","DataType":"String50","DisplayInSearchResults":false,"ExportWithReports":false},
{"ColumnName":"Territory_Region","DataType":"String50","DisplayInSearchResults":false,"ExportWithReports":true},
{"ColumnName":"Title","DataType":"String100","DisplayInSearchResults":false,"ExportWithReports":false}]

EXAMPLE

Get data on the demographics.

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

url = "http://www.example.com/api/rest/Demographics?accountName=acme&login=ApiUser";
headers = {'password':'sfhdf6df5fdy'}
resp = requests.get(url, headers=headers)
if resp.status_code == 200:
	print resp.text

http://www.example.com/api/rest/Demographics?accountName=acme &login=ApiUser &password=fsdfsdfw4sef

Share this: