CODEWITHSUNDEEP
c#asp.netjson
user1848850
user1848850

Reputation: 463

Detecting Extra Fields in ASP.NET Web API Request

I have been trying to get the example from this link to work.

I'm trying to detect extra fields in a json request and return an error if they are present.

Here's what I have:

ApiController:

public class MyClassController : ApiController
{
    public IHttpActionResult Add(MyClass myClass)
    {
        if (myClass.ContainsExtra)
        {
            return BadRequest(ModelState);
        }
        ...
     }
...
}

DynamicObject:

public class MyClass : DynamicObject
{
    private Dictionary<string, object> fields =
                        new Dictionary<string, object>(
                             StringComparer.OrdinalIgnoreCase);

    [Required]
    public string FirstName { get; set; }

    [Required]
    public string LastName { get; set; }

    public bool ContainsExtra { get; private set; }

    [JsonIgnore]
    public Dictionary<string, object> Extra
    {
        get { return fields; }
    }

    public override bool TryGetMember(GetMemberBinder binder,
                                              out object value)
    {
        return fields.TryGetValue(binder.Name, out value);
    }

    public override bool TrySetMember(SetMemberBinder binder,
                                                  object value)
    {
        this.ContainsExtra = true;

        fields[binder.Name] = value;
        return true;
    }
}

If I send this Json from Fiddler

{“FirstName”:”Test”, “LastName”:”Test”, “City”:”New York”}

The TrySetMember method should fire and it should set the bool ContainsExtra to true so it can be evaluated in the Add method on MyClassController. When it does contain an extra field, it should return an error to the client.

Unfortunately I just can't seem to get the TrySetMember to fire.

What am I Missing ?

Upvotes: 4

Views: 3096

Answers (1)

user1848850
user1848850

Reputation: 463

I got the functionality that i wanted by simply setting the MissingMemberHandling setting of the JSONMediaTypeFormatter to MissingMemberHandling.Error, in my case I:

WebConfigFile:

// Set up The Json Media Type Formatter
var JsonMTF = new JsonMediaTypeFormatter
{
  SerializerSettings = { MissingMemberHandling = MissingMemberHandling.Error }
};

// Clear all formatters
config.Formatters.Clear();

// Add the JSON formatter
config.Formatters.Add(JsonMTF);

Then write an ActionFilterAttribute:

public class ValidateModelFilterAttribute : ActionFilterAttribute
{
    public override void OnActionExecuting(HttpActionContext filterContext)
    {
        if (!filterContext.ModelState.IsValid)
        {
            filterContext.Response = filterContext.Request.CreateErrorResponse(HttpStatusCode.BadRequest, filterContext.ModelState);
        }
    }
}

Finally add the filter in the WebConfigFile:

// Add Validate Model Filter Attribute 
config.Filters.Add(new ValidateModelFilterAttribute());

Upvotes: 4

Related Questions