web api method to return data in json format?

Question

I am making a web api call and I want the controller method to return data in json format.

The model class I used is User.cs :

public partial class User
{
     public int UserID { get; set; }
     public string city { get; set; }
     public string email { get; set; }
     public string firstName { get; set; }
     public string lastName { get; set; }
     public string phone { get; set; }
     public string password { get; set; }
 }

I want to return all the users email data in json format through the following controller method.

public string GetUsers()
{
   IEnumerable<User> users = db.Users.ToList();
   var jsonSerialiser = new JavaScriptSerializer();
   var json = jsonSerialiser.Serialize(users);
   return json;
   //string json = JsonConvert.SerializeObject(users);
   //return json;
}

All I am getting is empty json like:

[]

Please help. I have covered all the methods recommended on stackoverflow.

jgauffin · Accepted Answer · 2015-02-24 14:39:07Z

3

This is a lot simpler than you think, you do not need to use a jsonSerializer.

You can change your method to the following:

public List<string> GetEmails()
{
    return db.Users.Select(e => e.email).ToList();
}

Then if the client specifies application/json the content is returned as json.

Please note with the above, I am only sending back the email address and not the full user details as I very much doubt you will want to send passwords out as json.

edited Feb 24, 2015 at 14:39

jgauffin

101k45 gold badges245 silver badges378 bronze badges

answered Feb 24, 2015 at 14:11

hutchonoid

33.4k15 gold badges102 silver badges106 bronze badges

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

6 Comments

jgauffin Over a year ago

your code wont work. you create an object with an email property but try to return it as a string. Either just .Select() the email or change the return type to List<object>

hutchonoid Over a year ago

@jgauffin Good point, I originally had it like above but changed it. Updated now, thanks.

jgauffin Over a year ago

you still returned an object. corrected it for you ;) Either way a +1 for the explanation why it works (and how).

hutchonoid Over a year ago

@jgauffin Thanks again, that will teach me for trying to answer without testing first. Too worried someone beats me to the answer. :)

smriti Over a year ago

what if I want to call my api like api/user to show me the firstName and email of all users in json format.

|

Collectives™ on Stack Overflow

web api method to return data in json format?

1 Answer 1

6 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

6 Comments

Your Answer

Sign up or log in

Post as a guest

Related