Oulun kaupungin avoimen datan (AD) rajapintakuvaus

AD rest api palvelu

Rajapinnan osoite: https://api.ouka.fi/v1

 

Rajapinta on kaikille avoin ja se on rakennettu PostgREST alustalle (https://postgrest.com/en/v4.3/api.html#). Rajapinta toimii ilman kirjautumista. Web palvelu tarjoaa JSON muotoisia sanomia api-kutsuihin. JSON sanomien rivimäärää ei ole rajoitettu ja palvelu sallii 10 yhtäaikaista tietokantayhteyttä. Palvelulla ei ole omaa html etusivua. Rajapinnan juuriosoitteessa https://api.ouka.fi/v1 esitetään kaikki käytettävissä olevat endpointit json-sanomana. Luettavampi esitys endpointeista on osoitteessa https://api.ouka.fi/swagger Rajapinta on käynnissä lukuoikeuksin varustetulla käyttäjätunnuksella, joten swagger dokumentaatiossa tarjotut sisäänrakennetut DML-operaatio - mahdollisuudet eivät ole käytettävissä. Rajapinnan käyttö onnistuu esim. Postman ohjelmalla. Postman tukee unicodea.  

Palvelussa saatavana olevat tiedot

Tässä kappaleessa luetellaan dataresurssit aihealueittain. Resurssista kerrotaan perusosoite ilman parametrointeja. Parametrointia käsitellään kappaleessa ”Käyttövinkkejä ja esimerkkejä tiedonhakuun”

Kiinteistötiedot

Kohteiden perustiedot

https://api.ouka.fi/v1/properties_basic_information

Dataelementti

Tietotyyppi

Kuvaus

property_id

Merkkijono

Kohteen tunnusnumero. Tunnusta käytetään yksilöimään tietty kiinteistö hauissa.

property_name

Merkkijono

Kohteen nimi esim. Yli-Iin paloasema.

intended_use

Merkkijono

Kohteen käyttötarkoitus sanallisesti kuvattuna

district_key

Merkkijono

Kaupunginosan tunnus

district_name

Merkkijono

Kaupunginosan nimi

property_address

Merkkijono

Kiinteistön osoite

postal_code

Merkkijono

Postinumero

grossarea

Merkkijono

Huoneala

totalgrossarea

Merkkijono

Bruttoneliöt

volume

Lukuarvo

Rakennuskuutiot

totalfloorarea

Lukuarvo

Rakennusala

year_built

Lukuarvo

Rakennusvuosi

year_renovated

Lukuarvo

Peruskorjausvuosi

floorcount

Lukuarvo

Kerrosten lkm

attic_floorcount

Lukuarvo

Ullakkokerrosten lkm

keyfield

Lukuarvo

Juokseva numero, tietueen yksilöivä avain.

 

Kohdelistaus

https://api.ouka.fi/v1/properties

Dataelementti

Tietotyyppi

Kuvaus

kohde_tunnus

Merkkijono

Kohteen tunnusnumero. Tunnusta käytetään yksilöimään tietty kiinteistö hauissa.

kohde_nimi

Merkkijono

Kohteen nimi esim. Yli-Iin paloasema.

Kohteiden käyttötarkoitukset

https://api.ouka.fi/v1/properties_intended_use

Dataelementti

Tietotyyppi

Kuvaus

intended_use_id

Merkkijono

Kohteen käyttötarkoituksen numeerinen koodi.

intended_use

Merkkijono

Kohteen käyttötarkoitus sanallisesti kuvattuna

 

Kohteiden lämmitystapa

https://api.ouka.fi/v1/properties_heating_systems

Dataelementti

Tietotyyppi

Kuvaus

property_id

Lukuarvo

Kohteen  id

property_name

Merkkijono

Kohteen nimi

heating_system

Merkkijono

Kohteen lämmitystapa sanallisesti kuvattuna.

meter_count

Lukuarvo

Mittarien lkm

keyfiled

Merkkijono

Juokseva numero, tietueen yksilöivä avain.

 

Kohteiden kulutusten mittauslajit

https://api.ouka.fi/v1/properties_consumption_measures

Dataelementti

Tietotyyppi

Kuvaus

mittauslaji

Merkkijono

Joko Lämpö, Vesi tai Sähkö

 

Kohteiden kulutukset, vuositasolla

https://api.ouka.fi/v1/properties_consumption_yearly

Dataelementti

Tietotyyppi

Kuvaus

property_id

Merkkijono

Kohteen tunnusnumero. Tunnusta käytetään yksilöimään tietty kiinteistö hauissa.

property_internal_id

Merkkijono

Kohteen vaihtoehtoinen tunnus

property_name

Merkkijono

Kohteen nimi

consumption_measure

Merkkijono

Kulutuksen mittauslaji

year

Lukuarvo

Kalenterivuosi

consumption

Lukuarvo

Kulutuksen määrä desimaalilukuna summattuna vuositasolla

 

Kohteiden kulutukset, kuukausitasolla

https://api.ouka.fi/v1/properties_consumption_monthly

Dataelementti

Tietotyyppi

Kuvaus

property_id

Merkkijono

Kohteen tunnusnumero. Tunnusta käytetään yksilöimään tietty kiinteistö hauissa

property_internal_id

Merkkijono

Kohteen vaihtoehtoinen tunnus

property_name

Merkkijono

Kohteen nimi

consumption_measure

Merkkijono

Kulutuksen mittauslaji

year

Lukuarvo

Kalenterivuosi

month

 

Kalenterikuukausi

consumption

Lukuarvo

Kulutuksen määrä desimaalilukuna summattuna kuukausitasolla

consumption_normalized

Lukuarvo

Kulutuksen normeerattu määrä desimaalilukuna summattuna kuukausitasolla

keyfield

Lukuarvo

Juokseva numero, tietueen yksilöivä avain.

 

Kohteiden kulutukset, päivätasolla

https://api.ouka.fi/v1/properties_consumption_daily

Dataelementti

Tietotyyppi

Kuvaus

property_id

Merkkijono

Kohteen tunnusnumero. Tunnusta käytetään yksilöimään tietty kiinteistö hauissa

property_internal_id

Merkkijono

Kohteen vaihtoehtoinen tunnus

property_name

Merkkijono

Kohteen nimi

consumption_measure

Merkkijono

Kulutuksen mittauslaji

year

Lukuarvo

Kalenterivuosi 2016..2017

month

Lukuarvo

Kalenterikuukausi numerona 1..12

day

Lukuarvo

Kalenteripäivä numerona 1..31

consumption

Lukuarvo

Kulutuksen määrä desimaalilukuna summattuna päivätasolla

 

Kohteiden kulutukset, tuntitasolla

https://api.ouka.fi/v1/properties_consumption_hourly

Dataelementti

Tietotyyppi

Kuvaus

property_id

Merkkijono

Kohteen tunnusnumero. Tunnusta käytetään yksilöimään tietty kiinteistö hauissa

property_internal_id

Merkkijono

Kohteen vaihtoehtoinen tunnus

property_name

Merkkijono

Kohteen nimi

consumption_measure

Merkkijono

Kulutuksen mittauslaji

year

Lukuarvo

Kalenterivuosi 2016..2017

month

Lukuarvo

Kalenterikuukausi numerona 1..12

starting_hour

Merkkijono

Mittausajankohdan alkava tunti 00, 01, 02, 03..23

consumption

Lukuarvo

Kulutuksen määrä desimaalilukuna tuntitasolla

keyfield

Lukuarvo

Juokseva numero, tietueen yksilöivä avain

day

Lukuarvo

Kalenteripäivä numerona 1..31

 

Kohteen mittareiden kulutukset, kuukausitasolla

https://api.ouka.fi/v1/properties_meter_consumption_monthly

Dataelementti

Tietotyyppi

Kuvaus

property_name

Merkkijono

Kohteen nimi

consumption_measure

Merkkijono

Kulutuksen mittauslaji

heating_system

Merkkijono

Lämmitystapa Lämpö –mittauksissa. Sähkön ja veden osalta NULL (puuttuva arvo)

unit

Merkkijono

Lämpö-mittauksissa kWh

meter_name

Merkkijono

Mittarin nimi

meter_id

Merkkijono

Mittarin id

year

Lukuarvo

Kalenterivuosi 2016..2017

month

Lukuarvo

Kalenterikuukausi numerona 1..12

consumption

Merkkijono

Kulutuslukema, desimaaliluku merkkijonona

keyfield

Lukuarvo

Juokseva numero, tietueen yksilöivä avain

property_id

Merkkijono

Kohteen tunnusnumero. Tunnusta käytetään yksilöimään tietty kiinteistö hauissa

property_internal_id

Merkkijono

Kohteen vaihtoehtoinen tunnus

property_address

Merkkijono

Kohteen osoite

postal_code

Merkkijono

Kohteen postinumero

postal_area

Merkkijono

Kohteen postitoimipaikka

intended_use

Merkkijono

Kohteen käyttötarkoitus

year_built

Merkkijono

Kohteen rakennusvuosi

measure_name

Merkkijono

Mittauksen tyyppi, päämittaus

 

Henkilöstöasiat

Henkilöstömittarit

https://api.ouka.fi/v1/city_personnel_kpi

Dataelementti

Tietotyyppi

Kuvaus

year

Lukuarvo

Kalenterivuosi 2016..2017

month

Lukuarvo

Kalenterikuukausi numerona 1..12

personnel_amount

Lukuarvo

Henkilömäärä organisaatiossa (vuoden ja kuukauden) poikkileikkauksena. Voimassa seuraavat ehdot: Palvelussuhde voimassa kuukauden viimeinen päivä, ilman työllistettyjä ja kesätyöntekijöitä, ilman toimenpidepalkkaisia, ilman oppilaita ja harjoittelijoita.

personnel_cost

Lukuarvo

Henkilöstömenot organisaatiossa (vuosi, kuukausi). Henkilöstömenoista rajataan pois Jaksotetut palkat ja palkkiot, Jaksotetut sosiaalivakuutusmaksut ja Jaksotetut eläkekulut.

personnel_effectivity

Lukuarvo

Toteutunut työpanos organisaatiossa (vuosi, kuukausi). Maksimityöpanoksesta vähennetään kaikki Personeciin kirjatut keskeytykset lukuun ottamatta palkallista koulutusta ja työajan tasausvapaata.  Käytännössä tilinpäätöksessä esitettävä HTV. Myös jos keskeytys = 72 eli toisen vakanssin hoito kaupungilla niin ko. keskeytys jää vähennyksen ulkopuolelle, koska vastaavaa työpanosta ei ole huomioitu maksimityöpanoksessa työpanoksessa. Keskeytyksiä ovat mm. kuntoutuspoissaolot, perhevapaat, sairauspoissaolot, kuntoutustuki ja koulutuspoissaolot (jotka kirjattu Personecissa palkattomiksi keskeytyksiksi). Toteutunut työpanos sisältää myös maksetut ylityöt (38:15/vk, 7:39/pv=1 htpv), keskimäärin 21 htpv = htkk.

personnel_sickleave_pct

Lukuarvo

Organisaation sairauspoissaolo-% (vuosi, kuukausi). Personeciin kirjatut sairauspoissaolot (=sair. poissaolot tp) muutettuna työpanokseksi jaettuna (/) palkallisella työpanoksella johon on lisätty palkattomalla sairauslomalla olevien henkilöiden maksimityöpanos (=resurssityöpanos). Prosentti huomioi kaikki sairauslomalla olevat (palkallinen ja palkaton) ja suhteuttaa ne palkkaa saavien henkilöiden lisäksi niihin henkilöihin, jotka ovat palkattomalla sairauslomalla.  Ko. henkilöt ovat tavallaan käytettävissä olevaa resurssia vaikka heille ei sillä hetkellä makseta palkkaa. Kaava: sair.poissaolot tp /resurssityöpanos.

organisation

Merkkijono

Kaupunkiorganisaation nimi. Hallintokunta, liikelaitos, peruskunta erikseen tai koko kaupunki erikseen.

organisation_code

Merkkijono

Organisaatiokoodi.

keyfield

Lukuarvo

Juokseva numero, tietueen yksilöivä avain

 

Henkilöstöorganisaatiot

https://api.ouka.fi/v1/purchase_invoices_orgs Samat organisaatiot ovat käytössä talouspuolella ostolaskuissa.

Dataelementti

Tietotyyppi

Kuvaus

organisaatio

Merkkijono

Kaupunkiorganisaation nimi. Hallintokunta, liikelaitos, yhtiö, peruskunta erikseen tai koko kaupunki erikseen.

organisaatio_koodi

Merkkijono

Organisaatiokoodi.

 

Talousasiat

Ostolaskut

https://api.ouka.fi/v1/purchase_invoices

Dataelementti

Tietotyyppi

Kuvaus

kuntanumero

Merkkijono

kuntanumero

kunnan_nimi

Merkkijono

kunnan_nimi

ostajan_y_tunnus

Merkkijono

ostajan_y_tunnus

tulosyksikon_id

Merkkijono

tulosyksikon_id

osasto

Merkkijono

osasto

kustannuspaikan_id

Merkkijono

kustannuspaikan_id

kustannuspaikan_nimi

Merkkijono

kustannuspaikan_nimi

laskun_paivamaara

Merkkijono

laskun_paivamaara

tositteen_numero

Merkkijono

tositteen_numero

ostotilausnumero

Merkkijono

ostotilausnumero

sopimusnumero

Merkkijono

sopimusnumero

kirjauspaivamaara

Merkkijono

kirjauspaivamaara

laskun_numero

Merkkijono

laskun_numero

tiliryhman_numero

Merkkijono

tiliryhman_numero

tilin_numero

Merkkijono

tilin_numero

tilin_nimi

Merkkijono

tilin_nimi

toimittajan_nimi

Merkkijono

toimittajan_nimi

toimittajan_y_tunnus

Merkkijono

toimittajan_y_tunnus

summa_alv0_euroina

Merkkijono

summa_alv0_euroina

alv_maara_euroina

Merkkijono

alv_maara_euroina

kokonaissumma_euroina

Merkkijono

kokonaissumma_euroina

verkkolaskuosoite

Merkkijono

verkkolaskuosoite

tilausnumero

Merkkijono

tilausnumero

toimittajan_numero

Merkkijono

toimittajan_numero

kumppaniyhtio

Merkkijono

kumppaniyhtio

kumppanin_id

Merkkijono

kumppanin_id

kumppanin_selkokielinen_nimi

Merkkijono

kumppanin_selkokielinen_nimi

kumppaniryhma

Merkkijono

kumppaniryhma

kumppaniryhman_selkokielinen_nimi

Merkkijono

kumppaniryhman_selkokielinen_nimi

avain

Merkkijono

avain

vuosi

Merkkijono

vuosi

kuukausi

Merkkijono

kuukausi

tulosyksikon_nimi

Merkkijono

tulosyksikon_nimi

tiliryhman_nimi

Merkkijono

tiliryhman_nimi

 

Ostolaskujen organisaatiot

https://api.ouka.fi/v1/purchase_invoices_orgs

Dataelementti

Tietotyyppi

Kuvaus

organissaatio_koodi

Merkkijono

organissaatio_koodi

organisaatio

Merkkijono

organisaatio

 

Tilinpäätös 2016

https://api.ouka.fi/v1/city_financial_statement_2016

Dataelementti

Tietotyyppi

Kuvaus

Field001

Merkkijono

Vuosi

Field002

Merkkijono

Organisaation koodi

Field003

Merkkijono

Organisaatio nimi

Field004

Merkkijono

Organisaatio OD taso

Field005

Merkkijono

Organisaatio OL taso

Field006

Merkkijono

Organisaatio OA taso

Field007

Merkkijono

Organisaatio OC taso

Field008

Merkkijono

Organisaatio OS taso

Field009

Merkkijono

Organisaatio OT taso

Field010

Merkkijono

Organisaatio OK taso

Field011

Merkkijono

Kustannuspaikka

Field012

Merkkijono

Tiliryhmä

Field013

Merkkijono

Tiliryhmä

Field014

Merkkijono

Tiliryhmä

Field015

Merkkijono

Tiliryhmä

Field016

Merkkijono

Tiliryhmä

Field017

Merkkijono

Tilinumero ja nimi

Field018

Merkkijono

 

Field019

Merkkijono

 

Field020

Merkkijono

Vuosi

Field021

Merkkijono

Summa

Field022

Merkkijono

Summa

Field023

Merkkijono

Summa

Field024

Merkkijono

Summa

 

Tilinpäätös tiliryhmät

https://api.ouka.fi/v1/city_financial_statement_accgroups

Dataelementti

Tietotyyppi

Kuvaus

Field014

Merkkijono

Tiliryhmä

 

Tilinpäätös organisaatiot

https://api.ouka.fi/v1/city_financial_statement_orgs

Dataelementti

Tietotyyppi

Kuvaus

Field003

Merkkijono

Organisaatio nimi

 

 

 

 

Liikuntapalvelut

Sankivaaran latukameratilasto, 30pv

https://api.ouka.fi/v1/latukamera_sankivaara_30pv

Dataelementti

Tietotyyppi

Kuvaus

intv_start

Aikaleima

Muotoa "2016-12-29 07:00:00"          

come_in

Lukuarvo

Kävijät

 

Sankivaaran latukameratilasto, 7pv

https://api.ouka.fi/v1/latukamera_sankivaara_vko

Dataelementti

Tietotyyppi

Kuvaus

intv_start

Aikaleima

Muotoa "2016-12-29 07:00:00"          

come_in

Lukuarvo

Kävijät

 

Valtuustokokoukset ja asiat

 

https://api.ouka.fi/v1/city_council_meeting_links Linkki sekä videoituun kokoukseen että kokouksen pöytäkirjaan.

Dataelementti

Tietotyyppi

Kuvaus

aika

Merkkijono

aika

nimi

Merkkijono

nimi

otsikko

Merkkijono

otsikko

poytakirjalinkki

Merkkijono

poytakirjalinkki

videolinkki

Merkkijono

videolinkki

avain

Merkkijono

avain

 

Valtuustovideot

https://api.ouka.fi/v1/city_council_meeting_videos

Dataelementti

Tietotyyppi

Kuvaus

videoid

Merkkijono

ID

publish_time

Merkkijono

Julkaisuaika

header

Merkkijono

Otsikko

keyfield

Merkkijono

Avainkenttä

 

Valtuustokokoukset

https://api.ouka.fi/v1/city_council_meetings

Dataelementti

Tietotyyppi

Kuvaus

mid

Merkkijono

kokous id

morgan

Merkkijono

kokous toimielin

mname

Merkkijono

kokousnumero

mdescription

Merkkijono

kokouksen kuvaus

mdatetime

Merkkijono

kokouksen päiväys

mlocation

Merkkijono

kokouksen sijainti

misactive

Merkkijono

 

mkey

Merkkijono

avainkenttä

doclink

Merkkijono

linkki kokousasiakirjaan

 

Päätökset

https://api.ouka.fi/v1/city_decisions

Dataelementti

Tietotyyppi

Kuvaus

did

Merkkijono

dokumentin id

order_

Merkkijono

asian järjestysnumero

title

Merkkijono

asian otsikko

content

Merkkijono

asiasisältö

keyfield

Merkkijono

avainkenttä

 

Kaupunkiasiat

Palautekooste

https://api.ouka.fi/v1/city_feedback

Dataelementti

Tietotyyppi

Kuvaus

id_key

Merkkijono

avainkenttä

createddate

Merkkijono

luontipäivä

completeddate

Merkkijono

käsitelty_päiväys

status

Merkkijono

tila

explanation

Merkkijono

viesti

subject

Merkkijono

aihe id

type

Merkkijono

tyyppi id

phase_id

Merkkijono

käsittelyvaiheen id

comment

Merkkijono

vastausviesti

phasecode

Merkkijono

 

location_id

Merkkijono

asian sijainti id

streetaddress

Merkkijono

asian osoite

loc_explanation

Merkkijono

sijannin selite

description

Merkkijono

asian kuvaus

keyfield

Merkkijono

avainkenttä

 

Uimavedet

https://api.ouka.fi/v1/swimming_water_quality_stats

Dataelementti

Tietotyyppi

Kuvaus

meas_id

Merkkijono

meas_id

water_temp

Merkkijono

water_temp

ecoli

Merkkijono

ecoli

entero

Merkkijono

entero

meas_time

Merkkijono

meas_time

year

Merkkijono

year

month

Merkkijono

month

day

Merkkijono

day

meas_person

Merkkijono

meas_person

var_name

Merkkijono

var_name

var_desc

Merkkijono

var_desc

var_unit

Merkkijono

var_unit

beach

Merkkijono

beach

beach_addinfo

Merkkijono

beach_addinfo

beach_type

Merkkijono

beach_type

beachtype_addinfo

Merkkijono

beachtype_addinfo

location

Merkkijono

location

water_struct

Merkkijono

water_struct

water_type_id

Merkkijono

water_type_id

water_type

Merkkijono

water_type

coli_threshold

Merkkijono

coli_threshold

coli_desc

Merkkijono

coli_desc

coli_unit

Merkkijono

coli_unit

entero_threshold

Merkkijono

entero_threshold

entero_desc

Merkkijono

entero_desc

entero_unit

Merkkijono

entero_unit

 

 

 

 

Oulu10 asioinnin tilastot

https://api.ouka.fi/v1/ewq_queue_routed

Dataelementti

Tietotyyppi

Kuvaus

sid

Merkkijono

tunniste

location

Merkkijono

sijainti

cashdesk

Merkkijono

kassapiste

group

Merkkijono

palvelutuote id

desc

Merkkijono

palvelutuote kuvaus

year

Merkkijono

vuosi

month

Merkkijono

kuukausi

day

Merkkijono

päivä

amount

Merkkijono

alkavan tunnin aikana kutsuttujen määrä

keyfield

Merkkijono

avainkenttä

hour

Merkkijono

alkava tunti

 

https://api.ouka.fi/v1/ewq_queue_waited

Dataelementti

Tietotyyppi

Kuvaus

group

Merkkijono

palvelutuote id

desc

Merkkijono

palvelutuote kuvaus

year

Merkkijono

vuosi

month

Merkkijono

kuukausi

day

Merkkijono

päivä

hour

Merkkijono

alkava tunti

minute

Merkkijono

alkavan tunnin aikana odotusaika minuutteina keskimäärin

second

Merkkijono

alkavan tunnin aikana odotusaika sekunteina keskimäärin

keyfield

Merkkijono

avainkenttä

 

https://api.ouka.fi/v1/ewq_queue_stats 

Dataelementti

Tietotyyppi

Kuvaus

type

Merkkijono

tapahtuman tyyppi: CALL

measure_desc

Merkkijono

mittarin kuvaus

amount

Merkkijono

mittarin arvo

data_last_updated

Merkkijono

edellisen päivityksen aikaleima

 

Merkkijono

 

 

Hyvinvointipalvelut

Järjestöavustukset

https://api.ouka.fi/v1/union_allowances

Dataelementti

Tietotyyppi

Kuvaus

kuntanumero

Merkkijono

564 Oulu

kunta_nimi

Merkkijono

Oulu

tulosyksikon_id

Merkkijono

kustannuspaikkahierarkia OD taso (lautakunta) id

kustannuspaikan_id

Merkkijono

kustannuspaikan_id

kustannuspaikan_nimi

Merkkijono

kustannuspaikan_nimi

laskun_paivamaara

Merkkijono

laskun_päivämäärä

tositteen_numero

Merkkijono

tositteen_numero

kirjauspaivamaara

Merkkijono

kirjauspäivämäärä

tiliryhman_numero

Merkkijono

tiliryhmän numero

tiliryhman_nimi

Merkkijono

tiliryhmän nimi

tilin_numero

Merkkijono

tilin numero

tilin_nimi

Merkkijono

tilin nimi

toimittajan_nimi

Merkkijono

avustuksen saajan nimi

toimittajan_y_tunnus

Merkkijono

avustuksen saajan y-tunnus

kokonaissumma_euroina

Merkkijono

euromäärä

avain

Merkkijono

avainkenttä

vuosi

Merkkijono

raportoitava vuosi

kuukausi

Merkkijono

raportoitava kuukausi

tulosyksikon_nimi

Merkkijono

kustannuspaikkahierarkia OD taso (lautakunta) nimi

 

 

Lahjoitusrahastoavustukset

https://api.ouka.fi/v1/lahjoitusrahastoavustukset

saajan nimitieto ei saatavilla!

Dataelementti

Tietotyyppi

Kuvaus

vuosi

Merkkijono

raportoitava vuosi

kuukausi

Merkkijono

raportoitava kuukausi

kustannuspaikka

Merkkijono

kustannuspaikka

tili

Merkkijono

tili

kohde

Merkkijono

kohde

toteuma

Desimaaliluku

euromäärä

 

Terveysasemajonot

https://api.ouka.fi/v1/chc_waiting_times_monthly_stats

Dataelementti

Tietotyyppi

Kuvaus

queue_id

Merkkijono

avainkenttä

doctor_queue

Merkkijono

odotusaika lääkärijonossa keskiarvo

nurse_queue

Merkkijono

odotusaika hoitajajonossa keskiarvo

time

Merkkijono

raportoitava päiväys

year

Merkkijono

raportoitava vuosi

month

Merkkijono

raportoitava kuukausi

day

Merkkijono

raportoitava päivä

chc

Merkkijono

terveysasema

 

Sivistys- ja kulttuuripalvelut

Kirjaston tilastot OKM vuositaso

https://api.ouka.fi/v1/library_yearly_stats

Dataelementti

Tietotyyppi

Kuvaus

measure

Merkkijono

mittarin nimi

value

Merkkijono

mittarin arvo

year

Merkkijono

raportoitava vuosi

keyfield

Merkkijono

avainkenttä

 

Merkkijono

 

 

 

Kirjaston kuukausitilastot

https://api.ouka.fi/v1/library_monthly_stats

Dataelementti

Tietotyyppi

Kuvaus

library

Merkkijono

kirjaston nimi

book_loans

Merkkijono

kirjalainat määrä

av_loans

Merkkijono

av-lainat määrä

other_loans

Merkkijono

muut lainat määrä

year

Merkkijono

raportoitava vuosi

month

Merkkijono

raportoitava kuukausi

district

Merkkijono

Siku alue (pohjoinen, keskinen, itäinen, eteläinen)

days_open

Merkkijono

aukiolopäivät

hours_open

Merkkijono

aukiolotunnit

visits

Merkkijono

kävijät

children_loans

Merkkijono

lasten lainat määrä

keyfield

Merkkijono

avainkenttä

 

 

Orkesterin tilastot

https://api.ouka.fi/v1/orchestra_visitor_stats

Dataelementti

Tietotyyppi

Kuvaus

year

Merkkijono

raportoitava vuosi

month

Merkkijono

raportoitava kuukausi

date

Merkkijono

konsertin päiväys

point_of_time

Merkkijono

konsertin ajankohta (past, coming)

concert_class

Merkkijono

konserttilaji

concert

Merkkijono

konsertin nimi

listeners

Merkkijono

kuulijoita määrä

keyfield

Merkkijono

avainkenttä

 

Orkesterin tilinpäätös

https://api.ouka.fi/v1/orchestra_financial_accounts_stats

Dataelementti

Tietotyyppi

Kuvaus

year

Merkkijono

raportoitava vuosi

measure

Merkkijono

mittarin nimi

amount

Merkkijono

mittarin arvo

keyfield

Merkkijono

avainkenttä

 

Merkkijono

 

 

Serviisi

Asiakaspalaute HON kuukausitilasto

https://api.ouka.fi/v1/hon_results_monthly

Dataelementti

Tietotyyppi

Kuvaus

unit_name

Merkkijono

palvelupisteen nimi

survey_key

Merkkijono

kyselyn tunniste

question_key

Merkkijono

kysymyksen tunniste

question

Merkkijono

kysymys

year_

Merkkijono

raportoitava vuosi

month_

Merkkijono

raportoitava kuukausi

res1

Lukuarvo

vastaus erittäin negatiivinen, määrä

res2

Lukuarvo

vastaus negatiivinen, määrä

res3

Lukuarvo

vastaus positiivinen, määrä

res4

Lukuarvo

vastaus erittäin positiivinen, määrä

 

Asiakaspalaute HON kuukausitilasto prosentit

https://api.ouka.fi/v1/hon_results_monthly_pct

Dataelementti

Tietotyyppi

Kuvaus

unit_name

Merkkijono

palvelupisteen nimi

survey_key

Merkkijono

kyselyn tunniste

question_key

Merkkijono

kysymyksen tunniste

question

Merkkijono

kysymys

year_

Merkkijono

raportoitava vuosi

month_

Merkkijono

raportoitava kuukausi

res1_pct

Lukuarvo

vastaus erittäin negatiivinen, määrä prosentteina

res2_pct

Lukuarvo

vastaus negatiivinen, määrä prosentteina

res3_pct

Lukuarvo

vastaus positiivinen, määrä prosentteina

res4_pct

Lukuarvo

vastaus erittäin positiivinen, määrä prosentteina

 

 

 

Käyttövinkkejä ja esimerkkejä tiedonhakuun

Lajittelu

Lajittelu noudattaa muotoa https://api.ouka.fi/v1/jokin_tietojoukko?order=jokin_dataelementti.järjestys{asc|desc}.puuttuvien_sijainti{nullslast}

esim.

https://api.ouka.fi/v1/properties_basic_information?order=year_built.desc.nullslast

Lajittelussa käytetään avainsanaa order. Edellisessä esimerkissä kiinteistöjen perustiedoissa on lajittelu laskevaan järjestykseen rakennusvuoden perusteella, jolloin saadaan uusimmat rakennukset tulosjoukkoon ensiksi (order=year_built.desc.nullslast). Nouseva järjestys saadaan kirjoittamalla (order=year_built.asc.nullslast) jolloin saadaan vanhimmat rakennukset tulosjoukkoon ensiksi. nullslast on avainsana joka pakottaa puuttuvat arvot tulosjoukon loppuun. sitä ei ole pakko käyttää. Lajitteluparametrin voi yhdistää muihin parametreihin kuten suodatuksiin.

Käyttämällä parametria limit (limit=jokin_lukuarvo) yhdistettynä laskevaan lajitteluun saadaan luotua top –listoja. Esimerkissä alla top10 suurimmat kiinteistöt brm2 (totalgrossarea) mukaan (order, limit)

https://api.ouka.fi/v1/properties_basic_information?order=totalgrossarea.desc.nullslast&limit=10

Tulosjoukon rivimäärän suodatus

Kuvassa alla eri vaihtoehtoja suodatusten käyttöön.

Wildcardin käyttö. Wildcard merkkejä ovat * ja %. Esimerkissä alla kaikki kohteet, joissa kohteen nimi alkaa Kaakkuri –sanalla (kopioi linkki omaan selaimeen)

https://api.ouka.fi/v1/properties?kohde_nimi=like.Kaakkuri* 

tai

https://api.ouka.fi/v1/properties?kohde_nimi=like.Kaakkuri%

 

Tulosjoukon sarakkeiden suodatus

Alla kuvassa esimerkkejä suodatusmahdollisuuksista

 

Yhdistelmä, jossa luetellut sarakkeet, suodatus Onnela ja suodatus Lämpö. Avainsanaa select käytetään luettelemaan sarakkeet (kopioi linkki omaan selaimeen)

https://api.ouka.fi/v1/properties_consumption_hourly?property_name=eq.Onnela&consumption_measure=eq.Lämpö&select=property_name,year,month,day,starting_hour,consumption