Trak Software Documentation logo

Status Codes

Status Code Name Description
200 Success All clear!
403 Unauthorized Action You are not allowed to use this endpoint with your User Group
404 Resource Not Found The resource passed can not be found
422 Unprocessable Entity The request parameters to not pass validation
429 Too Many Requests You have reached your request limit, view throttling below.
5XX Internal Error Internal Error in Trak Software

Error Messages

We expose API errors in two ways: standard HTTP response codes and human-readable messages in JSON format. For example, the following code snippet shows an HTTP 422 error response.

{
    "message": "The given data was invalid.",
    "errors": {
        "name": [
            "The name field is required."
        ],
        "status_id": [
            "The status id field is required."
        ],
        "notifications": [
            "The notifications field is required."
        ]
    }
}

Throttling

To improve connections and experiences for all our users, we use some connection limits when we see suspicious activity or other overload. Each user account is permitted up to 300 requests per minute, and you’ll receive an error message if you reach the limit.