JSON Specifications for LIXI2 Standards

LIXI has published JSON schema specifications corresponding to each of the transaction schemas in XML since the 31st October 2017. The production of these JSON schemas has been fully automated in LIXILab, and will be published with each and every standards release. The structural and data type conventions used in defining the JSON schema are described in detail on this page.

The initial work was a collaborative effort between LIXI Limited and the School of Systems, Management and Leadership within the Faculty of Engineering and Information Technology at the University of Technology Sydney.

Note: A quick way to convert between an XML and a JSON message (where the XML conforms to the LIXI2 XML Schema Definition and the JSON conforms to the LIXI2 JSON Schema Definition) is using the LIXI Python Package.

Key requirements

Key requirements that were taken into consideration in determining the conventions used include:

  1. The schema and conversion conventions should ensure no data is lost in either direction (XML to JSON or JSON to XML).
  2. A JSON message's tree structure will remain the same as the XML message structure (parent/child relationships are maintained) so that the existing documentation and related tools remain valid.
  3. A JSON message will implement native JSON types where appropriate (string, number, integer etc.).
  4. If possible, a non-breaking change to the XSD should also be non-breaking to the JSON schema.
  5. Maximise compatibility of the JSON schema with the tools that developers use to generate code based on the schema.
Why JSON?

JSON (JavaScript Object Notation) is a data format designed to encode object data derived from Javascript. It is now widely used as a data exchange format particularly in building APIs. More details about JSON can be found at json.org.

First Published: 1st November 2017 | Last Updated: 4th February 2020