ERP/2.50/Developers Guide/Reference/REST XML Schema Definition

REST XML Schema Definition

The REST web services produce and consume XML which should adhere to a certain XML Schema. The XML Schema is generated by Openbravo ERP on the basis of the model in the Application Dictionary.

You can always retrieve the XML Schema from your running Openbravo ERP instance calling this webservice (enter it in the browser):

http://localhost:8080/openbravo/ws/dal/schema

This XML Schema is generated from the model as it is defined in the Application Dictionary.

The REST XML Schema for this version of Openbravo ERP can also be downloaded.

A number of things to note about the Openbravo REST XML Schema:

• All elements have minOccurs="0": this is to support xml messages which only update part of an object. In this case only the updated elements have to be passed. This minOccurs="0" is also used to support read-restrictions when retrieving data. To see which elements are really mandatory, see the nillable attribute which is also present (next to minOccurs) on each element definition.
• Primitive typed elements (like a name or description) also have attributes (transient or inactive for example). This means that these elements are modeled using a complexType which extends a simpleType. See the complexType definitions at the end of the XML Schema.

 Entity Model |  Hibernate Mapping