Historia
xx.1.2016 Ensimmäinen versio
Rajapinnan käyttöehdot
Rajapinnan käyttöehdot lisätään tähän myöhemmin.
Kysymyksiä ja palautetta voi lähettää osoitteeseen [email protected].
Yleistä
Rajapinnan avulla voi kohdistaa hakuja Finna.fi:ssä mukana olevien organisaatioiden aineistoihin.
Rajapinnan kutsut noudattavat muotoa:
https://api.finna.fi/v1/<toiminto>?<parametrit>
Oletuksena tulokset palautetaan json-muodossa. jsonp-muotoa käytetään mikäli kutsussa on mukana callback-parametri
https://api.finna.fi/v1/<toiminto>?callback=process
Toiminnot
Search
https://api.finna.fi/v1/search?<parametrit>
Haku Finnan indeksistä.
Parametri | Tyyppi | Selite | Sallitut arvot |
---|---|---|---|
lookfor | Merkkijono | Hakusana | |
facet | Lista | Palautettavat fasetit |
"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 |
|
type | Merkkijono | Kohdekenttä |
Voit myös kohdistaa haun suoraan indeksin haettaviin kenttiin (ks. Finnan hakuindeksin kentät, sarake Search) määrittelemällä kohdekentän hakulausekkeessa. ?lookfor=publication_place_txt_mv:pomarkku&field[]=id&field[]=publication_place_str_mv&field[]=placesOfPublication&field[]=publicationInfo&prettyPrint=1 |
sort | Merkkijono | Järjestys |
|
page | Luku | Hakutulossivu | 1-n (oletus 1). Sivun koko tulee limit-parametrista (oletuksena siis 1 sivu = 20 tulosta). |
limit | Luku | Tulosten lukumäärä | 0-100 (oletus 20). Jos 0, ei tietueita palauteta ollenkaan. |
lng | Merkkijono | Fasettien 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 | Oletus 0 (rivinvaihdot eivät toiminnassa). Mikä tahansa muu arvo laittaa rivinvaihdot päälle. |
Eri lähteistä tulevat samanlaiset tietueet yhdistetään (deduplikoidaan) haun aikana ja hakutuloksessa näytetään ainoastaan korkeimmalle priorisoitu tietue. Tämä tapahtuu vaikka hakutulos suodatetaan organisaation (filter[]=building:"xxx") mukaan.
Deduplikoidun tietueen kenttä dedupIds sisältää kaikkien samanlaisten tietueiden tunnisteet, joiden avulla voidaan tarvittaessa palauttaa halutun lähteen versio tietueesta (ks. Record-toiminto).
Hakutuloksessa esiintyvän deduplikoidun tietueen kaikkien lähteiden tietueet vaikuttavat faseteissa näkyviin arvoihin. Esimerkiksi building-fasetissa näytetään kaikkien deduplikoitujen tietueiden sijainnit. Tämän voi halutessaan estää rajaamalla palautettavien fasettien arvot facetFilter-parametrilla.
Esimerkki:
{
"resultCount": 42,
"records": [
{
"id": "fennica.1003041",
"title": "Puhdistus",
"dedupIds": [
"fennica.1003041",
"jykdok.1256458",
"keski.2341400",
"vaari.1688117",
"vaski.2846838"
]
},
...
Record
https://api.finna.fi/v1/record?<parametrit>
Tietueiden nouto ID:llä
Parametri | Tyyppi | Selite | Sallitut arvot |
---|---|---|---|
id | Merkkijono tai lista | Tietueen ID tai tietueiden ID:t | |
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 | 0 tai 1 | Tulostetaanko JSON rivinvaihtojen kera | Oletus 0 |
Tuetut kentät
Seuraavia kenttiä voidaan käyttää field-parametrissa:
Huom! Kaikkia kenttiä ei tueta kaikissa tietueissa. Tuetut kentät riippuvat metadatan laadusta.
Kenttä | Tyyppi | Selite |
---|---|---|
accessRestrictions | Lista | Aineiston käyttörajoitukset, mikäli tiedossa "accessRestrictions": [ "University of Turku local network, remote access with Univ. of Turku username", "Turun yliopiston verkossa, et\u00e4k\u00e4ytt\u00f6 TY:n tunnuksilla" ] Joskus lisenssi: "accessRestrictions": [ "ELEKTRA-lisenssi" ] Joskus ikäraja: "accessRestrictions": [ "K11" ] |
alternativeTitles | Lista | Vaihtoehtoiset nimekkeet "alternativeTitles": [ "Miehet mustissa", "MIB" ] |
authors | Lista | Kaikki tekijät
"authors": { "main": "Bowie, David", "secondary": [ "Spiders from Mars" ] }
"authors": { "main": "Ozric Tentacles", "corporate": "Ozric Tentacles," } |
awards | Lista | Palkinnot. Merkitty varsin harvoin. "awards": [ "Tieto-Finlandia-palkinto 2013." ] |
bibliographicLevel | Merkkijono | Julkaisun tyyppi. Tyyppejä ainakin Monograph (monografia), MonographPart (monografian osa), Serial (sarjajulkaisu), SerialPart (sarjajulkaisun osa) ja Unknown (tuntematon). "bibliographicLevel": "Monograph" |
buildings | Lista | Sijainti (hierarkkinen). Sisältää kentät:
"buildings": [ { "value": "0\/TAIY\/", "translated": "Taideyliopisto" }, { "value": "1\/TAIY\/tea\/", "translated": "Teatterikorkeakoulun kirjasto" }, { "value": "2\/TAIY\/tea\/1\/", "translated": "Lainattavat" } ] |
callNumbers | Lista | Kirjastoaineiston hyllypaikat. Merkintätapa vaihtelee kirjastoittain. "callNumbers": [ "84.5", "KAUHU" ] |
childRecordCount | Luku | Tietueen lapsitietueiden lukumäärä. Tämän tiedon pyytäminen voi kasvattaa vasteaikaa merkittävästi. "childRecordCount": 0 |
classifications | Lista | Luokitukset eri luokitusjärjestelmissä. "classifications": { } |
cleanIsbn | Merkkijono | Pelkkä ISBN-tunnus ilman ulkoasua tms. Ks. myös isbns "cleanIsbn": "1402087179" |
cleanIssn | Merkkijono | Pelkkä ISSN-tunnus. Ks. myös issns "cleanIssn": "0065-2164" |
collections | Lista | Kokoelmat. Käytössä ainakin museoaineistossa. "collections": [ "Riuttalan talonpoikaismuseo" ] |
containerIssue | Merkkijono | Sisältävän julkaisun numero "containerIssue": "4" |
containerReference | Merkkijono | Viite sisältävään julkaisuun "containerReference": "s. 191-201" |
containerStartPage | Merkkijono | Alkusivu sisältävässä julkaisussa "containerStartPage": "191" |
containerTitle | Merkkijono | Sisältävän julkaisun nimeke "containerTitle": "Finland : an introduction" |
containerVolume | Merkkijono | Sisältävän julkaisun volyymi (vuosikerta / kirjasarjan osa) "containerVolume": "25" |
corporateAuthor | Merkkijono | Yhteisötekijä "corporateAuthor": "Valtiontalouden tarkastusvirasto." |
dedupIds | Lista | Muista lähteistä tulleiden samaa sisältöä edustavien tietueiden id:t "dedupIds": [ "alma.678448", "oula.894534", "tamcat.399614" ] |
dissertationNote | Merkkijono | Opinnäytteen huomautus "dissertationNote": "Pro gradu -ty\u00f6 : Tampereen yliopisto, historiatieteen laitos, yleinen historia." |
edition | Merkkijono | Painos, laitos tai versio "edition": "10. osin uud. laitos"
"edition": "Pidennetty versio" |
embeddedComponentParts | Lista | Tietueeseen sisältyvät osakohteet. Tämän tiedon pyytäminen voi kasvattaa vastauksen kokoa ja vasteaikaa merkittävästi. Käytössä ainakin äänitteissä. "embeddedComponentParts": [ { "id": "viola.305175", "title": "Juppihippipunkkari", "authors": [ "Koistinen, Petteri, s\u00e4velt\u00e4j\u00e4", "Alanko, Ilkka, sanoittaja", "Nelj\u00e4 Ruusua, esitt\u00e4j\u00e4" ], "otherAuthors": [ "Koistinen, Petteri, s\u00e4velt\u00e4j\u00e4", "Alanko, Ilkka, sanoittaja", "Nelj\u00e4 Ruusua, esitt\u00e4j\u00e4" ] }, { "id": "viola.305176", jne. (esimerkki katkaistu) |
events | Lista | Tietueeseen liittyvät tapahtumat, kuten valmistus, käyttö, muotoilu ja näyttely (museoaineisto) "events": { "valmistus": [ { "type": "valmistus", "date": "800 - 1050, viikinkiaika, rautakausi", "materials": [ "metalli", "hopea" ] } ], "n\u00e4yttely": [ { "type": "n\u00e4yttely", "name": "Raision museo -ja kulttuurikeskus Harkon arkeologinen n\u00e4yttely", "description": "26.5.2004 - 31.12.2006" } ] } |
formats | Lista | Tietueen aineistotyypit (hierarkkinen). Usein aineistotyyppi on datassa virheellisesti "Other", vaikka kyse olisi esim. cd-levystä, jolle löytyisi oma aineistotyyppikin.
Esimerkki: e-kirja on kirjan alalaji. Rajapinta palauttaa koko hierarkian ylhäältä alas: "formats": [ { "value": "0\/Book\/", "translated": "Kirja" }, { "value": "1\/Book\/eBook\/", "translated": "E-kirja" } ] |
fullRecord | Merkkijono | Alkuperäinen tietue XML-muodossa. Esimerkki jätetty pois koon vuoksi. |
generalNotes | Lista | Yleiset huomautukset. "generalNotes": [ "Ainoastaan verkkolehden vuoden viimeinen numero ilmestyy painettuna.", "Ei ilmestynyt lainkaan painettuna 2005." ] |
genres | Lista | Aineiston "genret". Ei käytetä fiktion ja musiikin lajityypin tai tyylilajin kuvaamiseen. Katso myös subjects. "genres": [ "Electronic books", "Conference proceedings" ]
"genres": [ "DVD-levyt" ]
"genres": [ "kirja-arvostelut" ] |
hierarchyParentId | Lista | Emotietueen ID, jos tietue kuuluu hierarkiaan. Käytössä ainakin arkisto- ja kirjastoaineistossa. "hierarchyParentId": [ "narc.VAKKA-192941.KA_VAKKA-62641.KA" ] |
hierarchyParentTitle | Lista | Emotietueen nimeke, jos tietue kuuluu hierarkiaan. Käytössä ainakin arkisto- ja kirjastoaineistossa. "hierarchyParentTitle": [ "Aa Diaarit" ]
"hierarchyParentTitle": [ "The rise and fall of Ziggy Stardust and the spiders from Mars" ] |
hierarchyTopId | Lista | Hierarkian päätietueen ID, jos tietue kuuluu hierarkiaan. Käytössä ainakin arkistoaineistossa. "hierarchyTopId": [ "narc.VAKKA-192941.KA" ] |
hierarchyTopTitle | Lista | Hierarkian päätietueen nimeke, jos tietue kuuluu hierarkiaan. Käytössä ainakin arkistoaineistossa. "hierarchyTopTitle": [ "Viipurin provinssikanslian arkisto" ] |
humanReadablePublicationDates | Lista | Julkaisuajankohdat ihmisen luettavassa muodossa. "humanReadablePublicationDates": [ "1983-2006." ] |
id | Merkkijono | Tietueen yksilöivä tunniste "id": "alma.757000" |
identifierString | Merkkijono
| Tietueen tunniste, ei yksilöivä. Käytössä ainakin museoaineistoissa ja tietokannoissa. Museoaineistossa inventaarionumero: "identifierString": "201190a20" Tietokannoissa tunniste: "identifierString": "FSD" |
imageRights | Lista | Kuvien käyttöoikeudet:
"imageRights": { "copyright": "CC BY 4.0", "link": "http:\/\/creativecommons.org\/licenses\/by\/4.0\/deed.fi", "description": [ "Finna-palvelussa julkaistuja Helsingin kaupunginmuseon kuvia voi k\u00e4ytt\u00e4\u00e4 vapaasti, my\u00f6s kaupallisessa k\u00e4yt\u00f6ss\u00e4. Kuvaa ei saa muunnella ilman lupaa ja kuvan yhteydess\u00e4 on mainittava kuvaaja(jos tiedossa) ja Helsingin kaupunginmuseo. Finnassa n\u00e4ytett\u00e4v\u00e4t kuvat lisensoidaan Nime\u00e4 4.0 Kansainv\u00e4linen (CC BY 4.0) -lisenssill\u00e4. Palvelussa n\u00e4ytett\u00e4v\u00e4t kuvat eiv\u00e4t ole painolaatuisia. Jos tarvitset painolaatuisen kuvan tai sinulla on muuta kysytt\u00e4v\u00e4\u00e4, ota yhteytt\u00e4 Helsingin kaupunginmuseon kuva-arkistoon: http:\/\/www.helsinginkaupunginmuseo.fi\/kuva-arkisto" ] } (description-kohtaan lisätty rivinvaihdot esimerkin lukemisen helpottamiseksi) |
images | Lista | Linkit tietueen kuviin. Kirjojen tietuekuvan linkki palauttaa 10x10 pikselin kokoisen läpinäkyvän .gif-kuvan mikäli oikeaa kuvaa ei löydy. "images": [ "https:\/\/www.finna.fi\/Cover\/Show?id=hkm.HKMS000005%3Akm002w3s&fullres=1&index=0" ] |
institutions | Lista | Organisaatio. Katso myös buildings
"institutions": [ { "value": "LUC", "translated": "Lapin korkeakoulukirjasto" } ] |
isbns | Lista | ISBN-tunnukset (ks. myös cleanIsbn) "isbns": [ "951-0-31435-8 (sid.)", "978-951-0-31435-7 (sid.)" ] |
isCollection | Totuusarvo | Onko tietue kokoelma (arkistoaineisto) "isCollection": true |
isPartOfArchiveSeries | Totuusarvo | Onko tietue osa arkistosarjaa (arkistoaineisto) "isPartOfArchiveSeries": true |
issns | Lista | ISSN-tunnukset. Ks. myös cleanIssn "issns": [ "1913-4711" ] |
languages | Lista | Aineiston kielet. Kielet palautetaan koodeina ja ne ovat usein mutteivät aina MARC-muodossa. Katso myös originalLanguages. "languages": [ "fin", "swe" ] |
lccn | Merkkijono | Library of Congress Control Number "lccn": "2010252176" |
manufacturer | Merkkijono | Valmistaja "manufacturer": "([Myllykoski] : Myllykosken kirjap.)" Joskus data on epämääräisempää: "manufacturer": "(Porvoo)" |
measurements | Lista | Kuvailun kohteen fyysiset mitat "measurements": [ "Pituus: 42 cm", "Leveys: helma 22 cm; rinta 34 cm; olka+hiha 14,5+32,5 cm", "Lis\u00e4mitta: Koko 110" ] |
nonPresenterAuthors | Lista | Tekijät ilman esittäjiä (ks. myös presenters)
"nonPresenterAuthors": [ { "name": "Doyle, Arthur Conan", }, { "name": "Attwood, David", "role": "ohj." } ] |
onlineUrls | Lista | Online-linkit (kirjastoaineisto). Sisältää kentät:
"onlineUrls": [ { "url": "http:\/\/eca.europa.eu\/portal\/page\/portal\/publications\/Journal", "text": "Elektroninen julkaisu (PDF)", "source": { "value": "selma", "translated": "Eduskunnan kirjasto - Selma" } } ] |
openUrl | Merkkijono | OpenURL (kirjastoaineisto). Esimerkki jätetty pois pituuden takia. |
originalLanguages | Lista | Aineiston alkuperäiskielet. Katso myös languages. "originalLanguages": [ "jpn" ] |
otherLinks | Lista | Muut tietueen linkit. Käytetään ainakin arvosteltujen teosten merkitsemiseen. "otherLinks": [ { "heading": "Arvosteltu teos", "title": "Viimeiset runonlaulajat", "author": "Martti Haavio" } ] |
physicalDescriptions | Lista | Aineiston fyysinen kuvaus. Käytössä ainakin arkistotietueissa. "physicalDescriptions": [ "0,01 hyllmeter", "1 arkivenheter" ] |
physicalLocations | Lista | Fyysiset sijainnit. Vain arkistotietueilla. "physicalLocations": [ "Historiska och litteraturhistoriska arkivet", "Helsingfors, Nationalbiblioteket" ] |
placesOfPublication | Lista | Julkaisupaikka "placesOfPublication": [ "New York, NY :" ] |
playingTimes | Lista | Toistoaika. Käytetään ainakin äänitteiden yksittäisissä kappaleissa ja äänikirjoissa. "playingTimes": [ "00:06:42" ] |
presenters | Esittäjät (ks. myös nonPresenterAuthors). Datan laatu ja merkintätavat vaihtelevat, esittäjät saattavat olla esim. pelkästään details-kentässä.
"presenters": { "presenters": [ { "name": "Carola", "role": "esitt." }, { "name": "Sarmanto, Heikki", "role": "esitt." }, { "name": "Heikki Sarmanto Trio", "role": "esitt." } ], "details": [ "Carola (voc), Heikki Sarmanto Trio: Heikki Sarmanto (p), Tapani Tamminen (b), Reino Laine (dr), Esa Pethman (fl, ts)" ] } | |
productionCredits | Lista | Tuotannon tekijätiedot. Käytetään ainakin joissakin äänitteissä. "productionCredits": [ "Miikka Huttunen (\u00e4\u00e4nitt\u00e4j\u00e4, miksaaja), Jukkis Uotila (tuottaja), Klaus Suonsaari (tuottaja), Svante Forsb\u00e4ck (masteroija)." ] |
projectedPublicationDate | Merkkijono | Arvioitu julkaisuajankohta "projectedPublicationDate": "12\/2015" |
publicationDates | Lista | Julkaisuajankohta "publicationDates": [ "1972" ] |
publicationEndDate | Merkkijono | Viimeinen julkaisuajankohta (kausijulkaisuissa) tai ensi-illan ajankohta (elokuvissa). "publicationEndDate": "2003" Edelleen jatkuva julkaisu merkitään usein vuotena 9999: "publicationEndDate": "9999" |
publicationFrequency | Lista | Julkaisutiheys. Ilmoitettu yleensä sanallisesti suomeksi. "publicationFrequency": [ "Kerran kuukaudessa." ] |
publicationInfo | Lista | Tietoa julkaisusta. Sisältää yleensä julkaisupaikan. "publicationInfo": [ "Dortmund" ] |
publishers | Lista
| Julkaisijat "publishers": [ "Published by E. & F.N. Spon for the Royal Institute of British Architects" ] |
previousTitles / newerTitles | Tieto voi sisältyä myös kenttään recordLinks | |
rating | Lista | Käyttäjien julkaisulle antamien arvostelujen keskiarvo ja lukumäärä. Arvostelut eivät ole käytössä kaikissa aineistotyypeissä.
"rating": { "average": 2.5, "count": 3 } |
rawData | Lista | Raaka metadata käsittelemättömänä. Esimerkkiä ei esitetä tässä suuren koon vuoksi. |
recordLinks | Lista | Tietueiden väliset linkit. Linkki voidaan muodostaa ainakin nimekkeen tai isn:n perusteella.
"recordLinks": [ { "value": "Baskervillen koira", "link": { "type": "isn", "value": "978-951-1-22851-6", "exclude": "arto.1567282" }, "translated": "Muu suhde" } ]
"recordLinks": [ { "value": "Julkisuuden salaisuudet : pakinoita ja satiireja journalismin ja julkisuuden kiehtovasta maailmasta", "link": { "type": "title", "value": "Julkisuuden salaisuudet : pakinoita ja satiireja journalismin ja julkisuuden kiehtovasta maailmasta" }, "translated": "Muu suhde" } ] |
series | Lista | Sarjatiedot
"series": [ { "name": "Ursan julkaisuja", "additional": "0357-7937;", "number": "28", "issn": "0357-7937" } ]
"series": [ { "name": "Laatukirjasto" } ] |
sfxObjectId | Merkkijono | SFX-tietueen tunniste "sfxObjectId": "1000000000310928" |
shortTitle | Merkkijono | Päänimeke. Katso myös title ja subTitle. "shortTitle": "Parhaat ruokasienet" |
source | Lista | Tietueen lähde
"source": [ { "value": "keski", "translated": "Keski-kirjastot" } ] |
subjects | Lista | Asiasanat/aiheet. Lista koostuu listoista, joissa on ensimmäisenä yläkäsite ja sen jälkeen mahdolliset alakäsitteet. Esim: "subjects": [ [ "Holmes, Sherlock,", "fikt." ], [ "elokuvat", "Iso-Britannia", "2000-2009" ], [ "j\u00e4nnityselokuvat" ], [ "rikoselokuvat" ] ] |
subTitle | Merkkijono | Alanimeke. Katso myös title ja shortTitle. "subTitle": "sieniopas" |
summary | Lista | Yhteenveto/tiivistelmä (pituus vaihtelee). Kaikkia Finnassa olevia tiivistelmiä ei tarjota rajapinnan kautta tekijänoikeudellisista syistä johtuen. Mikäli rajapinta palauttaa tiivistelmän, sen käyttö on sallittua rajapinnan käyttöehtojen mukaisesti. "summary": [ "Provides essential ideas of the new science of nanotechnology and mathematics. Covers contemporary topics in the areas of the environment, food safety, medicine and healthcare, consumer goods, agriculture, homeland security, and energy supply." ] |
systemDetails | Lista | Aineiston käyttöön tarvittava järjestelmä. "systemDetails": [ "Internet-yhteys; www-selain." ] |
title | Merkkijono | Koko nimeke. Katso myös shortTitle ja subTitle "title": "Parhaat ruokasienet : sieniopas" |
titleSection | Nimekkeeseen liittyvä osan numero, jos nimeke kuuluu sarjaan. Katso myös series. "titleSection": "3." | |
titleStatement | Merkkijono | Nimekkeeseen liittyvää lisätietoa. Sisältää usein tietoja tekijöistä. "titleStatement": "directed by Ridley Scott ; screenplay by Hampton Fancher and David Peoples" |
toc | Lista | Sisällysluettelo. Sisältää usein sisällysluettelon lisäksi tai sijasta muutakin kuvailutietoa ja jopa tiivistelmiä. "toc": [ "1 CD-\u00e4\u00e4nilevy + esiteliite", "Kappale Midnight in a perfect world sis. selke\u00e4n s\u00e4mplen Pekka Pohjolan kappaleesta Sekoilu seestyy", "Best foot forward. Building steam with a grain of salt. The number song. Changeling. What does your soul look like (part 4). Stem\/Long stem. Mutual slump. Organ donor. Why hip hop sucks in '96. Midnight in a perfect world. Napalm brain\/Scatter brain. What does your soul look like (part 1 - Blue sky revisit)", "DJ Shadow", "englanti" ] |
uniformTitles | Lista | Yhtenäistetyt nimekkeet (kirjastoaineisto). Yhtenäisyys ei välttämättä toteudu eri organisaatioiden välillä. "uniformTitles": [ "On the origin of species" ] |
unitId | Merkkijono | Arkistoyksikön tunniste (arkistoaineisto) "unitId": "Aa:6" |
urls | Lista | Linkit (tietueeseen liittyvät resurssit ja toiminnot ulkoisissa järjestelmissä. Sisältää myös kentän images kuvalinkit). Sisältää kentät:
"urls": [ { "url": "http:\/\/www.makupalat.fi\/", "desc": "Tietokannan k\u00e4ytt\u00f6liittym\u00e4" }, { "url": "http:\/\/www.makupalat.fi\/fi-FI\/Info\/", "desc": "Tietokantaopas" } ] |
year | Merkkijono | Vuosi (esimerkiksi julkaisuvuosi, valmistusvuosi). Käytetään myös main_date_str-fasetissa. "year": "1761"
|
Esimerkkejä
Tietueet hakusanalla "sibelius": | https://api.finna.fi/v1/search?lookfor=sibelius |
CD-levyt hakusanalla "sibelius": | https://api.finna.fi/v1/search?lookfor=sibelius&filter[]=format:"1/Sound/CD/" |
Verkossa saatavilla olevat kuvat hakusanalla "sibelius" | https://api.finna.fi/v1/search?lookfor=sibelius&filter[]=online_boolean:"1"&filter[]=format:"0/Image/" |
Verkossa saatavilla olevat kuvat hakusanalla "sibelius", hakutulokset ja fasetointi organisaation mukaan | https://api.finna.fi/v1/search?lookfor=sibelius&filter[]=online_boolean:"1"&filter[]=format:"0/Image/"&facet[]=building |
Kaikkien tietueiden aineistotyypit | https://api.finna.fi/v1/search?facet[]=format |
Kaikki verkossa saatavilla olevat kuvat | https://api.finna.fi/v1/search?filter[]=online_boolean:"1"&filter[]=format:"0/Image/" |
Tietueet sallitun käyttötavan mukaan (esimerkiksi "Saa muokata, myös kaupallinen") | https://api.finna.fi/v1/search?filter[]=usage_rights_str_mv:usage_B |
Mukana olevat organisaatiot, nimet ruotsiksi | https://api.finna.fi/v1/search?facet[]=building&lng=sv |
Tietueet, joissa tekijänä "sibelius" | https://api.finna.fi/v1/search?lookfor=sibelius&type=Author |
Yksittäisen tietueen noutaminen ID:n perusteella | https://api.finna.fi/v1/record?id=fennica.123 |
Kahden tietueen noutaminen ID:n perusteella | https://api.finna.fi/v1/record?id[]=fennica.123&id[]=fennica.124 |
Hakusana voi sisältää monimutkaisemman hakulausekkeen, esimerkiksi kohdistuksen tiettyyn indeksikenttään tai loogisen hakuoperaattorin:
Haku tietueen tunnisteella (ID:llä hakemiseen tarvitaan esimerkin mukaisesti kaksi vaihtoehtoa, joten parempi käyttää record-toimintoa) | https://api.finna.fi/v1/search?lookfor=id:vaski.2667110+OR+local_ids_str_mv:vaski.2667110 |
Haku hakusanoilla "sibelius" ja "festival" | https://api.finna.fi/v1/search?lookfor=sibelius+AND+festival |
Rajapinta tukee myös Finnan tarkennetun haun syntaksia samoin parametrein kuin tarkennetun haun hakutuloksessa:
https://api.finna.fi/v1/search?sort=relevance&bool0%5B%5D=AND&lookfor0%5B%5D=sibelius&type0%5B%5D=AllFields&lookfor0%5B%5D=festival&type0%5B%5D=AllFields&lookfor0%5B%5D=&type0%5B%5D=AllFields&join=AND&filter%5B%5D=~language%3A"fin"&limit=20