Search
K
MarketConnect-OrderEntry

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}],"486958":[{"id":"486958","type":"date","questionText":"Date of birth","questionSubText":"","displayValue":"1989-10-13","value":"1989-10-13","index":0}],"488043":[{"id":"488043","type":"radio","questionText":"Gender","questionSubText":"","displayValue":"Male","value":"Male","index":0}],"489353_FirstName_Main":[{"id":"489353_FirstName_Main","type":"text","questionText":"First Name","questionSubText":"","displayValue":"John","value":"John","index":0}],"489353_LastName_Main":[{"id":"489353_LastName_Main","type":"text","questionText":"Last Name","questionSubText":"","displayValue":"Doe","value":"Doe","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

UpdateTransactionRequest

object

Transaction update request. The data property matches TransactionResponse.data (field id → QuestionDataRows → QuestionData, with index for collection rows). Each field value must be a JSON array of rows. Every QuestionData object must include a value property (JSON null is permitted for an empty optional answer).

* Additional properties are NOT allowed.
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}],"486958":[{"id":"486958","type":"date","questionText":"Date of birth","questionSubText":"","displayValue":"1989-10-13","value":"1989-10-13","index":0}],"488043":[{"id":"488043","type":"radio","questionText":"Gender","questionSubText":"","displayValue":"Male","value":"Male","index":0}],"489353_FirstName_Main":[{"id":"489353_FirstName_Main","type":"text","questionText":"First Name","questionSubText":"","displayValue":"John","value":"John","index":0}],"489353_LastName_Main":[{"id":"489353_LastName_Main","type":"text","questionText":"Last Name","questionSubText":"","displayValue":"Doe","value":"Doe","index":0}]}

Show Child Parameters
Example

ValidationCondition

object

Single validation condition inside a FieldValidationRule. The shape varies by type: matchesRegexCondition uses regex; numberComparisonCondition uses value + operator; characterCountInBetween uses value: { minLength, maxLength }.

typestringrequired

The kind of validation this condition performs.

Allowed values:matchesRegexConditionnumberComparisonConditioncharacterCountInBetween

Example:matchesRegexCondition

targetNodeIdstringrequired

The answer node identifier this condition evaluates.

Example:Transaction.Beneficiaries[0].EmailAddresses["Home"].Address

regexstring

Regex pattern. Only used when type is matchesRegexCondition.

Example:^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$

operatorstring

Comparison operator. Only used when type is numberComparisonCondition.

Allowed values:lessThanlessThanOrEqualgreaterThangreaterThanOrEqualequalnotEqual

Example:lessThan

valueAny Of

Condition-specific value. Number for numberComparisonCondition; object { minLength, maxLength } for characterCountInBetween. Absent for matchesRegexCondition.

Variant 1number

Example:9999999999

Example

ValidationConditionGroup

object
* Additional properties are NOT allowed.
booleanOperatorstring

The boolean operator used to combine multiple conditions (e.g., “and”). Omitted when there is only one condition.

conditionsarray[object]

Single validation condition inside a FieldValidationRule. The shape varies by type: matchesRegexCondition uses regex; numberComparisonCondition uses value + operator; characterCountInBetween uses value: { minLength, maxLength }.

Show Child Parameters
Example

ValidationErrors

object

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

* Additional properties are NOT allowed.
fieldIdstring

ControlID as a string (numeric ids appear quoted). Omitted when fieldId is 0.

answerNodeIdstring

Answer node path from annuity NamedItem; matches FieldBlueprint.AnswerNodeId.

messagestring

The validation error message

sectionNamestring

The section/step name where the error occurred

Example