Sitecore Services Client 8.2 ODataController - 406 Not Acceptable error

Question

I am trying to request a GET using SSC ODataController with Sitecore 8.2 and it keeps throwing a 406 Not Acceptable error. URL - http://sc82/sitecore/ssc/api/example-controller/products

This is the sample ODataController code:

 public class ProductsController : ServiceBaseODataController<Product>
 {
    protected IReadOnlyEntityRepository<Product> ProductRepository { get; private set; }

    public ProductsController(IReadOnlyEntityRepository<Product> repository) : base(repository)
    {
    }

    public ProductsController() : this(new ProductRepository())
    {   
    }

    public override async Task<IHttpActionResult> Get()
    {  
        IQueryable<Product> result = await ProductRepository.GetData();           
        return Ok(result);    
    }

}

Please let me know if anyone has tried using ODataController with Sitecore 8.2 and faced similar issue.

Answer 1

The pure HTTP GET request to your ProductController, assuming it was registered by the aggregate descriptor as being part of the custom service, should look something like:

GET /sitecore/api/ssc/aggregate/custom/Products HTTP/1.1 Host: test.site Accept: application/json;

Via cUrl you would be able to request your Products:

curl -X GET -H "Accept: application/json;" "http://test.site/sitecore/api/ssc/aggregate/custom/Products"

If in doubt SSC provides a discovery service where you can identiy the aggregate services registered within a website.

curl -X GET -H "Accept: application/json;" "http://test.site/sitecore/api/ssc/aggregate/"

To retrieve the EDM metadata about your services fire a GET request at the sitecore/api/ssc/aggregate/custom/$metadata route.

Hope that helps :)

Answer 2

A client (e.g. your browser) can indicate to the webserver the characteristics of the data it will accept back from the webserver. This is done using 'accept headers' of the following types:

• Accept: The MIME types accepted by the client. For example, a browser may only accept back types of data (HTML files, GIF files etc.) it knows how to process.
• Accept-Charset, Accept-Encoding, Accept-Language, Accept-Ranges

If the Web server detects that the data it wants to return is not acceptable to the client, it returns a header containing the 406 error code

If you test with the browser, the accept header has nothing to do with Sitecore. If your accept header only states text/html, it is normal that the data from your controller is giving a 406 because that is not html. The default accept header in my Chrome for example is "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8". With these values I can retrieve data from controllers without problems.

More information on 406 can be found here - a complete reference to the accept headers here.

Some possible things to do:

• test with another browser
• check why your browser is sending just "text/html" as accept header and try to change that

An overview of what the default accept headers should be can be found here.