Errors¶
Example Json Object
1{
2 "all": [
3 {
4 "type": "GENERIC",
5 "errorMessage": "string",
6 "source": {},
7 "field": "string",
8 "errorKey": "string"
9 }
10 ]
11}
📄 Description: Data structure representing error information generated during API operations, including error codes and messages, to facilitate troubleshooting and enhance user experience in enterprise applications.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
all |
[oneOf] |
false |
none |
An array containing error messages related to the API request, providing insights for troubleshooting and resolution. |
📄 Description: oneOf
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
Data transfer object representing an error encountered in a field validation process, providing details necessary for troubleshooting and ensuring data integrity within business applications. |
📄 Description: xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» anonymous |
false |
none |
Data transfer object representing a generic error response, providing essential information about the nature of the error encountered during API interactions, facilitating effective troubleshooting and resolution. |