How to hide/show the result JSON using verbose parameter in ASP.net Web API

Question

I've written an ASP.Net web API, my requirement to show the full/some result (s) JSON based on the parameter i.e., verbose=true

To Explain this requirements.

My current JSON is

Without verbose

GET Method:

api/v1/patient?Key=1

{
    "user": {           
            "key": 1,
            "suffix": "1",
            "firstName": "Dhanu",
            "lastName": "Kumar",
            "middleName": "",
            "address": {
                "address1": "uuu",
                "address2": "TTT",
                "address3": "xx",
                "city": "yy"           
            }
        }
}

With verbose

api/v1/patient?Key=1&verbose=true

{
    "user": {           
            "key": 1,
            "firstName": "Dhanu",
            "lastName": "Kumar",
            "middleName": ""
        }
}

My User.cs

public UserDTO()
{
    public int Key { get; set; }
    public string Suffix { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public string MiddleName { get; set; }
    public Address Address {get;set;}       
}

Based on the verbose parameter, I'll Hide/Show some fields from the JSON.

Is there any way to achieve this?

Try using inheritance and have the endpoint return the type based on provided parameter. — Nkosi
– Nkosi, Commented May 22, 2018 at 16:23
@Nkosi Is there any other way without creating a new Class? I mean some annotation/quick way to denote that fields alone in the same class to show based on the verbose value ? — Jayendran
– Jayendran, Commented May 22, 2018 at 16:33
I mean you could always manually construct the response message...that will be a lot more work though — information_interchange
– information_interchange, Commented May 22, 2018 at 23:08

Nkosi · Accepted Answer · 2018-05-22 16:33:38Z

4

You can use inheritance

public class UserDTO {
    public int Key { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public string MiddleName { get; set; }    
}

public class VerboseUserDTO: UserDTO {
    public string Suffix { get; set; }
    public Address Address {get;set;}       
}

and have the endpoint return the type based on provided parameter.

//api/v1/patient
public IHttpActionResult Get(int key, bool verbose = false) {
    //...get data based on key

    if(data == nul)
        return NotFound();

    if(verbose) {
        var verboseDto = new { 
            user = new VerboseUserDTO {
                //...populated from data
            }
        };
        return Ok(verboseDto);
    }

    var dto = new { 
        user =  new UserDTO {
            //...populated from data    
        }
    };    
    return Ok(dto);
}

edited May 22, 2018 at 16:33

answered May 22, 2018 at 16:26

Nkosi

249k38 gold badges472 silver badges506 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to hide/show the result JSON using verbose parameter in ASP.net Web API

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related