Errors
Example response
{
"errors": [
{
"code": 400,
"message": "problem token",
"scope": "",
"type": 0,
"data": null
}
],
"success": false,
"data": null
}
Boosmap uses conventional HTTP responses to indicate the success or failure of a request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error caused by the information provided (e.g. a required parameter was omitted, etc.), and codes in the 5xx range indicate an error with Boosmap's servers (these are rare).
Attributes
| errors array | If the result is an error, the problem will be indicated with the corresponding code |
| success boolean | If the result is successful it will return true, otherwise it will send false |
| data array | Data where the result will be returned if successful |
Error codes
| 400 Bad Request | There is a problem with your request |
| 401 Unauthorized | Your API key is incorrect |
| 403 Forbidden | You do not have permission to view this page |
| 404 Not Found | The specified resource was not found |
| 405 Method Not Allowed | You tried to access a resource with an invalid method |
| 406 Not Acceptable | You requested a format that is not JSON |
| 410 Gone | The requested resource was removed from our servers |
| 418 | I'm a teapot ️ |
| 422 Unprocessable Entity | We cannot process your request, please review it.️ |
| 429 Too Many Requests | You are requesting too many resources! Slow down! |
| 500 Internal Server Error | We had a problem with our server. Try again later (these are rare) |
| 503 Service Unavailable | We are offline for maintenance. Try again later |