How to define xml attributes using web api and model binding

Question

I'm creating an xml feed of products which needs to match the clients scheme exactly.

I'm using web api. I would like the property extractDate to be an attribute. The following code is outputting extractDate as an element not an attribute

    public Feed GetProducts()
    {
             var feed = new Feed()
             {
                 extractDate = "extractDate",
                 incremental = true,
                 name = "name",
                 Brands = GetBrands(),
                 Categories = GetCategories(),
                 Products = GetProducts()
             };


         return feed;
    }

Here is my model Feed. Note the following doesn't seem to turn the element into an attribute

[XmlAttribute(AttributeName = "extractDate")]
public class Feed
{
    [XmlAttribute(AttributeName = "extractDate")] //attribute is ignored
    public string extractDate { get; set; }
    public bool incremental { get; set; }
    public string name { get; set; }
    public List<Brand> Brands { get; set; }
    public List<Category> Categories { get; set; } 
    public List<Product> Products { get; set; } 
}

How do i output

<feed extractDate="2012/01/01" 

// other logic

/>

possible duplicate of How do I bind XML Attributes to the action model in MVC Web API? — Daniel A. White
– Daniel A. White, Commented Jun 3, 2013 at 12:19
The above post appear to be related to the beta release. I've read this but not sure it's applicable now . My hunch is that i'm missing something obviously — frosty
– frosty, Commented Jun 3, 2013 at 12:57

Kiran · Accepted Answer · 2013-06-03 17:34:58Z

11

Web API by default uses DataContractSerializer in XmlMediaTypeFormatter and probably that's the reason you are not seeing your attribute decorations taking effect. Do you have the XmlSerializer enabled on the XmlMediaTypeFormatter to see your expected output?

config.Formatters.XmlFormatter.UseXmlSerializer = true;

Also, you could set XmlSerializer only for specific types too using the following api:

config.Formatters.XmlFormatter.SetSerializer<>

edited Jun 3, 2013 at 17:34

answered Jun 3, 2013 at 17:29

Kiran

58.1k16 gold badges179 silver badges163 bronze badges

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

Comments

Kristof · Accepted Answer · 2013-06-04 06:24:13Z

3

Edit
Managed to simulate your issue with a blank project and Kiran's answer seems to do the trick.
Just add this line in your controller(for testing purposes, it should probably be in your global.asax)

GlobalConfiguration.Configuration.Formatters.XmlFormatter.UseXmlSerializer = true;

Do you have the [XmlRoot] on top of your class or is it missing?
Not sure the attribute will work without an xml class decorator.
A simple sanity check you could do is serialize the class without web api involved to make sure it's nothing silly but actually web api related.

edited Jun 4, 2013 at 6:24

answered Jun 3, 2013 at 13:27

Kristof

3,3351 gold badge22 silver badges31 bronze badges

2 Comments

frosty Over a year ago

thanks, very useful. So i've added [XmlRoot] above my class name with no change I've just tested using the xml.serializer and the attributes are correct in this version. Is there a way i could output the serialize version from web api.

SixOThree Over a year ago

This line of code fixed the problem I was having with Web Api "ignoring" the XmlRootAttribute and XmlTypeAttribute of my complex types being used as parameters and returns.

pobed2 · Accepted Answer · 2013-06-03 15:17:38Z

0

How about this:

[XmlRoot("feed")]
public class Feed
{
     [XmlAttribute(AttributeName = "extractDate")]
     public string extractDate { get; set; }

     public bool incremental { get; set; }
     public string name { get; set; }
     public List<Brand> Brands { get; set; }
     public List<Category> Categories { get; set; } 
     public List<Product> Products { get; set; } 
}

answered Jun 3, 2013 at 15:17

pobed2

3592 silver badges9 bronze badges

3 Comments

frosty Over a year ago

hi, thanks for your comment. I've tried this. But still doesn't effect the output. Does this work for you?

pobed2 Over a year ago

It does actually. It might be stupid, but try putting an [XmlElement] on top of the others fields...

tartakynov Over a year ago

and don't forget about GlobalConfiguration.Configuration.Formatters.XmlFormatter.UseXmlSerializer = true;

Collectives™ on Stack Overflow

How to define xml attributes using web api and model binding

3 Answers 3

Comments

2 Comments

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

2 Comments

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related