DataFormQuestionDto
A question within a form section
Properties
| Name | Type | Description |
|---|---|---|
| code | string | Stable identifier for this question, used to key answers |
Stable identifier for this question, used to key answers | ||
| prompt* | string | The question text shown to the client |
The question text shown to the client | ||
| description | string | An optional hint or clarification shown beneath the prompt |
An optional hint or clarification shown beneath the prompt | ||
| longDescription | string | Optional rich-text long description shown as a tooltip on the form |
Optional rich-text long description shown as a tooltip on the form | ||
| questionType | enum | ClientField CustomField DataFormSpecific |
ClientField CustomField DataFormSpecific | ||
| clientField | enum | Name Code Type Status Email Telephone InternalReference CanContactPost CanContactTelephone CanContactEmail CanContactSms PclSent Manager Partner Associate CompanyNumber CompaniesHouseAuthenticationCode VatNumber VatRegistered VatRegDate VatScheme VatReportingPeriod Utr SelfAssessmentUtr CompanyUtr NiNumber PayeRef AccountsOfficeRef TradingAs NatureOfBusiness IncorporationDate RegisteredAddress PostalAddress InvoiceAddress RegisteredAddressLine1 RegisteredAddressLine2 RegisteredAddressLine3 RegisteredAddressCity RegisteredAddressPostCode RegisteredAddressCountry PostalAddressLine1 PostalAddressLine2 PostalAddressLine3 PostalAddressCity PostalAddressPostCode PostalAddressCountry InvoiceAddressLine1 InvoiceAddressLine2 InvoiceAddressLine3 InvoiceAddressCity InvoiceAddressPostCode InvoiceAddressCountry ContactName ContactTitle ContactFirstName ContactMiddleName ContactLastName ContactEmail ContactPhone ContactMobile ContactDateOfBirth PersonalCode ContactRelationships Team Website ContactNationality ContactMaritalStatus |
Name Code Type Status Email Telephone InternalReference CanContactPost CanContactTelephone CanContactEmail CanContactSms PclSent Manager Partner Associate CompanyNumber CompaniesHouseAuthenticationCode VatNumber VatRegistered VatRegDate VatScheme VatReportingPeriod Utr SelfAssessmentUtr CompanyUtr NiNumber PayeRef AccountsOfficeRef TradingAs NatureOfBusiness IncorporationDate RegisteredAddress PostalAddress InvoiceAddress RegisteredAddressLine1 RegisteredAddressLine2 RegisteredAddressLine3 RegisteredAddressCity RegisteredAddressPostCode RegisteredAddressCountry PostalAddressLine1 PostalAddressLine2 PostalAddressLine3 PostalAddressCity PostalAddressPostCode PostalAddressCountry InvoiceAddressLine1 InvoiceAddressLine2 InvoiceAddressLine3 InvoiceAddressCity InvoiceAddressPostCode InvoiceAddressCountry ContactName ContactTitle ContactFirstName ContactMiddleName ContactLastName ContactEmail ContactPhone ContactMobile ContactDateOfBirth PersonalCode ContactRelationships Team Website ContactNationality ContactMaritalStatus | ||
| customFieldDefinition | CodeAndNameDto | |
| dataType | enum | Text Number Date Boolean Select MultiSelect TextArea Address Email |
Text Number Date Boolean Select MultiSelect TextArea Address Email | ||
| options | string | JSON array of selectable options for Select/MultiSelect data types |
JSON array of selectable options for Select/MultiSelect data types | ||
| maxLength | integer | Maximum character length for Text and TextArea types |
Maximum character length for Text and TextArea types | ||
| lines | integer | Number of visible text lines for TextArea type |
Number of visible text lines for TextArea type | ||
| displayWidth | enum | Small Medium Large Full |
Small Medium Large Full | ||
| booleanDisplayMode | enum | Toggle Checkbox YesNo |
Toggle Checkbox YesNo | ||
| isRequired | boolean | When true, the client must answer this question before submitting the form |
When true, the client must answer this question before submitting the form | ||
| sortOrder | integer | The display order of this question relative to others in the section |
The display order of this question relative to others in the section | ||
JSON Example
{
"code": "string",
"prompt": "string",
"description": "string",
"longDescription": "string",
"questionType": "ClientField"
}