EMI-RPC Error Object and Codes
Error object will be part of the EMI-RPC response in case any errors occur. Error object has following structure:
“error”:
{
"code": <error_code>,
"message": <error_message>,
"data": <error_data>
}
| Key | Meaning | Type | Required |
|---|---|---|---|
| code | Error code number. Please see the table below for details. | JSON int | Required |
| message | Short description about the error in text format. | JSON string | Required |
| data | Extra details about the error. Data object is an array of strings and can therefore contain very detailed additional information about the error. | JSON array | optional |
Error codes for the error object are listed in the following table.
| Reference | Code | Meaning |
|---|---|---|
| EOK | 0 | No errors (data may include warnings) |
| EGENERAL | 100 | Error code is reserved for situations when EMI Server is not aware of the exact cause of error (3rd party modules, for example) |
| EMULTIPLE | 150 | This will indicate that there have been several errors and data field should contain more information. |
| ERPCPARSING | 200 | EMI-RPC Parse error |
| EBADPARAM | 300 | Bad EMI-RPC call parameters were supplied |
| ENOTFOUND | 500 | Key was not found |
| ELATER | 600 | Request is still in progress |
| ESYSBUSY | 700 | System is too busy to process the request |
| ESESSION | 800 | Error related to session |
| ESESREJECTED | 850 | New session request rejected |