createTeam

The createTeam API is used by a participant to either create a new TeamRaiser team for the event, or to re-form a team from a previous event. The participant becomes the captain by default.

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
CRTeamraiserAPI None. POST No.

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=createTeam &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 ] &fr_id=value &fr_id=value [ &previous_team_id=value ] [ &company_id=value ] [ &team_name=value ] [ &is_captain=value ]

Usage Notes

The createTeam method allows a constituent to create a team after registering for a TeamRaiser event as a participant. By default, the participant becomes captain of the team that is created.

Just like there are options available to a participant in the Participant Center (PC3) to join or leave a team, you can provide a form to allow the participant to create a team. The form can include Team Name and Team Company options. You can exclude the Captain option, because the constituent becomes the captain. The form provides an option to capture the previous event's Team ID if the constituent wants to re-form a team. 

The createTeam API creates a team based on the following passed parameters:

  • fr_id - Required
  • previous_team_id - Optional
  • company_id - Optional
  • team_name - Optional

Re-forming a Previous Team

To successfully use the createTeam API to re-form a previous team, you must:

  1. Enable the Returning Teams feature by setting the Site Option (SDP), F2F_RETURNING_TEAMS_ENABLED, to TRUE.
  2. Configure the TeamRaiser event with a Previous Event. (Edit current event > 1. Identify TeamRaiser > 8. Previous Event Association > select the previous event.)
  3. Configure the TeamRaiser event with the Returning Teams functionality. (Edit current event > 3. Select Event Options > c. Define Returning Teams Options > select the option to allow returning teams.)

When these conditions are met, a participant can recreate a previously-formed team in the current event and copy the team goal details. Goals are editable by the team captain after the team is created.

Note: If the Returning Teams functionality is not enabled in the current event, an error is thrown when attempting to recreate a previously-formed team.

A TeamRaiser event can only have one previous event, so a participant in the current event will only have one previous team to re-form. The participant can re-form that team if:

  • They are not on a team currently.
  • The current event is associated with a previous event.
  • The current event is configured to allow returning teams.
  • They were a participant in the previous event.
  • They were on a team in the previous event.
CreateTeam Errors

For common API errors such as authentication errors, the common error response is returned.

An XML example:

xmlns="http://convio.com/crm/v1.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2Incorrect API key.


A JSON example:

{"errorResponse":{

"code": "2",

"message": "Incorrect API key."

}}


When an event is not found, the below exception occurs.

xmlns="http://convio.com/crm/v1.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2601The event you requested does not exist or is not available.


When a participant is not registered to the event, the below exception occurs.

xmlns="http://convio.com/crm/v1.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2603The registration you requested does not exist or is not available.


When incorrect company_id is passed. the below exception occurs

xmlns="http://convio.com/crm/v1.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2730CompanyId specified in the request ({0}) does not match companyId associated with the participant ({1}).


When an incorrect team name or duplicate team name is passed, the below exception occurs.

xmlns="http://convio.com/crm/v1.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2760An error occurred while attempting to create the team.


Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

previous_team_id

Optional. A unique team ID.

Type xsd:nonNegativeInteger.

company_id

Optional. The id of the company.

Type xsd:nonNegativeInteger.

team_name

Optional. A unique team name.

Type xsd:string.

is_captain

Optional. Whether or not this participant is a team captain.

Type xsd:boolean.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8"?>
<createTeamResponse 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">
  <team>
    <name>Example Tecomam</name>
    <description>Example team description</description>
    <captainsMessage>Example captains message</captainsMessage>
    <goal>1000</goal>
    <id>10000</id>
  </team>
</createTeamResponse>
JSON response
{"createTeamResponse":{"team":{"goal":"1000","captainsMessage":"Example captains message","name":"Example Tecomam","description":"Example team description","id":"10000"}}}
Parent topic: TeamRaiser API
Previous topic: createAndLinkFacebookFundraiser
Next topic: confirmOrUnlinkFacebookFundraiser

Leave a Comment

Nickname
Comment
Enter this word:
Change