transactionIdstringrequired
The unique identifier for the transaction
Submit an order entry transaction for processing.
Accepts a transaction for submission and processes it asynchronously. Returns immediately without waiting for the backend service to complete.
post
Path Parameters
Response
application/json
Response
application/json
OK
SubmitTransactionResponse
* Additional properties are NOT allowed.
transactionIdstringrequired
The unique identifier for the submitted transaction. Echoed back from the request.
>= 1 characters
messagestringrequired
Human-readable confirmation that the submit request was accepted.
>= 1 characters
post/market-connect/order-entry/v1/transaction/{transactionId}/submit
Authentication
Path Parameters
application/json
Dataset
Dataset operations
Gets dataset values for a dependent control based on the provided payload.
Returns dataset contents based on the provided transaction, step, field, and dependency inputs.
post
Body
application/json
Body
application/json
object
Response
application/json
Response
application/json
Returns the dataset payload
DatasetResponse
* 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 | null
Dataset payload serialized as a JSON string. On success, a JSON array of {Name, Value} option objects. On failure, may be “[]” or omitted.
InstanceIdinteger | null(int64)
Identifier of the dataset instance returned by the upstream service. Present for success and most failures; absent for low-level exceptions.
post/market-connect/order-entry/v1/dataset
Authentication
Body
{
"transactionId": "1064187",
"stepName": "CarrierProductSelection",
"fieldId": "504436",
"Transaction.Parameters[\"CarrierID\"].Value": "USAA",
"Transaction.SolicitationState": "Alabama"
}
application/json
Attachment
Attachment management operations (get, save and delete transaction attachments)
Retrieves the attachment payload (documents, required documents and rules) for a transaction.
Returns documents, required documents, additional document types and document rules for the specified transaction.
get
Path Parameters
transactionIdstringrequired
Unique identifier assigned when the Order Entry transaction is created
Response
application/json
Response
application/json
Returns the attachment payload
AttachmentResponse
* Additional properties are NOT allowed.
transactionIdstringrequired
The unique identifier for the transaction the attachment belongs to
>= 1 characters
caseIdstring | null
Case identifier associated with the transaction
dataobjectrequired
Attachment data containing documents, required documents and rules
* Additional properties are NOT allowed.
Show Child Parameters
get/market-connect/order-entry/v1/attachment/{transactionId}
Authentication
Path Parameters
application/json