Class InvitationBatch

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

DTO defining an invitation batch

public class InvitationBatch

Inheritance

object

InvitationBatch

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

EmailColumnName

EmailColumnName contains the email address of the respondent

[JsonProperty("EmailColumnName", Required = Required.Always)]
[Required]
[StringLength(128, MinimumLength = 1)]
public string EmailColumnName { get; set; }

Property Value

string

Filters

Respondent filters

[JsonProperty("Filters", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<SampleFilterModel> Filters { get; set; }

Property Value

ICollection<SampleFilterModel>

InvitationTemplateId

Id of the invitation template to use for the invitations

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

Property Value

int

Name

Name of the batch

[JsonProperty("Name", Required = Required.Always)]
[Required]
[StringLength(700, MinimumLength = 1)]
public string Name { get; set; }

Property Value

string

ScheduledFor

Date the invitations are scheduled to be sent out

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

Property Value

DateTimeOffset?