Setting up surveys for interviewing with the Interviewer app
The Interviewer is an app that allows researchers to share surveys with the interviewers. The shared accounts for the interviewers are created using Snap XMP Online. When the interviewers log into the Interviewer app, they see the surveys that are assigned to them. Before you start check that The Interviewer app is available for devices that run Apple […]
Running a survey in kiosk mode
This tutorial describes how to create and run a survey on a standalone kiosk . This can be on a dedicated kiosk or a laptop, PC or tablet. Surveys are synchronized online with the kiosk using the Interviewer app. Once synchronized, you can set up the device in kiosk mode and select which survey to […]
Using YouTube videos in a questionnaire
In Snap XMP Desktop, a questionnaire can contain a link to a video on YouTube or another similar website. You can also insert media objects directly into a questionnaire. The easiest way to link to a YouTube video is to use the embed code provided on the YouTube site. This is a piece of HTML […]
Get Survey Responses
Get the responses of a survey. You can Please note that from Monday 5th December 2022 usage of the API becomes chargeable. The charge is that 0.1 unit will be consumed each time a survey response is delivered by the API. This applies if the same survey response is delivered by the API multiple times. […]
Get Survey Variable
Get the details of a variable of a survey. Changes from v1.0 Endpoint Method URL GET surveys/{surveyId}/variables/{variableId} Get the details of the specific variable identified by the variableId path variable of the specific survey identified by the surveyId path variable. Parameters Path parameters Path parameter Description {surveyId} The id of the survey. This is the […]
Get Survey Variables
Get details of all of the variables for a survey. Changes from v1.0 Endpoint Method URL GET surveys/{surveyId}/variables Gets the details for a specific survey ID. Parameters Path parameters Path parameter Description {surveyId} The id of the survey. This is the survey GUID and not the Interview URL. Query string parameters Query string parameter Required […]
Get Survey
Get details of a survey. Changes from v1.0 Endpoint Method URL GET surveys/{surveyId} Gets the details of a specific survey identified by the surveyId path variable. Parameters Path parameters Path parameter Description {surveyId} The id of the survey. This is the survey GUID and not the Interview URL. Query string parameters None Sample Request (In […]
Get Survey List
Get a list of surveys that are accessible by the user. This includes surveys that are shared to the user. Changes from v1.0 Endpoint Method URL GET surveys Get a list of surveys that are accessible by the user. Parameters Path parameters None Query string parameters None Sample Request (In the above code, replace {APIKEY} […]
Recommendation
Prior to creating your code we strongly recommend that you make use of a tool called Postman. Postman can be installed on a PC or accessed via a web browser. It is free for most of the tasks that an API consuming developer would want to achieve. Postman allows the developer to “play” with an […]
HTTP Status Codes
As well as specific return codes listed in the API Reference section, all end-points can return the following HTTP status codes: HTTP status code Description 400 Bad Request If a query parameter is incorrect or does not exist or is not provided when not optional. Note: This is a change from v1.0 version. 401 Unauthorized […]