TeamRaiser: Participant Search API

Kevin Suer

Feature Summary

Release: Winter 2010

Author: Casey Flinn

 

Overview

In alignment with Convio’s strategy to open up our platform, we have released another API for TeamRaiser. The Participant Search API allows organizations using TeamRaiser to develop search capabilities around participant attributes in order to enable donors to more easily find the participants they want to support with donations.

 

New Concepts or Terms

N/A

 

Use Scenario

Create a Custom TeamRaiser Participant Search Form

American Health Society would like put a form on their non-Convio site that would allow site visitors to search for participants in their Convio-Powered TeamRaiser event.  They would like to have complete control over the design and appearance of both the form and the search results in order to provide seamless integration with their site design.

 

 

Key Features

• Find Participants within a specified TeamRaiser event by searching using the first name, last name, or both
• Returned Participant record includes:

·         Participant Constituent ID

·         Participant First Name

·         Participant Last Name

·         Participant Personal Page URL

·         Donation URL to make a donation in support of this participant (if applicable)

·         Is the participant a Team Captain (true/false)

·         Team Name (if applicable)

·         Team Page URL (if applicable)

 

 

Out of Scope Features & Future Phases

• Search by Participant Email is expressly disallowed in order to prevent this from being used maliciously to validate email addresses.

 

 

Feature Configuration

Requires standard API configuration procedures be executed prior to usage. For more information on TeamRaiser APIs, visit: http://open.convio.com/api/#teamraiser_api

 

 

Screenshots

This screenshot shows one possible implementation of this API method, built using the YUI Library (http://developer.yahoo.com/yui/).  In the search results table, the Participant Name is a link to their personal page, the “Support” link is a link to make a donation on behalf of that participant, and the “Team Name” is a link to the Team Page.