BWS Status Message Schema Documentation

The BWS method Status returns an XML string containing information about the running BWS installation. The XML string is formated according to the http://schemas.bioid.com/2012/10/BWSStatus (XSD file) schema namespace.

(Note that this format is used beginning with version 1.6. Up to version 1.5 we used the namespace http://schemas.bioid.com/2012/02/BWSStatus)

The status message contains information about the deployment of the BWS installation that has been queried for the status. This includes its product version and the complete deployment label. For a list of the features of the different product versions please refer to the BWS Version History. Besides the version information, a list of the available storages, together with the enabled features, is part of the status message.

Parsing such an XML status message is very simple. Here is an example of how to do it in C#:


// parse the status message as returned by a call to the BWS Status method:
using (XmlReader reader = XmlReader.Create(new StringReader(status)))
{
    XmlSerializer serializer = new XmlSerializer(typeof(BWSStatus), "http://schemas.bioid.com/2012/10/BWSStatus");
    BWSStatus stat = (BWSStatus)serializer.Deserialize(reader);
}
// these are the classes we use for the deserialization:
[XmlRoot(ElementName = "BWS", Namespace = "http://schemas.bioid.com/2012/10/BWSStatus")]
public class BWSStatus
{
    [XmlAttribute]
    public string Version { get; set; }
    [XmlAttribute]
    public string Label { get; set; }
    [XmlElement("Feature")]
    public Feature[] Features { get; set; }
}
public class Feature
{
    [XmlAttribute]
    public string Name { get; set; }
    [XmlAttribute]
    public string Traits { get; set; }
    [XmlAttribute]
    public string Storage { get; set; }
    [XmlAttribute]
    public string Partitions { get; set; }
}