How to serialize a List of Objects returned from a webservice in C# ASP.NET 3.5?

Question

Here is the XML that I'd like the webservice to deliver:

<business>
  <locations>
    <location>location 1</location>
    <location>location 2</location>
  </locations>
</business>

However, instead the following is being returned:

<business>
  <locations>
    <location>
      <name>location 1</name>
    </location>
    <location>
       <name>location 2</name>
    </location>
  </locations>
</business>

Here is the code used:

    [WebMethod, ScriptMethod(ResponseFormat = ResponseFormat.Xml)]
    public Business GetBusiness()
    {
        var business = new Business();
        business.Locations = new List<Location>();
        business.Locations.Add(new Location { Name = "location 1" });
        business.Locations.Add(new Location { Name = "location 2" });
        return business;
    }

    [XmlType(TypeName = "business")]
    public class Business
    {
        [XmlArray(ElementName = "locations")]
        [XmlArrayItem(ElementName = "location")]
        public List<Location> Locations { get; set; }
    }

    [XmlType(TypeName = "location")]
    public class Location
    {
        [XmlElement(ElementName = "name")]
        public string Name { get; set; }
    }

How does one get the location string include the location tag instead of having a name tag?

TIA, George

nemesv · Accepted Answer · 2012-08-11 20:38:59Z

3

You need to use the XmlTextAttribute on the Name member to treat it as the text of an XML element:

[XmlType(TypeName = "location")]
public class Location
{
    [XmlText()]
    public string Name { get; set; }
}

answered Aug 11, 2012 at 20:38

nemesv

140k16 gold badges424 silver badges364 bronze badges

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

1 Comment

George Aguiar Over a year ago

YES! That is the trick I've been looking for... XmlText works perfectly, thank you.

hmqcnoesy · Accepted Answer · 2012-08-11 20:45:14Z

Why not just use a list of strings for locations instead of a list of location objects?

    [WebMethod, ScriptMethod(ResponseFormat = ResponseFormat.Xml)]
    public Business GetBusiness()
    {
        var business = new Business();
        business.Locations = new List<string>();
        business.Locations.Add("location 1");
        business.Locations.Add("location 2");
        return business;
    }

    [XmlType(TypeName = "business")]
    public class Business
    {
        [XmlArray(ElementName = "locations")]
        [XmlArrayItem(ElementName = "location")]
        public List<string> Locations { get; set; }
    }

    //[XmlType(TypeName = "location")]
    //public class Location
    //{
    //    [XmlElement(ElementName = "name")]
    //    public string Name { get; set; }
    //}

That results in the XML you're looking for.

RedFury · Accepted Answer · 2012-08-11 20:55:00Z

You can control the serialization and deserialization process using a number of methods specified in MSDN: http://msdn.microsoft.com/en-us/library/ty01x675%28v=vs.80%29.aspx

In your case you are serializing a list of locations, using the ElementName "location". If you were serializing a list of strings public List<string> Locations {get; set; } you would get the expected result. The Location object you use places an extra level in the hiearchy, thus is serialized on it's own with it's own properties (like name).

If you implement the ISerializable interface on the Locations class, you will be in full control of the generated XML output, and can simply pass back the contents of your 'Name' property.

Collectives™ on Stack Overflow

How to serialize a List of Objects returned from a webservice in C# ASP.NET 3.5?

3 Answers 3

1 Comment

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related