Search
K
MarketConnect-OrderEntry

Transaction

Transaction management operations

Retrieves the order entry blueprint and its associated responses for a created life or annuity transaction

This endpoint reopens an existing transaction and returns the order entry blueprint along with any previously saved responses, allowing the user to resume where they left off

Error Scenarios

  • 400 Bad Request:

  • VALIDATION_ERROR - Input validation failed

  • INVALID_TRANSACTION_ID - Transaction ID is less than or equal to 0

  • 401 Unauthorized:

  • UNAUTHORIZED - Authentication failed or token is invalid

  • 403 Forbidden:

  • FORBIDDEN - User does not have permission to access this resource

  • 404 Not Found:

  • TRANSACTION_ID_NOT_FOUND - Transaction not found in the system

  • NOT_FOUND - Transaction or step not found

  • 500 Internal Server Error:

  • BUILD_BLUEPRINT_ERROR - Error building the blueprint

  • JSON_PARSE_ERROR - Error parsing JSON response

  • UNEXPECTED_ERROR - Unexpected system error

Success Response

On success, returns a TransactionResponse with:

  • TransactionId: The transaction ID
  • CaseId: The case identifier returned by the upstream product service (may be null until the case is created)
  • Data: Transaction field data keyed by question ID
  • Blueprint: Complete section and field definitions for the transaction
  • Subscribers: Reactive subscriber definitions consumed by the UI to drive dependent dataset lookups
  • Errors: Empty array on success (or absent)
get

Path Parameters

transactionIdstringrequired

Unique identifier assigned when an order entry transaction is created

Response

application/json

Returns a product’s order entry blueprint with associated answer data

TransactionResponse

* Additional properties are NOT allowed.
transactionIdstringrequired

The unique identifier for the created transaction

>= 1 characters

caseIdstring | null

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 | null[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 | null[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 | null[object]

One validation message in API shape. Optional properties are omitted in JSON when null (e.g. fieldId is missing or 0).

Example:{"fieldId":"BeneficiaryAddress","answerNodeId":"Transaction.PrimaryOwner.PersonName.Prefix","message":"First name is required","sectionName":"EntityOwners"}

* Additional properties are NOT allowed.
Show Child Parameters
get/market-connect/order-entry/v1/transaction/{transactionId}
 
application/json

Update transaction data (enhanced blueprint)

Updates transaction data for enhanced blueprint transactions without providing a step name. When validation fails, returns 200 with a blueprint containing a validation-messages section and a validationErrors array listing field-level validation errors. Returns 404 with TRANSACTION_ID_NOT_FOUND or NOT_FOUND if the transaction does not exist.

put

Path Parameters

transactionIdstringrequired

Body

application/json

Transaction update request. The data property matches TransactionResponse.data (field id → array of QuestionData rows, with index for collection rows). A field value may also be a single QuestionData object when prefilled (see prefilled on QuestionData).

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

Response

application/json

OK

TransactionResponse

* Additional properties are NOT allowed.
transactionIdstringrequired

The unique identifier for the created transaction

>= 1 characters

caseIdstring | null

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 | null[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 | null[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 | null[object]

One validation message in API shape. Optional properties are omitted in JSON when null (e.g. fieldId is missing or 0).

Example:{"fieldId":"BeneficiaryAddress","answerNodeId":"Transaction.PrimaryOwner.PersonName.Prefix","message":"First name is required","sectionName":"EntityOwners"}

* Additional properties are NOT allowed.
Show Child Parameters
put/market-connect/order-entry/v1/transaction/{transactionId}

Body

{ "data": { "259726": [ { "id": "259726", "type": "dropdown", "questionText": "Account designation", "questionSubText": "Account designation", "displayValue": "Owner", "value": "Owner", "index": 0 } ], "486958": [ { "id": "486958", "type": "date", "questionText": "Date of birth", "questionSubText": "", "displayValue": "1989-10-13", "value": "1989-10-13", "index": 0 } ], "488043": [ { "id": "488043", "type": "radio", "questionText": "Gender", "questionSubText": "", "displayValue": "Male", "value": "Male", "index": 0 } ], "489353_FirstName_Main": [ { "id": "489353_FirstName_Main", "type": "text", "questionText": "First Name", "questionSubText": "", "displayValue": "John", "value": "John", "index": 0 } ], "489353_LastName_Main": [ { "id": "489353_LastName_Main", "type": "text", "questionText": "Last Name", "questionSubText": "", "displayValue": "Doe", "value": "Doe", "index": 0 } ] } }
 
application/json

Retrieves the order entry blueprint and its associated responses for a created life or annuity transaction on a specific step.

In a multi-blueprint setup, this endpoint allows navigation to a specific section within the blueprint structure and returns the blueprint for the selected section for rendering

Error Scenarios

  • 400 Bad Request:

  • VALIDATION_ERROR - Input validation failed

  • INVALID_TRANSACTION_ID - Transaction ID is less than or equal to 0

  • INVALID_STEP_NAME - Step name is null or whitespace

  • 401 Unauthorized:

  • UNAUTHORIZED - Authentication failed or token is invalid

  • 403 Forbidden:

  • FORBIDDEN - User does not have permission to access this resource

  • 404 Not Found:

  • TRANSACTION_ID_NOT_FOUND - Transaction not found in the system

  • NOT_FOUND - Transaction or step not found

  • 500 Internal Server Error:

  • BUILD_BLUEPRINT_ERROR - Error building the blueprint

  • JSON_PARSE_ERROR - Error parsing JSON response

  • UNEXPECTED_ERROR - Unexpected system error

Success Response

On success, returns a TransactionResponse with:

  • TransactionId: The transaction ID
  • CaseId: The case identifier returned by the upstream product service (may be null until the case is created)
  • Data: Transaction field data keyed by question ID
  • Blueprint: Section and field definitions for the requested step
  • Subscribers: Reactive subscriber definitions consumed by the UI to drive dependent dataset lookups
  • Errors: Empty array on success (or absent)
get

Path Parameters

transactionIdstringrequired

Unique identifier assigned when an order entry transaction is created

stepNamestringrequired

PascalCase step identifier matching the section ID in the blueprint (e.g. CarrierProductSelection, EntityOwners). Values are returned verbatim from the backend blueprint - do not lowercase or transform them.

Response

application/json

Returns a product’s order entry blueprint with associated answer data

TransactionResponse

* Additional properties are NOT allowed.
transactionIdstringrequired

The unique identifier for the created transaction

>= 1 characters

caseIdstring | null

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 | null[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 | null[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 | null[object]

One validation message in API shape. Optional properties are omitted in JSON when null (e.g. fieldId is missing or 0).

Example:{"fieldId":"BeneficiaryAddress","answerNodeId":"Transaction.PrimaryOwner.PersonName.Prefix","message":"First name is required","sectionName":"EntityOwners"}

* Additional properties are NOT allowed.
Show Child Parameters
get/market-connect/order-entry/v1/transaction/{transactionId}/{stepName}
 
application/json

Update the Order Entry transaction data for life and annuity products.

In a multi-blueprint setup, this endpoint is used to save user responses and return the next relevant blueprint for continued rendering

Request Body Format

The request body matches the data node returned by GET and Create transaction APIs:

  • data: Object keyed by question or composite field id
  • Values: Arrays of QuestionData rows (use index for repeatable collection rows)

Supported Field Types

  • Field Type | Description | Value Type | - input | Text input field | string | - dropdown | Select dropdown field | string | - radio | Radio button field | string | - checkbox | Checkbox field | boolean | - date | Date picker field | string (YYYY-MM-DD) | - phone | Phone number field | string | - collection | Complex nested data structure | array of CollectionItem | #### Simple Field Example
  "data": {
    "259726": [{
      "id": "259726",
      "type": "dropdown",
      "questionText": "Account designation",
      "questionSubText": "Account designation",
      "displayValue": "Owner",
      "value": "Owner",
      "index": 0
    }]
  }
}```

Collection Field Example

  "data": {
    "489363_FirstName": [{
      "id": "489363_FirstName",
      "type": "text",
      "questionText": "First Name",
      "displayValue": "John",
      "value": "John",
      "index": 0
    }],
    "489363_LastName": [{
      "id": "489363_LastName",
      "type": "text",
      "questionText": "Last Name",
      "displayValue": "Doe",
      "value": "Doe",
      "index": 0
    }]
  }
}```

Error Scenarios

  • 400 Bad Request:

  • VALIDATION_ERROR - Input validation failed (ModelState errors)

  • INVALID_TRANSACTION_ID - Invalid transaction ID provided

  • INVALID_STEP_NAME - Invalid step name provided

  • 401 Unauthorized:

  • UNAUTHORIZED - Authentication failed or token is invalid

  • 403 Forbidden:

  • FORBIDDEN - User does not have permission to update this transaction

  • 500 Internal Server Error:

  • SAVE_TRANSACTION_ERROR - Save operation failed at service level

  • SAVE_TRANSACTION_FAILED - Save operation not successful

  • INVALID_RESPONSE_FORMAT - Invalid response format from service

  • EMPTY_BLUEPRINT - Empty blueprint returned after save

  • BUILD_BLUEPRINT_ERROR - Error building blueprint for next step

  • UNEXPECTED_ERROR - Unexpected system error

Success Response

On success, returns a TransactionResponse with:

  • TransactionId: The transaction ID that was updated
  • CaseId: The case identifier returned by the upstream product service (may be null until the case is created)
  • Data: Updated transaction field data keyed by question ID
  • Blueprint: Blueprint for the next step in the workflow
  • Subscribers: Reactive subscriber definitions consumed by the UI to drive dependent dataset lookups (may be empty if no subscribers apply to the next step)
  • Errors: Empty array on success (or absent)

Workflow Progression

This endpoint is used to:

  • Save user input for the current step
  • Validate the input data
  • Automatically determine next step from breadcrumb
  • Return the blueprint for the next step
put

Path Parameters

transactionIdstringrequired

The unique identifier for the transaction

stepNamestringrequired

PascalCase step identifier matching the section ID in the blueprint (e.g. CarrierProductSelection, EntityOwners). Values are returned verbatim from the backend blueprint - do not lowercase or transform them. Optional for enhanced blueprint.

Body

application/json

The input data for updating the transaction (data object matching GET/Create response shape)

Transaction update request. The data property matches TransactionResponse.data (field id → array of QuestionData rows, with index for collection rows). A field value may also be a single QuestionData object when prefilled (see prefilled on QuestionData).

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

Response

application/json

Returns the Order Entry blueprint for next step or success status

TransactionResponse

* Additional properties are NOT allowed.
transactionIdstringrequired

The unique identifier for the created transaction

>= 1 characters

caseIdstring | null

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 | null[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 | null[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 | null[object]

One validation message in API shape. Optional properties are omitted in JSON when null (e.g. fieldId is missing or 0).

Example:{"fieldId":"BeneficiaryAddress","answerNodeId":"Transaction.PrimaryOwner.PersonName.Prefix","message":"First name is required","sectionName":"EntityOwners"}

* Additional properties are NOT allowed.
Show Child Parameters
put/market-connect/order-entry/v1/transaction/{transactionId}/{stepName}

Body

{ "data": { "259726": [ { "id": "259726", "type": "dropdown", "questionText": "Account designation", "questionSubText": "Account designation", "displayValue": "Owner", "value": "Owner", "index": 0 } ], "486958": [ { "id": "486958", "type": "date", "questionText": "Date of birth", "questionSubText": "", "displayValue": "1989-10-13", "value": "1989-10-13", "index": 0 } ], "488043": [ { "id": "488043", "type": "radio", "questionText": "Gender", "questionSubText": "", "displayValue": "Male", "value": "Male", "index": 0 } ], "489353_FirstName_Main": [ { "id": "489353_FirstName_Main", "type": "text", "questionText": "First Name", "questionSubText": "", "displayValue": "John", "value": "John", "index": 0 } ], "489353_LastName_Main": [ { "id": "489353_LastName_Main", "type": "text", "questionText": "Last Name", "questionSubText": "", "displayValue": "Doe", "value": "Doe", "index": 0 } ] } }
 
application/json