Search
K
MarketConnect-OrderEntry

SubscriberResponseValue

object
* Additional properties are NOT allowed.
typestring

Value source kind. “response-query” extracts via a query expression on the response body.

kindstring

Query language used to evaluate the value expression. Currently always “json-path”.

valuestring

The query expression itself (e.g., “$.data” to grab the response’s data branch).

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
repeatableobject

Repeat-instance metadata when the wizard subsection or custom control declares IsRepeated.

* Additional properties are NOT allowed.
Show Child Parameters
Example

TransactionDataQuestionRowsMap

object

Answers keyed by blueprint question id or composite collection field id. Named properties below are representative examples (same keys as the default example); any other field id is valid and uses the same value shape (see additionalProperties → QuestionDataRows → QuestionData). Each array entry is one row; use index for repeatable collection instances.

259726array[object]

One row of captured or echoed answer data. Must include id, type, and value (the JSON property value must be present on each row; use JSON null for an empty optional answer when applicable). On PUT, id must match the enclosing data field key (or the leaf key inside a collection item’s data). type must be a QuestionData storage type (see QuestionDataStorageTypes); collection value rows use collectionItem on each CollectionItem.

* 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

Answers keyed by blueprint question id or composite collection field id. Named properties below are representative examples (same keys as the default example); any other field id is valid and uses the same value shape (see additionalProperties → QuestionDataRows → QuestionData). Each array entry is one row; use index for repeatable collection instances.

Example:{"259726":[{"id":"259726","type":"dropdown","questionText":"Account designation","questionSubText":"Account designation","displayValue":"Owner","value":"Owner","index":0}]}

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

Reactive subscriber definitions consumed by the UI. Each subscriber declares trigger fields, an HTTP action to run on change, and a response handler. Two flavors are emitted: dataset-dependency (context-modification) and blueprint-modification (replace-whole).

Example:{"triggers":["FirstName"],"actions":[{"type":"http","verb":"get","url":"/market-connect/order-entry/v1/transaction/1125715/MCDPS","token":"OEToken","payload":{"type":"none"},"responseHandlers":[{"type":"blueprint-modification","action":"replace-whole","value":{"type":"response-query","kind":"json-path","value":"$.data"}}]}]}

* 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]

One validation message in API shape. Optional properties are omitted in JSON when null (e.g. fieldId is missing or 0).

Example:{"fieldId":"BeneficiaryAddress","answerNodeId":"Transaction.PrimaryOwner.PersonName.Prefix","message":"First name is required","sectionName":"EntityOwners"}

* Additional properties are NOT allowed.
Show Child Parameters
Example

UpdateEsignSignerDetailsRequest

object
* Additional properties are NOT allowed.
transactionIdinteger(int64)

Transaction (case) identifier whose signer contact details should be updated.

>= 1

signersarray[object]required

Signer rows with corrected email and/or phone while e-sign is pending.

>= 1 items

* Additional properties are NOT allowed.
Show Child Parameters
Example