REST Web Service bindings :
The following operations are supported :
For a formal REST definition, please review the Open API v3 Service Description
base_url = https://www.sentiweb.fr/api/v1/datasets/rest
- GET, HEAD{base_url}/incidence
- Get incidence data for an indicator for a geographic level (all available data).
- Return type : IncidenceDataset
- Parameters :
- indicator : int. id of the disease
- geo : string. geographic level to get
- span : string. span time . 'short' provides last ten time points, 'last' only last one (week or year).
- GET{base_url}/lastweek
- Get last week number available (using ISO 8601 week number in a numeric format : YYYYWW)
- Return type : int
- GET{base_url}/lastyear
- Get last year available
- Return type : int
- GET{base_url}/version
- Get Dabatase version id
- Return type : string
- GET{base_url}/indicators
- Get list of available indicators
- Return type : Indicator[]
- GET{base_url}/changelog
- Changelog of the service
- Return type : Changelog[]
Complex Types Definitions
IncidenceDataset
Fields :- metaIncidenceMetadata
- dataIncidenceRecord[]
IncidenceMetadata
Fields :- timestring Time scale of the data week (weekly data), year (yearly data)
- columnsIncidenceColumnsDescription
IncidenceColumnsDescription
Fields :- timestring Name of the column containing time point of each record
- indicatorstring Name of the column containing the indicator identifier of each record
- valuestring[] Name of the columns containing the incidence values. "inc_" prefix refers to incidence (in number of cases), "inc100_" prefix refers
- geostring Name of the columns containing the geographic information of each record
IncidenceRecord
Fields :- indicatorstring Surveillance indicator unique identifier. An indicator is defined for a given disease or health event under surveillance. A case definition is provided to define the inclusion and exclusion criteria.
- weekint nullable Time of observation for weekly data, number following 'YYYYWW' format (strftime '%G%V'), representing ISO 8601 year week number
- yearint nullable Year of observation (YYYY), only provided for for yearly data
- geo_inseestring INSEE (french statistic institute code) http://www.insee.fr/fr/methodes/nomenclatures/cog/. Use it for geograhphic area identifier. Note that 'FR' at national level does not include oversea lands.
- geo_namestring Geographic area name. Only for human reading purpose. It must not be used as a geographic area identifier. We provide no garantee for the stability of its content.
- incint Estimated incidence (number of cases)
- inc100int Estimated incidence rate (cases per 100,000 inhabitants)
- inc_upint Upper bound of the estimated incidence (number of cases)
- inc_lowint Lower bound of the estimated incidence (number of cases)
- inc100_upint Upper bound of the estimated incidence rate (cases per 100,000 inhabitants)
- inc100_lowint Lower bound of the estimated incidence rate (cases per 100,000 inhabitants)
Indicator
Fields :- idstring Surveillance indicator unique identifier (to be used to request data)
- namestring Indicator name (human readable label)
- case_definitionstring Case definition to include the patient in the surveillance process
- geostring[] Available geographic levels for the data. PAY=National level (mainland), REG=Regional level before 2016, RDD=Regional level after 2016
- periodsTimePeriod[] List of data availability time periods
- warningstring nullable Warning information about this surveillance
- ongoingbool Flag indicating if this surveillance is actively maintained or not
TimePeriod
Fields :- frequencystring Time frequency (week, year)
- startint Starting time
- endint nullable Ending time
Changelog
Fields :- datestring Date of the change (ISO 8601 format YYYY-MM-DD)
- descriptionstring Description of the change