The common vocabulary and dataset references

The SIIEAU maintains a repository dataset to ensure consistency of the Togo water related datasets. This repository aims to facilitate data exchange between the SIIEAU stakeholders. It contains:

The repository is managed by the SIIEAU Data administrator in close collaboration with the SIIEAU stakeholders and on-demand.

 The transfer files

The principle of data exchange is based on the transmission of data records stored in an Excel format file (97-2004/.xls). this is a simple and human readable format. It can be used with a worksheet software such as Open Office or Microsoft Office. The first line of each file contains the column labels found in the SIIEAU database. The next lines contain the transmitted data. The formats of the exchange files are different depending on the type of data transmitted. Several types of transfer files are distinguished:

  • The transfer file of  site
  • The transfer file of  variable  and optionaly a transfer file of  possible values  of the qualitative variables
  • The transfer file of  source
  • The transfer file of  method
  • The transfer file of  measured data
  • The transfer file of  metadata

In order to periodically transmit their measurements, observations and indicators data values, the SIEEAU data producers may use the data portal.

Regarding the reference sites, variables, methods, sources and metadata, completed transfer files must be sent by e-mail to the SIIEAU data administrator who will then take their introduction into the database.

By using the dedicated form, you can submit an update or an addition in the common vocabulary. After reviewing your application, the SIIEAU administrator will contact you.

 Interoperability and web services

Data references (Sites, Variables, Methods, Sources) as well as the common vocabulary data can be obtained using the API ReST. The standard data format is JSON.


1 - Get the common vocabulary entities

http://siieau.tg/rest/commonVocabulary

Try link


2 - Get the data of a common vocabulary entity

The request format is:
http://siieau.tg/rest/commonVocabulary/entity-name/lang
  • entity-name corresponds to the entity name and can be obtained using the previous request (JSON attribute name): /rest/commonVocabulary
  • lang is either fr or en
Examples:

http://siieau.tg/rest/commonVocabulary/Unit/fr

Try link

http://siieau.tg/rest/commonVocabulary/SampleMediumCV/en

Try link

  • it the entity name is unknown, the sytem will send back a 400 error and the following error message:
    Common commonVocabulary entity not found. Available common commonVocabulary entity names are: SuperGroupCV, GroupCV, ThemeCV, ConceptCV, SiteTypeCV, SpatialReference, DataTypeCV, SampleMediumCV, SpeciationCV, Unit, ValueTypeCV, VariableNameCV, CensorCodeCV, QualityControlLevel, OffsetType
  • if the language is unknown, the system will send back a 400 error:
    Language not supported: Supported languages are "fr" or "en".

3 - Get the data from all sites

The request format is:
http://siieau.tg/rest/sites/lang
  • lang is either fr or en
Example:

http://siieau.tg/rest/sites/fr

Try link


4 - Get the data of one site

The request format is:
http://siieau.tg/rest/site/id/lang
  • id is the site identifier, it corresponds to the JSON attribute id found in the previous request output (see section 3).
  • lang is either fr or en
Example:

http://siieau.tg/rest/site/2/fr

Try link


5 - Others reference data

The others references data can obtained using the same mecanism used to get sites data (see sections 3 and 4):

All variables:
http://siieau.tg/rest/variables/lang
One variable:
http://siieau.tg/rest/variable/id/lang
All methods:
http://siieau.tg/rest/methods/lang
One method:
http://siieau.tg/rest/methods/id/lang
All sources:
http://siieau.tg/rest/sources/lang
One source:
http://siieau.tg/rest/source/id/lang