Appearance
Errors
Every error includes a code, the HTTP status code, a short detail, and an additional meta can be used to help the YouCan support team investigate in your error quickly.
Errors Types
HTTP status | Description |
---|---|
404 | The resource requested not found or deleted |
405 | Method not allowed this error happened when the endpoint requested doesn't support the current request types |
422 | Unprocessable entity this error happened when the request doesn't respect the validation ex: missing required field, invalid fields type |
500 | 500 Internal Server Error this error is generic happened when something got wrong in the service side while processing the request |
Examples
Not found
json
{
"message": "item not found"
}
Validation error
json
{
"message": "The id field is required. (and 1 more error)",
"errors": {
"id": ["The id field is required."],
"status": ["The status field is required."]
}
}
Unsupported request type error
json
{
"detail": "The POST method is not supported for this route. Supported methods: GET, HEAD, PUT, DELETE.",
"meta": []
}
Internal error
json
{
"detail": "internal error"
}