-
Notifications
You must be signed in to change notification settings - Fork 0
Errors
Matthew Dowdell edited this page Jan 25, 2017
·
5 revisions
If an error occurs as a result of a request or generating a response, an error response will be returned in the following format:
{
"error": "$code",
"message": "$message",
"user_message": "$user_message",
"status": "$status"
}-
errorwill contain a unique code identifying the type of error that occurred. -
messagewill contain a message describing the error. This message is always present and is aimed at explaining the error to a developer. -
user_messagecontains a messages describing the error, but is designed to explain the error to an end user. This is not always present, but if a response contains one it should be used to describe the error to an end user. If it is not present, themessageshould be used instead. -
statuscontains the HTTP error code. This will be 400 for bad client request or 500 for an internal server error. Please report any internal errors to the issue tracker.