getDesignationTypes

This method returns designated giving types for a Donations 2 (not "Donations Classic") donation form.

Client Servlet	Server Servlet	HTTP Methods Supported	Requires Authentication
CRDonationAPI	None.	GET, POST	No.

Client API Syntax

https://secure2.convio.net/organization/site/CRDonationAPI?method=getDesignationTypes &api_key=value &v=value [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ] [ &form_id=value ]

Usage Notes

The Designated Giving feature in Online Giving allows you to set up Designees within your organization and then assign all funds from a donation form to a specific designee or permit your donors to specify which Designee(s) they would like to target with their gifts. To use this feature, you must first set up your list of Designees and Designation Types. Designation Types help organize your designees for display to your donors. For example, an educational institution might create the following Designation Types: Academic, Athletic, and Administrative. Individual designees, such as the football program or the biology department, can then be assigned to the appropriate Type.

Designation Types can be given a sort order. In the donation forms generated by the site, they are presented visually in ascending order of this value. In a custom form powered by the donation APIs, the form author may choose to either use or ignore this value when presenting them to the donors.

Designation Types that have been archived are not included in the results.

Donation forms that accept designations may be configured to either accept all designees or to only accept a specific subset of the designees. If the form accepts only a subset of designees and the validate parameter is set to "true" when calling the donate method, then an error will occur if the donor selects a designee that is not allowed. Use the form_id parameter for this method to restrict the results to only the designation types allowed for a specific form (those associated with the designees that are allowed for the form) to avoid this situation.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

form_id

Optional. The ID of the donation form.

Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<getDesignationTypesResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <type>
    <id>1021</id>
    <name>Program 1</name>
    <sortOrder>2</sortOrder>
  </type>
  <type>
    <id>1022</id>
    <name>Program 2</name>
    <sortOrder>1</sortOrder>
  </type>
</getDesignationTypesResponse>

JSON response

{"getDesignationTypesResponse":{"type":[{"id":"1021","sortOrder":"2","name":"Program 1"},{"id":"1022","sortOrder":"1","name":"Program 2"}]}}

Comments

Submitted by Steve Mook at 04:45 PM on February 20, 2012

Though there is no ReST API method to pull donation form totals by source code, you can obtiain this information either from reports in Luminate Online or by querying the Donation object through Convio Web Services.

Submitted by Peter at 12:42 PM on February 7, 2012

If we need to pass the API transaction details directly from the client browser, we cannot track donation totals on a remote Web site. Is there any method to pull donation form totals by source code?

Luminate Online