RESTful web service in c#

Question

I'm building a RESTful web service in c#.

So I have build this DTo Model like this:

namespace WebService.Models
{
    [DataContract(Name = "VitalSigns")]
    public class VitalSignsDTO
    {
        [DataMember(Name = "id", Order = 1)]
        public int id { get; set; }

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

        [DataMember(Name = "valore", Order = 3)]
        public string valore { get; set; }

        [DataMember(Name = "dataOra", Order = 3)]
        public DateTime? dataOra { get; set; }
    }
}

Now, this is the response of JSON:

{
    "id": 1,
    "name": "Altezza corporea",
    "valore": null,
    "dataOra": null
},
{
    "id": 2,
    "name": "Peso corporeo",
    "valore": null,
    "dataOra": null
}

now I want to know, if is possible to hidden valore and dataOra field that not have a value.

Possible duplicate of [How to ignore a property in class if null, using json.net](https://stackoverflow.com/questions/6507889/how-to-ignore-a-property-in-class-if-null-using-json-net) — mjwills, Feb 13 '18 at 12:13
If you are returning an array/collection of json objects I don't think you want to omit fields because it will make it more difficult for the consumer to deal with some that are there and some that are not. — Crowcoder, Feb 13 '18 at 12:14

score 0 · Accepted Answer · edited Feb 13 '18 at 12:27

0

use [JsonIgnore] attribute to your property.

namespace WebService.Models
{
    [DataContract(Name = "VitalSigns")]
    public class VitalSignsDTO
    {
        [DataMember(Name = "id", Order = 1)]
        public int id { get; set; }

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

        [JsonIgnore]
        [DataMember(Name = "valore", Order = 3)]
        public string valore { get; set; }

        [JsonIgnore]
        [DataMember(Name = "dataOra", Order = 3)]
        public DateTime? dataOra { get; set; }
    }
}

edited Feb 13 '18 at 12:27

Jaliya Udagedara

848
8
12

answered Feb 13 '18 at 12:13

programtreasures

4,202
1
9
27

If `dataOra` is set, will it be included in the JSON? – mjwills Feb 13 '18 at 12:19
1

No, it will not. – Jaliya Udagedara Feb 13 '18 at 12:21

Arun Selva Kumar · Answer 2 · 2018-02-13T12:37:12.180

If you are in .Net Core WebAPI, you can configure JSON Serializer in the middleware (Startup.cs).

   public void ConfigureServices(IServiceCollection services)
    {
        services.AddMvc()
                .AddJsonOptions(options => { options.SerializerSettings.NullValueHandling = NullValueHandling.Ignore; });
        services.AddAutoMapper();
        services.RegisterServices();
    }

If you are in ASP.NET WebAPI, refer Suppress properties with null value on ASP.NET Web API

RESTful web service in c#

2 Answers2