How to omit Get only properties in servicestack json serializer?

by

ServiceStack’s Text serializers follows .NET’s DataContract serializer behavior, which means you can ignore data members by using the opt-out [IgnoreDataMember] attribute

public class Poco 
{
    public int Id { get; set; }

    public string Name { get; set; }

    [IgnoreDataMember]
    public string IsIgnored { get; set; }
}

An opt-in alternative is to decorate every property you want serialized with [DataMember]. The remaining properties aren’t serialized, e.g:

[DataContract]
public class Poco 
{
    [DataMember]
    public int Id { get; set; }

    [DataMember]
    public string Name { get; set; }

    public string IsIgnored { get; set; }
}

Finally there’s also a non-intrusive option that doesn’t require attributes, e.g:

JsConfig<Poco>.ExcludePropertyNames = new [] { "IsIgnored" };

Dynamically specifying properties that should be serialized

ServiceStack’s Serializers also supports dynamically controlling serialization by providing conventionally named ShouldSerialize({PropertyName}) methods to indicate whether a property should be serialized or not, e.g:

public class Poco 
{
    public int Id { get; set; }

    public string Name { get; set; }

    public string IsIgnored { get; set; }

    public bool? ShouldSerialize(string fieldName)
    {
        return fieldName == "IsIgnored";
    }
}

More examples in ConditionalSerializationTests.cs

More Related Contents:

  1. Json.NET (Newtonsoft.Json) – Two ‘properties’ with same name?
  2. json.Marshal(struct) returns “{}”
  3. XSLT equivalent for JSON
  4. Why is JSON invalid if an integer begins with a leading zero?
  5. How to merge 2 JSON objects from 2 files using jq?
  6. Load images based on dynamic path in ReactJs
  7. Is there a limit on how much JSON can hold?
  8. Angular 2+ and Observables: Can’t bind to ‘ngModel’ since it isn’t a known property of ‘select’
  9. How to perform partial object serialization providing “paths” using Newtonsoft JSON.NET
  10. Iterating through a JSON file PowerShell
  11. Parsing JSON DateTime from Newtonsoft’s JSON Serializer
  12. OpenAPI: what schema to accept any (complex) JSON value
  13. Using jq how can I split a very large JSON file into multiple files, each a specific quantity of objects?
  14. Return results of a sql query as JSON in oracle 12c
  15. How do I add environment variables to launch.json in VSCode
  16. Twitter API error 215
  17. Partly JSON unmarshal into a map in Go
  18. How do I update a single value in a json document using jq?
  19. How to create multiple tables in jasper report using json as a datasource?
  20. Cannot convert PSCustomObjects within array back to JSON correctly
  21. How to use jq when the variable has reserved characters?
  22. pass JSON to HTTP POST Request
  23. Check if a Postgres JSON array contains a string
  24. Could not write JSON: Infinite recursion (StackOverflowError); nested exception spring boot
  25. Swift 4 Codable – Bool or String values
  26. How to pass payload via JSON file for curl?
  27. Size limit of JSON data type in PostgreSQL
  28. Constructing a JSON object from a bash associative array
  29. “Fatal error: ‘EXTERN.h’ file not found” while installing Perl modules
  30. How to read local json import in flutter?

Leave a Comment