Luminate Online

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

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=getCompanyTeams &api_key=value &v=value [ &auth=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 [ &company_id=value ] [ &include_download_url=value ] [ &team_id=value ] [ &auth=value ] [ &sso_auth_token=value ]

Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

company_id

Optional. The unique ID of the company.

Type xsd:nonNegativeInteger.

include_download_url

Optional. Specifies whether a url to download the data should be included in the response.

Type xsd:boolean.

team_id

Optional. An optional team ID. If this value is set and company_id is not included, the company associated with this team will be used.

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 response

<?xml version="1.0" encoding="UTF-8"?>
<getCompanyTeamsResponse 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">
  <companyTeam>
    <amount>1001</amount>
    <teamId>1</teamId>
    <teamName>example team 1</teamName>
    <numGifts>1</numGifts>
  </companyTeam>
  <companyTeam>
    <amount>1002</amount>
    <teamId>2</teamId>
    <teamName>example team 2</teamName>
    <numGifts>2</numGifts>
  </companyTeam>
  <companyTeam>
    <amount>1003</amount>
    <teamId>3</teamId>
    <teamName>example team 3</teamName>
    <numGifts>3</numGifts>
  </companyTeam>
</getCompanyTeamsResponse>

JSON response

{"getCompanyTeamsResponse":{"companyTeam":[{"teamName":"example team 1","amount":"1001","numGifts":"1","teamId":"1"},{"teamName":"example team 2","amount":"1002","numGifts":"2","teamId":"2"},{"teamName":"example team 3","amount":"1003","numGifts":"3","teamId":"3"}]}}

getCompanyTeams

Client API Syntax

Client API Parameters

Response

Leave a Comment