Search
K
MarketConnect-OrderEntry

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

DatasetRequest

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

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

Body

{ "transactionId": "1064187", "stepName": "CarrierProductSelection", "fieldId": "504436", "Transaction.Parameters[\"CarrierID\"].Value": "CARRIER-001", "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

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}
 
application/json

Comments

Comment management operations (save, list, and delete transaction comments)

Saves a comment against the specified transaction.

Saves a comment for the specified transaction and returns the upstream envelope including validation messages.

post

Body

application/json

The comment payload to save.

* Additional properties are NOT allowed.
appSubIndicatorstring | null

Indicator identifying whether the comment applies to the application or sub-application

commentSourcestring | null

Source system or user group that authored the comment

commentTextstringrequired

Free-form comment text

>= 1 characters

statusAtStepstring | null

Status code of the transaction at the step the comment was added

statusDisplayNamestring | null

Display name for the status at the step the comment was added

stepTitlestring | null

Title of the wizard step the comment was added on

transactionIdstringrequired

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

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

>= 1 characters

Response

application/json

Returns the save comment envelope

SaveCommentResponse

* Additional properties are NOT allowed.
caseIdstring | null

Case identifier associated with the transaction. Populated on successful saves.

isSuccessboolean

Indicates whether the operation was successful

messagestring | null

Human-readable message describing the result

statusstring | null

Status code of the operation (e.g., “Success”, “ValidationError”, “Failure”)

post/market-connect/order-entry/v1/comments

Body

{ "appSubIndicator": "App", "commentSource": "OrderEntryUI", "commentText": "Customer requested a follow-up call before submission.", "statusAtStep": "InProgress", "statusDisplayName": "In Progress", "stepTitle": "Owner Information", "transactionId": "1125715" }
 
application/json