admin/raven
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Browse Source
This commit is contained in:
John Cardinal
2019-03-28 21:36:39 +00:00
parent 5db6953b6d
commit f0806f9c73
4 changed files with 26 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/8.0/ayanova/docs/api-error-codes.md
View File

@@ -2,9 +2,9 @@
The AyaNova API will return an [error response](api-response-format.md#error-responses) when an error condition arises.
All API error codes wrap and indicate the entire response overall error and are numbers between 2000 and 3000 and are intended to be consumed by software clients or for reference purposes for developers.
All API error codes are numbers between 2000 and 3000 and are intended to be consumed by software clients or for reference purposes for developers.
API error codes are different from [server error codes](ops-error-codes.md) which are intended for AyaNova system operators and related only to the running of the server itself.
API error codes are distinct from [server error codes](ops-error-codes.md) which are intended for AyaNova system operators and related only to the running of the server itself.
Here are all the API level error codes that can be returned by the API server:
@@ -21,5 +21,14 @@ Here are all the API level error codes that can be returned by the API server:
| 2030 | Invalid operation - operation could not be completed, not valid, details in message property |
| 2200 | Validation error - general top level indicating object was not valid, specifics in "details" property |
| 2201 | Validation error - Field is required but is empty or null |
| 2202 | Validation error - Field length exceeded |
| 2203 | Validation error - invalid value |
| 2202 | Validation error - Field length exceeded. The limit will be returned in the `message` property of the validation error |
| 2203 | Validation error - invalid value. Usually an type mismatch or a logical or business rule mismatch (i.e. only certain values are valid for current state of object) |
| 2204 | Validation error - Customized form property set to required has an empty value |
| 2205 | Validation error - Required property is missing entirely. Usually a development or communications error |
| 2206 | Validation error - A text property is required to be unique but an existing record with an identical value was found in the database |
| StartDateMustComeBeforeEndDate | When an object requires a start and end date the start date must be earlier than the end date |
| InvalidValue | Generic error indicating an input object's property is not set correctly |
| ReferentialIntegrity | Indicates modifying the object (usually a delete) will break the link to other records in the database. The other records need to be modified before continuing |
| InvalidOperation | Indicates the operation is invalid, details provided in the `message` |
| NotChangeable | Indicates the attempted property change is invalid because the value is fixed and cannot be changed |