This article shows how to pass objects generated using Liquid XML Studio's XML Data Binder as parameters in a .Net Web Service.
See Also: Using XML Data Binding Objects in a WCF Web Service
In our example we are producing a Web Service that will provide information about a given product, given a product code.
The information returned describes the product, pricing, and stock levels.
The previous diagram show the XML Schema used to generate our data binding objects, the full schema is available here.
So we would like to build a web service with a web method that takes a ProductDetailsRequestType and returns a ProductDetailsResponseType.
Once we have generated our XML Data Binding class library from the schema, we can pull together our web service. The first thing to do is declare our web method.
[WebService(Namespace = "http://www.liquid-technologies.com/ProductDetailsSample")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
public class Service1 : System.Web.Services.WebService
[WebMethod(Description = "Gets the details about a given product.")]
public ProductDetailsResponse RequestProductDetails(ProductDetailsRequest productRequest)
ProductDetailsResponse response = new ProductDetailsResponse();
response.ProductDetails.Name = "Widget";
"The important widget that goes between the flange and the spindle";
response.ProductDetails.Price = 25.36;
response.ProductDetails.StockLevel = 15000;
Note the web service uses the targetNamespace from the XML Schema we defined at the start of the example. The web method takes in and returns the Data Bound classes generated by Liquid XML Studio.
If we left things here then the .Net framework would use its default serializer on our ProductDetailsRequest and ProductDetailsResponse objects. This works using reflection and would end up serializing a large amount of unwanted properties. Instead we are going to let these objects serialize themselves. In order to do this we must tell the framework about them.
partial class ProductDetailsRequest
// This is the method named by the XmlSchemaProviderAttribute applied to the type.
public static XmlQualifiedName MySchema(XmlSchemaSet xs)
// This method is called by the framework to get the schema for this type.
// We return an existing schema from disk.
if (xs.Schemas("http://www.liquid-technologies.com/ProductDetailsSample").Count == 0)
using (FileStream fs = new FileStream(@"ProductEnquiry.xsd", FileMode.Open))
XmlSchema s = XmlSchema.Read(fs, null);
return new XmlQualifiedName("ProductDetailsQueryType",
In order for the framework to be able to correctly describe the web service we first need to tell it about the schema. This is done by adding the XmlSchemaProvider attribute to all classes that are in or out parameters in the web service.
The XmlSchemaProvider attribute tells the framework that information about the schema can be obtained by calling the “MySchema” method. Now when the framework is trying to describe the web service it will call the MySchema method.
The framework expects our implementation of MySchema to add all the schemas it needs to know about into the schema set collection, so if you are working with elements from external schemas (HL7, FpML etc) then you can add these to the schemas collection as well.
The return parameter from MySchemas is the fully qualified name of the type within our XSD that describes the parameter. Note this must be a complexType, the .Net framework will not allow you to specify an element.
Because your web service contains complex parameters it is not possible to call it via the simple Web Service Explorer.
So in order to call it you need to either build yourself a test harness or use a test tool. Liquid XML Studio contains a handy tool for calling web services. This will automatically generate the request envelope and message, allowing you to modify can call it.
View Full Sample Request
View Full Sample Response
Examining Our Web Service
Because we have taken control of the serialization process the WSDL describing your web service contains the contents of the schemas that you added in via the MySchema method.
View Full WSDL for the sample Web Service
It is also possible to explore this graphically using the Web service Call Composer in Liquid XML Studio
Download the Full project source code
Liquid XML Studio - Developer Edition - Versions 220.127.116.116 and higher