DataMember Name property not working in entity framework

Question

I have Dto like this:

public class OptimizationNodeDto : IModelWithId
    {        
        public int Id { get; set; }

        [DataMember(Name = "parentId")]
        public int? ParentOptimizationNodeId { get; set; }

        [DataMember(Name = "name")]
        public string Text { get; set; }

        [DataMember(Name = "opened")]
        public bool IsOpened { get; set; }

        [DataMember(Name = "selected")]
        public SelectedStates SelectedState { get; set; }

        public List<OptimizationNodeDto> Children { get; set; }
    }

I want that when I send this object with any API it should give property name in JSON as like mentioned in DataMember but it's not happening. For ex.ParentOptimizationNodeId should be as parentId in JSON result. Here I am sending the Dto:

 [Route("{roleId}/Optimizations")]
        [HttpPost]
        public IHttpActionResult GetOptimizationList([FromUri]int roleId, [FromBody] FilterDto filter)
        {
            try
            {
                var groupManBo = _serviceLocator.Resolve<IRoleManagerBo>();
                return Ok(groupManBo.GetOptimization(roleId, this.ViewboxUser, filter));
            }
            catch (Exception ex)
            {
                return this.HandleError(ex);
            }
        }

I am new for Json serialiser. Will you please suggest steps to do it. — Dipak, Mar 17 '17 at 11:38
Okay so I think `[DataMember]` isn't the correct attribute to rename your JSON keys, I think `[JsonProperty(PropertyName="")]` is the one you want. — Callum Linington, Mar 17 '17 at 11:47
Are you also marking your type with [`[DataContract]`](https://msdn.microsoft.com/en-us/library/system.runtime.serialization.datacontractattribute.aspx)? From your question it looks as though you may not be, but perhaps you omitted the attribute when you pasted your code into the question. — dbc, Mar 19 '17 at 18:35

score 7 · Accepted Answer · answered Mar 19 '17 at 19:15

DataMemberAttribute is ignored by both Json.NET and DataContractJsonSerializer unless [DataContract] is also applied to the type itself. From the docs:

Apply the DataMemberAttribute attribute in conjunction with the DataContractAttribute to identify members of a type that are part of a data contract.

Thus your DTO must look like:

[DataContract]
public class OptimizationNodeDto : IModelWithId
{
    [DataMember]
    public int Id { get; set; }

    [DataMember(Name = "parentId")]
    public int? ParentOptimizationNodeId { get; set; }

    [DataMember(Name = "name")]
    public string Text { get; set; }

    [DataMember(Name = "opened")]
    public bool IsOpened { get; set; }

    [DataMember(Name = "selected")]
    public SelectedStates SelectedState { get; set; }

    [DataMember]
    public List<OptimizationNodeDto> Children { get; set; }
}

Note that data contract serialization is opt-in so you now must also mark Id and Children with [DataMember].

score 2 · Answer 2 · edited May 23 '17 at 12:09

2

See .NET NewtonSoft JSON deserialize map to a different property name

[JsonProperty("new name")]
public string SomeColumn { get; set; }

However, this would assume you are using Newtonsoft as the JSON serializer. If you replaced it with a different one, you'd have to use the attributes specific to that serializer.

edited May 23 '17 at 12:09

Community

1
1

answered Mar 17 '17 at 20:05

Daniel Lorenz

4,178
1
32
39

DataMember Name property not working in entity framework

2 Answers2