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.

Designees are the actual departments or programs within your organization that will receive the funds you raise. Tying a Donation Form to one or more designees is not required -- or even desirable in every organization. Often funds must be allocated strictly through a budgeting process. For some organizations, however, every gift must be designated for a specific purpose. In addition, for many organizations, presenting your donors with a list of one or more specific programs that they can "designate" as recipients of their gifts can increase the number and amount of gifts received.

Designees 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 designees allowed for a specific form to avoid this situation.

See also getDesignationTypes and donate.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

form_id

Optional. The ID of the donation form.

Type xsd:nonNegativeInteger.

html_format

Optional. For returned data that contains HTML, this specifies whether to return it as HTML-escaped text (value = "text") or as XHTML within the XML response document (value = "xhtml"). This does not apply when a JSON response is requested.

Type xsd:token.

Default is text.

Options are:

• text
• xhtml

Response

See topic HTTP Status Codes.

<?xml version="1.0" encoding="UTF-8"?>
<getDesigneesResponse 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">
  <designee>
    <id>1000</id>
    <name>Program 1</name>
    <typeId>1022</typeId>
    <description>
      <text>&lt;p>The &lt;em>first&lt;/em> designated giving program.&lt;/p></text>
    </description>
  </designee>
  <designee>
    <id>1001</id>
    <name>Program 2</name>
    <typeId>1022</typeId>
    <description>
      <text>&lt;p>The &lt;em>second&lt;/em> designated giving program.&lt;/p></text>
    </description>
  </designee>
</getDesigneesResponse>

        

{"getDesigneesResponse":{"designee":[{"id":"1000","description":{"text":"<p>The <em>first<\/em> designated giving program.<\/p>"},"name":"Program 1","typeId":"1022"},{"id":"1001","description":{"text":"<p>The <em>second<\/em> designated giving program.<\/p>"},"name":"Program 2","typeId":"1022"}]}}

        

Examples