Qgiv API

Last Updated: April 13, 2013

API Requests

Qgiv

API requests targeting the Hobnob system require API credentials for the Organization, Form or Admin user. When providing credentials for the Organization, data will be retrieved for all forms under the organization. When providing credentials for the Form, data will be retrieved for only that Form. When providing credentials for the Admin user, data will be retrieved for all forms that the Admin user governs.

Donor Logins

API requests targeting the Donor Logins system require API credentials for the Organization, Form or Admin user. When providing credentials for the Organization, data will be retrieved for all forms under the organization. When providing credentials for the Form, data will be retrieved for only that Form. When providing credentials for the Admin user, data will be retrieved for all forms that the Admin user governs.

Hobnob

API requests targeting the Hobnob system require API credentials for the Organization, Form or Admin user. Because the Event ID must be specified in the URL, data will be retrieved by the event specified in the URL only, regardless of the API credentials being used. When using Admin user credentials, the Admin must be administering the event specified in the URL.

Input/Output

Input and Output examples will be provided in both XML and JSON formats. Input will be accepted in XML and JSON formats only. Output format depends on the extension in the URL. For XML output, URLs must end in ".xml". For JSON output, URLs must end in ".json". The input format can be in XML or JSON regardless of the output format specified.

	
<parentNode>
	<childNode>
		<childOfChildNode>value</childOfChildNode>
	</childNode>
	<childNode>
		<childOfChildNode>value</childOfChildNode>
	</childNode>
</parentNode>
	

{
    "parentKey":[
        {
            "childKey":"value",
        },
        {
            "childKey2":"value"
        }
    ]
}

Notes:


* 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