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

Compare with Current View Page History

« Previous Version 3 Next »

History

29.1.2016 First version

Terms of Use

To be added later.

Questions and feedback may be sent to [email protected].

General

The API provides a way to perform searches to the material provided by the organizations participating in Finna.fi.

The queries are formatted in the following way:

https://api.finna.fi/v1/<action>?<parameters>

By default the results are returned in json-format. jsonp-format is used if the request includes a callback-parameter

https://api.finna.fi/v1/<action>?callback=process

Actions

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

Perform a search.

ParameterTypeSeliteSallitut arvot
lookforStringSearch term 
facetArrayFacets to be returned

List of index fields (column Core Fields) that may be used in faceting (Facet Field = Yes).

  • Results for non-hierarchical facets (other than format, building, sector_str_mv, category_str_mv) consist of the first 30 values sorted by count in decreasing order. 
  • The result item consists of the following fields:
    • value: facet value that may be used in the filter-parameter.

    • translated: translated display string

    • count: number of records

    • isApplied: 1 if if the facet is in used in the filter-parameter of the query

    • href: (relative) link for toggling (AND) filtering using the facet on or off (depending on whether the facet is active in the filter-parameter of the current query). For other operators, see 'filter' -field.

    • children Children facet items. Defined only for hierarchical facets.

"facets": {
"format": [
{
"value": "0\/MusicalScore\/",
"translated": "Musical score",
"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"
},
facetFilterArray

List of facet value filters

  • facetFilter[]=<facet>:"<regular expression>"
     
  • Allows filtering the returned facet items using regular expressions targeted to the value-field of the facet.
  • Note: the filtered facet needs to be present among the list of returned facets (facet-parameter).
    Examples:
    • Only University of Jyväskylä main level among building building-facet
    • University of Jyväskylä building-facet root level values:
      • facetFilter[]=building:"0/JYU"
    • University of Jyväskylä building-facet values (all levels):
      • facetFilter[]=building:"\d/JYU"
    • Format-facet root level items:
      • facetFilter[]=format:"^0/"
    • e-books and CDs from format-facet:
      • facetFilter[]=format:"(1/Book/eBook/|1/Sound/CD)"
  • The result will include the matched facet items and their possible parent items.
    For example when filtering e-books (facetFilter[]=format:"1/Book/eBook/") from format-facet values, the result will include also the root-level item Book (0/Book):
"facets": {
    "format": [
        {
            "value": "0\/Book\/",
            "translated": "Book",
            "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-book",
                    "count": 237,
                    "href": "?lookfor=sibelius&amp;type=AllFields&amp;filter%5B%5D=format%3A%221%2FBook%2FeBook%2F%22"
                }
            ]
        }
    ]
}
filterArraySearch filters
  • <facet>="<value>"
  • List of facet fields (column Core Fields) that may be used in filtering (Facet Field=Yes).
     
  • To return possible field values for a facet field you can perform a query without a search term and filters. For example to list all values for the format-field:
    • https://api.finna.fi/v1/search?lookfor=&facet[]=format&prettyPrint=1&limit=0
  • AND-filtering is used by default. OR or NOT filtering can be used by prepending the field with '~' (OR) or '-' (NOT). 
    Examples:
    • No books: 
      • filter[]=-format:"0:/Book"
    • Books or CDs: 
      • filter[]=~format:"0/Book/"&filter[]=~format:"1/Sound/CD/"
         

See type-field for using non-facet fields in filtering.

typeStringSearch type
  • AllFields (basic search, default)
  • Title

  • Author

  • Subject

  • year

  • JournalTitle

  • CallNumber (shelf location for library material).

  • publisher

  • Series

  • toc (Table of Contents)

  • ISN (Journal ISN-number)

  • Classification
    • For example:
      • Classification="ykl+35.6"

List of index fields that are used in different search types (column Search).

A query may be targeted to a specific (non-facet) index field by including the field in the search term.
For example to target the query to the field publication_place_txt_mv

?lookfor=publication_place_txt_mv:pomarkku&field[]=id&field[]=publication_place_str_mv&field[]=placesOfPublication&field[]=publicationInfo&prettyPrint=1

Note: put facet fields in the filter-parameter. For example:

?lookfor=format:0/Book/ (not supported)

?lookfor=&filter[]=format:0/Book/ (use this instead)

sortStringSearch result order
  • Relevance (relevance, default)
  • title
  • author
    • Main author is used when the record has multiple authors.
  • last_indexed desc (last indexed)
  • main_date_str desc (newest first)
  • main_date_str asc (oldest first)
  • callnumber (shelf location of library material)
    • When the record has multiple call numbers the first one is used in sorting.
pageNumberResult page1-n (default 1).
limitNumberNumber of results

0-100 (oletus 20). limit=0 is useful when you only need the number of results or the results of faceting.

lngStringLanguage version
  • fi (finnish, default)
  • sv (swedish)
  • en-gb (english)

    Language version only affects building and format facets and institutions record field.

fieldArrayRecord fields to be returned

See the list of supported record fields below. If not defined, the bolded record fields from the list are returned. If empty, no records are returned.

callbackStringJSONP callback-functionOptional, not in use by default.
prettyPrintNumberPretty printed JSON result0, 1 (default 0).

Similar records (mainly books) from different sources are combined (deduplicated) during the search and only the record with the highest priority is shown in the search results. Filter the results using building to restrict returned records to specific sources.

The record field of dedupIds of a deduplicated record contains the IDs of similar records, for eaxmple:

{
"resultCount": 42,
"records": [
{
"id": "fennica.1003041",
"title": "Puhdistus",
"dedupIds": [
"fennica.1003041",
"jykdok.1256458",
"keski.2341400",
"vaari.1688117",
"vaski.2846838"
]
},
 

The IDs can be used to return a specific version of a record (see Record-action).

Faceting results are affected by all similar records that have been combined in the search results to a single (deduplicated) result. For example, the values of all similar records are shown in the building facet. If needed, use facetFilter-parameter to restrict returned facet results.

More information on the deduplication algorithm

Record

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

Retrieve record fields.

ParameterTypeDescriptionSupported values
idString|ArrayRecord ID or IDs

id record field

  • For example jykdok.922403
fieldArrayRecord fields.

 See the list of supported record fields below. If not defined, the bolded record fields from the list are returned. If empty, no records are returned.

callbackStringJSONP callback-functionOptional, not in use by default.
prettyPrintNumberPretty printed JSON result0, 1 (default 0).

Supported record fields

The following record fields can be used in the field parameter.

Record field content is dependent on the quality of the metadata. Most record fields are not unified acrossa records and therefore, for example, author names may be presented in different ways. Fields may also contain untranslated content.

If a requested field is missing from the response, it is not defined for the record.

FieldTypeDesciption
accessRestrictions

Array

Access restrictions, if known.

For examples:

"accessRestrictions": [
    "University of Turku local network, remote access with Univ. of Turku username",
    "Turun yliopiston verkossa, et\u00e4k\u00e4ytt\u00f6 TY:n tunnuksilla"
]

"accessRestrictions": [

    "ELEKTRA-lisenssi"
]

"accessRestrictions": [

    "K11"
]
alternativeTitlesArray

Alternative titles.

For example:

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

Authors.

  • main: main author
  • corporate: corporate author
  • secondary: other authors

Examples:

"authors": {
    "main": "Bowie, David",
    "secondary": [
        "Spiders from Mars"
    ]
}
"authors": {
    "main": "Ozric Tentacles",
    "corporate": "Ozric Tentacles,"
}
awardsArray

Awards.

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

Publication type, for example 'Monograph', 'MonographPart' (part of a monograph), 'Serial' (serial publication), 'SerialPart' (part of a serial publication) and 'Unknown'.

"bibliographicLevel": "Monograph"
buildingsArray

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

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
classificationsArray

Luokitukset eri luokitusjärjestelmissä.

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

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

"cleanIsbn": "1402087179"
cleanIssnString

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

"cleanIssn": "0065-2164"
collectionsArray

Kokoelmat. Käytössä ainakin museoaineistossa.

"collections": [
    "Riuttalan talonpoikaismuseo"
]
containerIssueString

Sisältävän julkaisun numero

"containerIssue": "4"
containerReferenceString

Viite sisältävään julkaisuun

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

Alkusivu sisältävässä julkaisussa

"containerStartPage": "191"
containerTitleString

Sisältävän julkaisun nimeke

"containerTitle": "Finland : an introduction"
containerVolumeString

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

"containerVolume": "25"
corporateAuthorString

Yhteisötekijä

"corporateAuthor": "Valtiontalouden tarkastusvirasto."
dedupIdsArray

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

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

Opinnäytteen huomautus

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

Painos, laitos tai versio

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

 

"edition": "Pidennetty versio"
embeddedComponentPartsArray

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)

eventsArray

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

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

Yleiset huomautukset.

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

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

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

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

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

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

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

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

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

Julkaisuajankohdat ihmisen luettavassa muodossa.

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

Tietueen yksilöivä tunniste

"id": "alma.757000"
identifierString

String

 

Tietueen tunniste, ei yksilöivä. Käytössä ainakin museoaineistoissa ja tietokannoissa.

Museoaineistossa inventaarionumero:

"identifierString": "201190a20"

Tietokannoissa tunniste:

"identifierString": "FSD"
imageRightsArray

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)

imagesArray

Tieteen kuvien osoitteet.

"images": [
    "\/Cover\/Show?id=hkm.HKMS000005%3Akm002w3s&fullres=1&index=0"
]

Kuvaa luettaessa osoitteen alkuun tulee lisätä https://www.finna.fi, esimerkiksi:

https://www.finna.fi/Cover/Show?id=hkm.HKMS000005%3Akm002w3s&fullres=1&index=0

Kirjojen tietuekuvan linkki palauttaa 10x10 pikselin kokoisen läpinäkyvän .gif-kuvan mikäli oikeaa kuvaa ei löydy.

institutionsArray

Organisaatio. Katso myös buildings

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

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
issnsArray

ISSN-tunnukset. Ks. myös cleanIssn

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

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

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

Library of Congress Control Number

"lccn": "2010252176"
manufacturerString

Valmistaja

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

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

"manufacturer": "(Porvoo)"
measurementsArray

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

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."
    }
]
onlineUrlsArray

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

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

originalLanguagesArray

Aineiston alkuperäiskielet. Katso myös languages.

"originalLanguages": [
    "jpn"
]
otherLinksArray

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

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

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

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

Fyysiset sijainnit. Vain arkistotietueilla.

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

Array

Julkaisupaikka

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

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

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

Arvioitu julkaisuajankohta

"projectedPublicationDate": "12\/2015"
publicationDatesArray

Julkaisuajankohta

"publicationDates": [
    "1972"
]
publicationEndDateString

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

"publicationEndDate": "2003"

Edelleen jatkuva julkaisu merkitään usein vuotena 9999:

"publicationEndDate": "9999"
publicationFrequencyArray

Julkaisutiheys. Ilmoitettu yleensä sanallisesti suomeksi.

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

Tietoa julkaisusta. Sisältää yleensä julkaisupaikan.

"publicationInfo": [
    "Dortmund"
]
publishers

Array

 

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
ratingArray

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
}
rawDataArray

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

recordLinksArray

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"
    }
]
recordPageStringRelatiivinen linkki tietueen sivulle Finnassa. Lisää linkin alkuun https://www.finna.fi
seriesArray

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

SFX-tietueen tunniste

"sfxObjectId": "1000000000310928"
shortTitleString

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

"shortTitle": "Parhaat ruokasienet"
source

Array

Tietueen lähde

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

Asiasanat/aiheet. Array 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"
    ]
]
subTitleString

Alanimeke. Katso myös title ja shortTitle.

"subTitle": "sieniopas"
summaryArray

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

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

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

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

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

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

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

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

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

Arkistoyksikön tunniste (arkistoaineisto)

"unitId": "Aa:6"
urlsArray

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

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

Demo

https://github.com/NatLibFi/NDL-VuFind2/tree/gh-pages/api

Lisätietoja

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