Account Form Wording
This document lays out the specification of interacting with the Qgiv Account Form Wording system, allowing for reading, writing, and updating account form wording.
Account Form Wording Properties
- id (int) ***
- word (collection)
- id (int)
- original (string)
- value (string)
GET : https://secure.qgiv.com/admin/api/account/wording
Returns all form wording for each organization form.
{
"wording":{
"forms":[
{
"id":"2",
"form_name":"Qgiv Form",
"word":[
{
"id":1,
"original":"Personal Information",
"value":""
},
{
"id":76,
"original":"Billing Information",
"value":""
},
{
"id":130,
"original":"What type of donation are you making?",
"value":""
},
{
"id":3,
"original":"Additional Information",
"value":""
},
{
"id":4,
"original":"Participant Information",
"value":""
},
{
"id":5,
"original":"Payment Information",
"value":""
},
{
"id":129,
"original":"Required",
"value":""
},
{
"id":43,
"original":"Yes! ORGANIZATION may contact me at the e-mail address above.",
"value":""
},
{
"id":6,
"original":"I prefer that this donation remains anonymous.",
"value":""
},
{
"id":147,
"original":"Same as my personal information",
"value":null
},
{
"id":146,
"original":"Title",
"value":null
},
{
"id":83,
"original":"Select",
"value":""
},
{
"id":60,
"original":"First Name",
"value":""
},
{
"id":61,
"original":"Last Name",
"value":""
},
{
"id":62,
"original":"Address",
"value":""
},
{
"id":64,
"original":"City",
"value":""
},
{
"id":65,
"original":"State",
"value":""
},
{
"id":66,
"original":"Zip",
"value":""
},
{
"id":172,
"original":"State\/Province\/Region",
"value":null
},
{
"id":173,
"original":"Postal Code",
"value":null
},
{
"id":67,
"original":"Country",
"value":""
},
{
"id":145,
"original":"Email",
"value":null
},
{
"id":69,
"original":"Company",
"value":""
},
{
"id":70,
"original":"Phone number",
"value":""
},
{
"id":8,
"original":"Donation",
"value":""
},
{
"id":9,
"original":"Pledge",
"value":""
},
{
"id":10,
"original":"Events",
"value":""
},
{
"id":131,
"original":"Donation Amount",
"value":null
},
{
"id":40,
"original":"Other",
"value":""
},
{
"id":132,
"original":"Maximum",
"value":null
},
{
"id":133,
"original":"Please direct my donation to",
"value":null
},
{
"id":134,
"original":"How often do you want to make this donation?",
"value":null
},
{
"id":77,
"original":"One Time",
"value":""
},
{
"id":78,
"original":"Weekly",
"value":""
},
{
"id":79,
"original":"Monthly",
"value":""
},
{
"id":80,
"original":"Quarterly",
"value":""
},
{
"id":81,
"original":"Semi-Annually",
"value":""
},
{
"id":82,
"original":"Annually",
"value":""
},
{
"id":135,
"original":"Starting",
"value":null
},
{
"id":136,
"original":"Ending",
"value":null
},
{
"id":171,
"original":"Total Donation",
"value":null
},
{
"id":153,
"original":"What pledge would you like to make?",
"value":null
},
{
"id":16,
"original":"Create My Own Pledge",
"value":""
},
{
"id":154,
"original":"Direct my money to",
"value":null
},
{
"id":169,
"original":"I would like to dedicate this donation to someone",
"value":null
},
{
"id":170,
"original":"Wording",
"value":null
},
{
"id":24,
"original":"Dedication Name",
"value":""
},
{
"id":137,
"original":"What event are you signing up for?",
"value":null
},
{
"id":138,
"original":"Select an event or sponsorship",
"value":null
},
{
"id":139,
"original":"Date",
"value":null
},
{
"id":140,
"original":"Time",
"value":null
},
{
"id":55,
"original":"Location",
"value":""
},
{
"id":141,
"original":"About",
"value":null
},
{
"id":142,
"original":"How many tickets?",
"value":null
},
{
"id":143,
"original":"Make a one-time donation",
"value":null
},
{
"id":144,
"original":"Your total cost will be",
"value":null
},
{
"id":46,
"original":"Participant",
"value":""
},
{
"id":148,
"original":"All Payment Fields are Required",
"value":null
},
{
"id":73,
"original":"Card Number",
"value":""
},
{
"id":149,
"original":"CSC",
"value":null
},
{
"id":150,
"original":"Expiration",
"value":null
},
{
"id":151,
"original":"Routing Number",
"value":null
},
{
"id":152,
"original":"Bank Account Number",
"value":null
},
{
"id":37,
"original":"Make Donation",
"value":""
},
{
"id":38,
"original":"Send Pledge",
"value":""
},
{
"id":39,
"original":"Register for Event",
"value":""
},
{
"id":161,
"original":"Thank you for your donation!",
"value":null
},
{
"id":162,
"original":"Thank you for registering for this event!",
"value":null
},
{
"id":163,
"original":"Here are the details of the transaction for your records...",
"value":null
},
{
"id":116,
"original":"Amount",
"value":""
},
{
"id":100,
"original":"Transaction ID",
"value":""
},
{
"id":101,
"original":"Date",
"value":""
},
{
"id":102,
"original":"Payment Type",
"value":""
},
{
"id":103,
"original":"ending in",
"value":""
},
{
"id":164,
"original":"Opt-in",
"value":null
},
{
"id":99,
"original":"Billed Transaction Details",
"value":""
},
{
"id":108,
"original":"Recurring",
"value":""
},
{
"id":106,
"original":"One-Time",
"value":""
},
{
"id":110,
"original":"Restriction",
"value":""
},
{
"id":165,
"original":"Share this campaign with friends and family!",
"value":null
},
{
"id":166,
"original":"Share on Facebook",
"value":null
},
{
"id":167,
"original":"Share on Twitter",
"value":null
},
{
"id":168,
"original":"Total",
"value":null
}
]
}
...
]
}
}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/account/wording.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/account/wording.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/account/wording.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/account/wording.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/account/wording.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/account/wording
Updates the form wording.
Input
{"wording":
{"forms":[
{
"id":"2",
"form_name":"Qgiv Form",
"words":[
{
"id":"1",
"value":"Personal Donation Information"
}
]
},
...
]}
}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/account/wording.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/account/wording.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/account/wording.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/account/wording.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/account/wording.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
{
"wording":{
"forms":[
{
"id":"2",
"form_name":"Qgiv Form",
"word":[
{
"id":1,
"original":"Personal Donation Information",
"value":""
},
{
"id":76,
"original":"Billing Information",
"value":""
},
{
"id":130,
"original":"What type of donation are you making?",
"value":""
},
{
"id":3,
"original":"Additional Information",
"value":""
},
{
"id":4,
"original":"Participant Information",
"value":""
},
{
"id":5,
"original":"Payment Information",
"value":""
},
{
"id":129,
"original":"Required",
"value":""
},
{
"id":43,
"original":"Yes! ORGANIZATION may contact me at the e-mail address above.",
"value":""
},
{
"id":6,
"original":"I prefer that this donation remains anonymous.",
"value":""
},
{
"id":147,
"original":"Same as my personal information",
"value":null
},
{
"id":146,
"original":"Title",
"value":null
},
{
"id":83,
"original":"Select",
"value":""
},
{
"id":60,
"original":"First Name",
"value":""
},
{
"id":61,
"original":"Last Name",
"value":""
},
{
"id":62,
"original":"Address",
"value":""
},
{
"id":64,
"original":"City",
"value":""
},
{
"id":65,
"original":"State",
"value":""
},
{
"id":66,
"original":"Zip",
"value":""
},
{
"id":172,
"original":"State\/Province\/Region",
"value":null
},
{
"id":173,
"original":"Postal Code",
"value":null
},
{
"id":67,
"original":"Country",
"value":""
},
{
"id":145,
"original":"Email",
"value":null
},
{
"id":69,
"original":"Company",
"value":""
},
{
"id":70,
"original":"Phone number",
"value":""
},
{
"id":8,
"original":"Donation",
"value":""
},
{
"id":9,
"original":"Pledge",
"value":""
},
{
"id":10,
"original":"Events",
"value":""
},
{
"id":131,
"original":"Donation Amount",
"value":null
},
{
"id":40,
"original":"Other",
"value":""
},
{
"id":132,
"original":"Maximum",
"value":null
},
{
"id":133,
"original":"Please direct my donation to",
"value":null
},
{
"id":134,
"original":"How often do you want to make this donation?",
"value":null
},
{
"id":77,
"original":"One Time",
"value":""
},
{
"id":78,
"original":"Weekly",
"value":""
},
{
"id":79,
"original":"Monthly",
"value":""
},
{
"id":80,
"original":"Quarterly",
"value":""
},
{
"id":81,
"original":"Semi-Annually",
"value":""
},
{
"id":82,
"original":"Annually",
"value":""
},
{
"id":135,
"original":"Starting",
"value":null
},
{
"id":136,
"original":"Ending",
"value":null
},
{
"id":171,
"original":"Total Donation",
"value":null
},
{
"id":153,
"original":"What pledge would you like to make?",
"value":null
},
{
"id":16,
"original":"Create My Own Pledge",
"value":""
},
{
"id":154,
"original":"Direct my money to",
"value":null
},
{
"id":169,
"original":"I would like to dedicate this donation to someone",
"value":null
},
{
"id":170,
"original":"Wording",
"value":null
},
{
"id":24,
"original":"Dedication Name",
"value":""
},
{
"id":137,
"original":"What event are you signing up for?",
"value":null
},
{
"id":138,
"original":"Select an event or sponsorship",
"value":null
},
{
"id":139,
"original":"Date",
"value":null
},
{
"id":140,
"original":"Time",
"value":null
},
{
"id":55,
"original":"Location",
"value":""
},
{
"id":141,
"original":"About",
"value":null
},
{
"id":142,
"original":"How many tickets?",
"value":null
},
{
"id":143,
"original":"Make a one-time donation",
"value":null
},
{
"id":144,
"original":"Your total cost will be",
"value":null
},
{
"id":46,
"original":"Participant",
"value":""
},
{
"id":148,
"original":"All Payment Fields are Required",
"value":null
},
{
"id":73,
"original":"Card Number",
"value":""
},
{
"id":149,
"original":"CSC",
"value":null
},
{
"id":150,
"original":"Expiration",
"value":null
},
{
"id":151,
"original":"Routing Number",
"value":null
},
{
"id":152,
"original":"Bank Account Number",
"value":null
},
{
"id":37,
"original":"Make Donation",
"value":""
},
{
"id":38,
"original":"Send Pledge",
"value":""
},
{
"id":39,
"original":"Register for Event",
"value":""
},
{
"id":161,
"original":"Thank you for your donation!",
"value":null
},
{
"id":162,
"original":"Thank you for registering for this event!",
"value":null
},
{
"id":163,
"original":"Here are the details of the transaction for your records...",
"value":null
},
{
"id":116,
"original":"Amount",
"value":""
},
{
"id":100,
"original":"Transaction ID",
"value":""
},
{
"id":101,
"original":"Date",
"value":""
},
{
"id":102,
"original":"Payment Type",
"value":""
},
{
"id":103,
"original":"ending in",
"value":""
},
{
"id":164,
"original":"Opt-in",
"value":null
},
{
"id":99,
"original":"Billed Transaction Details",
"value":""
},
{
"id":108,
"original":"Recurring",
"value":""
},
{
"id":106,
"original":"One-Time",
"value":""
},
{
"id":110,
"original":"Restriction",
"value":""
},
{
"id":165,
"original":"Share this campaign with friends and family!",
"value":null
},
{
"id":166,
"original":"Share on Facebook",
"value":null
},
{
"id":167,
"original":"Share on Twitter",
"value":null
},
{
"id":168,
"original":"Total",
"value":null
}
]
}
]
}
}* 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