POST v1/Surveys/{surveyId}/InterviewSimulations/StartInterviewSimulations

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser

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

Supports survey simulations

Method used to start an interview simulation

Request Information

URI Parameters

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

Body Parameters

Options to start the simulation

StartInterviewSimulationsModel

Name	Description	Type	Additional information
InterviewsCount	Number of interviews to be simulated. Allowed value is from 1 to 500 or the maximum value for the domain	integer	Required
EnableReporting	Enable reporting for the simulation	boolean	None.
UseOriginalSample	Use sample data from the original survey	boolean	None.
HintsFile	Upload a hints file to be used by the simulation	HttpFileBase	None.
SampleDataFile	Upload a new sample data file to be used by the simulation	HttpFileBase	None.

Request Formats

application/json, text/json

Sample:

{
  "InterviewsCount": 1,
  "EnableReporting": true,
  "UseOriginalSample": true,
  "HintsFile": null,
  "SampleDataFile": null
}

application/xml, text/xml

Sample:

<StartInterviewSimulationsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <EnableReporting>true</EnableReporting>
  <HintsFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/ApiMultiPartFormData.Models" i:nil="true" />
  <InterviewsCount>1</InterviewsCount>
  <SampleDataFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/ApiMultiPartFormData.Models" i:nil="true" />
  <UseOriginalSample>true</UseOriginalSample>
</StartInterviewSimulationsModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

{
  "InterviewsCount": 1,
  "EnableReporting": false,
  "UseOriginalSample": true,
  "HintsFile": null,
  "SampleDataFile": null
}

Response Information

Resource Description

The activity ID can be used with the BackgroundActivities endpoint to request the status and other information.

Response Message

BackgroundActivityStatus

Name	Description	Type	Additional information
ActivityId	The id of the started activity	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ActivityId": "sample string 1"
}

application/xml, text/xml

Sample:

<BackgroundActivityStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <ActivityId>sample string 1</ActivityId>
</BackgroundActivityStatus>