Using JSON.net to deserialize an object

Question

I'm having trouble deserialising a JSON string into an object using JSON.net.

I'm calling the serialisation with:

Payload payload = JsonConvert.DeserializeObject<Payload>(string);

However, the resulting Payload object is null. Any ideas why?

My class:

public class Payload
{
    public Payload()
    { }

    public string Action { get; set; }
    public Payload.Bill[] Bills { get; set; }
    public string ResourceType { get; set; }
    public string Signature { get; set; }

    public class Bill
    {
        public Bill()
        { }

        public string Amount { get; set; }

        public string Id { get; set; }
        public string MerchantId { get; set; }
        public DateTimeOffset? PaidAt { get; set; }
        public string SourceId { get; set; }
        public string SourceType { get; set; }
        public string Status { get; set; }
        public string Uri { get; set; }
        public string UserId { get; set; }
    }
}

My JSON string:

{
  "payload": {
    "bills": [
      {
        "id": "xxxx",
        "status": "withdrawn",
        "uri": "xxxx",
        "amount": "5.19",
        "amount_minus_fees": "5.14",
        "source_type": "subscription",
        "source_id": "xxx",
        "payout_id": "xxx"
      }
    ],
    "resource_type": "bill",
    "action": "withdrawn",
    "signature": "xxx"
  }
}

Ilija Dimov · Accepted Answer · 2014-09-15 13:31:43Z

The resulting payload object is null because the json string structure does not match with your Payload class. You need additional wrapper class to deserialize it successfully:

public class PayloadWrapper
{
    public PayloadWrapper()
    {
        Payload = new Payload();
    }

    public Payload Payload { get; set; }
}

and the deserialization logic:

PayloadWrapper wrap = JsonConvert.DeserializeObject<PayloadWrapper>(jsonStr);

To avoid creating another wrapper class, you can use LINQ to JSON:

JObject obj = JObject.Parse(jsonStr);
Payload payload = obj["payload"].ToObject<Payload>();

where jsonStr variable is the json string you posted. Also I noticed that some of the properties in the json string do not match with the property names of the Payload class, like resource_type in the json string and ResourceType in the class. Add JsonProperty attribute to them for successful deserialization.

Sam Harwell · Accepted Answer · 2014-09-15 14:29:23Z

-1

try below one The type parameter for DeserializeObject has to be List<Payload> instead of string. it would be JsonConvert.DeserializeObject<List<Payload>>(json).

edited Sep 15, 2014 at 14:29

Sam Harwell

100k22 gold badges216 silver badges283 bronze badges

answered Sep 15, 2014 at 13:15

dew

11 bronze badge

4 Comments

Steve Over a year ago

I'm not sure what you mean.

dew Over a year ago

JsonConvert.DeserializeObject<List<Payload>>(json).

Ilija Dimov Over a year ago

This won't work. The json string is not an array, but it has an array property (bills).

Steve Over a year ago

That doesn't work. I managed to get it working by removing "{"payload": " from the string and the corresponding closing bracket

Collectives™ on Stack Overflow

Using JSON.net to deserialize an object

2 Answers 2

Comments

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related