Objects

The Question object

The same shape for form questions, the questions a session asks to find the form, and a custom form's questions.

Attributes

id string required
The answer's key: qst_…, stable for the life of the question. Three questions the session asks itself have fixed IDs: form (which document), need (what the user needs) and jurisdiction (the state).
type enum required
multiselect takes a list of option values ("select all that apply"). jurisdiction asks for a US state as ISO 3166-2 (US-FL); it is always the question with id jurisdiction. form asks which form the user needs: its option values are form IDs, plus other for "something else". address asks for a postal address in parts: street, second line, city, state and ZIP. One of text, textarea, number, currency, date, select, radio, multiselect, boolean, party, parties, address, jurisdiction, form
section string required
title string required
help string required
placeholder string
A sample answer to show in the empty field (e.g. Ford), for questions typed in: text, textarea, number, currency and date. Absent when there is none.
options array of Option objects required
Choices for select, radio, multiselect and form; the allowed states for jurisdiction (empty means every state); empty otherwise.
allow_unknown boolean required
"unknown" is accepted; the document leaves a labelled blank.
default any
Used when the answer is left out of direct generation. Without a default, a left-out answer is skipped.
show_if Condition object
When a follow-up applies. A simple condition names an earlier question and holds when that question was shown and its answer equals the value, or, for a multiselect, includes it. all, any and not combine conditions.
step string
The step it belongs to (e.g. step_3); questions of a step are asked together. Absent for one-at-a-time questions.