REST

setTeamCaptains

Sets one or more Team Members as Team Captains.

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
CRTeamraiserAPINone.GET, POSTNo.

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=setTeamCaptains &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 ] &captains=value &fr_id=value &team_id=value

Usage Notes

This method requires authentication. The logged-in user must be a Team Captain to execute this method successfully.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

captains

Required. Comma separated list of constituent IDs who should be captains of this team. Each constituent must already be a member of the team.

Type xsd:string.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

team_id

Required. A unique team ID.

Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8"?>
<getTeamMembersResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.teamraiser.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <member>
  <name>
    <first>Member</first>
    <last>Sample01</last>
  </name>
  <aTeamCaptain>true</aTeamCaptain>
  <teamName>Sample Team Name</teamName>
  <personalPageUrl>http://www.convio.net/site/TR/RunEvent/General?px=1002000&amp;amp;pg=personal&amp;amp;fr_id=1000</personalPageUrl>
  <donationUrl>https://www.convio.net/org/site/Donation2?df_id=1000&amp;amp;FR_ID=1000&amp;amp;PROXY_ID=1002000&amp;amp;PROXY_TYPE=20</donationUrl>
  <teamPageUrl>http://www.convio.net/site/TR/RunEvent/General?team_id=1000&amp;amp;pg=team&amp;amp;fr_id=1000</teamPageUrl>
  <consId>1002000</consId>
  </member>
  <member>
  <name>
    <first>Member</first>
    <last>Sample11</last>
  </name>
  <aTeamCaptain>true</aTeamCaptain>
  <teamName>Sample Team Name</teamName>
  <personalPageUrl>http://www.convio.net/site/TR/RunEvent/General?px=1002001&amp;amp;pg=personal&amp;amp;fr_id=1000</personalPageUrl>
  <donationUrl>https://www.convio.net/org/site/Donation2?df_id=1000&amp;amp;FR_ID=1000&amp;amp;PROXY_ID=1002001&amp;amp;PROXY_TYPE=20</donationUrl>
  <teamPageUrl>http://www.convio.net/site/TR/RunEvent/General?team_id=1000&amp;amp;pg=team&amp;amp;fr_id=1000</teamPageUrl>
  <consId>1002001</consId>
  </member>
  <member>
  <name>
    <first>Member</first>
    <last>Sample21</last>
  </name>
  <aTeamCaptain>false</aTeamCaptain>
  <teamName>Sample Team Name</teamName>
  <personalPageUrl>http://www.convio.net/site/TR/RunEvent/General?px=1002002&amp;amp;pg=personal&amp;amp;fr_id=1000</personalPageUrl>
  <donationUrl>https://www.convio.net/org/site/Donation2?df_id=1000&amp;amp;FR_ID=1000&amp;amp;PROXY_ID=1002002&amp;amp;PROXY_TYPE=20</donationUrl>
  <teamPageUrl>http://www.convio.net/site/TR/RunEvent/General?team_id=1000&amp;amp;pg=team&amp;amp;fr_id=1000</teamPageUrl>
  <consId>1002002</consId>
  </member>
</getTeamMembersResponse>
JSON response
JSON 
{"getTeamMembersResponse":{"member":[{"teamName":"Sample Team Name","consId":"1002000","name":{"last":"Sample01","first":"Member"},"donationUrl":"https://www.convio.net/org/site/Donation2?df_id=1000&amp;FR_ID=1000&amp;PROXY_ID=1002000&amp;PROXY_TYPE=20","aTeamCaptain":"true","personalPageUrl":"http://www.convio.net/site/TR/RunEvent/General?px=1002000&amp;pg=personal&amp;fr_id=1000","teamPageUrl":"http://www.convio.net/site/TR/RunEvent/General?team_id=1000&amp;pg=team&amp;fr_id=1000"},{"teamName":"Sample Team Name","consId":"1002001","name":{"last":"Sample11","first":"Member"},"donationUrl":"https://www.convio.net/org/site/Donation2?df_id=1000&amp;FR_ID=1000&amp;PROXY_ID=1002001&amp;PROXY_TYPE=20","aTeamCaptain":"true","personalPageUrl":"http://www.convio.net/site/TR/RunEvent/General?px=1002001&amp;pg=personal&amp;fr_id=1000","teamPageUrl":"http://www.convio.net/site/TR/RunEvent/General?team_id=1000&amp;pg=team&amp;fr_id=1000"},{"teamName":"Sample Team Name","consId":"1002002","name":{"last":"Sample21","first":"Member"},"donationUrl":"https://www.convio.net/org/site/Donation2?df_id=1000&amp;FR_ID=1000&amp;PROXY_ID=1002002&amp;PROXY_TYPE=20","aTeamCaptain":"false","personalPageUrl":"http://www.convio.net/site/TR/RunEvent/General?px=1002002&amp;pg=personal&amp;fr_id=1000","teamPageUrl":"http://www.convio.net/site/TR/RunEvent/General?team_id=1000&amp;pg=team&amp;fr_id=1000"}]}}