Proper REST response for empty table?

by

I’d say, neither.

Why not 404 (Not Found) ?

The 404 status code should be reserved for situations, in which a resource is not found. In this case, your resource is a collection of users. This collection exists but it’s currently empty. Personally, I’d be very confused as an author of a client for your application if I got a 200 one day and a 404 the next day just because someone happened to remove a couple of users. What am I supposed to do? Is my URL wrong? Did someone change the API and neglect to leave a redirection.

Why not 204 (No Content) ?

Here’s an excerpt from the description of the 204 status code by w3c

The server has fulfilled the request but does not need to return an entity-body, and might want to return updated metainformation.

While this may seem reasonable in this case, I think it would also confuse clients. A 204 is supposed to indicate that some operation was executed successfully and no data needs to be returned. This is perfect as a response to a DELETE request or perhaps firing some script that does not need to return data. In case of api/users, you usually expect to receive a representation of your collection of users. Sending a response body one time and not sending it the other time is inconsistent and potentially misleading.

Why I’d use a 200 (OK)

For reasons mentioned above (consistency), I would return a representation of an empty collection. Let’s assume you’re using XML. A normal response body for a non-empty collection of users could look like this:

<users>
  <user>
    <id>1</id>
    <name>Tom</name>
  </user>
  <user>
    <id>2</id>
    <name>IMB</name>
  </user>
</users>

and if the list is empty, you could just respond with something like this (while still using a 200):

<users/>

Either way, a client receives a response body that follows a certain, well-known format. There’s no unnecessary confusion and status code checking. Also, no status code definition is violated. Everybody’s happy.

You can do the same with JSON or HTML or whatever format you’re using.

More Related Contents:

  1. What is the difference between POST and PUT in HTTP?
  2. Is an entity body allowed for an HTTP DELETE request?
  3. REST HTTP status codes for failed validation or invalid duplicate
  4. URL matrix parameters vs. query parameters
  5. Which status code should I use for failed validations or invalid duplicates?
  6. Detecting the character encoding of an HTTP POST request
  7. Why does my web server software disallow PUT and DELETE requests?
  8. Content-Length header with HEAD requests?
  9. Which HTTP methods match up to which CRUD methods?
  10. HTTP status code for a partial successful request
  11. What is the difference between HTTP and REST?
  12. Doing a HTTP PUT from a browser
  13. REST response code for invalid data
  14. Custom HTTP Authorization Header
  15. RESTful Alternatives to DELETE Request Body
  16. Payloads of HTTP Request Methods
  17. REST, HTTP DELETE and parameters
  18. Can I stream a file upload to S3 without a content-length header?
  19. Should I use PATCH or PUT in my REST API?
  20. Is REST DELETE really idempotent?
  21. How can I deal with HTTP GET query string length limitations and still want to be RESTful?
  22. What is the proper HTTP response to send for requests that require SSL/TLS
  23. Are HTTP headers case-sensitive?
  24. How to forward headers on HTTP redirect
  25. Location detecting techniques for IP addresses
  26. Standard for adding multiple values of a single HTTP Header to a request or response
  27. How to point to localhost:8000 with the Dart http package in Flutter?
  28. Setting HTTP headers
  29. I need two instances of AngularJS $http service or what?
  30. How does url rewrite works?

Leave a Comment