Support Forums

Questions about surveying? How does this thing work? We're here to help!

The Forums are now closed, because much of the older info is out of date.

Check out our Knowledge Base, ask a support question: Support.SurveyGizmo.com or ask a sales question with our Sales Contact Form.

Current User: Guest

API Question – submitSurveyResponse

Topic Locked
UserPost

5:23
May 18, 2009


Paul

Member

posts 35

Post edited 12:25 – May 18, 2009 by Paul
Post edited 12:26 – May 18, 2009 by Paul
Post edited 12:27 – May 18, 2009 by Paul


Hi,


If a user was submitting a response to this 2 question survey:

What is your name?

What is your favourite colour?


and they submitted a partial response (just the first question) because they wanted to submit the rest at a later date:

... &cmd=submitSurveyResponse&sid=555555&values=2:Paul

How can the API submit the remaining answers for that particular user? If the user was to later submit:

 ... &cmd=submitSurveyResponse&sid=555555&values=2:Paul|3:Blue

Then wouldn't that response become a new response with a new response ID, leaving the original incomplete?

Kind regards,

-Paul

6:00
May 18, 2009


Paul

Member

posts 35

I have also noticed that when you submit a partial response the getSurveyList call shows the 'count_abandoned' field increment by 1 for about a minute, then reduces by 1 and then the 'count_complete' increments by 1. All the while, the 'total_responses' field remains at zero.


I appreciate the API is still in beta with a new version coming soon, so any help would be great.

3:13
May 19, 2009


jonathan

Admin

posts 1129

Hey, Paul!


Sorry! Through our current API, there isn't a way to submit a partial response or update response data after it has already been submitted. We like the idea, and I just spoke with our Dev team about it, and we'll wait to hear back from them to see if that might become a future feature.

The total responses field will take a moment to update after a response has been submitted. First, the response is either a partial (or abandoned) until the data gets processed into a complete, then the total responses field is updated.

Jonathan Turk, SurveyGizmo Account Manager
Did this answer help? Let us know!
Want to be a SurveyGizmo Expert? Learn here!

6:15
May 19, 2009


Paul

Member

posts 35

Cheers Jonathan,


Returning a response ID in the success/fail XML after the submitResponse call would be a good way to implement this from a developers view. Then having the response ID field as an optional field in the submitResponse method (which overwrites or appends the previous submission).


I'm still a little confused by this total responses field and how it relates to the count_complete field. I'm getting the following xml from a getSurveyList call:

<id>136514</id>
<title LANGUAGE=”English”>One Question Test</title>
<date_created>2009-05-17 18:54:46</date_created>
<date_lastactivity>2009-05-18 09:23:23</date_lastactivity>
<total_responses>0</total_responses>
<survey_type>Standard Survey</survey_type>
<status>Launched</status>
<count_inprogress>0</count_inprogress>
<count_complete>9</count_complete>
<count_partial>0</count_partial>
<count_overflow>0</count_overflow>
<count_abandoned>0</count_abandoned>


I'm a little confused as to how the total_responses field can be zero while the count_complete can be 9. Any ideas?


10:53
May 19, 2009


jonathan

Admin

posts 1129

Post edited 5:54 – May 19, 2009 by jonathan


Hey, Paul!

Woops! We already covered the response ID info in your other post!

It looks like I was wrong! The the total_responses field isn't fully functioning *yet*. Being that the API is in Beta, there are still things we're working on adding or or correcting. The total_responses field tries to pull a pre-tallied number from a database column that it can't yet find (because its not there). We're going to be soon updating the API to use a tally of the count_x fields instead.

Jonathan Turk, SurveyGizmo Account Manager
Did this answer help? Let us know!
Want to be a SurveyGizmo Expert? Learn here!

9:30
May 20, 2009


Paul

Member

posts 35

No worries Jonathan, I appreciate this is still in beta. Would this also explain why the TEXTBOX question type isn't returning any option fields with regard to formatting – e.g.:

<question sku=”3″ type=”TEXTBOX” required=”true”>
<title>What is the date?</title>
<options/>
</question>


Just wondering how I could know whether a textbox field has been setup for currency, or percentage or date, etc. And what would happen if I submitted text to a date field?


Kind regards,


-Paul

10:00
May 20, 2009


jonathan

Admin

posts 1129

Hey, Paul!

Textboxes actually don't have Options like a radio button or drop-down menu, so the options tag will simply self close (ie <options />).

The date/number/etc formatting and Regex validation is only for actual survey flow. When you submit a response via the API, the response will be saved as it is submitted, so if you enter “YES” into a textfield question that is formatted for date, it will save “Yes”.

Jonathan Turk, SurveyGizmo Account Manager
Did this answer help? Let us know!
Want to be a SurveyGizmo Expert? Learn here!

9:29
July 18, 2009


Paul

Member

posts 35

Does the SKU number corresponds to the 'questionid' as documented in the submitSurvey call. I see no mention of this 'questionid' in the survey design xml. Thus, I'm a little confused if my submit survey code is right. My current code uses the sku as the questionid:

values=questionid:answervalue|questionid:answervalue

Is this correct?

8:47
July 20, 2009


jonathan

Admin

posts 1129

Hey, Paul!

Thats right, the SKU and the ID are the same – sorry for that inconsistancy. I'll make sure I pass along the information to our tutorial writers to make sure we keep the same terminology between all documents.

Jonathan Turk, SurveyGizmo Account Manager
Did this answer help? Let us know!
Want to be a SurveyGizmo Expert? Learn here!

12:50
July 21, 2009


Paul

Member

posts 35

Appreciate your help Jonathan,

The documentation is a little sparse, as I also got confused as to how one should submit certain question types like rank, radio and checkboxes. For example, suppose a checkbox question type such as this:


What are you favourite colors?
Red        (selected)
Blue
Green     (selected)
Orange
Other      (selected with value: Purple)


Would the submit string be as follows:

values=questionid:Red;Green;Purple

or

values=questionid:TRUE;FALSE;TRUE;FALSE;Purple

or

values=questionid:1;0;1;0;Purple


Also for ranking, do you just have the text choices written one after each other separated by the semi-colon?

2:08
July 21, 2009


jonathan

Admin

posts 1129

Hey, Paul!


You're right on the first take – you're submitting your REPORTING VALUES to the survey, so if your reporting values for that checkbox question are “Red”, “Green” and “Purple”, then you would write values=questionid:Red;Green;Purple

Also, thats precisely right for the ranking question types. ;-)

Jonathan Turk, SurveyGizmo Account Manager
Did this answer help? Let us know!
Want to be a SurveyGizmo Expert? Learn here!

9:11
July 23, 2009


Paul

Member

posts 35

For the submitSurvey call I've noticed your API documentation refers to strict RFC 3986 encoding of the string. I'm assuming that is because of the ':' and ';” delimiters for the questionids and each value?

However, I have noticed that RFC 3986 does NOT specify the pipe character '|' as a delimiter, which the submitSurvey call needs to separate questions. Thus, if a user was to type a pipe into a textbox and I submit the value, wouldn't that break the call? So wouldn't I need escape characters for pipes also?

10:32
July 23, 2009


Mario

Admin

Boulder, CO

posts 994

The pipe symbol is used in mathematics, physics, and computing, so it's unlikely in a response to be included as part of your respondents data. The specification was necessary because a custom pointed out some specifics and thus we wanted to be explicit, but I can't remember the exact differences between that RFC and another standard that was being confused. Sorry!

Mario Lurig
Sales Engineer – SurveyGizmo
How was my customer service? Provide feedback!

11:33
July 24, 2009


Paul

Member

posts 35

Hi,

When calling submitSurvey for a Continuous Sum question type what do I do for a question containing an 'Other' field?

I was expecting on the call string looking like this:

values=questionid:12;34;546;76

Yet the 'Other' field allows a user to enter a text string as an alternative option. So how do I submit that text string as well as it's numerical value?

11:25
July 28, 2009


marybeth

Admin

posts 245

Hi Paul,

Our API response submisssions are supposed to be for simple surveys.  The 'other' textbox feature isn't accepted through the API and is a current limitation. You will need to collect the informaiton in a separate textbox.  You can use radio, checkbox, menu, textbox and essay question types without a problem.

Sorry for the confusion!

Marybeth



The Forums are now closed, because much of the older info is out of date.

Check out our Knowledge Base, ask a support question: Support.SurveyGizmo.com or ask a sales question with our Sales Contact Form.