Luminate Online

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

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=getSurveyResponses &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 [ &question_=value ] [ &requested_only=value ] [ &survey_id=value ] [ &use_filters=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.

question_

Optional. Include either question_ or question_key_ parameters for each question on the survey. Provide either existing values returned by the getSurveyResponses method or updated values. For questions with IDs 123 and 456, include parameters question_123 and question_456.

Type xsd:string.

requested_only

Optional. This boolean value determines whether or not to include responses for questions in the survey you did not explicitly request.

Type xsd:boolean.

survey_id

Optional. The survey ID (default is the event registration survey).

Type xsd:nonNegativeInteger.

use_filters

Optional. Whether or not to filter the list of questions based on participation type or team captaincy. Default is False.

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"?>
<getSurveyResponsesResponse 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">
  <responses>
    <questionText>Sample question 1</questionText>
    <responseValue>SampleResponse</responseValue>
    <questionId>101</questionId>
    <surveyInstanceId>1111</surveyInstanceId>
    <userId>1234567</userId>
    <key>T-Shirt_Size</key>
    <isHidden>false</isHidden>
  </responses>
  <responses>
    <questionText>Sample question 2</questionText>
    <responseValue>SampleResponse</responseValue>
    <questionId>102</questionId>
    <surveyInstanceId>1111</surveyInstanceId>
    <userId>1234567</userId>
    <key>T-Shirt_Size</key>
    <isHidden>false</isHidden>
  </responses>
  <responses>
    <questionText>Sample question 3</questionText>
    <responseValue>SampleResponse</responseValue>
    <questionId>103</questionId>
    <surveyInstanceId>1111</surveyInstanceId>
    <userId>1234567</userId>
    <key>T-Shirt_Size</key>
    <isHidden>false</isHidden>
  </responses>
</getSurveyResponsesResponse>

JSON response

{"getSurveyResponsesResponse":{"responses":[{"isHidden":"false","questionId":"101","userId":"1234567","questionText":"Sample question 1","surveyInstanceId":"1111","key":"T-Shirt_Size","responseValue":"SampleResponse"},{"isHidden":"false","questionId":"102","userId":"1234567","questionText":"Sample question 2","surveyInstanceId":"1111","key":"T-Shirt_Size","responseValue":"SampleResponse"},{"isHidden":"false","questionId":"103","userId":"1234567","questionText":"Sample question 3","surveyInstanceId":"1111","key":"T-Shirt_Size","responseValue":"SampleResponse"}]}}

getSurveyResponses

Client API Syntax

Client API Parameters

Response

Leave a Comment