I can't seem to prevent Web API/JSON.NET from using Newtonsoft.Json.PreserveReferencesHandling.Objects
when serializing objects. In other words, $id/$ref are always used in the serialized objects despite using the following settings:
public class MvcApplication : System.Web.HttpApplication {
protected void Application_Start () {
WebApiConfig.Register(GlobalConfiguration.Configuration);
}
}
public static class WebApiConfig {
public static void Register (HttpConfiguration config) {
JsonMediaTypeFormatter jsonFormatter = config.Formatters.OfType<JsonMediaTypeFormatter>().Single();
jsonFormatter.UseDataContractJsonSerializer = false;
jsonFormatter.SerializerSettings.Formatting = Newtonsoft.Json.Formatting.Indented;
jsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
jsonFormatter.SerializerSettings.PreserveReferencesHandling = Newtonsoft.Json.PreserveReferencesHandling.None;
}
}
Any ideas?
Put this in the Global.asax to configure reference handling. PreserveReferencesHandling should not be 'All'
GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.PreserveReferencesHandling = Newtonsoft.Json.PreserveReferencesHandling.None;
Here is some javascript I'm using to handle the $id/$ref objects on the client side:
// function to return a JSON object form a JSON.NET serialized object with $id/$ref key-values
// obj: the obj of interest.
// parentObj: the top level object containing all child objects as serialized by JSON.NET.
function getJsonNetObject(obj, parentObj) {
// check if obj has $id key.
var objId = obj["$id"];
if (typeof (objId) !== "undefined" && objId != null) {
// $id key exists, so you have the actual object... return it
return obj;
}
// $id did not exist, so check if $ref key exists.
objId = obj["$ref"];
if (typeof (objId) !== "undefined" && objId != null) {
// $ref exists, we need to get the actual object by searching the parent object for $id
return getJsonNetObjectById(parentObj, objId);
}
// $id and $ref did not exist... return null
return null;
}
// function to return a JSON object by $id
// parentObj: the top level object containing all child objects as serialized by JSON.NET.
// id: the $id value of interest
function getJsonNetObjectById(parentObj, id) {
// check if $id key exists.
var objId = parentObj["$id"];
if (typeof (objId) !== "undefined" && objId != null && objId == id) {
// $id key exists, and the id matches the id of interest, so you have the object... return it
return parentObj;
}
for (var i in parentObj) {
if (typeof (parentObj[i]) == "object" && parentObj[i] != null) {
//going one step down in the object tree
var result = getJsonNetObjectById(parentObj[i], id);
if (result != null) {
// return found object
return result;
}
}
}
return null;
}
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With