The web service has 2 operating modes:
- List of indicators. Metadata extraction: list of published indicators, as well as indicator information required to form an indicator data request.
- Indicator data. Extraction of data of specific indicator.
It is important to know:
- The web service response is in JSON format.
- Anonymous requests: no user authentication is available.
- Unsupported versions: the last version of the data is always returned.
List of indicators. The web service returns a list of published indicators.
|
Parameter
|
Type
|
Description
|
|
lang
|
String
|
Language: lit – lithuanian (default value) or eng – english.
|
Examples:
https://sveikstat.hi.lt/api/indicators.aspx - list of indicators in lithuanian
https://sveikstat.hi.lt/api/indicators.aspx?lang=eng – list in english
Fragment of response:
{
"indicators": [
{
"ind_code": "100000",
"ind_name": "Demografinė ir socioekonominė situacija Eng",
"ind_long_name": "Demografinė ir socioekonominė situacija Eng",
"ind_desc": "Eng Demografinė ir socioekonominė situacija yra",
"ind_is_municipal_level": true,
"ind_is_hci_level": false
}
]
}
Indicator data. The web service returns data of specific indicator.
|
Parametrai
|
Tipas
|
Aprašymas
|
|
indicator
|
String
|
Indicator code, received using web service for list of indicators.
|
|
indicator
|
String
|
Language: lit – lithuanian (default value) or eng – english.
|
|
level
|
String
|
Level: mun – municipality level data (default value) or hci – health care institution data level.
|
|
includeDimension
|
String
|
Include dimensions data: true or false (default value).
|
Examples:
https://sveikstat.hi.lt/api/indicator-values.aspx?indicator=211108&lang=eng&level=mun – indicator with code 211108, municipality level data in english
https://sveikstat.hi.lt/api/indicator-values.aspx?indicator=690101&lang=eng&level=hci – indicator with code 690101, health care institution level data in english
https://sveikstat.hi.lt/api/indicator-values.aspx?indicator=210401&lang=eng&level=mun&includeDimension=true – indicator with code 210401, municipality level data together with dimensions data in english
Fragment of response, municipality level data:
{
"indicators_values": [
{
"indicator_code": "690101",
"region_name": "Vilniaus m. sav Eng",
"year": 2015,
"dimension_name": "",
"dimension_value": "",
"indicator_value": 98.8,
"indicator_nominator": 21396,
"indicator_denominator": 21651,
"indicator_ci_lower": 98.7,
"indicator_ci_upper": 99,
"indicator_trend": 97,
"indicator_val3": 21862.1,
"indicator_nominator3": 22554,
"indicator_denominator3": 97,
"indicator_ci_lower3": 97.1,
"indicator_ci_upper3": 5820.1,
"indicator_ci_trend3": 121
}
]
}
Fragment of response, health care institution data level:
{
"indicators_values": [
{
"indicator_code": "690101",
"hci_name": " Abromiškių reabilitacijos ligoninė Eng",
"year": 2015,
"dimension_name": "",
"dimension_value": "",
"indicator_value": 98.8,
"indicator_nominator": 21396,
"indicator_denominator": 21651,
"indicator_ci_lower": 98.7,
"indicator_ci_upper": 99,
"indicator_trend": 97,
"indicator_val3": 21862.1,
"indicator_nominator3": 22554,
"indicator_denominator3": 97,
"indicator_ci_lower3": 97.1,
"indicator_ci_upper3": 5820.1,
"indicator_ci_trend3": 121
}
]
}