Error Handling

All REST endpoints return JSON along with an HTTP status code.

1
{
2
  "success": true,
3
  "...": "other response fields"
4
}

When a request fails, the response includes a descriptive message:

1
{
2
  "success": false,
3
  "message": "Why the request failed"
4
}

Log errors with the associated request ID whenever possible so that the Resemble team can help debug issues quickly.