Breaking News: Grepper is joining You.com. Read the official announcement!

webApi return types

Preeti Gupta answered on February 3, 2024 Popularity 1/10 Helpfulness 1/10

answer webApi return types

webApi return types

Comment

using System.Collections.Generic;
using System.Net;
using System.Net.Http;
using System.Web.Http;

public class ValuesController : ApiController
{
    // GET api/values
    public IEnumerable<string> Get()
    {
        return new string[] { "value1", "value2" };
    }

    // GET api/values/5
    public IHttpActionResult Get(int id)
    {
        if (id == 1)
        {
            return Ok("Value found");
        }
        else
        {
            return NotFound();
        }
    }

    // POST api/values
    public HttpResponseMessage Post([FromBody]string value)
    {
        // Your logic here

        var response = Request.CreateResponse(HttpStatusCode.Created, value);
        response.Headers.Location = new System.Uri(Request.RequestUri + "/" + value);
        return response;
    }

    // PUT api/values/5
    public void Put(int id, [FromBody]string value)
    {
        // Your logic here
    }

    // DELETE api/values/5
    public void Delete(int id)
    {
        // Your logic here
    }

    // Custom action returning XML
    [HttpGet]
    [Route("api/values/getxml")]
    public IHttpActionResult GetXml()
    {
        var data = new List<string> { "value1", "value2" };
        return Content(HttpStatusCode.OK, data, Configuration.Formatters.XmlFormatter);
    }

    // Custom action returning HttpResponseMessage
    [HttpGet]
    [Route("api/values/getresponsemessage")]
    public HttpResponseMessage GetResponseMessage()
    {
        var response = new HttpResponseMessage(HttpStatusCode.OK);
        response.Content = new StringContent("Custom response message");
        response.Content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("text/plain");
        return response;
    }

    // Custom action throwing HttpResponseMessageException
    [HttpGet]
    [Route("api/values/getexception")]
    public IHttpActionResult GetException()
    {
        throw new HttpResponseException(new HttpResponseMessage(HttpStatusCode.NotFound)
        {
            Content = new StringContent("Resource not found"),
            ReasonPhrase = "Custom Reason Phrase"
        });
    }
}

Popularity 1/10 Helpfulness 1/10 Language csharp

Source: chat.openai.com

Tags: c# webapi

Link to this answer
Share Copy Link

Contributed on Feb 03 2024

Preeti Gupta

0 Answers Avg Quality 2/10

webApi return types

Contents

More Related Answers

webApi return types

Grepper

Documentation

Social

Legal

Contact

Oops, You will need to install Grepper and log-in to perform this action.