TeamRaiser Registration API Example README

Summary

This example implements a basic TeamRaiser registrtion workflow that adapts itself to the configuration of a specified TeamRaiser Event. It utilizes jQuery librarys for DOM access, user interface design, styling and input validation. It also adapts the TeamRaiser Event Search Example and code from the Survey API Reference Implementation which are also available for download from open.convio.com.

File or Directory Description
registration.html HTML markup and forms for the registration app.
js/register.js The registration app code.
js/survey_rest.js Code for creating the registration questions form, adapted from the Survey API Reference Implementation example.
find_event.html
js/ConvioYUIDataSource.js
The TeamRaiser Event Search Example, copied verbatim with links modified to reference the registration.html page.

API Methods Used

Several API methods are employed in this example. Documentation for each of these methods is linked in the table below. In addition to the documentation, it can also be helpful to be able to execute the API methods with different inputs and inspect the results. This table also links to html forms that you can use to test API method inputs and outputs while developing or debugging your code.

Method Used for Links
processRegistration Registering for a TeamRaiser Event Docs Form
getParticipationTypes Determining the configuration of an Event Docs Form
getRegistrationDocument Determining the configuration of an Event Docs Form
getParticipants Finding Participants and Teams Docs Form
getTeamraisersByDistance Finding an Event Docs Form
getTeamraisersByInfo Finding an Event Docs Form
login Authenticating a constituent Docs Form
getUser Retrieving constituent information Docs Form
create Creating a new constituent record Docs Form
update Updating a constituent record Docs Form

Limitations

Some features of TeamRaiser registration are not implemented in this example. These include but are not necessarily limited to:

Deploying to a Web Server

  1. Replace the api_client.html file with the one from the /api directory on your Convio website.
  2. Edit registration.html reference to ConvioApi.js to point to the /api directory on your Convio website.
  3. On your Convio website, go to Settings/Open API Configuration, check your API settings, and add your domain to the list of allowed JavaScript domains. Note the JavaScript client distinguishes between  *.domain.org and domain.org (no wildcard), so it is best to add both.

Copyright (C) 2011 Convio, Inc.