- Sentinelles.svc Service Document Metadata Document Browse online Usage Example
What is OData ?
OData is a Data Publishing Protocol proposed by Microsoft Corp.(c). This page expose OData endpoints for the French "Sentinelles" Network, and aims to be a data oriented view of http://www.sentiweb.fr
OData is based on well-known web standards : HTTP, AtomPub, XML et JSON. It also follows REST architecture principles: a resource (here a dataset) is identified by the URI used to access it. By this way, you only need to build the URI, using predefined and simple rules, to get, select, or modify data.
In a OData service, data are organized in structure similar to a relational database, called Entity composed of strongly typedproperties. Some property could handle a relation to another entity (like foreign key in a RDB).
A dataset is provided as a collection of instances of a kind of Entity (called EntitySet). It could be represented in an XML stream, embedded in an AtomPub document, or in a JSON document.
A OData service exposes several kind of documents :
- Service Document / describing available datasets (EntitySet) in the service XML AtomPub
- Metadata Document /$metadatadescribing the schema of the database with all data structures, relationships between data and allowed operations on data. XML EDMX
- AtomPub Document (Collection) exposing datasets.
A dataset could be accessed by simply using the name of the corresponing EntitySet and by adding some parmeters to restrict or specify the query on data.
For example:
- Sentinelles.svc/HEALTH_EVENT access to the HEALTH_EVENT dataset (as an AtomPub XML document)
- Sentinelles.svc/HEALTH_EVENT?$format=json : get the same data as a JSON document
- Several parameters and URI-constructing rules are available to build the complex query on data, they are all described in the OData Protocol Documentation
We also propose on this website an online browser of our OData service. OData documents are vizualized as dynamic HTML pages, more friendly than XML documents to read for most of normal people.
This service is not dedicated to respond to an intensive usage but only to enable data access to a primary user. If you want to redistribute our data to secondary users or clients please do not use this service as direct data source but proxy it with a cache strategy.
These data are mainly updated on a weekly basis
The last available week (for weekly data) and year (for yearly data) are available on these resources meta.json, meta.xml
The access to this service can be restricted at any time in case of usage overloading our bandwidth or limiting resources for other services, please be reasonable
Qu'est ce que OData ?
OData est un protocole d'accès aux données proposé par Microsoft Corp.(c). Cette page est dédiée au point d'accès du réseau Sentinelles.
OData est un protocole basé sur des standards éprouvés du web : HTTP, AtomPub, XML et JSON permettant de construire un point d'accès aux données simple et basé sur des standards existants. Il est basé sur les principes REST, associant une adresse (URI) à une resource (ici, un flux de données, ou une selection particulière des données). Récuperer une donnée consiste alors à en construire l'adresse pour y avoir accès.
OData ressemble à une base de données relationnelle les données sont organisées en Entité composée de propriétés, dont certaines peuvent relier à une autre entité (proche des tables, organisée en colonne/champs, pouvant contenir une clés étrangères vers une autre table)
Les données sont accessibles sous forme de flux de données (flux AtomPub ou JSON), contenant bout à bout chaque enregistrement (EntitySet pour OData), comme les lignes d'une table
OData expose plusieurs types de documents:
- Le Service Document (URI: /) décrit les flux de données disponibles sur un point d'accès XML AtomPub
- Le Metadata Document (URI: /$metadata) décrit le schema des stuctures de données accessible via le point d'accès (entités, lien entre celles-ci, opérations possibles, etc) XML EDMX
- AtomPub Document (Collection) expose les flux de données proprement dit.
L'URI d'un flux de données correspond au nom de l'entité, pouvant inclure des paramètres pour restreindre ou spécifier la requête.
Par exemple :- Sentinelles.svc/HEALTH_EVENT: expose le flux de données de l'entité HEALTH_EVENT (en flux XML AtomPub)
- Sentinelles.svc/HEALTH_EVENT?$format=json : expose les données précédentes en JSON
Nous proposons sur ce site un explorateur du service (bouton "Browse online"), permettant de visualiser les documents sous forme de pages HTML dynamiques, plus facile à lire que des documents XML pour le commun des mortels.
Ce service n'est pas dédié à un usage intensif mais à faciliter un accès aux données pour un destinataire primaire. Si vous integrez ce service dans vos applications destinées à des clients externes merci de ne pas utiliser ce service comme source principale de données pour chaque client. Merci de mettre en place une stratégie de cache des données téléchargées si vous les redistribuez.
La mise à jour des données est hebdomadaire !
La dernière semaine disponible (pour les données hebdomadaires) et la dernière année disponible (pour les données annuelles) sont disponibles en JSON ou en XML
L'accès à ce service pourra être limité à tout moment si celui-ci venait à surcharger nos serveur
News
- 2018 Dec. 12
- meta.json, meta.xml expose last update week & year to facilitate external cache strategies
- 2018 Oct. 18
- Fix URL generation in https. OData was not working.
- 2017 Jan., 20
- Data for new administrative regions (2016's French regions) are now available. ADMIN_LEVEL code is RDD (new regions codes start with 'RDD' + number of the new region). GEOGRAPHIC_PLACE table maps these internal codes to INSEE codes (official french administrative codes), ISO and NUTS codes are not available yet.
- 2014 Jan., 08
- Data availability has changed for some indicators, now only accessible on a annual basis. To keep compatibility with previous schema, OBSERVATION EntitySet still contains weekly data and a new EntitySet named OBSVERVATION_YEAR provides access to yearly data. A new field of the TIME_SERIES, named "FREQUENCY" indicates the maximum frequency of each time series (year or week). if the field is set to "year", data are only available through OBSVERVATION_YEAR EntitySet. "week" value indicates that data are available in OBSVERVATION_YEAR (yearly data) and OBSVERVATION (weekly data) EntitySets.
Visit source website www.sentiweb.fr for more information about this change.