CODEWITHSUNDEEP
asp.netserializationasp.net-mvc-4asp.net-web-api
Adam Carr
Adam Carr

Reputation: 2986

Exclude property from json serialization in ApiController

I am trying to exclude properties from being serialized to JSON in web ApiControllers. I have verified the following 2 scenarios work.

I have included the following attributes on the property I wish to exclude.

[System.Web.Script.Serialization.ScriptIgnore]
[System.Xml.Serialization.XmlIgnore]

If I manually serialize my object using the JavaScriptSerializer, the property is excluded. Also, if I view the serialized XML output from the web ApiController, the property is excluded. The problem is, the serialized JSON via the web ApiController still contains the property. Is there another attribute that I can use that will exclude the property from JSON serialization?

UPDATE:

I realized all my tests were in a much more complex project and that I hadn't tried this in a an isolated environment. I did this and am still getting the same results. Here is an example of some code that is failing.

public class Person
{
    public string FirstName { get; set; }

    [System.Web.Script.Serialization.ScriptIgnore]
    [System.Xml.Serialization.XmlIgnore]
    public string LastName { get; set; }
}

public class PeopleController : ApiController
{
    public IEnumerable<Person> Get()
    {
        return new[]
                   {
                       new Person{FirstName = "John", LastName = "Doe"},
                       new Person{FirstName = "Jane", LastName = "Doe"}
                   };
    } 
}

Here is the generated output.

JSON:

[
    {
        "FirstName" : "John",
        "LastName" : "Doe"
    },
    {
        "FirstName" : "Jane",
        "LastName" : "Doe"
    }
]

XML:

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfPerson xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <Person>
        <FirstName>John</FirstName>
    </Person>
    <Person>
        <FirstName>Jane</FirstName>
    </Person>
</ArrayOfPerson>

Upvotes: 4

Views: 20760

Answers (5)

JMD
JMD

Reputation: 7377

This is a little late to the game, but IgnoreDataMember is precisely what we need in your/my scenario:

[System.Runtime.Serialization.IgnoreDataMember]
public int NotSerialized { get; set; }

According to the MSDN, IgnoreDataMember came in with .NET 3.0 SP2.

Upvotes: 4

crimbo
crimbo

Reputation: 11281

You can use [JsonIgnore] attribute for a JSON-specific fix; or you can use [DataContract] and [DataMember] for a fix that works both with the JSON formatter, and with the (XML) DataContractSerializer.

This article provides more detailed info on the default media-type formatters:

http://www.asp.net/web-api/overview/formats-and-model-binding/json-and-xml-serialization#json_media_type_formatter

Upvotes: 4

joym8
joym8

Reputation: 4232

JsonIgnore modifies the entire class definition. In case you want to control specific action/request, you can try this approach.

Upvotes: 1

Adam Carr
Adam Carr

Reputation: 2986

Looks like this covers what I need. It shows you you can swap out formatters. It even includes an example formatter that uses the JavaScriptSerializer which is what I need.

http://wildermuth.com/2012/2/22/WebAPI_for_the_MVC_Guy

Upvotes: 0

Mike Wasson
Mike Wasson

Reputation: 6622

Be aware that JSON serialization is changing in Web API.

In the beta release, Web API used DataContractJsonSerializer to serialize JSON. However, this has changed; the latest version of Web API uses json.net by default, although you can override this and use DataContractJsonSerializer instead.

With DataContractJsonSerializer, you can use [DataContract] attributes to control the serialization. I'm stil not very familiar with json.net, so I don't know how it controls serialization.

Upvotes: 4

Related Questions