C# MVC4 Web API - Resulting JSON should return objects instead of $ref to object

Question

I have an ASP.NET MVC 4 Web API app using EntityFramework for ORM.

In the JSON I return, there are some cases where the same child node is present for multiple parent nodes. In these cases, the first occurrence of the child node is fully visible with all it's members. Any subsequent occurrence shows up as a $ref to the first occurrence. I'd like instead to see the full object everytime it shows up in the JSON returned.

For example, instead of seeing:

    [{
    "$id": "1",
    "userId": 1,
    "Badge": {
        "$id": "2",
        "badgeId": 1,
        "badgeName": "Gold"
        }
    }, {
    "$id": "3",
    "userId": 2,
    "Badge": {
        "$ref": "2"
        }
    }]

i'd like to see:

    [{
    "$id": "1",
    "userId": 1,
    "Badge": {
        "$id": "2",
        "badgeId": 1,
        "badgeName": "Gold"
        }
    }, {
    "$id": "3",
    "userId": 2,
    "Badge": {
        "$id": "4",
        "badgeId": 1,
        "badgeName": "Gold"
        }
    }]

Basically I want to get rid of any "$ref" in the JSON. Is there a way?

Thanks!

score 1 · Accepted Answer · answered Jul 28 '12 at 05:32

1

An easy way is to edit the generated entity classes code. For each of the entity classes, there will be a [DataContract(IsReference=true)] attribute assigned.

Something like the following:

[EdmEntityTypeAttribute(NamespaceName="YourNamespace", Name="YourEntity")]
[Serializable()]
[DataContractAttribute(IsReference=true)]
public partial class YourEntity : EntityObject
{

Change it to IsReference=false. That should do the trick.

answered Jul 28 '12 at 05:32

Amry

4,791
2
23
24

sorry it took me forever to respond. i didn't know there was an answer. the work-around i resorted to at the time was to explicitly set some of the members of the object to null in the webservice before returning it. I will give this solution a shot as well. thanks! – niltoid Jan 06 '13 at 20:21
Is there a way to do this with the fluent API instead of attributes? – BlackICE Apr 01 '13 at 19:21

score 0 · Answer 2 · answered Jul 28 '20 at 08:53

0

In my case, I'm using the Entity model, I simply set an entity key for a unique field in my .edmx diagram table.

answered Jul 28 '20 at 08:53

Ravikant Gupta

205
2
11

C# MVC4 Web API - Resulting JSON should return objects instead of $ref to object

2 Answers2

Linked