Feasibility Response
Feasibility Response is an event sent by Feasibility Provider back to Orchestrator in response to a Feasibility Request event. It is an asynchronous reply event to a JMS queue.
The response for feasibility has completed and passed flags. Orchestrator will route the order lifecycle based on the returned value of these flags. The two flags can be used to distinguish between technical and business exceptions. For example, a failure to complete would generally indicate a technical exception so complete would be false. A validation failure would indicate a business exception where complete would be true, but passed would be false.
Based on different scenarios, these flags should be set as follows:
Completed | Passed | Description | |
Technical Error | False | False True | Orchestrator refers the order to the Pre-Qualification Failed Handler if error handling is enabled for feasibility, or the error is withdrawn if error handling is not enabled. |
Business Error | True | False | Orchestrator refers the order to the Pre-Qualification Failed Handler if error handling is enabled for feasibility, or the error is withdrawn if error handling is not enabled. |
Success | True | True | The processing continues as normal. |
The event has the following property:
The event has the following payload:
The following table lists the details of the elements.
Element | Type | Cardinality | Description |
businessTransactionID | String | Optional | Unique identifier for tracing purposes across function calls. |
correlationID | String | Required | Unique identifier to correlate the request message with a response message. Even though this field is marked as optional in the response schema, it is required for Orchestrator to be able to correlate the response with the correct version of the submitted order. Populate this field the same as correlationID in the request message. |
resultStatus | Type | Required |
Result status type. See Appendix A for the specification of this type. |
orderID | String | Required | Order ID for the order that was feasibility checked. |
orderRef | String | Required | Order ref for the order that was feasibility checked. |
completed | Boolean | Required | Flag indicating whether the feasibility call completed. |
passed | Boolean | Required | Flag indicating whether the order has passed feasibility. |
message | Type | 0-M | Message type. See Appendix A for the specification of this type. This list of messages will be passed to the Pre-Qualification Failed Handler if invoked. |