PATCH v1/Surveys/{surveyId}/InterviewInteractionsSettings

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser LimitedUser OperationsUser

Permissions required to make this request: Survey.Write Survey.Read

Has survey type usage restrictions online

Update interview interactions settings for the survey.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	id of the survey	string	Required

Body Parameters

new interview settings

SurveyInterviewInteractionsSettingsRequestModel

Name	Description	Type	Additional 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.

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<SurveyInterviewInteractionsSettingsRequestModel 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>
</SurveyInterviewInteractionsSettingsRequestModel>

application/x-www-form-urlencoded

Sample:

BackButtonAvailable=true&PauseButtonAvailable=true&ClearButtonAvailable=true

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

the updated interview interactions settings

Response Message

SurveyInterviewInteractionsSettingsResponseModel

Name	Description	Type	Additional 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>