Class FormSubmissionValue

Namespace

Crews.PlanningCenter.Api.People.V2022_01_05

Assembly

Crews.PlanningCenter.Api.dll

Attributes for the FormSubmissionValue resource.

public record FormSubmissionValue : IEquatable<FormSubmissionValue>

Inheritance

object

FormSubmissionValue

Implements

IEquatable<FormSubmissionValue>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

FormSubmissionValue()

public FormSubmissionValue()

FormSubmissionValue(FormSubmissionValue)

protected FormSubmissionValue(FormSubmissionValue original)

Parameters

original FormSubmissionValue

Properties

Attachments

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("attachments")]
public JsonArray? Attachments { get; init; }

Property Value

JsonArray

DisplayValue

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("display_value")]
public string? DisplayValue { get; init; }

Property Value

string

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

Value

Write-only. Accepted when creating a submission and never returned.

The submitted answer. The shape depends on the parent FormField's field_type:

- string, text, number, note, medical: the literal value as a string
- date, birthday, anniversary: an ISO 8601 date as a string
- boolean: "true" or "false"
- gender, marital_status, school, primary_campus: the option's id as a string (look up via /people/v2/genders, /people/v2/marital_statuses, /people/v2/school_options, /people/v2/campuses)
- grade: the grade number as a string, such as "3"
- checkboxes, dropdown, workflow_checkbox, workflow_checkboxes, workflow_dropdown: the FormFieldOption id as a string, not the option's text. A checkboxes or workflow_checkboxes field takes one included FormSubmissionValue per selected option. To answer the field's Other option, send { "other": "…" } instead. For the workflow_* types, submitting the answer creates a WorkflowCard in the linked workflow.
- phone_number: an object like { "number": "555-555-1234", "location": "Mobile" }. location defaults to "Mobile" when omitted.
- address: an object like { "location": "Home", "street": "123 Main St", "city": "Carlsbad", "state": "CA", "zip": "92008", "country_code": "US" }. location defaults to "Home" when omitted. street is a single string, not the street_line_1/street_line_2 pair the Address resource uses; put \n before a second line. country_code is an uppercase ISO 3166-1 alpha-2 code. When the field is required, every property except location must be filled in.
- file: an array of { "fileID": "us4-…", "fileName": "waiver.pdf" } objects. Each object must have exactly those two keys and no others. fileID is the full id returned by the upload service, including its datacenter prefix (see "Uploading files" above). Single-file fields accept one object; fields whose settings.multiple_files is true accept up to 5. Each file may be at most 10 MB, and common executable and script file types are rejected. The fileName key is required, but its value is ignored: the stored file keeps the name it was uploaded with.
- custom_field: follows the linked FieldDefinition's data_type — usually a string, or the file array above when data_type is file.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("value")]
public string? Value { get; init; }

Property Value

string

Methods

Equals(FormSubmissionValue?)

public virtual bool Equals(FormSubmissionValue? other)

Parameters

other FormSubmissionValue

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Operators

operator ==(FormSubmissionValue?, FormSubmissionValue?)

public static bool operator ==(FormSubmissionValue? left, FormSubmissionValue? right)

Parameters

left FormSubmissionValue

right FormSubmissionValue

Returns

bool

operator !=(FormSubmissionValue?, FormSubmissionValue?)

public static bool operator !=(FormSubmissionValue? left, FormSubmissionValue? right)

Parameters

left FormSubmissionValue

right FormSubmissionValue

Returns

bool