Search
K
MarketConnect-OrderEntry

FieldGroupBlueprint

object
* Additional properties are NOT allowed.
idstringrequired

The unique identifier for the field group

>= 1 characters

partNamestringrequired

An identifier (partName) for the field group

>= 1 characters

textobject

The text associated with a field group, such as descriptions or related notes. Supports localization through language codes (e.g., en, fr).

* Additional properties are NOT allowed.
Show Child Parameters
titleobject

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

* Additional properties are NOT allowed.
Show Child Parameters
isCustomboolean

Indicates whether this is a custom field group

fieldsarray[object]

Array of fields (questions) within this field group

* Additional properties are NOT allowed.
Show Child Parameters
displayAsCardboolean

Indicates if this field group should be displayed as a card

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.

repeatableobject

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

* Additional properties are NOT allowed.
Show Child Parameters
Example

FieldValidationRule

object
* Additional properties are NOT allowed.
messageobjectrequired

Localized message displayed to the user when validation fails

* Additional properties are NOT allowed.
Show Child Parameters
conditionsobjectrequired

The validation conditions wrapper containing an optional booleanOperator and an array of individual conditions

Example:{"booleanOperator":"and","conditions":[{"type":"numberComparisonCondition","targetNodeId":"Transaction.Payments[0].MonetaryAmounts[\"PaymentAmount\"].CurrencyAmount","value":9999999999,"operator":"lessThan"},{"type":"numberComparisonCondition","targetNodeId":"Transaction.Payments[0].MonetaryAmounts[\"PaymentAmount\"].CurrencyAmount","value":1,"operator":"greaterThan"},{"type":"numberComparisonCondition","targetNodeId":"Transaction.Payments[0].MonetaryAmounts[\"PaymentAmount\"].CurrencyAmount","value":9999999999,"operator":"lessThan"},{"type":"numberComparisonCondition","targetNodeId":"Transaction.Payments[0].MonetaryAmounts[\"PaymentAmount\"].CurrencyAmount","value":1,"operator":"greaterThan"}]}

* Additional properties are NOT allowed.
Show Child Parameters
Example

GetCommentsResponse

object
* Additional properties are NOT allowed.
caseIdstring

Case identifier associated with the transaction

dataobject

Comments data payload

* Additional properties are NOT allowed.
Show Child Parameters
isSuccessboolean

Indicates whether the operation was successful

messagestring

Human-readable message describing the result

statusstring

Status code of the operation

Example

IngestAttachmentDocumentRequest

object
* Additional properties are NOT allowed.
transactionIdstringrequired

Unique identifier for the Order Entry transaction (positive integer encoded as a string).

Match pattern:^[1-9][0-9]*$

>= 1 characters

documentIdstringrequired

Electronic document service (EDS) identifier for the uploaded or deleted file.

>= 1 characters

sourceSystemstringrequired

Originating source system identifier (for example, AnnuityNet or LifeSpeed).

Allowed values:AnnuityNetLifeSpeed

>= 1 characters

actionstringrequired

Document lifecycle action. Allowed values: added, deleted.

Allowed values:addeddeleted

>= 1 characters

Example

IngestAttachmentDocumentResponse

object
* Additional properties are NOT allowed.
caseIdstring

Case identifier associated with the transaction.

isSuccessboolean

Indicates whether the ingestion operation was successful.

messagestring

Human-readable message describing the result.

statusstring

Status code of the operation (for example, Success, ValidationError, Failure).

Example