Class SurveyModel

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

The model representing a Survey, this is a Data Transfer Object (DTO).

public class SurveyModel : SurveyBaseModel

Inheritance

object

SurveyBaseModel

SurveyModel

Inherited Members

SurveyBaseModel.SurveyId

SurveyBaseModel.SurveyName

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ClientName

The name of the client or organization for whom the survey is being conducted

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

Property Value

string

Description

A detailed description providing context and purpose of the survey

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

Property Value

string

EnableRespondentsGateway

Enables the Respondents Gateway feature for managing survey samples externally

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

Property Value

bool

InterviewerInstruction

Instructions and guidelines provided to interviewers conducting the survey

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

Property Value

string

IsBlueprint

Indicates whether this survey serves as a template (blueprint) for creating other surveys

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

Property Value

bool

LastStartDate

The timestamp when the survey was last started or restarted for data collection

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

Property Value

DateTimeOffset?

QuestionnaireMD5

MD5 hash of the compiled questionnaire, used for versioning and change detection

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

Property Value

string

SurveyGroupId

The identifier of the survey group to which this survey belongs for organizational purposes

[JsonProperty("SurveyGroupId", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
[Range(1, 2147483647)]
public int SurveyGroupId { get; set; }

Property Value

int

SurveyState

The current lifecycle state of the survey (e.g., Created, Testing, Live, Closed)

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

Property Value

SurveyState

SurveyType

The type of survey: Basic, Advanced, EuroBarometer, EuroBarometerAdvanced, OnlineBasic, Cati

[JsonProperty("SurveyType", Required = Required.Always)]
[Required]
public string SurveyType { get; set; }

Property Value

string