0

I am working on a POST HTTP API which does not modify or create any state on the server. The API is implemented with method POST as it needs to accept multiple complex inputs which would not be possible using query parameters.

What is the correct response status to return in case of conditional check failures (If-Match/If-None-Match) for such read-only POST APIs, should it be 304 Not Modified or 412 Precondition Failed?

Note: This is an internal service API where the client is aware that it is a non modifying request.

Sumit Jain
  • 1,484
  • 2
  • 25
  • 44

1 Answers1

1

For a GET request, we would expect an If-None-Match header, which would normally produce a 200 response with an updated copy of the representation if the condition holds, and a 304 response when the precondition fails (meaning that the clients copy of the resource is already up to date).

The semantics should be the same when we use POST in a read-only way. (Note that we are in a bit of an edge case here; a general purpose client won't normally know that this particular POST request is safe, and probably won't know which precondition headers to attach to the request. For instance, if you try to use an HTML form in a web browser to access this resource, you probably aren't going to get the conditional headers that you want.)

412 Precondition Failed is normally used when requesting a modification to the resource, in combination with an If-Match header.

Reference: HTTP Semantics, section 13.

VoiceOfUnreason
  • 52,766
  • 5
  • 49
  • 91