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.

auth

Optional. You must provide either this parameter or the sso_auth_token parameter. If using this parameter, you must specify an auth token generated by an embedded [[S86]] session tag in a Convio web page.

sso_auth_token

Optional. You must provide either this parameter or the auth parameter. If using this parameter, you must specify a valid session authentication token returned by login, authenticateUser, or getSingleSignOnToken.

Response

See topic HTTP Status Codes.

<?xml version="1.0" encoding="UTF-8"?>
<getTeamResponse 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>Sample Team Name</name>
    <description>Sample Team Description</description>
    <captainsMessage>Sample Captains Message</captainsMessage>
    <goal>50000</goal>
    <id>12345</id>
  </team>
</getTeamResponse>

        

{"getTeamResponse":{"team":{"id":"12345","description":"Sample Team Description","name":"Sample Team Name","captainsMessage":"Sample Captains Message","goal":"50000"}}}