Search
K
MarketConnect-OrderEntry

CommentsData

object
* Additional properties are NOT allowed.
commentsarray[object]

List of comments for the current page

* Additional properties are NOT allowed.
Show Child Parameters
totalCountinteger(int32)

Total number of comments for the transaction across all pages

pageinteger(int32)

Current page number (1-based). Present when pagination query parameters are supplied.

pageSizeinteger(int32)

Number of comments per page. Present when pagination query parameters are supplied.

Example

CreateTransactionRequest

object
* Additional properties are NOT allowed.
statestringrequired

The state in which the life or annuity transaction is being solicited.

>= 1 characters

cusipstringrequired

The unique identifier for the product. This code allows the Order Entry API to determine the appropriate distributor, carrier, and product configuration

>= 1 characters

Example

DatasetRequest

object
transactionIdstringrequired

Unique identifier of the transaction (positive integer as a string).

>= 1 characters

stepNamestringrequired

Name of the wizard step containing the dependent control.

>= 1 characters

fieldIdstringrequired

Identifier of the field (control) whose dataset is being requested.

>= 1 characters

Example

DatasetResponse

object
* Additional properties are NOT allowed.
Statusstringrequired

Outcome of the dataset lookup. “Success” on success; otherwise the backend exception type name (e.g. “NullReferenceException”, “ItemNotFoundException`2”).

>= 1 characters

Messagestringrequired

Human-readable message describing the outcome. On success a confirmation string; on failure the backend error message.

>= 1 characters

Datastring

Dataset payload serialized as a JSON string. On success, a JSON array of {Name, Value} option objects. On failure, may be “[]” or omitted.

InstanceIdinteger(int64)

Identifier of the dataset instance returned by the upstream service. Present for success and most failures; absent for low-level exceptions.

Example

DeleteCommentRequest

object
* Additional properties are NOT allowed.
commentIdstringrequired

Unique identifier of the comment to delete (positive integer encoded as a string)

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

>= 1 characters

transactionIdstringrequired

Unique identifier of the transaction the comment belongs to (positive integer encoded as a string)

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

>= 1 characters

Example