How to specific C# property to Json object in ASP.NET MVC?

Question

++ Model

    public class Product{
        public int ProductId { get; set; }
        public string ProductName { get; set; }

        public DataTable dt = new DataTable();
        public Category Category = new Category();
    }

++Controller

    public JsonResult Index(){
        Product dto = new Product();
        dto.ProductId = 1;
        dto.ProductName = "Coca Cola";
        return Json(dto, JsonRequestBehavior.AllowGet);
    }

How to specific Json object, I mean need only ProductId, ProductName and other no need to Json object.

++Want

    {
        "ProductId": 1,
        "ProductName": "Coca Cola"
    }

One possible way is to return anonymous object like `return Json(new { ProductId = dto.ProductId, ... });` — Aleks Andreev, Apr 04 '19 at 11:04
Possible duplicate of [Only serialize some specific properties of a class?](https://stackoverflow.com/questions/13658580/only-serialize-some-specific-properties-of-a-class) — krillgar, Apr 04 '19 at 11:04

Amir Molaei · Accepted Answer · 2019-04-04T11:38:20.397

4

You can use [ScriptIgnore] attribute from System.Web.Script.Serialization on every property that you want to exclude from the object when serializing or deserializing:

  using System.Web.Script.Serialization;

  public class Product{
        public int ProductId { get; set; }
        public string ProductName { get; set; }

        [ScriptIgnore]
        public DataTable dt = new DataTable();
        [ScriptIgnore]
        public Category Category = new Category();
    }

edited Apr 04 '19 at 11:38

answered Apr 04 '19 at 11:06

Amir Molaei

3,700
1
17
20

Can you tell me about Controller? – Apr 04 '19 at 11:17
The controller is fine and does not need any changes. – Amir Molaei Apr 04 '19 at 11:19
Try `[ScriptIgnore]` from `System.Web.Script.Serialization` instead of `[JsonIgnore]` and let me know it's working. – Amir Molaei Apr 04 '19 at 11:26
use [ScriptIgnore] instead of [JsonIgnore] It's working. Thank you. – Apr 04 '19 at 11:31
Glad it helped. And since you are using `JavaScriptSerializer` , `[JsonIgnore]` wouldn't work for you. – Amir Molaei Apr 04 '19 at 11:35

score 2 · Answer 2 · edited Apr 04 '19 at 11:09

2

In same class, create two functions returning boolean like this:

 public bool ShouldSerializedt()
 {
      return false;
 }

 public bool ShouldSerializeCategory()
 {
      return false;
 }

Function returns boolean. Its name is ShouldSerialize<<PropertyName>> and the return type of boolean controls serialization behavior

edited Apr 04 '19 at 11:09

Aleks Andreev

7,016
8
29
37

answered Apr 04 '19 at 11:06

Harsimran Dhami

31
1

I don't understand, I am beginner. – Apr 04 '19 at 11:18
In the same Product class where you are defining properties like ProductId , ProductName etc. define the functions I mentioned. Check the name of both functions. Name starts with "ShouldSerialize" and end with "dt" or "Category" which are names of properties which shouldn't be serialized. If such function returns false, then corresponding property won't get serialized. – Harsimran Dhami Apr 04 '19 at 12:45

score 0 · Answer 3 · answered Apr 04 '19 at 11:05

Best to use C# serialization mechanism. You may need separate class for the purpose of this "limited" serialization (in case you want these properties serialized in other scenarios) but that should do it. Take a look here: How to exclude property from Json Serialization

score 0 · Answer 4 · answered Apr 04 '19 at 11:37

0

Annotate the field you want to exclude with[JsonIgnore]

answered Apr 04 '19 at 11:37

Leke Okewale

15
1
8

I already try [JsonIgnore] It's not work. but use [ScriptIgnore] It's work. Answer from above. – Apr 04 '19 at 16:24

How to specific C# property to Json object in ASP.NET MVC?

4 Answers4