Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,25 @@ This includes:
- Normative documentation and samples for the SDMX-JSON data message format
- Normative documentation and samples for the SDMX-JSON metadata message format

The current release version is SDMX-JSON 2.1.0
The schemas are published to <https://json.sdmx.org>

## Repository Structure

- `docs/` — Markdown content pages for the SDMX-JSON specification.
- `mkdocs.yml` — MkDocs configuration integrating this component into the
`sdmx-docs` site.

## Version Branches

Each release of this component is maintained on a dedicated branch following the
pattern `X.Y.x` (e.g., `2.1.x`). The branch tracked by the
[`sdmx-docs`](https://github.com/sdmx-twg/sdmx-docs) parent repository is
declared in `.gitmodules` at the root of that repo. Switching the tracked branch
in the parent repository is how a new version of this component is published on
the documentation site.

## Formatting Conventions

For Markdown and MkDocs formatting conventions that apply to content in `docs/`,
see the [`sdmx-docs` README](https://github.com/sdmx-twg/sdmx-docs#readme).

The schemas are published to https://json.sdmx.org
14 changes: 0 additions & 14 deletions data-message/docs/0-status.md

This file was deleted.

1,774 changes: 0 additions & 1,774 deletions data-message/docs/1-sdmx-json-field-guide.md

This file was deleted.

Binary file removed data-message/docs/images/logo.png
Binary file not shown.
34 changes: 0 additions & 34 deletions data-message/docs/tools/Makefile

This file was deleted.

Empty file removed data-message/docs/tools/README.md
Empty file.
27 changes: 0 additions & 27 deletions data-message/docs/tools/doc-style.html

This file was deleted.

21 changes: 0 additions & 21 deletions data-message/docs/tools/options.sty

This file was deleted.

3 changes: 0 additions & 3 deletions data-message/docs/tools/title.txt

This file was deleted.

44 changes: 44 additions & 0 deletions docs/data_message/0_Introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Introduction to SDMX-JSON Data Message 2.1.0

Let's first start with a brief introduction of the SDMX information model.

In order to make sense of some statistical data, we need to know the concepts
associated with them. For example, on its own the figure 1.2953 is pretty meaningless,
but if we know that this is an exchange rate for the US dollar against the euro on
23 November 2006, it starts making more sense.

There are two types of concepts: dimensions and attributes. Dimensions, when combined,
allow to uniquely identifying statistical data. Attributes on the other hand do not help
identifying statistical data, but they add useful information (like the unit of measure
or the number of decimals). Dimensions and attributes are known as "components".
Since SDMX 3.0, attributes in SDMX-JSON 2.X.X also include reference metadata attributes.

The measurement of some phenomenon (e.g. the figure 1.2953 mentioned above) is known as an
"observation" in SDMX. Sometimes, observations can also have several measures, e.g. an
estimated value can be complemented with the value corresponding to the upper confidence
limit and the value corresponding to the lower confidence limit of the esimation.
Observations, when exchanged, are grouped together into a "data set". However, there
can also be an intermediate grouping. For example, all exchange rates for the US dollar
against the euro can be measured on a daily basis and these measures can then be
grouped together, in a so-called "time series". Similarly, you can group a collection of
observations made at the same point in time, in a "cross-section" (for example,
the values of the US dollar, the Japanese yen and the Swiss franc against the euro at a
particular date). Of course, these intermediate groupings are entirely optional and you
may simply decide to have a flat list of observations in your data set.

The SDMX information model is much richer than this limited introduction;
however the above should be sufficient to understand the sdmx-json format. For
additional information, please refer to the [SDMX documentation](../../index.md).

Samples, tools and other SDMX-JSON resources are available in the public
[Github repository](https://github.com/sdmx-twg/sdmx-json).

Before we start, let's clarify a few more things about this guide:

- New fields may be introduced in later versions. Therefore
consuming applications should tolerate the addition of new fields with ease.
- The ordering of fields in objects is undefined. The fields may appear in any order
and consuming applications should not rely on any specific ordering. It is safe to consider a
nulled field and the absence of a field as the same thing.
- Not all fields appear in all contexts. For example response with error status messages
may not contain fields for data, dimensions and attributes.
Loading