PUT Request for REST API in C# console application using HttpClient()

Question

I am very new to creating and consuming REST web services in C#. I have programmed the data I want to send over to REST end point. I am not sure if I am doing everything correctly. Like I mentioned previously, this is the first time I am writing a RESTful PUT request.

I have created a class and created a PUT request. I want to see my JSON result. It shows no content. Functions are returning correct results for me.

How can I see my JSON result?

sb is object of type Student and when I am sending the request to the URL, it returns a 204 status and fails to update the record. I am trying to understand what is incorrect in this code:

class Student
{
    public string Name{ get; set; }
    public string Email{ get; set; }
    public int Marks{ get; set; }
    public List<int> Skills{ get; set; }
}

public static void SendDataSomewhere(List<Student> studentsList)
{
    using (var client = new HttpClient())
    {
        Student sb = new Student
        {
            Name= "Test Name",
            Email = "[email protected]",
            Marks = HighestMarksFromList(studentsList),
            Skills = InDemandSkills(studentsList),                    
        };

        client.BaseAddress = new Uri("http://testingApi.net/");
        var response = client.PutAsJsonAsync("test", sb).Result;

        if (response.IsSuccessStatusCode)
        {
            Console.Write("Success");
        }
        else
            Console.Write("Error");
    }
}

Functions are returning correct results for me. var response is returning a 204 status code.

How can I see my JSON result?

204 means "No Content", so there probably isn't a JSON response. Why do you think there should be? (Side note: Calling .Result is very often the wrong approach. Make use of async/await instead.) — David
– David, Commented Mar 22, 2019 at 18:54
It looks like you aren't awaiting the result of the asynchronous PUT, though I'd expect result to not have a value in that case. Is this a real API (and your real code?) and is it supposed to return a result for a PUT? — Charleh
– Charleh, Commented Mar 22, 2019 at 18:58
@Charleh Yes it is real code and API. Links are not real. Some properties are not real too but API is real. I have changed the names of properties/classes. How do I wait for the result of the asynchronous PUT request? — Learn AspNet
– Learn AspNet, Commented Mar 22, 2019 at 19:33
@LearnAspNet: Then it sounds like the response is empty. Which a 204 HTTP code is likely to have. So what exactly is the problem? If you're expecting a response from the server but not getting one then that sounds like something to take up with whoever maintains that API. — David
– David, Commented Mar 22, 2019 at 20:08

Matthew · Accepted Answer · 2019-03-22 20:39:37Z

3

An API returning 204 - No Content from a PUT request simply means that the API received the request and processed it, but it doesn't have anything meaningful to give back other than a successful (2xx) response status.

In a RESTful API, this is a perfectly normal response to be expecting.

In order to know for sure what should be happening, you'll need to consult the documentation of the API you're using.

edited Mar 22, 2019 at 20:39

answered Mar 22, 2019 at 20:37

Matthew

26k9 gold badges86 silver badges118 bronze badges

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

3 Comments

Learn AspNet Over a year ago

I checked the URI(REST Endpoint), nothing has been updated. Also, I am debugging my code

Matthew Over a year ago

Please look at this answer for more detail: stackoverflow.com/a/2342589/507793

Learn AspNet Over a year ago

My response.Content is also empty? Is there a way I can see JSON results that PutAsJsonAsync did?

Krishna Chaithanya Muthyala · Accepted Answer · 2019-03-27 14:28:10Z

In my opinion, others have already answered it via answers as well as comments. But since the question is still open, let me try to answer with some more details.

Your assumption that you should be able to get a JSON result as part of PUT API response is not always correct, it depends on the implementation of the API.

Here are different ways a PUT API can be implemented:

PUT API giving the object in response:

[HttpPut]
public HttpResponseMessage Put(int id, Product product)
{
    //save the Product object.

    return Request.CreateResponse(HttpStatusCode.OK, product);
}

In this implementation, the API gives the object in the response, this is what you are expecting.

PUT API giving empty response:

[HttpPut]
public void Put(int id, Product product)
{
    //save the Product object.
}

In this implementation, API returns nothing in response.

Based on your explanation, the API you are calling is following the second way. You can verify this if you have access to the API code.

So, if your only problem is to know whether the API is not working or not, execute your code to do a PUT and then do a GET on the same object to verify if the update has been successful.

Hope this helps!

jo_Veera · Accepted Answer · 2019-03-25 07:41:56Z

0

You can use API testing tool like Postman or some other tools online and give the appropriate inputs in the tool. Check the output for the Put query. Then you can may be know the exact problem.

answered Mar 25, 2019 at 7:41

jo_Veera

3134 silver badges14 bronze badges

Collectives™ on Stack Overflow

PUT Request for REST API in C# console application using HttpClient()

3 Answers 3

3 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related