API: Response Codes and Errors

HTTP Status Codes

The SubSift API attempts to return appropriate HTTP status codes for every request. It is possible to suppress HTTP response codes for the REST API.

Error Messages

The SubSift API returns error messages in the requested format (e.g. xml or json).

JSON example:

{
   "error" : "No such bookmarks folder: foobar"
}

TERMS example:

result(error('No such bookmarks folder: foobar')).

XML example:

<?xml version="1.0" encoding="UTF-8"?>
<result>
  <error>No such bookmarks folder: foobar</error>
</result>

YAML example:

---
error : 'No such bookmarks folder: foobar'