Haku API:n kautta

JSON API:n haussa ja hakutuloksissa käytettävät toiminnot.

Haku

Käyttö:

Hakujen osalta API:a kutsutaan lähes samallalailla kuin HTML-hakutuloksessakin. Ainoa muuttuva kohta on "FILETYPE"-parametri.

Ohessa esimerkkinä ns. normaali HTML-tiedoston palauttava haku:

/lib4/src?PBFORMTYPE=01001&PROFILESET=FIN&DATABASE=1&FREETEXT=internet&TITTYPE=-1&MAX=100&SORT=1&FILETYPE=HTML

Ohessa esimerkkinä ylläolevaa vastaava JSON-tietueen palauttava haku:

/lib4/src?PBFORMTYPE=01001&PROFILESET=FIN&DATABASE=1&FREETEXT=internet&TITTYPE=-1&MAX=100&SORT=1&FILETYPE=JSON

Hakutulos JSON

Ylläoleva hakuesimerkki voisi palauttaa esimerkiksi tällaisen hakutuloksen:

{"status":"OK","failcode":"0","errtxt":"","vertxt":"20", "pbtitles": [ {"title": { "titleid":"29389", "titleinfo":"Livsberättelser : mening och identitet i tid och rum", "titlelink":"?PBFORMTYPE=01002&TITLEID=29389&PROFILESET=fin&DATABASE=1&DEPARTMENT=&SORT=10&MAX=50&FILETYPE=HTML", "authorinfo": { "maincorporateauthor":"Karlstads universitet. Pedagogiskt arbete", "authors":"Marie Karlsson och Héctor Pérez Prieto (red)", "additionalauthors":"", "mainauthor":"" }, "publishinfo": {"printable": "Karlstad : Pedagogik och pedagogiskt arbete, Estetisk-filosofiska fakulteten, Karlstads universitet, 2012", "publisher":"","place":"","dateof":""}, "outlookinfo": {"printable":"179 s. : kuv"}, "seriesinfo": {"printable":"Karlstad University studies, ISSN 1403-8099 ; 2012:8"}, "classes": {"printable":""}, "subjects": {"printable":""}, "keywords": {"printable":""}, "documents": [ {"document": { "doctype":"Internet", "docname":"http://urn.kb.se/resolve?urn=urn:nbn:se:kau:diva-11624; urn:nbn:se:kau:diva-11624", "docdesc":"" } } ] } } ]}

JSON vastauksen kentät

Ylläolevassa JSON vastauksessa näkyvistä kentistä löydät selityksiä alla.

HUOM: v4.80.203 sisältää uuden lisäparametrin "APIV", jolle annettaessa arvo 2 eli "..&APIV=2&..", jolla saa lyhyempiä nimiä käyttävän hakutuloksen. Tämä lyhentää hakutuloksen kokoa huomattavasti isoissa hakutuloksissa. Aiempi tapa tulee yhteensopivuuden vuoksi edelleen oletuksena ja kaikilla muilla "APIV"-parametrin arvoilla. Parametri ei ole pakollinen. Typistettyjen objektinimien selitykset alimpana.

Mikäli tiedoissa löytyy "Printable", sisältää se kenttä käyttäjälle näytettävissä olevan muodon, jonka voi näyttää suoraan käyttöliittymässä. Tässä API versiossa suurimmasta osasta kenttiä on saatavilla vain "printable" tiedot, eikä esimerkiksi "tekijöitä" jokaista eriteltynä.

titleid = Nimekkeen kussakin tietokannassa yksilöivä numero.

titleinfo = Nimekkeen nimi "käyttäjälle näytettävässä" muodossa. Päänimeke, alanimeke, rinnakkaisnimeke.

titlelink = Linkki nimekkeen tarkempiin tietoihin. Käytännössä voi olla sama tieto kuin tässä hakutuloksessakin. Voi sisältää tulevissa versioissa enemmän tietoa.

authorinfo = Tekijätiedot, sisältää useita kenttiä.

maincorporateauthor = yhteisötekijä.

mainauthor = Pääkirjaus tekijästä.

additionalauthors = Lisäkirjaus tekijästä.

authors = Tekijätiedot vapaamuotoisessa kentässä.

publishinfo = Julkaisutiedot.

outlookinfo = Ulkoasutiedot.

seriesinfo = Sarjaa koskevat tiedot.

classes = Luokitukset.

sujects = Asiasanat.

keywords = Avainsanat.

documents = Nimekkeelle tallennettavissa olevia linkkejä (esim PDF dokumentteihin, tiivistelmiin, tiedostoihin yms.)

API versio 2

Selitykset käytettäessä hakuparametriä "APIV=2". !KESKEN PÄIVITETÄÄN!

tid = Nimekkeen kussakin tietokannassa yksilöivä numero.

tinfo = Nimekkeen nimi "käyttäjälle näytettävässä" muodossa. Päänimeke, alanimeke, rinnakkaisnimeke.

tlnk = Linkki nimekkeen tarkempiin tietoihin. Käytännössä voi olla sama tieto kuin tässä hakutuloksessakin. Voi sisältää tulevissa versioissa enemmän tietoa.

ai = Tekijätiedot, sisältää useita kenttiä.

mca = yhteisötekijä.

ma = Pääkirjaus tekijästä.

aa = Lisäkirjaus tekijästä.

? = Tekijätiedot vapaamuotoisessa kentässä.

pi = Julkaisutiedot.

oi = Ulkoasutiedot.

si = Sarjaa koskevat tiedot.

? = Luokitukset.

? = Asiasanat.

? = Avainsanat.

? = Nimekkeelle tallennettavissa olevia linkkejä (esim PDF dokumentteihin, tiivistelmiin, tiedostoihin yms.)