API Documentation / Error Responses

HTTP Status Codes

200 HTTP_OK
Request Completed Successfully
201 HTTP_CREATED
The Entity was Created Successfuly
400 HTTP_BAD_REQUEST
The request was malformed, or invalid data was provided
401 HTTP_UNAUTHORIZED
The account requesting the action does not have sufficient privileges to perform the action.
403 HTTP_FORBIDDEN
This resource is not accessible
404 HTTP_NOT_FOUND
The requested resource was not found
500 HTTP_INTERNAL_SERVER_ERROR
An error occured while processing the request
501 HTTP_NOT_IMPLEMENTED
The requested endpoint is not implemented

API Response Code Strings

already_exists
When trying to create an object, an object with this name already exists
invalid
Typically the result of a validation error

Error Response Format

            
{
    "message": "Human Friendly Error Message",
    "status_code": 400,
    "errors": [
        {
            "resource":   "user",
            "field":      "username",
            "code":       "already_exists",   // A machine readable code, defined above
            "message":    "A human friendly string describing the issue.",
        }
    ]
}