prevent property from being serialized in web API

by

ASP.NET Web API uses Json.Net as default formatter, so if your application just only uses JSON as data format, you can use [JsonIgnore] to ignore property for serialization:

public class Foo
{
    public int Id { get; set; }
    public string Name { get; set; }

    [JsonIgnore]
    public List<Something> Somethings { get; set; }
}

But, this way does not support XML format. So, in case your application has to support XML format more (or only support XML), instead of using Json.Net, you should use [DataContract] which supports both JSON and XML:

[DataContract]
public class Foo
{
    [DataMember]
    public int Id { get; set; }
    [DataMember]
    public string Name { get; set; }

    //Ignore by default
    public List<Something> Somethings { get; set; }
}

For more understanding, you can read the official article.

More Related Contents:

  1. How to return a file (FileContentResult) in ASP.NET WebAPI
  2. How to update a claim in ASP.NET Identity?
  3. Difference between MVC 5 Project and Web Api Project
  4. 404 error after adding Web API to an existing MVC Web Application
  5. TempData null in asp.net core
  6. POST string to ASP.NET Web Api application – returns null
  7. How to add Web API to an existing ASP.NET MVC (5) Web Application project?
  8. Web Api Request Content is empty in action filter
  9. WCF Service or Web API [closed]
  10. How do I get the contents of a JSON file I added in the StartUp method to use it in one of my actions?
  11. How to get DropDownList SelectedValue in Controller in MVC
  12. Failed to serialize the response in Web API with Json
  13. How to return PDF to browser in MVC?
  14. ASP.NET MVC Global Variables
  15. Adding your own HtmlHelper in ASP.NET MVC 3
  16. Proper JSON serialization in MVC 4
  17. An error occurred during report processing. -RLDC reporting in ASP.NET MVC
  18. How do I log a user out when they close their browser or tab in ASP.NET MVC?
  19. Order of execution with multiple filters in web api
  20. Why is Asp.Net Identity IdentityDbContext a Black-Box?
  21. Windows Authentication and add Authorization Roles through database – MVC asp.net
  22. ASP.NET Core v2 (2015) MVC : How to get raw JSON bound to a string without a type?
  23. Assign format of DateTime with data annotations?
  24. How can I secure passwords stored inside web.config?
  25. Simple JWT authentication in ASP.NET Core 1.0 Web API
  26. Why is this web api controller not concurrent?
  27. {version} wildcard in MVC4 Bundle
  28. Disable *all* exception handling in ASP.NET Web API 2 (to make room for my own)?
  29. Opposite of [compare(” “)] data annotation in .net?
  30. How do I maintain ModelState errors when using RedirectToAction?

Leave a Comment