Search
K
MarketConnect-OrderEntry

LayoutSettings

object
* Additional properties are NOT allowed.
sizeinteger(int32)

The size of the field in a 12-column HTML grid that determines its rendered width (12 = full-width, 6 = half-width, 4 = one-third, 3 = quarter-width). Field column widths sum to 12 per row - e.g., two fields of 6 sit side-by-side, three fields of 4 share a row, four fields of 3 share a row.

Example

LocalizedText

object
* Additional properties are NOT allowed.
enstring

English text content

Example

QuestionData

object

Represents data for a single question in the transaction

* Additional properties are NOT allowed.
idstringrequired

The unique identifier for the question

>= 1 characters

typestringrequired

The data-storage type of the question. Canonical values: input, dropdown, radio, checkbox, checkboxgroup, date, phone, email, money, number, label, information, collection, Person, Address, Hidden. FieldBlueprint.fieldType covers rendering types; QuestionData.type additionally supports ‘collection’ for nested repeatable groups.

>= 1 characters

questionTextstring

The title of the question shown to the user. This value should be kept in sync with the title property of the associated field

questionSubTextstring

The subtext shown to the user below the question title. This value should be kept in sync with the text property of the associated field

displayValuestring

The display text representing the user’s selected answer. For example, a country dropdown may display ‘United States of America’ to the user, while the blueprint stores the value as ‘USA’

valueAny Of

The actual value of the question. Can be a string, integer, number, float, date, date-time, boolean, or array of CollectionItem objects depending on the field type.

Variant 1string

String value for simple fields

Example:PrimaryBeneficiary

Example

RenderCondition

object

Single condition controlling whether a field/section is rendered.

typestringrequired

Kind of comparison performed by the condition.

Allowed values:equalityrangepresence

Example:equality

isEqualboolean

When true the condition passes if the target value equals ‘value’; when false the condition passes if it differs.

Example:true

valuestring

The value to compare against the resolved target answer.

Example:NY

targetNodeIdstringrequired

The answer node identifier whose value is evaluated by this condition.

Example:SolicitationStateCode

Example

RequiredDocument

object
* Additional properties are NOT allowed.
attachmentTypestring

Attachment type code

displayNamestring

Display name shown to the user

documentTypestring

Document type code

formTypestring

Form type code

messagestring

Instructional message for the required document

Example