Home/ Questions/Q 732907
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Asked: 2026-05-14T07:11:44+00:00

I am designing a RESTful API and I would like to know what the

  • 0

I am designing a RESTful API and I would like to know what the most RESTful way is to return details about an operation.

E.g. an operation on a resource occurs when some data is POSTed to a URL. HTTP status codes will indicate either success or failure for the operation. But apart from success/failure I need to indicate some other info to the client, such as an ID number.

So my question is, should the ID number be returned in an XML document in the response content, or should it be returned in some custom HTTP header fields? Which is more in line with the principles of REST? Or am I free to choose.

Share

Leave an answer

You must login to add an answer.

Need An Account,

1 Answer

  1. Editorial Team

    Returning an entity is a perfectly valid response to an HTTP POST.

    You also do not need to return XML you could just use the content type text/plain and simply return a string value.

    Using a header would require you to define a new custom header which is not ideal. I would expect clients would have an easier time parsing a response body than extracting the information from a header.

    • 0