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

Dictionary keyed by question id or composite collection field id; values are arrays of QuestionData (includes index for collection rows).

blueprintobjectrequired

The blueprint containing section and field definitions

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

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

UpdateTransactionRequest

object

Transaction update request. The data property matches TransactionResponse.data (field id → array of QuestionData rows, with index for collection rows).

* Additional properties are NOT allowed.
dataobjectrequired

Dictionary keyed by question id or composite collection field id; values are arrays of QuestionData (includes index for collection rows).

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