- Fixed an issue where adding a contact via the API returned invalid results when there were more than 50 contacts in the system. (v2 & v3)
- Fixed an issue with the contact object not functioning with v3 of the api (v3)
- Fixed an issue with sbusinessphone and saddress2 in the contact object (v2 & v3)
- Poll embed code is now properly escaped (v2 & v3)
All updates for API v3 unless otherwise noted. Note that some of these updates were released prior to locking v1 and v2, the documentation of the fixes was just a little late.
- API now properly returns all translations for fields with multiple languages entered.
- Survey object properly displays embed codes if one or more are available. (v1, v2 and v3)
- “Publish” link (found under the survey object inside “Links” array) is no longer truncated when requeting xml format. (v1, v2 and v3)
- API now returns “Alias/Short Name” information for questions. Found under SurveyQuestion object, field name: “shortname” (v1, v2 and v3)
Updates to the Contact object (survey/{surveyID}/surveycampaign/{campaignID}/contact)
- Can now see fields estatus and esubscriberstatus
- esubscriberstatus is updated when emails are sent. Possible values are unsent, sent, unsubscribed and bounced
- Can now set/change estatus through the app (not the API) to Active, Deleted, Unsubscribed
- Can now submit “other/please specify” data. (v1, v2 and v3)
Example:
&data[2][10001]=otherreportingvalue
&data[2][10001-other]=othertextboxvalue
Development of new features is no longer being done for v1 and v2 of the REST API. All development of new features is currently being done on v3 of the REST API.
XML returned by v3 of the API includes underscores normally found in other formats.
Children of the “data” node are named _#, where # is the index.
eg.
<data>
<_0>…</_0>
<_1>…</_1>
</data>
API calls pointing to restapi.surveygizmo.com/head/ will point to restapi.surveygizmo.com/v2/ beginning Monday, February 27th. Currently, head points to v1.
In order to access new updates, you will want to update your calls to v2 or head. However, if you prefer to remain on V1, you may continue to use restapi.surveygizmo.com/v1/
As some of you have noticed, the past week has been a bit bumpy with a few releases impacting the API — our apologies! The good news is that these issues should be resolved, and also that we have added our version 2 or v2 of the restful API, which will make it easier to expand functionality and access using the API with less impact on your existing development.
For many of our API users, XML results without cdata tags could be problematic. One errant < or > and things break. For some time the data has not included these tags and this has been updated. The default setting is to have calls for SurveyResponse now include the cdata tags.
Some users have requested example scripts to parse the basic survey response array into something more malleable for working with the data. The following example is very similar to code we use to organize survey data into an array that is easier to work with, at least within PHP.
/**
One of the things we’ve been working on is a new way to present our documentation. As I’m sure you’ve noticed we have a ton of custom scripting functions, and the organization and presentation could be improved. So, to see what you all think, we’ve decided to post an early version of what we’re working on!
Before you head over to the new documentation, there are a few things that you should know:
You can email any feedback you have to dan@sgizmo.com. This is the reason we’re putting it up, so please let us know what you think!
Now, without further ado: http://forplayplay.com/SurveyGizmo/beta/CSDoc/CSDoc.html
If you’d like a couple of tips on how to use the documentation…
Here’s a PHP example that uses Curl to pull response data for a single survey. Please use this forum thread for any questions or discussions of this example: http://developer.surveygizmo.com/forum/topic/php-curl-example
<?php /** * This script is a example of how to do a basic curl call to the SurveyGizmo Restful API to retrieve * responses for a given survey and display results. * More documentation on the Restful API can be found at http://developer.surveygizmo.com/ * @author Seth McClaine, SurveyGizmo Web Developer * 9/20/2011 **/ //Required Fields $user = 'seth@sgizmo.com'; //Email address used to log in $pass = 'password'; //Passord used to log in $survey = '123456';//Survey to pull from //Options Filter examples, uncomment to see theese in use #$status = "&filter[field][1]=status&filter[operator][1]==&filter[value][1]=Complete";//Only show complete responses #$datesubmmitted = "&filter[field][0]=datesubmitted&filter[operator][0]=>=&filter[value][0]=2011-02-23+13:23:28";//Submit date greater than 2/23/2011 at 1:23:28 PM //Restful API Call URL $url ="https://restapi.surveygizmo.com/v1/survey/{$survey}/surveyresponse?user:pass={$user}:{$pass}{$status}{$datesubmmitted}"; echo $url; //Curl call $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); $output = curl_exec($ch); //The standard return from the API is JSON, decode to php. (It is also possible to request a PSON, PHP object, back. See documentation for more details) $output= json_decode($output); //If there are no responses, display an error (Either if the filter is to strong or the given survey does not have responses) if($output->total_count<1) { die('<h3>No responses found</h3>'); } //Run through responses foreach($output->data as $response) { $count++; unset($row); foreach($response as $key => $value) { if($count == 1) { $header .= "<th>{$key}</th>"; } $row .= "<td>{$value}</td>"; } $trows[] = "<tr>{$row}</tr>"; } //Display results in a table echo "<table border='1'>"; echo "<tr>{$header}</tr>"; echo join($trows); echo "</table>"; ?>