C#/.NET webapi - Returning an exception (HTTP Status Code) From Method in Controller with List Return Type

Question

I want to restrict access to api when token passed in header does not match value in my configuration. I have created a custom guid in my project to prevent access to non matching token values or empty header values.

Using this setup how do I properly return a 404 or some other status from an action in a controller whose return type is a list of a specific type (used for returning JSON)?

  [HttpGet]
  [Route("getList")]
  public List<_Type> func([FromUri] int? value)
  {
      if (Request.Headers == null || !Request.Headers.Contains("token") || Request.Headers.GetValues("token").First() != ConfigurationManager.AppSettings["token"])
          throw new HttpException(404, "Not found");   //works but triggers a object null reference exeption
      return new List<_Type>();
  }

set the Response.StatusCode = 404 and throw an exception

Rudresha Parameshappa
– Rudresha Parameshappa

2017-05-02 20:03:40 +00:00
Commented May 2, 2017 at 20:03 — Rudresha Parameshappa
– Rudresha Parameshappa, Commented May 2, 2017 at 20:03

miechooy · Accepted Answer · 2017-05-02 20:03:30Z

2

You can change return type into IHttpActionResult. Ok() method takes an object as parameter so you can pass your collection.

[HttpGet]
  [Route("getList")]
  public IHttpActionResult func([FromUri] int? value)
  {
      if (Request.Headers == null || !Request.Headers.Contains("token") || Request.Headers.GetValues("token").First() != ConfigurationManager.AppSettings["token"])
          return NotFound();  //works but triggers a object null reference exeption
      return Ok(new List<_Type>());
  }

answered May 2, 2017 at 20:03

miechooy

3,44212 gold badges41 silver badges66 bronze badges

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

Comments

earloc · Accepted Answer · 2017-05-02 20:02:23Z

1

[HttpGet]
[Route("getList")]
public ActionResult func([FromUri] int? value) {
    if (Request.Headers == null || !Request.Headers.Contains("token") || Request.Headers.GetValues("token").First() != ConfigurationManager.AppSettings["token"])
        return NotFound();
    return Json(new List<_Type>());
}

answered May 2, 2017 at 20:02

earloc

2,10016 silver badges22 bronze badges

1 Comment

earloc Over a year ago

and, for your Scenario, consider usage of ActionFilter

Collectives™ on Stack Overflow

C#/.NET webapi - Returning an exception (HTTP Status Code) From Method in Controller with List Return Type

2 Answers 2

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related