Class SurveyDataRequestModel

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

Fields required to create a survey data download request on nfield manager surveys

public class SurveyDataRequestModel

Inheritance

object

SurveyDataRequestModel

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

CustomColumnName

Custom column name for filtering download data

[JsonProperty("CustomColumnName", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string CustomColumnName { get; set; }

Property Value

string

CustomColumnValue

Custom column value for filtering download data

[JsonProperty("CustomColumnValue", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string CustomColumnValue { get; set; }

Property Value

string

EndDate

Optional. The end date for the data requested.

[JsonProperty("EndDate", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public DateTimeOffset? EndDate { get; set; }

Property Value

DateTimeOffset?

FileName

Optional. Name of the file. The default is the surveyName.

[JsonProperty("FileName", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string FileName { get; set; }

Property Value

string

IncludeAuditLog

Include in the download the audit log file

[JsonProperty("IncludeAuditLog", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool IncludeAuditLog { get; set; }

Property Value

bool

IncludeCapturedAudioQuestionFiles

Include Audio Files. This parameter will be ignored if IncludeCapturedMediaFiles is true

[JsonProperty("IncludeCapturedAudioQuestionFiles", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool IncludeCapturedAudioQuestionFiles { get; set; }

Property Value

bool

IncludeCapturedAudioSilentRecordingFiles

Include Audio Silent Recording Files. This parameter will be ignored if IncludeCapturedMediaFiles is true

[JsonProperty("IncludeCapturedAudioSilentRecordingFiles", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool IncludeCapturedAudioSilentRecordingFiles { get; set; }

Property Value

bool

IncludeCapturedMediaFiles

This property is to Capture All Media Files (AudioQuestion, VideoQuestion, PhotoQuestion, AudioSilentRecording)

[JsonProperty("IncludeCapturedMediaFiles", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool IncludeCapturedMediaFiles { get; set; }

Property Value

bool

IncludeCapturedPhotoQuestionFiles

Include Photo Files. This parameter will be ignored if IncludeCapturedMediaFiles is true

[JsonProperty("IncludeCapturedPhotoQuestionFiles", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool IncludeCapturedPhotoQuestionFiles { get; set; }

Property Value

bool

IncludeCapturedVideoQuestionFiles

Include Video Files. This parameter will be ignored if IncludeCapturedMediaFiles is true

[JsonProperty("IncludeCapturedVideoQuestionFiles", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool IncludeCapturedVideoQuestionFiles { get; set; }

Property Value

bool

IncludeClosedAnswers

Include in the download the closed answer data of the interviews
Previously: DownloadClosedAnswerData

[JsonProperty("IncludeClosedAnswers", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool IncludeClosedAnswers { get; set; }

Property Value

bool

IncludeDroppedOut

Include in the download the dropped out interviews
Previously: DownloadSuspendedLiveInterviewData

[JsonProperty("IncludeDroppedOut", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool IncludeDroppedOut { get; set; }

Property Value

bool

IncludeOpenAnswers

Include in the download the open answer data of the interviews
Previously: DownloadOpenAnswerData

[JsonProperty("IncludeOpenAnswers", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool IncludeOpenAnswers { get; set; }

Property Value

bool

IncludeParaData

Include in the download the para data of the interviews
Previously: DownloadParaData

[JsonProperty("IncludeParaData", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool IncludeParaData { get; set; }

Property Value

bool

IncludeQuestionnaireScript

Include in the download the questionnaire script
Previously: DownloadQuestionnaireScript

[JsonProperty("IncludeQuestionnaireScript", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool IncludeQuestionnaireScript { get; set; }

Property Value

bool

IncludeRejected

Include in the download the rejected interviews
Previously: DownloadRejectedLiveInterviewData

[JsonProperty("IncludeRejected", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool IncludeRejected { get; set; }

Property Value

bool

IncludeScreenOut

Include in the download the screen out interviews
Previously: DownloadNotSuccessfulLiveInterviewData

[JsonProperty("IncludeScreenOut", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool IncludeScreenOut { get; set; }

Property Value

bool

IncludeSuccessful

Include in the download the successful interviews
Previously: DownloadSuccessfulLiveInterviewData

[JsonProperty("IncludeSuccessful", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool IncludeSuccessful { get; set; }

Property Value

bool

IncludeTestData

Include in the download test interviews
Previously: DownloadTestInterviewData

[JsonProperty("IncludeTestData", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool IncludeTestData { get; set; }

Property Value

bool

IncludeVarFile

Include in the download the variables file of the interviews
Previously: DownloadVarFile

[JsonProperty("IncludeVarFile", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool IncludeVarFile { get; set; }

Property Value

bool

StartDate

Optional. The start date for the data requested.

[JsonProperty("StartDate", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public DateTimeOffset? StartDate { get; set; }

Property Value

DateTimeOffset?

SurveyVersion

Optional. The survey version (Etag)

[JsonProperty("SurveyVersion", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string SurveyVersion { get; set; }

Property Value

string