<%= render 'docs/sidebar' %>
<%= render 'response' %>

Error Codes



<% t(:error_codes).each do |key, values| %> <% end %>
<%= t(:error_code) %> <%= t(:error_http_status) %> <%= t(:error_message) %> <%= t(:error_details) %>
<%= key %> <%= values[:http_status] %> <%= values[:message] %> <%= values[:details] %>
All errors will be sent with their corresponding HTTP status code.

Example error response: error_auth_required
The response will be a JSON error object, for example: 
{
  "status": "401",
  "error":
  {
    "error_code": "error_auth_required",
    "message": "Authorization Required",
    "details": "Please make sure that your API key is correct."
  }
}
The response will be an XML error object, for example: 
<?xml version="1.0" encoding="UTF-8"?>
<error>
  <error-code>error_auth_required</error-code>
  <message>Authorization Required</message>
  <details>Please make sure that your API key is correct.</details>
</error>