Child pages
  • XML-siirrot
Skip to end of metadata
Go to start of metadata

XML-siirrot

Kirjastokarttapalvelu tarjoaa rajapinnan, joka mahdollistaa palvelun sisältämien tietojen hyödyntämisen muissa verkkopalveluissa tai tietojärjestelmissä. Tietojen hakeminen tapahtuu HTTP-protokollan kautta ja palvelu palauttaa tiedot XML-muodossa.

Hakuehtojen rajaaminen tapahtuu rajapinnan hakuosoitteeseen liitettävien parametrien avulla. Rajapinnan tukemat parametrit on esitetty taulukossa 1.

Parametri

Kuvaus

Arvo

search

Hakusana. Isoilla ja pienillä kirjaimilla ei ole merkitystä.

merkkijono

type

Hakutyyppi. Mihin kenttään haku kohdistuu.

callno / code / desc / note / subject / staffNote1 / staffNote2 / shelf / floor / id / all

position

Hakusanan sijainti kentän sisällä. Hakusana voi esiintyä kentän alussa, keskellä tai lopussa. Match-vaihtoehto puolestaan tarkoittaa, että kenttä sisältää vain hakusanan määrittämän merkkijonon, eikä mitään muuta.

first / last / any / match

children

Näytetäänkö hakutuloksissa myös sijaintien sisältämät sijainnit eli esim. kirjaston kokoelmat ja kokoelmien hyllyluokat.

yes / no

owner

Sen kirjaston ISIL-tunnus, jonka sijainteihin haku kohdistuu.

merkkijono

versionHaussa käytettävä rajapinnan versio. Parametrin arvo 1 tarkoittaa suoraan tietokantaan kohdistuvaa hakua ja parametrin arvo 2 Solr-hakuindeksiin kohdistuvaa hakua. Mikäli parametria ei anneta, käytetään versiota 1. Eri versioiden palauttamat hakutulokset ovat sisällöiltään muutoin samanlaisia, mutta tulosten järjestys voi olla eri, jonka lisäksi versio 2 palauttaa kunkin sijainnin hakutuloksissa vain yhden kerran. Versio 1:n palauttama vastaus voi sen sijaan sisältää saman sijainnin useampaan kertaan, mikäli käytetty hakuehto löytyy sijainnin tiedoista monesta eri kentästä.1 / 2

Taulukko 1. Rajapinnan tukemat parametrit.

Hakutyyppi eli type-parametri määrittelee mihin kenttään haku kohdistuu. Taulukossa 2 on esitetty mihin sijainteihin liittyviin tietoihin eri hakutyypit kohdistuvat.

Hakutyyppi

Haun kohde

callno

Sijaintitieto kokonaisuudessaan. Sijainnin ollessa kirjasto => location code. Sijainnin ollessa kokoelma => kirjaston location code + kokoelman location code. Sijainnin ollessa hyllyluokka => kirjaston location code + kokoelman location code + hyllyluokan location code

code

Location code

desc

Description

note

Note

subject

Subject matters (HUOM! vain collection- ja shelf-tyyppiset sijainnit)

staffNote1

Staff note 1

staffNote2

Staff note 2

shelfShelf (HUOM! vain collection- ja shelf-tyyppiset sijainnit)
floorFloor
idKirjaston, kokoelman tai hyllyluokan id
allKaikki owner-parametrin osoittaman kirjaston sijainnit. Position- tai type-parametrien arvoilla ei vaikutusta.

Taulukko 2. Hakutyyppien kohdistuminen.

Alla esitetty URL-osoite havainnollistaa parametrien käyttöä

Recently Updated

  • No labels