Luminate Online

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=getParticipantProgress &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 ] &cons_id=value &fr_id=value

Client API Parameters

Common Client Parameters

See topic Common Parameters.

cons_id

Required. A unique constituent ID.

Type xsd:nonNegativeInteger.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<getParticipantProgressResponse 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">
  <personalProgress>
    <goal>10000</goal>
    <raised>5600</raised>
    <percent>56</percent>
    <giftAidMatch>2000</giftAidMatch>
  </personalProgress>
  <teamProgress>
    <goal>25000</goal>
    <raised>12500</raised>
    <percent>50</percent>
  </teamProgress>
  <companyProgress>
    <goal>50000</goal>
    <raised>12500</raised>
    <percent>25</percent>
  </companyProgress>
  <daysLeft>7</daysLeft>
</getParticipantProgressResponse>

JSON response

{"getParticipantProgressResponse":{"teamProgress":{"percent":"50","raised":"12500","goal":"25000"},"personalProgress":{"percent":"56","raised":"5600","giftAidMatch":"2000","goal":"10000"},"daysLeft":"7","companyProgress":{"percent":"25","raised":"12500","goal":"50000"}}}

getParticipantProgress

Client API Syntax

Client API Parameters

Response

Leave a Comment