docs/8.0/ayanova/docs/api-error-codes.md

@@ -0,0 +1,25 @@
+# API ERROR CODES
+
+The AyaNova API will return an [error response](api-response-format.md#error-responses) when an error condition arises.
+
+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.
+
+Here are all the API level error codes that can be returned by the API server:
+
+| CODE | MEANING |
+| ----- | ------------------------------ |
+| 2000 | API closed - Server is running but access to the API has been closed to all users |
+| 2001 | API closed all non OPS routes - Server is running but access to the API has been restricted to only server maintenance operations related functionality |
+| 2002 | Internal error from the API server, details in [server log](common-log.md) file |
+| 2003 | Authentication failed, bad login or password, user not found |
+| 2004 | Not authorized - current user is not authorized for operation attempted on the resource (insufficient rights) |
+| 2005 | Object was changed by another user since retrieval (concurrency token mismatch) |
+| 2010 | Object not found - API could not find the object requested |
+| 2020 | PUT Id mismatch - object Id does not match route Id |
+| 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 |