Page History
...
https://api.finna.fi/v1/search?<parametrit>
Haku Finnan indeksistä.
filter-kentän mahdollisia arvoja saa selville tekemällä kyselyn ilman hakusanaa ja rajauksia:
- aineistotyypit:
https://api.finna.fi/v1/search?lookfor=&facet[]=format&prettyPrint=1&limit=0
- kielikoodit:
https://api.finna.fi/v1/search?lookfor=&facet[]=language&prettyPrint=1&limit=0
(käytössä hieman laajennettu ISO 639-3, ks. myös mappaustaulukko)
Parametri | Tyyppi | Selite | Sallitut arvot | ||
---|---|---|---|---|---|
lookfor | Merkkijono | Hakusana | |||
facet | Lista | Palautettavat fasetit | Lista Finnan hakuindeksin kentistä (sarake Core Fields), joita voi käyttää fasetoinnissa (Facet Field=Yes).
"facets": { | ||
facetFilter | Lista | Lista palautettavien fasettiarvojen rajauksille |
"facets": { "format": [ { "value": "0\/Book\/", "translated": "Kirja", "count": 4893, "href": "?lookfor=sibelius&type=AllFields&filter%5B%5D=format%3A%220%2FBook%2F%22", "children": [ { "value": "1\/Book\/eBook\/", "translated": "E-kirja", "count": 237, "href": "?lookfor=sibelius&type=AllFields&filter%5B%5D=format%3A%221%2FBook%2FeBook%2F%22" } ] } ] } | ||
filter | Lista | Rajaukset |
Rajaukset ovat oletuksena AND-rajauksia. OR tai NOT-rajausta voi käyttää lisäämällä fasetin eteen '~' (OR) tai '-' (NOT).
| ||
type | Merkkijono | Hakutyyppi |
| ||
sort | Merkkijono | Hakutulosten järjestys |
| ||
page | Luku | Hakutulossivu | 1-n (oletus 1). Huom! Rajapinta palauttaa korkeintaan 100 000 tulosta, eli jos limit=20, niin suurin mahdollinen page=5000. Jos on tarpeen käsitellä suurempaa joukkoa tietueita, on mahdollista rajata kerralla noudettava tietuejoukko esim. last_indexed-kentän perusteella. | ||
limit | Luku | Tulosten lukumäärä | 0-100 (oletus 20). limit=0 on hyödyllinen kun tarvitaan vain tulosten lukumäärä tai fasetoinnin tulokset. | ||
lng | Merkkijono | Kieliversio |
| ||
field | Lista | Palautettavat tietuekentät. | Ks. tuetut kentät allaolevassa taulukossa. Jos ei määritelty, palautetaan alla olevassa kenttäluettelossa korostetut kentät. Jos tyhjä, ei tietueita palauteta ollenkaan. | ||
callback | Merkkijono | callback-funktio JSONP-tilassa | Oletuksena ei käytössä | ||
prettyPrint | Luku | Tulostetaanko JSON rivinvaihtojen kera | 0, 1 (oletus 0). |
...