View on GitHub

easitrace

« Back to Contents

API | Error Codes

EasiTrace returns error codes for requests that return them.

Model

{
  "code": "string",
  "field": "string",
  "description": "string",
  "category": "integer", // see table of error categories
  "severity": "integer", // see table of error severity
  "specificError": {
    "code": "string",
    "field": "string",
    "description": "string",
    "category": "integer",
    "severity": "integer",
  }
}

Most EasiTrace errors will not include a specificError whereas errors returned from Movement Services will always include a specificError although the amount of detail will depend on the kind of error returned.

Error Categories

Value Category
1 Invalid Data
2 Invalid Format
3 Invalid Request
4 Condition Violation
5 Service System Error
6 Service System Error - Retry
7 Transaction not Allowed
8 Animal
9 Authentication

Error Severity

Value Severity
10 Fatal
9 Severe
6 High
4 Medium
1 Low
0 Warning

Error Codes

EasiTrace Errors

Code Description
ES-1000 Parameter Missing
ES-404 Not Found
ES-1001 Already Exists
ES-1002 Invalid Data
ES-1003 Invalid Request
ES-1004 Movement Service not Found
ES-1005 Species not Supported
ES-1006 Capability not Supported
ES-1007 Server Error

Movement Service Errors

Code Description
MS-1000 Unknown Error
MS-1001 Authentication Error
MS-1002 Condition Violation
MS-1003 Duplicate Animal
MS-1004 Invalid Data Format
MS-1005 Invalid Data Value
MS-1006 Invalid Request
MS-1007 Service System Error
MS-1008 Service System Error - Retry
MS-1009 Transaction Not Allowed
MS-1010 Unknown Animal

Authentication

Code Description
A-1000 Service Credentials Invalid
A-1001 User Service Credentials Invalid
A-1002 Authorisation Error
A-1003 Service Token Invalid or Expired