Edit

Share via

Prefer odata.continue-on-error

  • Article

Applies To:# OData WebApi v7 for aspnet webapi supported Green circle with a checkmark inside it. OData AspNet WebApi V7# OData Webapi for Webapi supported Green circular checkmark icon to indicate a success. OData AspNet WebApi V6

Since OData Web API V5.7, it supports odata.continue-on-error.

Enable odata.continue-on-error

Users should call the following API to enable continue on error

  • For Microsoft.AspNet.OData (supporting classic ASP.NET Framework):

        var configuration = new HttpConfiguration();
        configuration.EnableContinueOnErrorHeader();

  • For Microsoft.AspNetCore.OData (supporting ASP.NET Core):

    It can be enabled in the service's HTTP request pipeline configuration method Configure(IApplicationBuilder app, IHostingEnvironment env) of the typical Startup class:


        app.UseMvc(routeBuilder =>
        {
           routeBuilder.Select().Expand().Filter().OrderBy().MaxTop(100).Count()
                        .EnableContinueOnErrorHeader();  // Additional configuration to enable continue on error.
           routeBuilder.MapODataServiceRoute("ODataRoute", "odata", builder.GetEdmModel());
       });

Prefer odata.continue-on-error

We can use the following codes to prefer continue on error


HttpRequestMessage request = new HttpRequestMessage(...);
request.Headers.Add("Prefer", "odata.continue-on-error");
request.Content = new StringContent(...);
request.Headers.ContentType = MediaTypeHeaderValue.Parse("multipart/mixed; boundary=batch_abbe2e6f-e45b-4458-9555-5fc70e3aebe0");
HttpResponseMessage response = client.SendAsync(request).Result;
...

The response will have all responses, includes the error responses.