JsonResult or ActionResult [Answered]RSS

• • Reply
  rkrex

  Member

  182 Points

  211 Posts

  JsonResult or ActionResult

  Mar 21, 2019 09:18 PM|rkrex|LINK

  Hi Friends,

  Should a Web API return a JsonResult or a ActionResult? Also I was wondering should I use Jquery Ajax with my Web API's? Thanks !

• • Reply
  mgebhard

  All-Star

  38781 Points

  15939 Posts

  Re: JsonResult or ActionResult

  Mar 21, 2019 09:41 PM|mgebhard|LINK

  rkrex

  Should a Web API return a JsonResult or a ActionResult? Also I was wondering should I use Jquery Ajax with my Web API's? Thanks !

  Please take the time read through the Getting Started tutorials as it covers the basics. 

  Generally, Web API returns an object and/or HTTP status.   Using AJAX or not is up to you and your project requirements.  

• • Reply
  yogyogi

  Participant

  780 Points

  500 Posts

  Re: JsonResult or ActionResult

  Mar 22, 2019 05:33 AM|yogyogi|LINK

  You can return an object from the API and this object will be returned in JSON format:

  public Student Get(int id) {
      Student stu = new Student();
      stu.Name = "Jack";
      stu.Age = 10;
      return stu; 
  }

  You can also return  HTTP status from the API like:

  public StatusCodeResult Get(int id) {
      if (id != null)
      {
          // do some work
          return Ok();
      }
      return NotFound();
  }

  Tutorial - API Controllers – Creating API in ASP.NET Core

  Your other question is regarding jQuery AJAX. The jQuery AJAX can be used by the client to consume the API.

  See - How to use JQuery AJAX Method to Call an API

   

  Helping you always. Don't forget to click "Mark as Answer" on the post that helped you.
  
• • Reply
  Yuki Tao

  Contributor

  2650 Points

  1073 Posts

  Re: JsonResult or ActionResult

  Mar 22, 2019 06:57 AM|Yuki Tao|LINK

  Hi rkrex,

  rkrex

  Should a Web API return a JsonResult or a ActionResult?

  A Web API controller action can return any of the following:

  1. void
  2. HttpResponseMessage
  3. IHttpActionResult
  4. Some other type

  I suggest you could use IHttpActionResult rather than JsonResult and ActionResult.

  rkrex

  Also I was wondering should I use Jquery Ajax with my Web API's?

  You could use Jquery Ajax or HttpClient or any other to call Web API,It depends on you.

  For example:

  1.Call web api by ajax:

   $.ajax({
                      type: "POST",
                      url: "/api/AjaxAPI/AjaxMethod",
                      data: person,
                      contentType: "application/json; charset=utf-8",
                      dataType: "json",
                      success: function (response) {
                          alert("Hello: " + response.Name + ".\nCurrent Date and Time: " + response.DateTime);
                      },
                      failure: function (response) {
                          alert(response.responseText);
                      },
                      error: function (response) {
                          alert(response.responseText);
                      }
                  });

  Controller:

  public class AjaxAPIController : ApiController
  {
      [Route("api/AjaxAPI/AjaxMethod")]
      [HttpPost]
      public PersonModel AjaxMethod(PersonModel person)
      {
          person.DateTime = DateTime.Now.ToString();
          return person;
      }
  }

  More details about Call (Consume) Web API using jQuery AJAX in ASP.Net MVC,you could refer to:

  https://www.aspsnippets.com/Articles/Call-Consume-Web-API-using-jQuery-AJAX-in-ASPNet-MVC.aspx

  2.Call web api by HttpClient:

  More details about Consume Web API in .NET using HttpClient,you could refer to:

  https://www.tutorialsteacher.com/webapi/action-method-return-type-in-web-api

  Best Regards.

  Yuki Tao

  Please remember to "Mark as Answer" if suggestion helps.
• • Reply
  bruce (sqlwo...

  All-Star

  51264 Points

  12334 Posts

  Re: JsonResult or ActionResult

  Mar 22, 2019 02:51 PM|bruce (sqlwork.com)|LINK

  1) if you just return an object from webapi, it will support the accept type sent in the request. so the api can return json or xml. 

  2) while you can use jQuery, the native fetch api is more powerful, and preferred. unless you need support for IE < 11, there really is little reason for jQuery anymore.

  bruce (sqlwork.com)