Send JSON via POST in C# and Receive the JSON returned?

by

I found myself using the HttpClient library to query RESTful APIs as the code is very straightforward and fully async’ed. To send this JSON payload:

{
  "agent": {                             
    "name": "Agent Name",                
    "version": 1                                                          
  },
  "username": "Username",                                   
  "password": "User Password",
  "token": "xxxxxx"
}

With two classes representing the JSON structure you posted that may look like this:

public class Credentials
{
    public Agent Agent { get; set; }
    
    public string Username { get; set; }
    
    public string Password { get; set; }
    
    public string Token { get; set; }
}

public class Agent
{
    public string Name { get; set; }
    
    public int Version { get; set; }
}

You could have a method like this, which would do your POST request:

var payload = new Credentials { 
    Agent = new Agent { 
        Name = "Agent Name",
        Version = 1 
    },
    Username = "Username",
    Password = "User Password",
    Token = "xxxxx"
};

// Serialize our concrete class into a JSON String
var stringPayload = JsonConvert.SerializeObject(payload);

// Wrap our JSON inside a StringContent which then can be used by the HttpClient class
var httpContent = new StringContent(stringPayload, Encoding.UTF8, "application/json");

var httpClient = new HttpClient()
    
// Do the actual request and await the response
var httpResponse = await httpClient.PostAsync("http://localhost/api/path", httpContent);

// If the response contains content we want to read it!
if (httpResponse.Content != null) {
    var responseContent = await httpResponse.Content.ReadAsStringAsync();
    
    // From here on you could deserialize the ResponseContent back again to a concrete C# type using Json.Net
}

More Related Contents:

  1. How to deserialize an array of values with a fixed schema to a strongly typed data class?
  2. Detect if deserialized object is missing a field with the JsonConvert class in Json.NET
  3. Casting interfaces for deserialization in JSON.NET
  4. How to serialize/deserialize a custom collection with additional properties using Json.Net
  5. How to tell Json.Net globally to apply the StringEnumConverter to all enums
  6. Json.NET serialize object with root name
  7. Custom Deserialization using Json.NET
  8. How can I serialize/deserialize a dictionary with custom keys using Json.Net?
  9. JToken: Get raw/original JSON value
  10. How to call JsonConvert.DeserializeObject and disable a JsonConverter applied to a base type via [JsonConverter]?
  11. Cannot deserialize JSON array into type – Json.NET
  12. How to apply indenting serialization only to some properties?
  13. JSON.net (de)serialize untyped property
  14. Ignoring null fields in Json.net
  15. Deserialize json object with dynamic items in C#
  16. How can I merge two JObject? [duplicate]
  17. Json.NET adding backslash while returning json serialized string
  18. How do I get formatted and indented JSON in .NET using C#?
  19. Deserializing JSON into an object with Json.NET
  20. Json.net rename properties
  21. Newtonsoft JSON for .net is ignoring jsonproperty tags
  22. Json.net serialize/deserialize derived types?
  23. How can I deserialize a child object with dynamic (numeric) key names?
  24. Deserializing JSON when sometimes array and sometimes object
  25. Deserializing dates with dd/MM/yyyy format using Json.Net
  26. Deserializing JSON with unknown object names
  27. How to convert datatable to json string using json.net?
  28. JContainer, JObject, JToken and Linq confusion
  29. Replace part of a JSON with other (using a string token)
  30. How do I get a deeply-nested property from JSON string?

Leave a Comment