Rest API Returning HTTP Status Code

Question

I have a scenario where my API application contacts external datasources and for this particular example, my API requests a list of colours from the external datasource. Sometimes the datasource doesnt have these colours and returns a plain text response of "There are no options to display" with a HTTP status code of 200 OK.

What i am wondering is what status code i should return to the client which is consuming my API in this scenario? A 404 not found or 204 no content...? Im not sure what would fit best.

Thanks

Dave Watts · Accepted Answer · 2012-04-12 19:12:59Z

1

Is it valid not to return any colours? In which case your original 200 may be the right status code to use.

204 is normally used to indicate success, but the client need not update any information it holds; deleting or updating a resource for example are valid times to use 204.

404 seems wrong if the same URL is being accessed, in your scenario it sounds like the state of resource may change overtime (and it may be empty), but it always exists.

answered Apr 12, 2012 at 19:12

Dave Watts

8907 silver badges11 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

gdp Over a year ago

So what your saying is that a 200 could be right if its valid that no colours are returned. I think i will go with that then. Thanks for pushing me in the right direction.

Dave Watts Over a year ago

In a nutshell, yes :-), glad you found the answer helpful!

Defkon1 Over a year ago

yep, 200 with empty list of results is the right approach imho

Collectives™ on Stack Overflow

Rest API Returning HTTP Status Code

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related