Introduction

SoGoSurvey provides simple and powerful programmatic access to your survey data using your preferred secure application programming interface:

  • SoGoSurvey REST API
  • SoGoSurvey Web services API
To use this document, you should have a basic familiarity with software development, Web services, RESTful services and the SoGoSurvey user interface.

The 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 support1@sogosurvey.com.

SoGoSurvey is both scalable and extensible, and it embraces open Internet standards (HTTP, XML, SOAP, JSON, WSDL) for access and consumption by any client or Internet-enabled device.

Customize and Integrate

Customize, integrate, and extend your SoGoSurvey solution using the language and platform of your choice:

  • Create advanced surveys and customize the look and feel by using your own logos, colors, and branding guide.
  • Integrate SoGoSurvey with your HR, CRM, or School Portal systems to meet any advanced requirements you or your clients may encounter.

Standards Compliance

The REST services API is implemented to comply with the following specifications:

Status Reference
JavaScript Object Notation (JSON) https://jsonapi.org/format/
Web services Description Language (WSDL) 1.1 http://www.w3.org/TR/2001/NOTE-wsdl-20010315
HTTP Verbs (GET, POST, PUT, DELETE) http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html

The Web services API is implemented to comply with the following specifications:

Status Reference
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 services 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
HTTP GET/POST http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html

Development Platforms

The REST and Web services API can be used in all major programming languages that support HTTP Protocol.

Web references for the REST and Web services API can be used in development platforms that support them.

If Web references are not supported in a development platform, REST and Web services API can be used through simple HTTP POST Request.

Sample code for REST and Web services API usages in C#, VB.NET, Python, PHP and Curl are provided in this document.

Note: Development platforms vary in their SOAP implementations.

API Support Policy

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.

Backward Compatibility

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.

API End-of-Life

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.

Environment

You can access the SoGoSurvey API on the following URLs:

REST API (JSON Output)
https://www.sogosurvey.com/_restapi/restservice.svc

Web services API (SOAP Output)
https://www.sogosurvey.com/_web-service/Webservice.asmx

HTTP Response Status Codes

We use conventional HTTP response status codes to indicate the success or failure of a REST and Web services 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.

Output Code Description
200 Success
400 Bad request
401 Unauthorized
500 Internal Server Error

SoGoSurvey Account Enablement

To take advantage of API integration, sign up for a SoGoSurvey Enterprise+ account with API access enabled. Sign up here: https://www.sogosurvey.com/pricing/

Please contact SoGoSurvey Support with any questions at support1@sogosurvey.com.