updateSurveyResponses

Updates survey responses.

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

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=updateSurveyResponses &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 ] [ &question_key_=value ] [ &require_response=value ] [ &survey_id=value ] [ &auth=value ] [ &sso_auth_token=value ]

Usage Notes

This method allows for updating a constituent's response to survey questions that they may or may not have previously taken. This is used primarily in the case of TeamRaiser surveys when the option to allow constituents to update their responses to registration questions is enabled within that TeamRaiser.

Note: This method does not enforce that option being enabled for the teamraiser specified by the fr_id.

Only questions that should normally be requested of the user will be updated. This means that if your TeamRaiser survey contains questions for All Participants, questions for Team Captains Only, and questions for only certain Participation Types, a participant who is not a Team Captain will only be allowed to provide updates to the questions for All Participants and their Participation Type.

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.

question_key_

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 key 'T-Shirt_Size' and 'Permission_Slip_Returned', include parameters question_key_T-Shirt_Size and question_key_Permission_Slip_Returned.

Type xsd:string.

require_response

Optional. Verify that answers to questions requiring a response are not blank.

Type xsd:boolean.

Default is false.

survey_id

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

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"?>
<updateSurveyResponsesResponse 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">
  <success>true</success>
</updateSurveyResponsesResponse>

        
JSON response
{"updateSurveyResponsesResponse":{"success":"true"}}

        

Leave a Comment

Nickname
Comment
Enter this word: