ResultStatus
This class is a result structure common for all operations. For any operation, the reply schema contains this mandatory object. It specifies if the service execution succeeded or failed.
Any client of operation must first check the value of the "severity" field to identify if the execution was successful or not.
The JSON schema structure is as follows:
This class contains the following elements:
| Element name | Description |
|---|---|
| Component | Name of the component that detected the error.
For the TIBCO Order Management - Low Latency component implementation, this field is set to the deployment variable of the TIBCO BusinessEvents in which the error occurred. (Optional) |
| Operation |
This text field identifies the operation in progress at the point of failure. This is helpful when a request consists of many operations and the same code might be returned in more than one operation. This field displays the name of the operation where the error occurred. Errors that occur within TIBCO BusinessEvents are identified by the same operation name with '-BE' appended to the name. |
| Severity |
A single character {F E W I S}. F- Fatal, E - Error, W - Warning, I - Information, and S - Success. |
| Code | The error code, a string that identifies the error and the
TIBCO Order Management - Low Latency component that produced the error. This code is also visible inside component log and audit files.
Refer Response Codes and Messages for details of this format. |
| Message | A descriptive text string associated with the code. |