CRSurveyAPI:submitSurvey

servlet
methodThe method name
api_key An arbitrary value that must be passed when invoking the Convio Client and Server APIs. The value passed by the caller must match the value in the CONVIO_API_KEY site configuration parameter, which is unique for each Convio site.
v API version to invoke. Must be "1.0".
auth Required for some client-side methods that access sensitive information. Must be a system-generated authentication token for the session obtained from a "[[S86]]" tag in Convio-generated content. Alternatively, the "sso_auth_token" parameter can be used with a different system-generated token obtained from a single sign-on (SSO) API method call.
center_id The ID of a center (in a multi-center enabled site) to associate with the current session.
error_redirect Specifies a URL that the method should redirect to in the event of an error.
redirect Specifies a URL that the method should redirect to upon completion. Used in the absence the more specific ones that depend on whether the request succeeds or fails
response_format Used to specify either XML or JSON formatting for the response.
sign_redirects Specifies that redirect URLs should be signed with a timestamp and a hash of the query string arguments and a secret key.
source Text to associate with newly created constituent records to identify how or from where the record was added. This is recognized by all API methods even though most of them do not directly create constituent records. This is because the value is remembered in the visitor's current web browser session and used if they take any action, either via API call or browser interaction, that causes a new constituent record to be created.
sub_source Further detail to save with the "source" information.
success_redirect Specifies a URL that the method should redirect to upon successful completion.
suppress_response_codes Specifies that all responses will be returned with an HTTP 200 OK status code - even errors. This parameter exists to accommodate Flash and JavaScript applications running in browsers that intercept all non-200 responses. If used, it's then the job of the client to determine error states by parsing the response body.
survey_id The ID of the survey you are accessing.
auth Required for some client-side methods that access sensitive information. Must be a system-generated authentication token for the session obtained from a "[[S86]]" tag in Convio-generated content. Alternatively, the "sso_auth_token" parameter can be used with a different system-generated token obtained from a single sign-on (SSO) API method call.
cons_birth_date Parameter containing the value of the Birth Date field when submitting a survey containing a Constituent Registration Information Question, formatted per the ISO 8601 specification.
cons_city Parameter containing the value of the City field when submitting a survey containing a Constituent Registration Information Question.
cons_country Parameter containing the value of the Country field when submitting a survey containing a Constituent Registration Information Question.
cons_email Parameter containing the value of the Email field when submitting a survey containing a Constituent Registration Information Question.
cons_email_format Parameter containing the value of the Preferred Email Format field when submitting a survey containing a Constituent Registration Information Question. Default value if not provided is '0' indicating the user has no preferred format.
cons_email_opt_in Parameter indicating the Email Opt In choice of a user when submitting a survey containing a Constituent Registration Information (CRI) Question. True indicates the constituent should be opted in, false indicates they should be opted out.
cons_employer Parameter containing the value of the Employer field when submitting a survey containing a Constituent Registration Information Question.
cons_first_name Parameter containing the value of the First Name field when submitting a survey containing a Constituent Registration Information Question.
cons_gender Parameter containing the value of the Gender field when submitting a survey containing a Constituent Registration Information Question.
cons_last_name Parameter containing the value of the Last Name field when submitting a survey containing a Constituent Registration Information Question.
cons_middle_name Parameter containing the value of the Middle Name field when submitting a survey containing a Constituent Registration Information Question.
cons_occupation Parameter containing the value of the Occupation field when submitting a survey containing a Constituent Registration Information Question.
cons_password Parameter containing the value of the Password field when submitting a survey containing a Constituent Registration Information Question.
cons_phone Parameter containing the value of the Phone Number field when submitting a survey containing a Constituent Registration Information Question.
cons_postal_opt_in Parameter indicating the Postal Mail Opt In choice of a user when submitting a survey containing a Constituent Registration Information (CRI) Question. True indicates the constituent should be opted in, false indicates they should be opted out.
cons_prof_suffix Parameter containing the value of the Professional Suffix field when submitting a survey containing a Constituent Registration Information Question.
cons_rep_password Parameter containing the value of the Confirm / Re-enter Password field when submitting a survey containing a Constituent Registration Information Question.
cons_state Parameter containing the value of the State field when submitting a survey containing a Constituent Registration Information Question.
cons_street1 Parameter containing the value of the Street 1 field when submitting a survey containing a Constituent Registration Information Question.
cons_street2 Parameter containing the value of the Street 2 field when submitting a survey containing a Constituent Registration Information Question.
cons_suffix Parameter containing the value of the Suffix field when submitting a survey containing a Constituent Registration Information Question.
cons_title Parameter containing the value of the Title field when submitting a survey containing a Constituent Registration Information Question.
cons_user_name Parameter containing the value of the User name field when submitting a survey containing a Constituent Registration Information Question.
cons_zip_code Parameter containing the value of the Zip / Postal Code field when submitting a survey containing a Constituent Registration Information Question.
denyApiSubmit Parameter indicating that the submission should NOT be accepted. This is a weak method of preventing scripts from submitting spam via your surveys by including a text input field that is hidden using Cascading Style Sheets (CSS). Do not use a hidden input field for this, as most spam-scripts do not auto-populate hidden inputs. If a script automatically fills in that field and submits the survey, the submission will not be processed. It is recommended that you provide a label indicating that humans should not fill in this field so that humans using a screen reader know to leave that field empty.
question_ This parameter is not used by itself, but is used in conjunction with the Question's Id to create a Question Indicator Parameter. You must append a question's question Instance ID after the underscore, at which point this parameter indicates the answer to that question. Ex: 'question_1001=hello' would indicate that the question with the id 1001 is being submitted with an answer of 'hello'. When providing answers to a DateQuestion question, this parameter must be a date string formatted per the ISO 8601 specification. When providing answers to a NumericValue question this parameter must be a numeric value. For all other question types, this parameter is a string. Note: This type of Question Indicator Parameter is not used for Constituent Registration Information questions.
s_rememberMe Parameter indicating that the system should remember the user after logging them in (if the question is configured to log new users in).
survey_cancel Parameter indicating that user clicked the cancel/skip button. Submitting a value of 'true' indicates that the user has cancelled and the API will return a response indicating that the submission was successful and that the user cancelled. The response will include URL to redirect to based on the survey configuration (if any). Does not perform an automatic redirect.
sso_auth_tokenThe auth token

login

servlet
method
v
api_key
user_name
password


logout

servlet
method
v
api_key