Fields

This document lays out the specification of interacting with the Qgiv Custom Fields system, allowing for reading, writing, and updating custom fields.

Custom Fields Properties

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

Returns all custom fields associated with the current form or organization

T-shirt order size Shirt size Receive a free t-shirt with a donation over $10.00 10.00 B 1 1 1 1 1 1 1 1 
{
    "customField": [
    {
     "id": "2811"
        "reference": "T-shirt order size",
        "title": "Shirt size",
        "content": "Receive a free t-shirt with a donation over $10.00",
        "amountToBecomeRequired": "10.00",
        "inputType": "B",
        "displayBlock": "1",
        "isRequired": "1",
        "displayOnFrontend": "1",
        "displayOnVT": "1",
        "displayOnKiosk": "1",
     "displayMobile": "1",
     "sort": "1",
        "state": "1"
    }
    ]
    ...
}
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/customFields/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/customFields/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/customFields/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/customFields/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/customFields/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 : /customFields/[id]

Returns the custom field requested, individually specified by ID

T-shirt order size Shirt size Receive a free t-shirt with a donation over $10.00 10.00 B 1 1 1 1 1 1 1 1 
{
    "customField": {
     "id": "2811"
        "reference": "T-shirt order size",
        "title": "Shirt size",
        "content": "Receive a free t-shirt with a donation over $10.00",
        "amountToBecomeRequired": "10.00",
        "inputType": "B",
        "displayBlock": "1",
        "isRequired": "1",
        "displayOnFrontend": "1",
        "displayOnVT": "1",
        "displayOnKiosk": "1",
     "displayMobile": "1",
     "sort": "1",
        "state": "1"
    }
}
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/customFields/2811.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/customFields/2811.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/customFields/2811.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/customFields/2811.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/customFields/2811.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 : /customFields/create

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

T-shirt order size Shirt size Receive a free t-shirt with a donation over $10.00 10.00 B 1 1 1 1 1 1 
{
    "customField": [
    {
        "reference": "T-shirt order size",
        "title": "Shirt size",
        "content": "Receive a free t-shirt with a donation over $10.00",
        "amountToBecomeRequired": "10.00",
        "inputType": "B",
        "displayBlock": "1",
        "isRequired": "1",
        "displayOnFrontend": "1",
        "displayOnVT": "1",
        "displayOnKiosk": "1",
        "displayMobile": "1"
    }
    ...
    ]
}
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/customFields/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/customFields/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/customFields/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/customFields/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/customFields/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

Output

T-shirt order size Shirt size Receive a free t-shirt with a donation over $10.00 10.00 B 1 1 1 1 1 1 1 1 
{
    "customField": {
     "id": "2811"
        "reference": "T-shirt order size",
        "title": "Shirt size",
        "content": "Receive a free t-shirt with a donation over $10.00",
        "amountToBecomeRequired": "10.00",
        "inputType": "B",
        "displayBlock": "1",
        "isRequired": "1",
        "displayOnFrontend": "1",
        "displayOnVT": "1",
        "displayOnKiosk": "1",
     "displayMobile": "1",
     "sort": "1",
        "state": "1"
    }
}

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

Updates one or more custom fields with the values passed in, returning the complete custom fields

Sweater Sweater size 
{
   "customfields":[
      {
         "id":"2811",
         "reference":"Sweater",
         "title":"Sweater size"
      }
   ]
   ...
}
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/customFields/2811.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/customFields/2811.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/customFields/2811.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/customFields/2811.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/customFields/2811.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

Output

Sweater Sweater size Receive a free t-shirt with a donation over $10.00 10.00 B 1 1 1 1 1 1 1 1 
{
    "customField": {
     "id": "2811"
        "reference": "Sweater",
        "title": "Sweate size",
        "content": "Receive a free t-shirt with a donation over $10.00",
        "amountToBecomeRequired": "10.00",
        "inputType": "B",
        "displayBlock": "1",
        "isRequired": "1",
        "displayOnFrontend": "1",
        "displayOnVT": "1",
        "displayOnKiosk": "1",
     "displayMobile": "1",
     "sort": "1",
     "state": "1"
    }
}

* 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