Writing an inline schema for my XML which is returned from my web service.

I would NOT return XML or Datasets.  My approach below binds the type to the schema and generates WSDL that includes the schema constraints.  If you use XMLDocument as return type then it will show in WSDL is </any> and that is bad.  Instead use this approach which binds to an xml schema.  This or using WSCF is the very best approach for doing web services the right way.


[XmlSchemaProvider("GetCustomerSchema")]
[XmlRoot("Customer", Namespace = "http://tempuri.com/Customer/v1")]

public class Customer : IXmlSerializable
{
    public string FirstName;

    public string LastName;

    public DateTime DOB;

    public string SSN;

    //serialization code.

    private static readonly string ns = "http://tempuri.com/Customer/v1";

    #region IXmlSerializable Members

    public XmlSchema GetSchema()
    {
        return null;
    }

    public void ReadXml(XmlReader reader) { }

    public void WriteXml(XmlWriter writer)
    {
        writer.WriteElementString("FirstName", ns, FirstName);
        writer.WriteElementString("LastName", ns, LastName);
        writer.WriteElementString("DOB", ns, DOB.ToShortDateString());
        writer.WriteElementString("SSN", ns, SSN);
    }

    #endregion

    public static XmlQualifiedName GetCustomerSchema(XmlSchemaSet xs)
    {
        XmlSerializer schemaSerializer = new XmlSerializer(typeof(XmlSchema));

        string xsdPath = "CustomerSchema.xsd";

        XmlSchema s = (XmlSchema)schemaSerializer.Deserialize(
            new XmlTextReader(xsdPath), null);

        xs.XmlResolver = new XmlUrlResolver();

        xs.Add(s);

        return new XmlQualifiedName("Customer", ns);
    }
}

Put this code in and run it.  You'll see the magic when you look at the WSDL generated and how nice it works on the other side of the wire.  Also you'll get near perfect interop with non .NET languages this way.  Also the interface nicely.

hi devsolns,

i am excited about your answer but i am little but confused...

Are you saying that in my webservice that i should used XMLdocument?

I actually do this

[WebMethod(Description="Returns test data")]
            public XmlDocument Gettestdata(string codCliente)
            {

and on the other side i.e.the app that calls the webservice i set the retun type to a xmlNode so i can use xpath to interrogate it

Are you saying i should be doing a different way?

Thanks in advance

Ian

The problem with returning an XMLDocument type is the user of your service/wsdl has an unknown interface.  All its going to say is the return is "some" xml document but i can tell you whats in it hence the reason you wanted to put in an inline schema.

The approach above solves both issues.  It provides the exact interface and what elements are included in the Customer object and it also includes the xml schema declaration in the wsdl.