You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

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

https://api.finna.fi/v1/search?<parametrit>

Haku Finnan indeksistä.

ParametriTyyppiSeliteSallitut arvot
lookforMerkkijonoHakusana 
facetListaPalautettavat fasetit

Finnan hakuindeksin kentät.  

  • kenttä (Sarake Core Fields)
  • voi käyttää fasetoinnissa (Sarake Facet Field = Yes)
  • Hierarkisten fasettien (format, building, sector_str_mv, category_str_mv) tulokset palautetaan kokonaisuudessaan. Muiden fasettien osalta ensimmäiset 30.
  • Sisältää kentät:
    • value: koodi

    • translated: käännös

    • count: tietueiden lukumäärä

    • isApplied: 1 jos fasettia on käytetty kyselyn filter-parametrissa

    • href: AND-rajaus päälle tai pois (riippuen siitä onko fasetin koodia käytetty kyselyn filter-parametrissa). Muut operaattorit, ks. 'filter' -kentän ohje.

    • children

"facets": {
"format": [
{
"value": "0\/MusicalScore\/",
"translated": "Noter",
"count": 96,
"isApplied": false,
"href": "?lookfor=notbok&amp;type=AllFields&amp;limit=2&amp;filter%5B%5D=building%3A%220%2FVaski%2F%22&amp;filter%5B%5D=format%3A%220%2FMusicalScore%2F%22"
},
facetFilterListaLista palautettavien fasettiarvojen rajauksille
  • facetFilter[]=<fasetti>:"<säännöllinen lauseke>"
  • Mahdollistaa palautettavien fasettiarvojen rajaamisen sännöllisten lausekkeiden avulla. 
  • Huom: Rajattava fasetti tulee olla palautettavien fasettien joukossa.
    Esimerkkejä:
    • Sijainti-fasetin arvoista vain Jyväskylän yliopiston päätaso:
      • facetFilter[]=building:"0/JYU"
    • Sijainti-fasetin arvoista vain Jyväskylän yliopistoon kuuluvat:
      • facetFilter[]=building:"\d/JYU"
    • Aineistotyyppi-fasetin arvoista vain esnimmäiselle tasolle kuuluvat:
      • facetFilter[]=format:"^0/"
    • Aineistotyyppi-fasetin arvoista vain e-kirjat ja CD-levyt:
      • facetFilter[]=format:"(1/Book/eBook/|1/Sound/CD)"
  • Mikäli säännöllinen lauseke kohdistuu hierakisen fasetin päätasoa alemmille tasoille, palautetaan kohdefasetin lisäksi hierarkiassa tätä edeltävät fasetit.
    Esimerkiksi kun rajataan Aineistotyyppi-fasetista e-kirjat (facetFilter[]=format:"1/Book/eBook/"), tulos sisältää myös päätason fasetin Kirja (o/Book):
"facets": {
    "format": [
        {
            "value": "0\/Book\/",
            "translated": "Kirja",
            "count": 4893,
            "href": "?lookfor=sibelius&amp;type=AllFields&amp;filter%5B%5D=format%3A%220%2FBook%2F%22",
            "children": [
                {
                    "value": "1\/Book\/eBook\/",
                    "translated": "E-kirja",
                    "count": 237,
                    "href": "?lookfor=sibelius&amp;type=AllFields&amp;filter%5B%5D=format%3A%221%2FBook%2FeBook%2F%22"
                }
            ]
        }
    ]
}
filterListaRajaukset
  • <fasetti>="<arvo>".
  • Rajauksissa käytettävissä olevat fasetit ks. yllä. 
  • Fasettien arvot saa selville tekemällä kyselyn ilman hakusanaa ja rajauksia. Esimerkki: listataan kaikki aineistotyypit:
    • https://api.finna.fi/v1/search?lookfor=&facet[]=format&prettyPrint=1&limit=0
  • Rajaukset ovat oletuksena AND-rajauksia. OR tai NOT-rajausta voi käyttää lisäämällä fasetin eteen '~' (OR) tai '-' (NOT).
    Esimerkkejä:
    • Ei kirjoja: 
      • filter[]=-format:"0:/Book"
    • Kirja tai CD-levy: 
      • filter[]=~format:"0/Book/"&filter[]=~format:"1/Sound/CD/"
typeMerkkijonoKohdekenttä
  • AllFields (perushaku, oletus)
  • Title (nimeke)

  • Author (tekijä)

  • Subject (asiasana)

  • year (vuosi)

  • JournalTitle (lehden nimeke)

  • CallNumber (kirjastoaineiston hyllypaikka). Huomaa että jos hakee esim. luokalla 84 rajapinta ei palauta alaluokkaa 84.2 edustavia tuloksia.

  • publisher (julkasija)

  • Series (sarja)

  • toc (sisällysluettelo)

  • ISN (lehden ISN-numero)

  • Classification (luokitus)
    • Esim:
      • Classification="ykl+35.6"

Voit myös kohdistaa haun suoraan indeksin haettaviin kenttiin (ks. Finnan hakuindeksin kentät, sarake Search) määrittelemällä kohdekentän hakulausekkeessa.
Esimerkki: kohdistetaan haku kenttään publication_place_txt_mv:

?lookfor=publication_place_txt_mv:pomarkku&field[]=id&field[]=publication_place_str_mv&field[]=placesOfPublication&field[]=publicationInfo&prettyPrint=1
sortMerkkijonoJärjestys
  • Relevance (relevanssi, oletus)
  • title (nimeke)
  • author (tekijä)
    • Jos tekijöitä on useita, lajitellaan päätekijän mukaan
  • last_indexed desc (viimeksi indeksoidut)
  • main_date_str desc (uusimmat ensin)
  • main_date_str asc (vanhimmat ensin)
  • callnumber (kirjastoaineiston hyllypaikka)
    • Jos tietueessa on useita callnumbereita, lajittelu tehdään ensimmäisen perusteella.
pageLukuHakutulossivu1-n (oletus 1). Sivun koko tulee limit-parametrista (oletuksena siis 1 sivu = 20 tulosta).
limitLukuTulosten lukumäärä

0-100 (oletus 20). Jos 0, ei tietueita palauteta ollenkaan.

lngMerkkijonoFasettien kieliversio
  • fi (suomi, oletus)
  • sv (ruotsi)
  • en-gb (englanti)
fieldListaPalautettavat 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.

callbackMerkkijonocallback-funktio JSONP-tilassaOletuksena ei käytössä
prettyPrintLukuTulostetaanko JSON rivinvaihtojen keraOletus 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"
]
},
...
 

Lisätietoja deduplikointi-algoritmista.

Record

https://api.finna.fi/v1/record?<parametrit>

Tietueiden nouto ID:llä

ParametriTyyppiSeliteSallitut arvot
idMerkkijono tai listaTietueen ID tai tietueiden ID:t 
fieldListaPalautettavat 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.

callbackMerkkijonocallback-funktio JSONP-tilassaOletuksena ei käytössä
prettyPrint0 tai 1Tulostetaanko JSON rivinvaihtojen keraOletus 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äTyyppiSelite
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"
]
alternativeTitlesLista

Vaihtoehtoiset nimekkeet

"alternativeTitles": [
    "Miehet mustissa",
    "MIB"
]
authorsLista

Kaikki tekijät

  • main: päätekijä (jos on)
  • corporate: yhteisötekijä (jos on)
  • secondary: muut tekijät (jos on)
"authors": {
    "main": "Bowie, David",
    "secondary": [
        "Spiders from Mars"
    ]
}

 

"authors": {
    "main": "Ozric Tentacles",
    "corporate": "Ozric Tentacles,"
}
awardsLista

Palkinnot. Merkitty varsin harvoin.

"awards": [
    "Tieto-Finlandia-palkinto 2013."
]
bibliographicLevelMerkkijono

Julkaisun tyyppi. Tyyppejä ainakin Monograph (monografia), MonographPart (monografian osa), Serial (sarjajulkaisu), SerialPart (sarjajulkaisun osa) ja Unknown (tuntematon).

"bibliographicLevel": "Monograph"
buildingsLista

Sijainti (hierarkkinen). Sisältää kentät:

  • value: sijainnin koodi, käytetään fasetoinnissa
  • translated: sijainnin käännös
"buildings": [
    {
        "value": "0\/TAIY\/",
        "translated": "Taideyliopisto"
    },
    {
        "value": "1\/TAIY\/tea\/",
        "translated": "Teatterikorkeakoulun kirjasto"
    },
    {
        "value": "2\/TAIY\/tea\/1\/",
        "translated": "Lainattavat"
    }
]
callNumbersLista

Kirjastoaineiston hyllypaikat. Merkintätapa vaihtelee kirjastoittain.

"callNumbers": [
    "84.5",
    "KAUHU"
]
childRecordCountLuku

Tietueen lapsitietueiden lukumäärä. Tämän tiedon pyytäminen voi kasvattaa vasteaikaa merkittävästi.

"childRecordCount": 0
classificationsLista

Luokitukset eri luokitusjärjestelmissä.

"classifications": {
"udk": [
"001.81",
"001.818",
],
"ykl": [
"16.7",
"38.3",
]
}
cleanIsbnMerkkijono

Pelkkä ISBN-tunnus ilman ulkoasua tms. Ks. myös isbns

"cleanIsbn": "1402087179"
cleanIssnMerkkijono

Pelkkä ISSN-tunnus. Ks. myös issns

"cleanIssn": "0065-2164"
collectionsLista

Kokoelmat. Käytössä ainakin museoaineistossa.

"collections": [
    "Riuttalan talonpoikaismuseo"
]
containerIssueMerkkijono

Sisältävän julkaisun numero

"containerIssue": "4"
containerReferenceMerkkijono

Viite sisältävään julkaisuun

"containerReference": "s. 191-201"
containerStartPageMerkkijono

Alkusivu sisältävässä julkaisussa

"containerStartPage": "191"
containerTitleMerkkijono

Sisältävän julkaisun nimeke

"containerTitle": "Finland : an introduction"
containerVolumeMerkkijono

Sisältävän julkaisun volyymi (vuosikerta / kirjasarjan osa)

"containerVolume": "25"
corporateAuthorMerkkijono

Yhteisötekijä

"corporateAuthor": "Valtiontalouden tarkastusvirasto."
dedupIdsLista

Muista lähteistä tulleiden samaa sisältöä edustavien tietueiden id:t

"dedupIds": [
    "alma.678448",
    "oula.894534",
    "tamcat.399614"
]
dissertationNoteMerkkijono

Opinnäytteen huomautus

"dissertationNote": "Pro gradu -ty\u00f6 : Tampereen yliopisto, historiatieteen laitos, yleinen historia."
editionMerkkijono

Painos, laitos tai versio

"edition": "10. osin uud. laitos"

 

"edition": "Pidennetty versio"
embeddedComponentPartsLista

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)

eventsLista

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"
        }
    ]
}
formatsLista

Tietueen aineistotyypit (hierarkkinen). Usein aineistotyyppi on datassa virheellisesti "Other", vaikka kyse olisi esim. cd-levystä, jolle löytyisi oma aineistotyyppikin.

  • value: aineistotyypin koodi
  • translated: aineistotyypin käännös

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"
    }
]
fullRecordMerkkijonoAlkuperäinen tietue XML-muodossa. Esimerkki jätetty pois koon vuoksi.
generalNotesLista

Yleiset huomautukset.

"generalNotes": [
    "Ainoastaan verkkolehden vuoden viimeinen numero ilmestyy painettuna.",
    "Ei ilmestynyt lainkaan painettuna 2005."
]
genresLista

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"
]
hierarchyParentIdLista

Emotietueen ID, jos tietue kuuluu hierarkiaan. Käytössä ainakin arkisto- ja kirjastoaineistossa.

"hierarchyParentId": [
    "narc.VAKKA-192941.KA_VAKKA-62641.KA"
]
hierarchyParentTitleLista

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"
]
hierarchyTopIdLista

Hierarkian päätietueen ID, jos tietue kuuluu hierarkiaan. Käytössä ainakin arkistoaineistossa.

"hierarchyTopId": [
    "narc.VAKKA-192941.KA"
]
hierarchyTopTitleLista

Hierarkian päätietueen nimeke, jos tietue kuuluu hierarkiaan. Käytössä ainakin arkistoaineistossa.

"hierarchyTopTitle": [
    "Viipurin provinssikanslian arkisto"
]
humanReadablePublicationDatesLista

Julkaisuajankohdat ihmisen luettavassa muodossa.

"humanReadablePublicationDates": [
    "1983-2006."
]
idMerkkijono

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"
imageRightsLista

Kuvien käyttöoikeudet:

  • copyright: Käyttöoikeus lyhyessä muodossa

  • link: Linkki lisenssiin

  • description: Käyttöoikeuden mahdollinen pidempi kuvaus ja/tai lisätietoja

"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)

imagesLista

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"
]
institutionsLista

Organisaatio. Katso myös buildings

  • value: organisaation koodi
  • translated: organisaation nimi käännettynä
"institutions": [
    {
        "value": "LUC",
        "translated": "Lapin korkeakoulukirjasto"
    }
]
isbnsLista

ISBN-tunnukset (ks. myös cleanIsbn)

"isbns": [
    "951-0-31435-8 (sid.)",
    "978-951-0-31435-7 (sid.)"
]
isCollectionTotuusarvo

Onko tietue kokoelma (arkistoaineisto)

"isCollection": true
isPartOfArchiveSeriesTotuusarvo

Onko tietue osa arkistosarjaa (arkistoaineisto)

"isPartOfArchiveSeries": true
issnsLista

ISSN-tunnukset. Ks. myös cleanIssn

"issns": [
    "1913-4711"
]
languagesLista

Aineiston kielet. Kielet palautetaan koodeina ja ne ovat usein mutteivät aina MARC-muodossa. Katso myös originalLanguages.

"languages": [
    "fin",
    "swe"
]
lccnMerkkijono

Library of Congress Control Number

"lccn": "2010252176"
manufacturerMerkkijono

Valmistaja

"manufacturer": "([Myllykoski] : Myllykosken kirjap.)"

Joskus data on epämääräisempää:

"manufacturer": "(Porvoo)"
measurementsLista

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"
]
nonPresenterAuthorsLista

Tekijät ilman esittäjiä (ks. myös presenters)

  • name: tekijän nimi
  • role: tekijän rooli (jos on)
"nonPresenterAuthors": [
    {
        "name": "Doyle, Arthur Conan",
    },
    {
        "name": "Attwood, David",
        "role": "ohj."
    }
]
onlineUrlsLista

Online-linkit (kirjastoaineisto). Sisältää kentät:

  • url: linkin URL
  • text: linkin teksti (ei käännetty)
  • source: tietueen tietolähde (organisaatio)
    • value: organisaation koodi
    • translated: nimi käännettynä
"onlineUrls": [
    {
        "url": "http:\/\/eca.europa.eu\/portal\/page\/portal\/publications\/Journal",
        "text": "Elektroninen julkaisu (PDF)",
        "source": {
            "value": "selma",
            "translated": "Eduskunnan kirjasto - Selma"
        }
    }
]
openUrlMerkkijono

OpenURL (kirjastoaineisto). Esimerkki jätetty pois pituuden takia.

originalLanguagesLista

Aineiston alkuperäiskielet. Katso myös languages.

"originalLanguages": [
    "jpn"
]
otherLinksLista

Muut tietueen linkit. Käytetään ainakin arvosteltujen teosten merkitsemiseen.

"otherLinks": [
    {
        "heading": "Arvosteltu teos",
        "title": "Viimeiset runonlaulajat",
        "author": "Martti Haavio"
    }
]
physicalDescriptionsLista

Aineiston fyysinen kuvaus. Käytössä ainakin arkistotietueissa.

"physicalDescriptions": [
    "0,01 hyllmeter",
    "1 arkivenheter"
]
physicalLocationsLista

Fyysiset sijainnit. Vain arkistotietueilla.

"physicalLocations": [
    "Historiska och litteraturhistoriska arkivet",
    "Helsingfors, Nationalbiblioteket"
]
placesOfPublication

Lista

Julkaisupaikka

"placesOfPublication": [
    "New York, NY  :"
]
playingTimesLista

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 (lista)
    • name: esittäjän nimi
    • role: esittäjän rooli
  • details (lista): lisätietoja
"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)"
    ]
}
productionCreditsLista

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)."
]
projectedPublicationDateMerkkijono

Arvioitu julkaisuajankohta

"projectedPublicationDate": "12\/2015"
publicationDatesLista

Julkaisuajankohta

"publicationDates": [
    "1972"
]
publicationEndDateMerkkijono

Viimeinen julkaisuajankohta (kausijulkaisuissa) tai ensi-illan ajankohta (elokuvissa).

"publicationEndDate": "2003"

Edelleen jatkuva julkaisu merkitään usein vuotena 9999:

"publicationEndDate": "9999"
publicationFrequencyLista

Julkaisutiheys. Ilmoitettu yleensä sanallisesti suomeksi.

"publicationFrequency": [
    "Kerran kuukaudessa."
]
publicationInfoLista

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
ratingLista

Käyttäjien julkaisulle antamien arvostelujen keskiarvo ja lukumäärä. Arvostelut eivät ole käytössä kaikissa aineistotyypeissä.

  • average: keskiarvo, 0-5 tähteä, pyöristettynä alaspäin lähimpään puoleen tähteen.

  • count: arvostelujen lukumäärä

"rating": {
    "average": 2.5,
    "count": 3
}
rawDataLista

Raaka metadata käsittelemättömänä. Esimerkkiä ei esitetä tässä suuren koon vuoksi.

recordLinksLista

Tietueiden väliset linkit. Linkki voidaan muodostaa ainakin nimekkeen tai isn:n perusteella.

  • value
  • link
    • type: linkin muodostamisperuste, kuten title tai isn
    • value: tieto linkin muodostamiseksi
    • exclude
  • translated: käännetty kuvaus tietueen suhteesta linkitettyyn tietueeseen

 

"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"
    }
]
seriesLista

Sarjatiedot

  • name: sarjan nimi
  • additional (valinnainen)
  • number: järjestysluku (valinnainen)
  • issn: issn-numero (valinnainen)

 

"series": [
    {
        "name": "Ursan julkaisuja",
        "additional": "0357-7937;",
        "number": "28",
        "issn": "0357-7937"
    }
]

 

"series": [
    {
        "name": "Laatukirjasto"
    }
]
sfxObjectIdMerkkijono

SFX-tietueen tunniste

"sfxObjectId": "1000000000310928"
shortTitleMerkkijono

Päänimeke. Katso myös title ja subTitle.

"shortTitle": "Parhaat ruokasienet"
source

Lista

Tietueen lähde

  • value: organisaation koodi
  • translated: organisaation käännetty nimi
"source": [
    {
        "value": "keski",
        "translated": "Keski-kirjastot"
    }
]
subjectsLista

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"
    ]
]
subTitleMerkkijono

Alanimeke. Katso myös title ja shortTitle.

"subTitle": "sieniopas"
summaryLista

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."
]
systemDetailsLista

Aineiston käyttöön tarvittava järjestelmä.

"systemDetails": [
    "Internet-yhteys; www-selain."
]
titleMerkkijono

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."
titleStatementMerkkijono

Nimekkeeseen liittyvää lisätietoa. Sisältää usein tietoja tekijöistä.

"titleStatement": "directed by Ridley Scott ; screenplay by Hampton Fancher and  David Peoples"
tocLista

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"
]
uniformTitlesLista

Yhtenäistetyt nimekkeet (kirjastoaineisto). Yhtenäisyys ei välttämättä toteudu eri organisaatioiden välillä.

"uniformTitles": [
    "On the origin of species"
]
unitIdMerkkijono

Arkistoyksikön tunniste (arkistoaineisto)

"unitId": "Aa:6"
urlsLista

Linkit (tietueeseen liittyvät resurssit ja toiminnot ulkoisissa järjestelmissä. Sisältää myös kentän images kuvalinkit). Sisältää kentät:

  • url: linkin URL
  • desc: kuvaus käännettynä (jos on)
"urls": [
    {
        "url": "http:\/\/www.makupalat.fi\/",
        "desc": "Tietokannan k\u00e4ytt\u00f6liittym\u00e4"
    },
    {
        "url": "http:\/\/www.makupalat.fi\/fi-FI\/Info\/",
        "desc": "Tietokantaopas"
    }
]
yearMerkkijono

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
https://api.finna.fi/v1/record?id=vaski.2667110
Haku hakusanoilla "sibelius" ja "festival"
https://api.finna.fi/v1/search?lookfor=sibelius+AND+festival

Lisätietoja hakusyntaksista.

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
  • No labels