Hide virtual ICollection Property From WebApi Result

Question

Hello,
My model is like this

public class Emp
{
public int ID {get;set;}
public string Name {get;set;}
public int DepartmentID {get;set;}
public Department Department {get;set;}
}

public class Department
{
Department()
{
emps = new HashSet<Emp>();
}
public int ID { get;set; }
public string Name {get;set;}
public virtual ICollection<Emp> emps {get;set;}
}

after I Getting reponse in json format by running GetALL Api for department.

It shows
Department.json result
{

"name": "Income Tax",
"Emps": [] // want to hide this
}
So, I want to hide emps: []

how to do this?

Answer 1

Hi @PrathameshShende-2581 ,

To ignore individual properties, you can use the [JsonIgnore] attribute,like this:
Model:

  public class Emp  
    {  
        public int ID { get; set; }  
        [JsonIgnore]  
        public string Name { get; set; }  
        
    }  

c#

Emp emp = new Emp()  
            {  
                ID = 1,  
                Name = "Test"  
            };  
           var json = JsonSerializer.Serialize(emp);  
            Console.WriteLine(json);  

Result:

For more ignored properties of System.Text.Json, you can refer to the official documentation for viewing.
How to ignore properties with System.Text.Json

---

If the answer is helpful, please click "Accept Answer" and upvote it.

Note: Please follow the steps in our documentation to enable e-mail notifications if you want to receive the related email notification for this thread.

Best Regards,

ChaoDeng

Answer 2

You could use the DTO pattern and shape the data that will be sent.

https://learn.microsoft.com/en-us/aspnet/web-api/overview/data/using-web-api-with-entity-framework/part-5

https://www.codeproject.com/Articles/1050468/Data-Transfer-Object-Design-Pattern-in-Csharp