How To Send a Request to an External Webservice using SurveyToGo

Overview

SurveyToGo allows you to send asynchronous web service requests directly from your survey scripts. This enables surveys to communicate with external systems, retrieve data, validate information, or submit data to third-party services during an interview.

SurveyToGo provides built-in functions for sending both HTTP GET and HTTP POST requests.

Web Service Functions

HTTP POST Request

Use the following function to send data to a web service using a POST request:

string WebServicePost(string inUrl, string inData)

Parameters

• inUrl – The URL of the web service.

• inData – The data to be sent in the request body.

HTTP GET Request

Use the following function to retrieve data from a web service using a GET request:

string WebServiceGet(string inUrl)

Parameters

• inUrl – The URL of the web service.

Receiving the Web Service Response

The WebServicePost() and WebServiceGet() functions operate asynchronously.

This means that the request is sent immediately, but the response is not returned directly to the calling script.

To process the response, add the OnWebServiceResult() callback function to the survey's Advanced Scripts section.

This callback is automatically triggered when a web service response is received.

Example

function OnWebServiceResult(inRequestId, inResult)
{
    // Process the response here
}

The callback allows you to inspect and process the response returned by the web service once the request has completed.

Parsing JSON Responses

SurveyToGo also provides functionality for parsing web service responses into objects when the returned data is valid JSON.

This allows you to access individual properties and values from the response rather than manually processing the raw response text.

When a web service returns properly formatted JSON, the response can be converted into an object and used directly within your survey logic, making it easier to work with structured data returned from external systems.

Object ParseJson(string JsonString);

An example of an overload to the OnWebServiceResult callback with a call to the ParseJson function which will set the response value to a global variable:

function OnWebServiceResult(inTicket, inOriginalUrl, inXMLResult, inIsError, inHttpStatus, inContentType)
{
Vars["response"] = ParseJson(inXMLResult);
}

 

Please Note:
On Android please make sure that you do not have any spaces included in the URL, to overcome you can use one of the following options:
1. Add %20 instead of the spaces 
2. use a JavaScript function to do it, for example: 

• encodeURI("Thanks for being a part of the survey")