Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

limit

Optional. Limit

Type xsd:string.

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"?>
<getTopDonorsResponse 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">
  <teamraiserData>
    <name>Sample Donor 01</name>
    <total>$100.00</total>
  </teamraiserData>
  <teamraiserData>
    <name>Sample Donor 11</name>
    <total>$50.00</total>
  </teamraiserData>
  <teamraiserData>
    <name>Sample Donor 21</name>
    <total>$33.33</total>
  </teamraiserData>
  <teamraiserData>
    <name>Sample Donor 31</name>
    <total>$25.00</total>
  </teamraiserData>
  <teamraiserData>
    <name>Sample Donor 41</name>
    <total>$20.00</total>
  </teamraiserData>
  <teamraiserData>
    <name>Sample Donor 51</name>
    <total>$16.66</total>
  </teamraiserData>
  <teamraiserData>
    <name>Sample Donor 61</name>
    <total>$14.28</total>
  </teamraiserData>
  <teamraiserData>
    <name>Sample Donor 71</name>
    <total>$12.50</total>
  </teamraiserData>
  <teamraiserData>
    <name>Sample Donor 81</name>
    <total>$11.11</total>
  </teamraiserData>
  <teamraiserData>
    <name>Sample Donor 91</name>
    <total>$10.00</total>
  </teamraiserData>
</getTopDonorsResponse>

        

{"getTopDonorsResponse":{"teamraiserData":[{"total":"$100.00","name":"Sample Donor 01"},{"total":"$50.00","name":"Sample Donor 11"},{"total":"$33.33","name":"Sample Donor 21"},{"total":"$25.00","name":"Sample Donor 31"},{"total":"$20.00","name":"Sample Donor 41"},{"total":"$16.66","name":"Sample Donor 51"},{"total":"$14.28","name":"Sample Donor 61"},{"total":"$12.50","name":"Sample Donor 71"},{"total":"$11.11","name":"Sample Donor 81"},{"total":"$10.00","name":"Sample Donor 91"}]}}