SoGoSurvey provides programmatic access to your survey data using a simple, powerful, and secure application programming interface, the SoGoSurvey Web Services API. To use this document, you should have a basic familiarity with software development, Web services, and the SoGoSurvey user interface.
Functionality described in this guide is available only in Enterprise+ accounts enabled for API integration. To enable this option within your Enterprise+ account, contact SoGoSurvey Support at firstname.lastname@example.org.
SoGoSurvey is both scalable and extensible, and it embraces open Internet standards (HTTP, XML, SOAP, WSDL) for access and consumption by any client or Internet-enabled device.
Customize, integrate, and extend your SoGoSurvey solution using the language and platform of your choice:
The API is implemented to comply with the following specifications:
|Simple Object Access Protocol (SOAP) 1.1||http://www.w3.org/TR/2000/NOTE-SOAP-20000508/|
|Simple Object Access Protocol (SOAP) 1.2||http://www.w3.org/TR/soap12-part1/|
|Web Service Description Language (WSDL) 1.1||http://www.w3.org/TR/2001/NOTE-wsdl-20010315|
|WS-I Basic Profile 1.1||http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-0824.html|
The API can be used in all major programming languages that support HTTP Protocol.
Web references for the Web service can be used in development platforms that support them.
If Web references are not supported in a development platform, API can be used through simple HTTP POST Request.
Sample code for API usages in C#, VB.NET, Python, PHP and Curl are provided in this document.
Note: Development platforms vary in their SOAP implementations.
We recommend using the most recent version of the SoGoSurvey WSDL file with your client applications to ensure you’re able to take full advantage of richer feature sets and enhanced efficiency. Upgrade instructions and details are published whenever a new WSDL file is released.
SoGoSurvey strives to make backward compatibility easy for our API users. We maintain support for each API version across releases of the platform software. The API is backward compatible in that an application created to work with a given API version will continue to work with that same API version in future platform software releases. SoGoSurvey does not guarantee that an application written against one API version will work with future API versions: Changes in method signatures and data representations are often required as we continue to enhance the API. However, we strive to keep the API consistent from version to version with minimal changes required to port applications to newer API versions. For example, an application written using API version 2.5 will continue to work with SoGoSurvey platform version 11.0 and v11.5 and all future releases beyond that until deprecated. However, that same application may not work with API version 4.0 without modifications to the application.
SoGoSurvey is committed to supporting each API version for a minimum of two years from the date of its first release. In order to mature and improve the quality and performance of the API, versions that are more than two years old may cease to be supported. When an API version is to be deprecated, advance end-of-life notice will be given at least six months before support for the API version is ended.
We use conventional HTTP response status codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error caused by the information provided (a required parameter was omitted, a method was not found, etc.), and codes in the 5xx range indicate an error with our servers.
|500||Internal Server Error|