POST v1/Surveys/{surveyId}/DataDownload

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

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

Supports survey simulations

Post a request for a data download. The surveyDataRequest specifies the information required on the download.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The survey for which the download is requested	string	Required

Body Parameters

The information that the download should contain

SurveyDataRequestModel

Name	Description	Type	Additional information
FileName	Optional. Name of the file. The default is the surveyName.	string	None.
StartDate	Optional. The start date for the data requested.	date	None.
EndDate	Optional. The end date for the data requested.	date	None.
SurveyVersion	Optional. The survey version (Etag)	string	None.
IncludeSuccessful	Include in the download the successful interviews Previously: DownloadSuccessfulLiveInterviewData	boolean	None.
IncludeScreenOut	Include in the download the screen out interviews Previously: DownloadNotSuccessfulLiveInterviewData	boolean	None.
IncludeDroppedOut	Include in the download the dropped out interviews Previously: DownloadSuspendedLiveInterviewData	boolean	None.
IncludeRejected	Include in the download the rejected interviews Previously: DownloadRejectedLiveInterviewData	boolean	None.
IncludeTestData	Include in the download test interviews Previously: DownloadTestInterviewData	boolean	None.
IncludeClosedAnswers	Include in the download the closed answer data of the interviews Previously: DownloadClosedAnswerData	boolean	None.
IncludeOpenAnswers	Include in the download the open answer data of the interviews Previously: DownloadOpenAnswerData	boolean	None.
IncludeParaData	Include in the download the para data of the interviews Previously: DownloadParaData	boolean	None.
IncludeCapturedMediaFiles	Include in the download the captured media files during the interviews Previously: DownloadCapturedMedia	boolean	None.
IncludeVarFile	Include in the download the variables file of the interviews Previously: DownloadVarFile	boolean	None.
IncludeQuestionnaireScript	Include in the download the questionnaire script Previously: DownloadQuestionnaireScript	boolean	None.
IncludeAuditLog	Include in the download the audit log file	boolean	None.
CustomColumnName	Custom column name for filtering download data	string	None.
CustomColumnValue	Custom column value for filtering download data	string	None.

Request Formats

application/json, text/json

Sample:

{
  "FileName": "sample string 1",
  "StartDate": "2024-05-20T13:41:14.8098703+00:00",
  "EndDate": "2024-05-20T13:41:14.8098703+00:00",
  "SurveyVersion": "sample string 2",
  "IncludeSuccessful": true,
  "IncludeScreenOut": true,
  "IncludeDroppedOut": true,
  "IncludeRejected": true,
  "IncludeTestData": true,
  "IncludeClosedAnswers": true,
  "IncludeOpenAnswers": true,
  "IncludeParaData": true,
  "IncludeCapturedMediaFiles": true,
  "IncludeVarFile": true,
  "IncludeQuestionnaireScript": true,
  "IncludeAuditLog": true,
  "CustomColumnName": "sample string 15",
  "CustomColumnValue": "sample string 16"
}

application/xml, text/xml

Sample:

<SurveyDataRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.SurveyData">
  <CustomColumnName>sample string 15</CustomColumnName>
  <CustomColumnValue>sample string 16</CustomColumnValue>
  <EndDate>2024-05-20T13:41:14.8098703+00:00</EndDate>
  <FileName>sample string 1</FileName>
  <IncludeAuditLog>true</IncludeAuditLog>
  <IncludeCapturedMediaFiles>true</IncludeCapturedMediaFiles>
  <IncludeClosedAnswers>true</IncludeClosedAnswers>
  <IncludeDroppedOut>true</IncludeDroppedOut>
  <IncludeOpenAnswers>true</IncludeOpenAnswers>
  <IncludeParaData>true</IncludeParaData>
  <IncludeQuestionnaireScript>true</IncludeQuestionnaireScript>
  <IncludeRejected>true</IncludeRejected>
  <IncludeScreenOut>true</IncludeScreenOut>
  <IncludeSuccessful>true</IncludeSuccessful>
  <IncludeTestData>true</IncludeTestData>
  <IncludeVarFile>true</IncludeVarFile>
  <StartDate>2024-05-20T13:41:14.8098703+00:00</StartDate>
  <SurveyVersion>sample string 2</SurveyVersion>
</SurveyDataRequestModel>

application/x-www-form-urlencoded

Sample:

FileName=sample&StartDate=Nullable`1&EndDate=Nullable`1&SurveyVersion=sample&IncludeSuccessful=true&IncludeScreenOut=true&IncludeDroppedOut=true&IncludeRejected=true&IncludeTestData=true&IncludeClosedAnswers=true&IncludeOpenAnswers=true&IncludeParaData=true&IncludeCapturedMediaFiles=true&IncludeVarFile=true&IncludeQuestionnaireScript=true&IncludeAuditLog=true&CustomColumnName=sample&CustomColumnValue=sample

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

ActivityId of the download request

Response Message

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.