Setting the file name returned by ASP .NET Web API

Question

I am looking to set the name of the file that is being returned by the ASP .NET WEB API. Currently its just returns in the name of the parameters that is being passed in the URL. But what if I need then to be returned as ABC.JSON

public class NewTestController : ApiController
{
public string Getdetails([FromUri] string[] id)
{using (OracleConnection dbconn = new OracleConnection("DATA SOURCE=J;PASSWORD=C;PERSIST SECURITY INFO=True;USER ID=T"))
    {
        var inconditions = id.Distinct().ToArray();
        var srtcon = string.Join(",", inconditions);
        DataSet userDataset = new DataSet();
        var strQuery = @"SELECT 
                       * from STPR_STUDY where STPR_STUDY.STD_REF IN (" + srtcon + ")";
        OracleCommand selectCommand = new OracleCommand(strQuery, dbconn);
        OracleDataAdapter adapter = new OracleDataAdapter(selectCommand);
        DataTable selectResults = new DataTable();
        adapter.Fill(selectResults);
        return JsonConvert.SerializeObject(selectResults);
}}}

I did see in other forums using Content-Disposition but I am not using HTTPResponse in code. How can this be done. Thanks

I tried like below

 OracleCommand selectCommand = new OracleCommand(strQuery, dbconn);
            OracleDataAdapter adapter = new     OracleDataAdapter(selectCommand);
            DataTable selectResults = new DataTable();
            adapter.Fill(selectResults);
            string result =  JsonConvert.SerializeObject(selectResults);
            HttpResponseMessage response = new HttpResponseMessage();
            response.StatusCode = HttpStatusCode.OK;
            response.Content = new StreamContent(result);
            response.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment")
            {
                FileName = "Abc.JSON"
            };
     return(result);

But it throws the error in StreamContent saying,the best overloaded method match for has some invalid arguments in StreamConent

You returning string from your controller. You should use at least IHttpActionResult, but better HttpResponseMessage to set your file name — teo van kot
– teo van kot, Commented Jul 25, 2016 at 15:42
Teo van kot, I tried using HTTPResponseMessageand I am getting error in the best overloaded method match for has some invalid arguments in StreamConent. I am creating my first Web API — trx
– trx, Commented Jul 25, 2016 at 16:09
Returning serialized DataTable doesn't make sense from API, What is the end result you are hoping to get at the client side? — Win
– Win, Commented Jul 25, 2016 at 16:44
I want them to be JSON in response. I am converting from DataTable to the JSON using JsonConvert.SerializeObject — trx
– trx, Commented Jul 25, 2016 at 16:47

Paresh · Accepted Answer · 2016-07-25 17:41:01Z

1

You can use CreateResponse method of Request object like below

    public HttpResponseMessage Get()
    {
        string fileName = "abc.json";
        return Request.CreateResponse(HttpStatusCode.OK, fileName);
    }

Edit 1:

   string contentDisposition = "inline; filename=abc.json";
   HttpResponseMessage response = Request.CreateResponse(HttpStatusCode.OK, byteInfo, MediaTypeHeaderValue.Parse("application/json"));
   response.Content.Headers.ContentDisposition = ContentDispositionHeaderValue.Parse(contentDisposition);
   return response;

edited Jul 25, 2016 at 17:41

answered Jul 25, 2016 at 16:18

Paresh

9931 gold badge7 silver badges15 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

trx Over a year ago

But I am converting the DataTable in to the JSON. So wont I be returning them in the String. I am sorry, I am new and little stuck.

Paresh Over a year ago

Even if it is string you should use HttpResponseMessage to return data to client. if you need help on, how to use it on the client side let me know

trx Over a year ago

'DataTable selectResults = new DataTable(); adapter.Fill(selectResults); string result = JsonConvert.SerializeObject(selectResults); HttpResponseMessage response = new HttpResponseMessage(); response.StatusCode = HttpStatusCode.OK; var fileName = "abc.json"; return Request.CreateResponse(HttpStatusCode.OK, fileName);' I tried this code and it opes the file as NewTest.JSOn with data inside as ABC.JSON. It doesnot return the original data

Paresh Over a year ago

Oh ok I thought you only wanted to return the filename. I have modified my answer based on your above comment. Let me know if that works

trx Over a year ago

Yes I tried using the above code like I showed in my comment. It opens a file as NewTest.Json(which is name of the controller of the Web API application) but if I open it inside it has data as abc.json

|

Collectives™ on Stack Overflow

Setting the file name returned by ASP .NET Web API

1 Answer 1

6 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

6 Comments

Your Answer

Sign up or log in

Post as a guest

Related