Search
K
MarketConnect-OrderEntry

SectionBlueprint

object
* Additional properties are NOT allowed.
idstringrequired

The unique identifier for the section

>= 1 characters

sectionGroupKeystring

A key used to group related sections within the blueprint

partNamestringrequired

An identifier (partName) for the section

>= 1 characters

titleobjectrequired

The section title in multiple languages. Supports localization through language codes (e.g., en, fr)

* Additional properties are NOT allowed.
Show Child Parameters
modulesarray[string]

An array of module names associated with this section

isCustomboolean

Indicates whether this section is custom

subsectionsarray[object]

Array of subsections within this section

* Additional properties are NOT allowed.
Show Child Parameters
copyablestring

Role identifier controlling copy behavior. Use ‘none’ to disable copying, or a role name (e.g., ‘owner’, ‘annuitant’, ‘insured’, ‘payor’). Multiple roles may be comma-separated.

renderOnarray[string]

An array of conditions that determine when a section is rendered

pdfDocumentsarray[string]

An array of PDF document identifiers where this section appears

platformsarray[string]

An array of platforms where this section is available (e.g., D2C-only versus advisor-driven experiences)

visibleobject

Visibility conditions for the section. When present, the section is only visible when all conditions are met. Example: { “booleanOperator”: “AND”, “conditions”: [ { “type”: “equality”, “isEqual”: true, “value”: “NY”, “targetNodeId”: “SolicitationStateCode” } ] }

Example:{"booleanOperator":"AND","conditions":[{"type":"equality","isEqual":true,"value":"Yes","targetNodeId":"Transaction.SolicitationState"},{"type":"equality","isEqual":true,"value":"Yes","targetNodeId":"Transaction.SolicitationState"}]}

* Additional properties are NOT allowed.
Show Child Parameters
Example

SectionGroupBlueprint

object
* Additional properties are NOT allowed.
idstringrequired

The unique identifier for the section group

>= 1 characters

titleobjectrequired

The section group title in multiple languages. Supports localization through language codes (e.g., en, fr)

* Additional properties are NOT allowed.
Show Child Parameters
partNamestring

An identifier (partName) for the section group

Example

SelectOption

object
* Additional properties are NOT allowed.
textobjectrequired

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’

* Additional properties are NOT allowed.
Show Child Parameters
valuestringrequired

The value 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’

>= 1 characters

Example

SelectOptionsApplicationContext

object
* Additional properties are NOT allowed.
tagstring

Tag used to associate dataset values with a field

labelKeyobject

Localized label key for dataset items

* Additional properties are NOT allowed.
Show Child Parameters
valuePathstring

Dataset value path

Example

SubmitTransactionResponse

object
* Additional properties are NOT allowed.
transactionIdstringrequired

The unique identifier for the submitted transaction. Echoed back from the request.

>= 1 characters

messagestringrequired

Human-readable confirmation that the submit request was accepted.

>= 1 characters

Example