How do I return a list as a JSON object with a nested array instead of just an array?

Question

Using ASP.NET Core web API framework, my controller returns a list, which currently formats its output in JSON as a plain array. How do I wrap an object around this so it outputs as an object with an array nested inside of it instead?

I know that I can do this by creating a new class to hold this list as a property, but I wanted to know if there is a cleaner way that I can do this code block (especially since the class would only be used for this method).

My controller code is as follows:

public async Task<IActionResult> GetIntranets(string utilityServer,
     string configuration) {

     List<Intranet> intranets = 
          await _intranetService.GetIntranets(utilityServer, configuration);
            
     return new OkObjectResult(intranets);
}

Current output:

[
  {
    "name": "Intranet 1",
    "taskmanPath": "\\\\hostname\\syteline",
    "reportPreviewUrl": "https://cname.domain.com/slreports",
    "reportServerUrl": "http://hostname/ReportServer_XYZ_TEST",
    "masterSite": "DALS"
  },
  {
    "name": "Intranet 2",
    "taskmanPath": "\\\\hostname\\syteline",
    "reportPreviewUrl": "https://cname.domain.com/slreports",
    "reportServerUrl": "http://fqdn/ReportServer_XYZ_PILOT",
    "masterSite": "DALS"
  },
]

Desired output:

{
  "Intranets": [
    {
      "name": "Intranet 1",
      "taskmanPath": "\\\\hostname\\syteline",
      "reportPreviewUrl": "https://cname.domain.com/slreports",
      "reportServerUrl": "http://hostname/ReportServer_XYZ_TEST",
      "masterSite": "DALS"
    },
    {
      "name": "Intranet 2",
      "taskmanPath": "\\\\hostname\\syteline",
      "reportPreviewUrl": "https://cname.domain.com/slreports",
      "reportServerUrl": "http://fqdn/ReportServer_XYZ_PILOT",
      "masterSite": "DALS"
    }
  ]
}

Michael · Accepted Answer · 2020-08-29 06:18:59Z

4

If you change your code to look like this:

public async Task<IActionResult> GetIntranets(string utilityServer, string configuration)
{
     List<Intranet> intranets = 
          await _intranetService.GetIntranets(utilityServer, configuration);
     
     var objectWrapper = new 
     {
        Intranets = intranets
     };     
     return new OkObjectResult(objectWrapper);
}

An anonymous object will be created and serialized how you want it to be. There was an answer regarding the fact that anonymous types shouldn't be used because of type safety, but by returning an OkObjectResult you are dealing with type of object anyway, which already disregards type safety.

This wasn't mentioned in your question, but in case you are wondering how to deserialize it, you can take a look at this good example: https://www.newtonsoft.com/json/help/html/DeserializeAnonymousType.htm

edited Aug 29, 2020 at 6:18

answered Aug 29, 2020 at 0:07

Michael

863 bronze badges

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

4 Comments

Tanveer Badar Over a year ago

Note that this will output { "Data" : [ ] } rather than { "Intranets" : [ ] }.

Michael Over a year ago

I edited the name of the variable, so it is a direct answer, thanks.

Michael Over a year ago

@Tanveer Badar, Btw, I don't have enough rep to put a comment on your answer, but I don't believe your second answer compiles, doesn't a tuple need two elements minimum?

Tanveer Badar Over a year ago

I have removed that post now since removing the tuple version would just leave it a rewording of your answer without adding anything new.

Collectives™ on Stack Overflow

How do I return a list as a JSON object with a nested array instead of just an array?

1 Answer 1

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related