Error Codes Format - leoswaldo/ciao GitHub Wiki

If an error occurs while processing our API request, you get a non 2xx API status code. The system also returns additional information about the fault in the body of the response.

Example: Fault: JSON response

{
    "error": {
        "code": 404,
        "name": "StatusNotFound",
        "message": "The instance does not exist"
    }
}

Keys description

"error" : Static key, all data json return the "error" key, as value a json.

"code": HTTP Return Error code number. Integer type.

"name": Name of Code. String type.

"message": A more meaningful message describing the error. String type.

For a full description of names refer to Golang net/http package docs