API Docs / Schemas / DataFormSectionDto

DataFormSectionDto

A section within a form

Properties

Name Type Description
codestring

Stable identifier for this section, used to match across saves

Stable identifier for this section, used to match across saves

titlestring

The display title of the section

The display title of the section

introductionstring

Introductory text shown to clients at the top of this section.

Introductory text shown to clients at the top of this section.

sortOrderinteger

The display order of this section relative to others in the form

The display order of this section relative to others in the form

clientTypesarray of enum

The types of clients this section is applicable to.
An empty list means the section is shown to all client types.

PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader

The types of clients this section is applicable to.
An empty list means the section is shown to all client types.

PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader

questionsarray of DataFormQuestionDto

The questions belonging to this section, in display order

The questions belonging to this section, in display order

JSON Example

{
  "code": "string",
  "title": "string",
  "introduction": "string",
  "sortOrder": 0,
  "clientTypes": [
    "PrivateLimitedCompany"
  ]
}

Contained in Schemas