Child pages
  • API Statistics - migrating from JSON web service to API Statistics

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

All visualisation application must be migrated to use the DissChain WDDS Translator.

When doing the migration, the following need to be taken into consideration:

...

  • JSON-stat HREF element contains all parameters:

    • The HREF property at the root contains the URL of the request

  • JSON-stat “updated” property contains a date instead of timestamp:

    • if no time is specified, the value of "updated” should contain a date and not a timestamp with 0 values set for time

  • JSON-stat “source” value is “Eurostat”, instead of “ESTAT”.

Anchor
DECOMMISSION
DECOMMISSION
Methods, parameters and elements to be decommissioned in

...

API Statistics

The table below are lists the methods, parameters and elements that will be decommissioned in RENOV WDDS TranslatorAPI Statistics:

target

method


filterNonGeo

method


getRegionalCategorization

method

The "geo_categorical" parameter is used for the UNICODE which won’t be supported anymore.

getCountryLabel

method

The "country_label" parameter is used for the UNICODE which won’t be supported anymore.

callBack

method

callBack is replaced by CORS.

precision

parameter

The "precision" parameter is used for the UNICODE which won’t be supported anymore.

shortLabel

parameter


groupedIndicators

parameter


unitLabel

parameter


HREF

Response JSON-stat element

Not used.

The methods and parameters that will be carried on to the RENOV WDDS Translator API Statistics are:

  • lastTimePeriod

  • sinceTimePeriod

  • untilTimePeriod

  • geoLevel, can be multiple and available values are:

    • aggregate: European aggregates based on a white list - EU15, EU25, EU27_2007, EU27_2019, EU28, EA19, etc.
    • country: any country code (EU Member States, or EFTA, or Candidate Countries or other countries) - any 2 digits - i.e. FR

    • nuts1: NUTS code level 1 - any 3 digits - i.e. FR4 (see this page for more information about NUTS classification)

    • nuts2: NUTS code level 2 - any 4 digits - i.e. FR41 (see this page for more information about NUTS classification)

    • nuts3: NUTS code level 3 - any 5 digits - i.e. FR413 (see this page for more information about NUTS classification)

    • city: code at city level - any 7 digits - i.e. DE_DEL1 (Karlsruhe)

Anchor
JSON_DIFF
JSON_DIFF
Differences between

...

WDDS 2.1 JSON and

...

API Statistics JSON

Differences in TIME_PERIOD values

...

Difference type

TSV files in legacy Bulk Download

WDDS 2.1 JSON


API Statistics JSON

TSV files in the RENOV API



Change in data Time period code

Pattern

Example

Pattern

Example

Comment

5 years

YYYY

2019

YYYY

2019

The indicated year is the last one of the 5 years period.

Year

YYYY

2019

YYYY

2019


Semester

YYYYSN

2015S1

YYYY-SN

2015-S1


Quarter

YYYYQN

2015Q4

YYYY-QN

2015-Q4


Month

YYYYMNN

2015M02

YYYY-MM

2015-02


Week

YYYYWNN

2020W28

YYYY-WNN

2020-W28


Day

YYYYMNNDNN

2019M06D13

YYYY-MM-DD

2015-12-31


Differences

...

in fields

  • The field order:

WDDS 2.1

JSON-stat

Legacy JSON

API Statistics

JSON-stat 2.1 WDDS Translator

1.version

2.label

3.href

4.source

5.updated

6.status

7.extension

8.class

9.value

10.dimension

11.id

12.size

1.version

2.class

3.label

4.source

5.updated

6.value

7.status

8.id

9.size

10.dimension

11.extension<<"href" is not present in this version>>



  • “source” property value:

WDDS 2.1

JSON-stat

API Statistics Legacy JSON

JSON-stat 2.1 WDDS Translator

Eurostat

ESTAT


  • “updated” property format:

WDDS 2.1

Legacy JSON-stat

API Statistics

JSON-stat 2.1 WDDS Translator

YYYY-MM-DD

yyyy-MM-ddTHH:mm:ssZ


  • “extension” field:

WDDS 2.1

JSON-stat

API Statistics Legacy JSON

JSON-stat 2.1 WDDS Translator

"datasetId" property name

“id” property name

“description” property is present

“description” property is not present

“subTitle” property is present

“subTitle” property is moved into the section “annotation” – see below.

“annotation” is not present

“annotation” is present and it contains the following extra fields:

DISSEMINATION_OBJECT_TYPE

OBS_COUNT

OBS_PERIOD_OVERALL_OLDEST

OBS_PERIOD_OVERALL_LATEST

UPDATE_STRUCTURE

UPDATE_DATA

SUBTITLE

SOURCE_INSTITUTIONS

DISSEMINATION_PRESENTATIONS

Combinations of flags are not present

Combinations of flags are present


  • “dimension” field:

WDDS 2.1

JSON-stat

Legacy JSON

API Statistics

JSON-stat 2.1 WDDS Translator

"freq" dimension is not present

"freq" dimension is present

"label" property contains the dimension code

"label" property contains the dimension title


  • “id” field:

WDDS 2.1

Legacy JSON-stat

API Statistics

JSON-stat 2.1 WDDS Translator

"freq" is not present

"freq" is present


  • “size” field:

WDDS 2.1

JSON-stat

API Statistics Legacy JSON

JSON-stat 2.1 WDDS Translator

"size" field does not include the "freq" dimension

"size" field includes the "freq" dimension