GET v1/Surveys/{surveyId}/InterviewInteractionsSettings

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser Supervisor Scripter LimitedUser QuotaManager LocalDomainManager GlobalDomainManager OperationsUser SampleManager RepositoryManager DemoUser All

Permissions required to make this request: Survey.Read

Has survey type usage restrictions online

Get interview interactions settings for the survey.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyId

id of the survey

 string

Required

Body Parameters

None.

Response Information

Resource Description

interview interactions settings of the survey

Response Message

SurveyInterviewInteractionsSettingsResponseModel
NameDescriptionTypeAdditional information
BackButtonAvailable

Allow to navigate backwards

 boolean

None.
PauseButtonAvailable

Allow identified users to pause the interview

 boolean

None.
ClearButtonAvailable

Allow to clear all answers from the screen

 boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "BackButtonAvailable": true,
  "PauseButtonAvailable": true,
  "ClearButtonAvailable": true
}

application/xml, text/xml

Sample: 
<SurveyInterviewInteractionsSettingsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <BackButtonAvailable>true</BackButtonAvailable>
  <ClearButtonAvailable>true</ClearButtonAvailable>
  <PauseButtonAvailable>true</PauseButtonAvailable>
</SurveyInterviewInteractionsSettingsResponseModel>