Skip to content

Commit

Permalink
Second public review (#58)
Browse files Browse the repository at this point in the history
* Update 1-sdmx-json-field-guide.md

* Update 2-references.md

* Update 3-full-example-with-comments.md

* Create agri.json

* Update exr-action-delete.json

* Update exr-cross-section.json

* Update exr-flat.json

* Update exr-time-series.json

* Create sdmx-json-data-schema.json

* Delete sdmx-json-data-schema.json

* Update README.md

* Update README.md

* Update 1-sdmx-json-field-guide.md
  • Loading branch information
dosse authored Oct 19, 2018
1 parent 9603f80 commit 1fe7bf3
Show file tree
Hide file tree
Showing 11 changed files with 3,252 additions and 2,118 deletions.
37 changes: 20 additions & 17 deletions data-message/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@
# SDMX-JSON Data Message

SDMX-JSON Data Message is a SDMX data exchange format based on JSON. JSON
(JavaScript Object Notation) is a widely used standardised lightweight data-
interchange format.
As one of the standard SDMX data exchange formats, SDMX-JSON Data Message is
a JSON (JavaScript Object Notation) based data exchange message format
designed for and therefore responding to the main use case of data discovery
and visualisation on the web.

SDMX-JSON Data Message works together with the SDMX RESTful Web Services API. It
will assist developers to write software that requests data responses in JSON
from SDMX RESTful API and processes the data and metadata in the JSON response
in order to produce data visualizations in web. SDMX-JSON Data Message focuses
on data visualisation and it supports all features of the SDMX RESTful API for
data queries.
JSON is a widely used standardised lightweight data-interchange format.
SDMX-JSON with a simple and dense but generic message format that supports
different types of data structures will ease writing software for the web
that easily consumes SDMX data resources. It should allow for an efficient
client-server exchange with few roundtrips, small message sizes and fast
parsing. The format may be used in a wide variety of programming languages
and application programs. Testing and development of the format has focused
on JavaScript applications running in web browsers.

The proposed format conforms to the JSON standard specification, and it supports
the SDMX 2.1 Information Model and the full functionality of the SDMX 2.1
RESTful API for data queries for various types of visualisations. SDMX-JSON
format is streamable from a supporting web service in order to limit the amount
of server resources. It should provide fast responses from a web service: few
roundtrips, small message sizes and fast parsing. In addition, the format aims
to ease the development of client applications with a simple, but generic
message structure that supports different types of data structures.
The SDMX-JSON Data Message format supports the SDMX 2.1 Information Model
and works together with the SDMX 2.1 RESTful Web Services API for data queries.
The SDMX-JSON format is streamable from a supporting web service in order to
limit the amount of server resources.

See:
- docs: for the descriptive documentation
- samples: for message samples
- tools: for the normative JSON schema usable for validation purposes
Loading

0 comments on commit 1fe7bf3

Please sign in to comment.