Magento 2 – How to Return a 304 HTTP Response from REST API Method

apimagento2rest

In a custom REST API endpoint method, returning the object promised in the service class interface will generate a 200 OK response. Additionally, I can return a specific HTTP error code by throwing an particular type of exception. For example, throwing a NoSuchEntityException returns a 404 NOT FOUND and a AuthorizationException returns a 401 UNAUTHORIZED.

My question: is there a way to return other HTTP codes, such as a 304 NOT MODIFIED code?

Best Answer

Custom status codes are currently not supported, you can only get one of the following: 200, 400, 401, 403, 404, 406, 500 (see \Magento\Framework\Webapi\Exception). If you have real use case when you need this functionality, feel free to create pull request or file an issue at https://github.com/magento/magento2 .

Related Solutions

Magento 1.9 REST API – No Response from POST to Custom Route

If you take a look at class Mage_Api2_Model_Resource which should be extended by your class, you can find function _render().

By examining dispach() function of this class, you can see, that _render() function is called by retrieve operations. So you can use this function at the end of your action like so $this->_render($data).

This function is not used by create operations, which only set Location header to newly created resource url.

To take an advantage of attribute filtering, use $this->getFilter()->out($data) before $this->_render($data)

Mage_Api2_Model_Resource::dispatch() can answer a lot of questions regarding magento REST!

Magento – How to set HTTP Response Code in Custom REST API

You can configure the whole HTTP response with the response object from a controller:

$this->getResponse()
    ->clearHeaders()
    ->setHeader('HTTP/1.0', YOUR_STATUS_CODE, true)
    ->setHeader('Content-Type', 'text/html') // can be changed to json, xml...
    ->setBody(YOUR_RETURN_CONTENT);

Best Answer

Related Solutions

Magento 1.9 REST API – No Response from POST to Custom Route

Magento – How to set HTTP Response Code in Custom REST API

Related Topic