DatasetResponse
objectOutcome of the dataset lookup. “Success” on success; otherwise the backend exception type name (e.g. “NullReferenceException”, “ItemNotFoundException`2”).
>= 1 characters
Human-readable message describing the outcome. On success a confirmation string; on failure the backend error message.
>= 1 characters
Dataset payload serialized as a JSON string. On success, a JSON array of {Name, Value} option objects. On failure, may be “[]” or omitted.
Identifier of the dataset instance returned by the upstream service. Present for success and most failures; absent for low-level exceptions.
DocumentRule
objectConditions under which the rule applies
Rule key
Rule message shown to the user
Rule value
ErrorInfo
objectBackend error codes returned by the Order Entry API indicating validation failures, transaction issues, blueprint generation errors, authorization errors, or unexpected system failures.
Allowed values:VALIDATION_ERRORINVALID_TRANSACTION_IDINVALID_STEP_NAMETRANSACTION_CREATION_FAILEDTRANSACTION_ID_NOT_FOUNDSAVE_TRANSACTION_ERRORSAVE_TRANSACTION_FAILEDINVALID_RESPONSE_FORMATBUILD_BLUEPRINT_ERRORJSON_PARSE_ERRORTRANSFORMER_NULL_RESPONSEEMPTY_BLUEPRINTUNEXPECTED_ERRORSERVICE_ERRORUNAUTHORIZEDFORBIDDENNOT_FOUNDFIRST_STEP_SETUP_FAILED
ErrorResponse
object>= 1 characters
Example:{"code":"VALIDATION_ERROR","description":"Input validation failed","details":"One or more input fields are invalid","timestamp":"2024-01-15T10:30:00.000Z"}
Show Child Parameters
FieldBlueprint
objectThe type of field displayed for collecting response values:
money - Currency input field
date - Date selection input field
information - Read-only informational text display field
radio - Single-selection radio button field
input - Free-form text input field
email - Email address input field
dropdown - Selection field with predefined options
phone - Phone number input field
checkboxgroup - Checkbox group field for multiple selections
number - Number input field for numeric values
checkbox - Checkbox field for single selection (value is string)
Allowed values:moneydateinformationradioinputemaildropdownphonecheckboxgroupnumbercheckbox
The text associated with a field title, such as descriptions or related notes. Supports localization through language codes (e.g., en, fr)
Show Child Parameters
The field title in multiple languages. Supports localization through language codes (e.g., en, fr)
Show Child Parameters
A unique identifier used to store and infer a field’s answer, and to build validation and visibility conditions across the order entry blueprint
Single condition controlling whether a field/section is rendered.
Show Child Parameters
An array of platforms where this field is available (e.g., D2C-only versus advisor-driven experiences)
A comma-separated list of roles (e.g., annuitant, insured, owner, payor) that are allowed to copy this field.
Indicates whether the field triggers step navigation
Layout options for the field. Used to define the field’s rendered width in the 12-column grid.
Show Child Parameters
Indicates whether this field should be displayed in card preview mode
Array of application modes where this field is available. Helper for filtering what is shown in different modes or channels
List of localized default text values for the field. When rendered, the appropriate localized text is displayed as the field’s initial answer until modified.
Show Child Parameters
The unique identifier for the field
>= 1 characters
An identifier (partName) for the field.
>= 1 characters
Validation type applied to fields such as phone numbers, where the value must contain digits only. These validations exist and are managed through Zinnia Form Engine SDK
Array of options (answers) that can be selected for dropdown, radio, checkbox, or checkboxgroup fields
Show Child Parameters
Application context for select options sourced from subscriber dataset
Example:{"tag":"507602","labelKey":{"en":"Name"},"valuePath":"Value"}
Show Child Parameters
Visibility settings containing a boolean operator and an array of conditions that determine when the field is visible.
Example:{"booleanOperator":"AND","conditions":[{"type":"equality","isEqual":true,"value":"Yes","targetNodeId":"Transaction.SolicitationState"},{"type":"equality","isEqual":true,"value":"Yes","targetNodeId":"Transaction.SolicitationState"}]}
Show Child Parameters
An array of validation rules applied to the field (e.g., regex, number range, character count)
Example:{"message":{"en":"Please enter valid email address"},"conditions":{"conditions":[{"type":"matchesRegexCondition","targetNodeId":"Transaction.Beneficiaries[0].EmailAddresses[\"Home\"].Address","regex":"^\\w+([-+.']\\w+)*@\\w+([-.]\\w+)*\\.\\w+([-.]\\w+)*$"}]}}
Show Child Parameters
Indicates if this field is optional (not required)