How to return a file using Web API?

by

Better to return HttpResponseMessage with StreamContent inside of it.

Here is example:

public HttpResponseMessage GetFile(string id)
{
    if (String.IsNullOrEmpty(id))
        return Request.CreateResponse(HttpStatusCode.BadRequest);

    string fileName;
    string localFilePath;
    int fileSize;

    localFilePath = getFileFromID(id, out fileName, out fileSize);
       
    HttpResponseMessage response = new HttpResponseMessage(HttpStatusCode.OK);
    response.Content = new StreamContent(new FileStream(localFilePath, FileMode.Open, FileAccess.Read));
    response.Content.Headers.ContentDisposition = new System.Net.Http.Headers.ContentDispositionHeaderValue("attachment");
    response.Content.Headers.ContentDisposition.FileName = fileName;
    response.Content.Headers.ContentType = new MediaTypeHeaderValue("application/pdf");

    return response;
}

UPDATE from comment by patridge:
Should anyone else get here looking to send out a response from a byte array instead of an actual file, you’re going to want to use new ByteArrayContent(someData) instead of StreamContent (see here).

More Related Contents:

  1. Best practice to call ConfigureAwait for all server-side code
  2. Entity Framework change connection at runtime
  3. Specifying a custom DateTime format when serializing with Json.Net
  4. Best practice to return errors in ASP.NET Web API
  5. Single controller with multiple GET methods in ASP.NET Web API
  6. Why should I use IHttpActionResult instead of HttpResponseMessage?
  7. Web API Put Request generates an Http 405 Method Not Allowed error
  8. prevent property from being serialized in web API
  9. How to update a claim in ASP.NET Identity?
  10. HTTP 404 Page Not Found in Web Api hosted in IIS 7.5
  11. MVC web api: No ‘Access-Control-Allow-Origin’ header is present on the requested resource
  12. catch all unhandled exceptions in ASP.NET Web Api
  13. Suppress properties with null value on ASP.NET Web API
  14. How to use a client certificate to authenticate and authorize in a Web API
  15. Webapi formdata upload (to DB) with extra parameters
  16. Multiple Controller Types with same Route prefix ASP.NET Web Api
  17. Order of execution with multiple filters in web api
  18. Manually set operationId to allow multiple operations with the same verb in Swashbuckle
  19. Asp.net WEB API – What problems could arise if I use POST instead of PUT and DELETE?
  20. Put content in HttpResponseMessage object?
  21. Strings sent through Web API’s gets wrapped in quotes
  22. Return Json, but it includes backward slashes “\”, which I don’t want
  23. What’s the difference between WCF Web API and ASP.NET Web API
  24. Web Api Request Content is empty in action filter
  25. C# unsupported grant type when calling web api
  26. ASP.NET Web API ActionFilter example
  27. Disable *all* exception handling in ASP.NET Web API 2 (to make room for my own)?
  28. WCF Service or Web API [closed]
  29. jQuery posts null instead of JSON to ASP.NET Web API
  30. Web API complex parameter properties are all null

Leave a Comment