Restrictions

Last Updated: May 14, 2012

This document lays out the specification of interacting with the Qgiv Restrictions system, allowing for reading, writing, and updating restrictions.

Restriction Properties

id (int)
title (string)
exportHeader (string)
displayTitle (string)
restrictionDescription (string)
subrestrictions (collection)
- title (string)
- restrictionDescription (string)
displayDescription (int)
displayMobile (int)
displayOnKiosk (int)
displayOnFrontend (int)
displayOnVT (int)
isCustomRestriction (int)
state (int)
sort (int)

Warning: Creating default object from empty value in /srv/users/qgiv/apps/qgivcom/public/api/restrictions.php on line 38

GET : https://secure.qgiv.com/admin/api/restrictions/list

Returns all restrictions associated with the current form

Greatest Need Greatest Need All proceeds will go to our greatest need 1 Missions focused All proceeds will go to our greatest need in the missions field 3 1 1 0 0 1 0

{
   "restrictions":[
      {
         "id":"5249",
         "displayMobile":"0",
         "title":"Greatest Need",
         "exportHeader":"",
         "displayTitle":"Greatest Need",
         "restrictionDescription":"All proceeds will go to our greatest need",
         "displayDescription":"1",
         "subrestrictions":[
            {
               "title":"Missions focused",
               "restrictionDescription":"All proceeds will go to our greatest need in the missions field"
            }
         ],
         "displayOnFrontend":"1",
         "displayOnKiosk":"0",
         "displayOnVT":"1",
         "isCustomRestriction":"1",
         "sort":"3",
         "state":"0"
      }
      ...
   ]
}

Libraries to use :
using System.Net;
using System.Text;
using System.IO;


string postData = "token=skyMV9YeaxQ7EjbEUHt8TUiP";
HttpWebResponse resp = null;
string result = null;

try {
		HttpWebRequest req = WebRequest.Create(new Uri("https://secure.qgiv.com/admin/api/restrictions/list.xml")) as HttpWebRequest;
		req.Method = "POST";  
		req.Accept = "*/*";
		req.UserAgent = "http_request/0.1";
		req.Timeout = 50000;
		req.ContentType = "application/x-www-form-urlencoded";
		byte[] formData = UTF8Encoding.UTF8.GetBytes(postData);
		using (Stream post = req.GetRequestStream()) { 
 		post.Write(formData, 0, formData.Length);
		}
		// Pick up the response:
		resp = req.GetResponse() as HttpWebResponse;

		if (resp.StatusCode == System.Net.HttpStatusCode.OK) {
			using (resp) { 
  			StreamReader reader =
    		new StreamReader(resp.GetResponseStream());
  			result = reader.ReadToEnd();
			}
		}
} catch (Exception e) {
  	result = "error : " + e.Message;
}

String data = URLEncoder.encode("token", "UTF-8") + "=" + URLEncoder.encode("skyMV9YeaxQ7EjbEUHt8TUiP", "UTF-8");

URL url = new URL("https://secure.qgiv.com/admin/api/restrictions/list.xml");
URLConnection conn = url.openConnection();
conn.setDoOutput(true);
OutputStreamWriter wr = new OutputStreamWriter(conn.getOutputStream());
wr.write(data);
wr.flush();

BufferedReader rd = new BufferedReader(new InputStreamReader(conn.getInputStream()));
String line;
String output;
while ((line = rd.readLine()) != null) {
  output += line;
}

wr.close();
rd.close();
return output;

var apiRequest = false;
var url = "https://secure.qgiv.com/admin/api/restrictions/list.xml";
var postData = "token=skyMV9YeaxQ7EjbEUHt8TUiP";
var results;

var isIE8 = window.XDomainRequest ? true : false;
if (typeof XMLHttpRequest != "undefined") {
	if(isIE8) {
		apiRequest = new Window.XDomainRequest()
	} else {
		apiRequest = new XMLHttpRequest();
	}
} else if (window.ActiveXObject) {
	var ieVersions = ["MSXML2.XMLHttp.5.0","MSXML2.XMLHttp.4.0","MSXML2.XMLHttp.3.0","MSXML2.XMLHttp","Microsoft.XMLHttp"];
	for (var i = 0; i < ieVersions.length; i++) {
		try {
			apiRequest = new ActiveXObject(aVersions[i]);
		} catch(oError) {
			throw new Error("XMLHttp object could be created.");
		}
	}
}

if (!apiRequest) {
	alert("An error has occuerd while creating XMLHttpRequest object");
}


if (apiRequest) {
	apiRequest.open("POST", url, true);
	apiRequest.onreadystatechange = handleResponse;
	apiRequest.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
	apiRequest.send(postData);
}

function handleResponse() {
	if (apiRequest.readyState == 4) {
	if (apiRequest.status == 200) {
		results = apiRequest.responseText;
	} else {
		results = "Server response is unsuccessful";
	}
	} else {
		results = "Server response is incomplete"
	}
}

$postArray = array(
  	'token' => '[your API token]'
);

$postString = http_build_query($postArray);

$url = 'https://secure.qgiv.com/admin/api/restrictions/list.xml';

$curlHandler = curl_init();

curl_setopt($curlHandler, CURLOPT_URL, $url);
curl_setopt($curlHandler, CURLOPT_POST, true);
curl_setopt($curlHandler, CURLOPT_POSTFIELDS, $postString);
curl_setopt($curlHandler, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curlHandler, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curlHandler, CURLOPT_SSL_VERIFYHOST, false);

$response = curl_exec($curlHandler);

if (curl_errno($curlHandler)) {
	$response = 'error : '.curl_error($curlHandler);
} else {
	curl_close($curlHandler);
}

return $response;

import urllib, urllib2

postArray = {
  	'token' => '[your API token]'
}

postString = urllib.urlencode(postArray)

url = 'https://secure.qgiv.com/admin/api/restrictions/list.xml';

request = urllib2.Request(url, data=data)

try:
  response = urllib2.urlopen(request)
  result = response.read()
  response.close()
except urllib2.URLError, e:
  result = 'error : ' + str(e.code)

return result

GET : https://secure.qgiv.com/admin/api/restriction/[id]

Returns the restriction requested, individually specified by ID.

Greatest Need Greatest Need All proceeds will go to our greatest need 1 Missions focused All proceeds will go to our greatest need in the missions field 0 1 1 1 1 3 0

{
   "restriction":{
      "id":"5249",
      "title":"Greatest Need",
      "exportHeader":"",
      "displayTitle":"",
      "restrictionDescription":"",
      "displayDescription":"1",
      "subrestrictions":[
         {
            "title":"Missions focused",
            "restrictionDescription":"All proceeds will go to our greatest need in the missions field"
         }
      ],
      "displayOnKiosk":"0",
      "displayOnFrontend":"1",
      "displayOnVT":"1",
      "displayOnMobile":"1",
      "isCustomRestriction":"1",
      "sort":"3",
      "state":"0"
   }
}

Libraries to use :
using System.Net;
using System.Text;
using System.IO;


string postData = "token=skyMV9YeaxQ7EjbEUHt8TUiP";
HttpWebResponse resp = null;
string result = null;

try {
		HttpWebRequest req = WebRequest.Create(new Uri("https://secure.qgiv.com/admin/api/restriction/5249.xml")) as HttpWebRequest;
		req.Method = "POST";  
		req.Accept = "*/*";
		req.UserAgent = "http_request/0.1";
		req.Timeout = 50000;
		req.ContentType = "application/x-www-form-urlencoded";
		byte[] formData = UTF8Encoding.UTF8.GetBytes(postData);
		using (Stream post = req.GetRequestStream()) { 
 		post.Write(formData, 0, formData.Length);
		}
		// Pick up the response:
		resp = req.GetResponse() as HttpWebResponse;

		if (resp.StatusCode == System.Net.HttpStatusCode.OK) {
			using (resp) { 
  			StreamReader reader =
    		new StreamReader(resp.GetResponseStream());
  			result = reader.ReadToEnd();
			}
		}
} catch (Exception e) {
  	result = "error : " + e.Message;
}

String data = URLEncoder.encode("token", "UTF-8") + "=" + URLEncoder.encode("skyMV9YeaxQ7EjbEUHt8TUiP", "UTF-8");

URL url = new URL("https://secure.qgiv.com/admin/api/restriction/5249.xml");
URLConnection conn = url.openConnection();
conn.setDoOutput(true);
OutputStreamWriter wr = new OutputStreamWriter(conn.getOutputStream());
wr.write(data);
wr.flush();

BufferedReader rd = new BufferedReader(new InputStreamReader(conn.getInputStream()));
String line;
String output;
while ((line = rd.readLine()) != null) {
  output += line;
}

wr.close();
rd.close();
return output;

var apiRequest = false;
var url = "https://secure.qgiv.com/admin/api/restriction/5249.xml";
var postData = "token=skyMV9YeaxQ7EjbEUHt8TUiP";
var results;

var isIE8 = window.XDomainRequest ? true : false;
if (typeof XMLHttpRequest != "undefined") {
	if(isIE8) {
		apiRequest = new Window.XDomainRequest()
	} else {
		apiRequest = new XMLHttpRequest();
	}
} else if (window.ActiveXObject) {
	var ieVersions = ["MSXML2.XMLHttp.5.0","MSXML2.XMLHttp.4.0","MSXML2.XMLHttp.3.0","MSXML2.XMLHttp","Microsoft.XMLHttp"];
	for (var i = 0; i < ieVersions.length; i++) {
		try {
			apiRequest = new ActiveXObject(aVersions[i]);
		} catch(oError) {
			throw new Error("XMLHttp object could be created.");
		}
	}
}

if (!apiRequest) {
	alert("An error has occuerd while creating XMLHttpRequest object");
}


if (apiRequest) {
	apiRequest.open("POST", url, true);
	apiRequest.onreadystatechange = handleResponse;
	apiRequest.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
	apiRequest.send(postData);
}

function handleResponse() {
	if (apiRequest.readyState == 4) {
	if (apiRequest.status == 200) {
		results = apiRequest.responseText;
	} else {
		results = "Server response is unsuccessful";
	}
	} else {
		results = "Server response is incomplete"
	}
}

$postArray = array(
  	'token' => '[your API token]'
);

$postString = http_build_query($postArray);

$url = 'https://secure.qgiv.com/admin/api/restriction/5249.xml';

$curlHandler = curl_init();

curl_setopt($curlHandler, CURLOPT_URL, $url);
curl_setopt($curlHandler, CURLOPT_POST, true);
curl_setopt($curlHandler, CURLOPT_POSTFIELDS, $postString);
curl_setopt($curlHandler, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curlHandler, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curlHandler, CURLOPT_SSL_VERIFYHOST, false);

$response = curl_exec($curlHandler);

if (curl_errno($curlHandler)) {
	$response = 'error : '.curl_error($curlHandler);
} else {
	curl_close($curlHandler);
}

return $response;

import urllib, urllib2

postArray = {
  	'token' => '[your API token]'
}

postString = urllib.urlencode(postArray)

url = 'https://secure.qgiv.com/admin/api/restriction/5249.xml';

request = urllib2.Request(url, data=data)

try:
  response = urllib2.urlopen(request)
  result = response.read()
  response.close()
except urllib2.URLError, e:
  result = 'error : ' + str(e.code)

return result

POST : https://secure.qgiv.com/admin/api/restrictions/create

Creates one or more restrictions with the values passed in, returning the complete restrictions with the new ID

Greatest Need Greatest Need All proceeds will go to our greatest need 1 Missions focused All proceeds will go to our greatest need in the missions field 0 1 1 1 1 3 0

{
   "restrictions":[
      {
         "title":"Greatest Need",
         "exportHeader":"",
         "displayTitle":"Greatest Need",
         "restrictionDescription":"All proceeds will go to our greatest need",
         "displayDescription":"1",
         "subrestrictions":[
            {
               "title":"Missions focused",
               "restrictionDescription":"All proceeds will go to our greatest need in the missions field"
            }
         ],
         "displayOnKiosk":"0",
         "displayOnFrontend":"1",
         "displayOnVT":"1",
         "displayOnMobile":"1",
         "isCustomRestriction":"1",
         "sort":"3",
         "state":"0"
      }
      ...
   ]
}

Libraries to use :
using System.Net;
using System.Text;
using System.IO;


string postData = "token=skyMV9YeaxQ7EjbEUHt8TUiP&package=[xml or json formatted input]";
HttpWebResponse resp = null;
string result = null;

try {
		HttpWebRequest req = WebRequest.Create(new Uri("https://secure.qgiv.com/admin/api/restrictions/create.xml")) as HttpWebRequest;
		req.Method = "POST";  
		req.Accept = "*/*";
		req.UserAgent = "http_request/0.1";
		req.Timeout = 50000;
		req.ContentType = "application/x-www-form-urlencoded";
		byte[] formData = UTF8Encoding.UTF8.GetBytes(postData);
		using (Stream post = req.GetRequestStream()) { 
 		post.Write(formData, 0, formData.Length);
		}
		// Pick up the response:
		resp = req.GetResponse() as HttpWebResponse;

		if (resp.StatusCode == System.Net.HttpStatusCode.OK) {
			using (resp) { 
  			StreamReader reader =
    		new StreamReader(resp.GetResponseStream());
  			result = reader.ReadToEnd();
			}
		}
} catch (Exception e) {
  	result = "error : " + e.Message;
}

String data = URLEncoder.encode("token", "UTF-8") + "=" + URLEncoder.encode("skyMV9YeaxQ7EjbEUHt8TUiP", "UTF-8");
data += "&" + URLEncoder.encode("package", "UTF-8") + "=" URLEncoder.encode("[xml or json formatted input]", "UTF-8");

URL url = new URL("https://secure.qgiv.com/admin/api/restrictions/create.xml");
URLConnection conn = url.openConnection();
conn.setDoOutput(true);
OutputStreamWriter wr = new OutputStreamWriter(conn.getOutputStream());
wr.write(data);
wr.flush();

BufferedReader rd = new BufferedReader(new InputStreamReader(conn.getInputStream()));
String line;
String output;
while ((line = rd.readLine()) != null) {
  output += line;
}

wr.close();
rd.close();
return output;

var apiRequest = false;
var url = "https://secure.qgiv.com/admin/api/restrictions/create.xml";
var postData = "token=skyMV9YeaxQ7EjbEUHt8TUiP&package=[xml or json formatted input]";
var results;

var isIE8 = window.XDomainRequest ? true : false;
if (typeof XMLHttpRequest != "undefined") {
	if(isIE8) {
		apiRequest = new Window.XDomainRequest()
	} else {
		apiRequest = new XMLHttpRequest();
	}
} else if (window.ActiveXObject) {
	var ieVersions = ["MSXML2.XMLHttp.5.0","MSXML2.XMLHttp.4.0","MSXML2.XMLHttp.3.0","MSXML2.XMLHttp","Microsoft.XMLHttp"];
	for (var i = 0; i < ieVersions.length; i++) {
		try {
			apiRequest = new ActiveXObject(aVersions[i]);
		} catch(oError) {
			throw new Error("XMLHttp object could be created.");
		}
	}
}

if (!apiRequest) {
	alert("An error has occuerd while creating XMLHttpRequest object");
}


if (apiRequest) {
	apiRequest.open("POST", url, true);
	apiRequest.onreadystatechange = handleResponse;
	apiRequest.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
	apiRequest.send(postData);
}

function handleResponse() {
	if (apiRequest.readyState == 4) {
	if (apiRequest.status == 200) {
		results = apiRequest.responseText;
	} else {
		results = "Server response is unsuccessful";
	}
	} else {
		results = "Server response is incomplete"
	}
}

$postArray = array(
	'token' => '[your API token]',
	'package' => '[xml or json formatted input]'
);

$postString = http_build_query($postArray);

$url = 'https://secure.qgiv.com/admin/api/restrictions/create.xml';

$curlHandler = curl_init();

curl_setopt($curlHandler, CURLOPT_URL, $url);
curl_setopt($curlHandler, CURLOPT_POST, true);
curl_setopt($curlHandler, CURLOPT_POSTFIELDS, $postString);
curl_setopt($curlHandler, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curlHandler, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curlHandler, CURLOPT_SSL_VERIFYHOST, false);

$response = curl_exec($curlHandler);

if (curl_errno($curlHandler)) {
	$response = 'error : '.curl_error($curlHandler);
} else {
	curl_close($curlHandler);
}

return $response;

import urllib, urllib2

postArray = {
	'token' : '[your API token]',
	'package' : '[xml or json formatted input]'
}

postString = urllib.urlencode(postArray)

url = 'https://secure.qgiv.com/admin/api/restrictions/create.xml';

request = urllib2.Request(url, data=data)

try:
  response = urllib2.urlopen(request)
  result = response.read()
  response.close()
except urllib2.URLError, e:
  result = 'error : ' + str(e.code)

return result

Greatest Need Greatest Need All proceeds will go to our greatest need 1 Missions focused All proceeds will go to our greatest need in the missions field 0 3 1 1 1 1 0

{
   "restrictions":[
      {
         "id":"5249",
         "title":"Greatest Need",
         "exportHeader":"",
         "displayTitle":"Greatest Need",
         "restrictionDescription":"All proceeds will go to our greatest need",
         "displayDescription":"1",
         "subrestrictions":[
            {
               "title":"Missions focused",
               "restrictionDescription":"All proceeds will go to our greatest need in the missions field"
            }
         ],
         "displayOnKiosk":"0",
         "sort":"3",
         "displayOnFrontend":"1",
         "displayOnVT":"1",
         "displayOnMobile":"1",
         "isCustomRestriction":"1",
         "state":"0"
      }
      ...
   ]
}

POST : https://secure.qgiv.com/admin/api/restrictions/[id]

Updates the given restriction, specified by ID, with the values passed in, returning the complete restriction

0 The Greatest Need

{
   "restrictions":[
      {
         "id":"5249",
         "displayOnMobile":"0",
         "title":"The Greatest Need"
      }
      ...
   ]
}

Libraries to use :
using System.Net;
using System.Text;
using System.IO;


string postData = "token=skyMV9YeaxQ7EjbEUHt8TUiP&package=[xml or json formatted input]";
HttpWebResponse resp = null;
string result = null;

try {
		HttpWebRequest req = WebRequest.Create(new Uri("https://secure.qgiv.com/admin/api/restrictions/5249.xml")) as HttpWebRequest;
		req.Method = "POST";  
		req.Accept = "*/*";
		req.UserAgent = "http_request/0.1";
		req.Timeout = 50000;
		req.ContentType = "application/x-www-form-urlencoded";
		byte[] formData = UTF8Encoding.UTF8.GetBytes(postData);
		using (Stream post = req.GetRequestStream()) { 
 		post.Write(formData, 0, formData.Length);
		}
		// Pick up the response:
		resp = req.GetResponse() as HttpWebResponse;

		if (resp.StatusCode == System.Net.HttpStatusCode.OK) {
			using (resp) { 
  			StreamReader reader =
    		new StreamReader(resp.GetResponseStream());
  			result = reader.ReadToEnd();
			}
		}
} catch (Exception e) {
  	result = "error : " + e.Message;
}

String data = URLEncoder.encode("token", "UTF-8") + "=" + URLEncoder.encode("skyMV9YeaxQ7EjbEUHt8TUiP", "UTF-8");
data += "&" + URLEncoder.encode("package", "UTF-8") + "=" URLEncoder.encode("[xml or json formatted input]", "UTF-8");

URL url = new URL("https://secure.qgiv.com/admin/api/restrictions/5249.xml");
URLConnection conn = url.openConnection();
conn.setDoOutput(true);
OutputStreamWriter wr = new OutputStreamWriter(conn.getOutputStream());
wr.write(data);
wr.flush();

BufferedReader rd = new BufferedReader(new InputStreamReader(conn.getInputStream()));
String line;
String output;
while ((line = rd.readLine()) != null) {
  output += line;
}

wr.close();
rd.close();
return output;

var apiRequest = false;
var url = "https://secure.qgiv.com/admin/api/restrictions/5249.xml";
var postData = "token=skyMV9YeaxQ7EjbEUHt8TUiP&package=[xml or json formatted input]";
var results;

var isIE8 = window.XDomainRequest ? true : false;
if (typeof XMLHttpRequest != "undefined") {
	if(isIE8) {
		apiRequest = new Window.XDomainRequest()
	} else {
		apiRequest = new XMLHttpRequest();
	}
} else if (window.ActiveXObject) {
	var ieVersions = ["MSXML2.XMLHttp.5.0","MSXML2.XMLHttp.4.0","MSXML2.XMLHttp.3.0","MSXML2.XMLHttp","Microsoft.XMLHttp"];
	for (var i = 0; i < ieVersions.length; i++) {
		try {
			apiRequest = new ActiveXObject(aVersions[i]);
		} catch(oError) {
			throw new Error("XMLHttp object could be created.");
		}
	}
}

if (!apiRequest) {
	alert("An error has occuerd while creating XMLHttpRequest object");
}


if (apiRequest) {
	apiRequest.open("POST", url, true);
	apiRequest.onreadystatechange = handleResponse;
	apiRequest.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
	apiRequest.send(postData);
}

function handleResponse() {
	if (apiRequest.readyState == 4) {
	if (apiRequest.status == 200) {
		results = apiRequest.responseText;
	} else {
		results = "Server response is unsuccessful";
	}
	} else {
		results = "Server response is incomplete"
	}
}

$postArray = array(
	'token' => '[your API token]',
	'package' => '[xml or json formatted input]'
);

$postString = http_build_query($postArray);

$url = 'https://secure.qgiv.com/admin/api/restrictions/5249.xml';

$curlHandler = curl_init();

curl_setopt($curlHandler, CURLOPT_URL, $url);
curl_setopt($curlHandler, CURLOPT_POST, true);
curl_setopt($curlHandler, CURLOPT_POSTFIELDS, $postString);
curl_setopt($curlHandler, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curlHandler, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curlHandler, CURLOPT_SSL_VERIFYHOST, false);

$response = curl_exec($curlHandler);

if (curl_errno($curlHandler)) {
	$response = 'error : '.curl_error($curlHandler);
} else {
	curl_close($curlHandler);
}

return $response;

import urllib, urllib2

postArray = {
	'token' : '[your API token]',
	'package' : '[xml or json formatted input]'
}

postString = urllib.urlencode(postArray)

url = 'https://secure.qgiv.com/admin/api/restrictions/5249.xml';

request = urllib2.Request(url, data=data)

try:
  response = urllib2.urlopen(request)
  result = response.read()
  response.close()
except urllib2.URLError, e:
  result = 'error : ' + str(e.code)

return result

The Greatest Need Greatest Need All proceeds will go to our greatest need 1 Missions focused All proceeds will go to our greatest need in the missions field 0 3 1 1 0 1 0

{
   "restrictions":[
      {
         "id":"5249",
         "title":"The Greatest Need",
         "exportHeader":"",
         "displayTitle":"Greatest Need",
         "restrictionDescription":"All proceeds will go to our greatest need",
         "displayDescription":"1",
         "subrestrictions":[
            {
               "title":"Missions focused",
               "restrictionDescription":"All proceeds will go to our greatest need in the missions field"
            }
         ],
         "displayOnKiosk":"0",
         "sort":"3",
         "displayOnFrontend":"1",
         "displayOnVT":"1",
         "displayOnMobile":"0",
         "isCustomRestriction":"1",
         "state":"0"
      }
      ...
   ]
}

* denotes a required field

** denotes a required field based on Event settings

*** denotes a field that is only required when submitting Form level API credentials