Search
K
MarketConnect-OrderEntry

SubscriberResponseValue

object
* Additional properties are NOT allowed.
typestring
kindstring
valuestring
Example

SubsectionBlueprint

object
* Additional properties are NOT allowed.
idstringrequired

The unique identifier for the subsection

>= 1 characters

partNamestringrequired

The part name for the subsection

>= 1 characters

textobject

Text content for the subsection

* Additional properties are NOT allowed.
Show Child Parameters
titleobjectrequired

The title of the subsection

* Additional properties are NOT allowed.
Show Child Parameters
isCustomboolean

Indicates if this is a custom subsection

fieldGroupsarray[object]

Array of field groups within this subsection

* Additional properties are NOT allowed.
Show Child Parameters
subsectionsarray[object]

Array of nested subsections within this subsection

* Additional properties are NOT allowed.
Show Child Parameters
showInNavigationboolean

Indicates if this subsection should be shown in navigation

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.

visibleobject

Visibility conditions for the subsection. When present, the subsection 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

TransactionResponse

object
* Additional properties are NOT allowed.
transactionIdstringrequired

The unique identifier for the created transaction

>= 1 characters

caseIdstring

The case identifier returned by the product service

dataobjectrequired

Dictionary of question data keyed by question ID

blueprintobjectrequired

The blueprint containing section and field definitions

* Additional properties are NOT allowed.
Show Child Parameters
subscribersarray[object]

Subscribers defining dataset dependency actions

* Additional properties are NOT allowed.
Show Child Parameters
errorsarray[object]

Collection of errors if the operation failed

Example:{"code":"VALIDATION_ERROR","description":"Input validation failed","details":"One or more input fields are invalid","timestamp":"2024-01-15T10:30:00.000Z"}

* Additional properties are NOT allowed.
Show Child Parameters
validationErrorsarray[object]

Collection of validation errors when transaction validation fails. Includes transaction ID, field ID, and error messages.

Example:{"answerNodeId":"Transaction.PrimaryOwner.FirstName","message":"First name is required","sectionName":"PersonalInformation"}

* Additional properties are NOT allowed.
Show Child Parameters
Example

ValidationErrors

object
* Additional properties are NOT allowed.
answerNodeIdstring

The named item (answer node) associated with the validation error

messagestring

The validation error message

sectionNamestring

The section/step name where the error occurred

Example

VisibilityCondition

object

Single condition controlling whether a field/section is visible at runtime.

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