JSON Specifications for LIXI2 Standards

LIXI is pleased to announce the publication of RFC (Request For Comment) JSON schema corresponding to each of the transaction XML schema in the LIXI Master Schema 2.2.6 (incorporating CAL 2.6.6; DAS 2.2.6; CNZ 2.0.6 & CDA 2.0.4) on the 31st October 2017 and the the LIXI Master Schema 2.2.7 (incorporating CAL 2.6.7; DAS 2.2.7; CNZ 2.0.7 & CDA 2.0.5) on the 1st December 2017.

LIXI will continue to publish JSON schema artefacts with every LIXI2 transaction schema release.

LIXI will also provide an API for converting LIXI conformant XML to LIXI conformant JSON and vice versa.

This is a collaborative effort with the School of Systems, Management and Leadership within the Faculty of Engineering and Information Technology at the University of Technology Sydney.

To assist, we have published documentation describing the conventions that the LIXI2 JSON schema are based on and some notes on the conversion process and a demonstration tool that converts LIXI2 messages between XML and JSON in both directions.

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.
Documentation & Resources
Message Conversion Tool
LIXI has prepared a demonstration tool (available to registered users) that allows testing of bi-directional message conversions based on the proposed structural and data type conventions.

Conventions Documentation
The structural and data type conventions used are described in detail on this page.

JSON is a data format that was designed to encode object data derived from Javascript (JSON is an abbreviation for JavaScript Object Notation). It is now very widely used as a data exchange format on the internet, and in particular for providing data to APIs.

More details about the JSON data format can be found at json.org.

Updated: 11th December 2017