getTeamCaptains

Provides a list of team captains.

Client Servlet Server Servlet HTTP Methods Supported Requires Authentication
CRTeamraiserAPI None. GET, POST No.

Client API Syntax

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

Client API Parameters

Common Client Parameters

See topic Common Parameters.

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"?>
<getTeamCaptainsResponse 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">
  <captain>
    <name>
      <first>Cap</first>
      <last>Sample01</last>
    </name>
    <aTeamCaptain>true</aTeamCaptain>
    <teamName>Sample Team Name</teamName>
    <donationUrl>http://example.com/donateurl</donationUrl>
    <personalPageUrl>http://example.com/personalpageurl</personalPageUrl>
    <teamPageUrl>http://example.com/teampageurl</teamPageUrl>
    <consId>1001000</consId>
  </captain>
  <captain>
    <name>
      <first>Cap</first>
      <last>Sample11</last>
    </name>
    <aTeamCaptain>true</aTeamCaptain>
    <teamName>Sample Team Name</teamName>
    <donationUrl>http://example.com/donateurl</donationUrl>
    <personalPageUrl>http://example.com/personalpageurl</personalPageUrl>
    <teamPageUrl>http://example.com/teampageurl</teamPageUrl>
    <consId>1001001</consId>
  </captain>
  <captain>
    <name>
      <first>Cap</first>
      <last>Sample21</last>
    </name>
    <aTeamCaptain>true</aTeamCaptain>
    <teamName>Sample Team Name</teamName>
    <donationUrl>http://example.com/donateurl</donationUrl>
    <personalPageUrl>http://example.com/personalpageurl</personalPageUrl>
    <teamPageUrl>http://example.com/teampageurl</teamPageUrl>
    <consId>1001002</consId>
  </captain>
</getTeamCaptainsResponse>

        
JSON response
{"getTeamCaptainsResponse":{"captain":[{"teamName":"Sample Team Name","aTeamCaptain":"true","teamPageUrl":"http://example.com/teampageurl","consId":"1001000","donationUrl":"http://example.com/donateurl","name":{"last":"Sample01","first":"Cap"},"personalPageUrl":"http://example.com/personalpageurl"},{"teamName":"Sample Team Name","aTeamCaptain":"true","teamPageUrl":"http://example.com/teampageurl","consId":"1001001","donationUrl":"http://example.com/donateurl","name":{"last":"Sample11","first":"Cap"},"personalPageUrl":"http://example.com/personalpageurl"},{"teamName":"Sample Team Name","aTeamCaptain":"true","teamPageUrl":"http://example.com/teampageurl","consId":"1001002","donationUrl":"http://example.com/donateurl","name":{"last":"Sample21","first":"Cap"},"personalPageUrl":"http://example.com/personalpageurl"}]}}

        

Leave a Comment

Nickname
Comment
Enter this word: