Prettylib-tuoteratkaisut - Wiki

PrettyLibServer API

Owned by Pauli Porkka (Unlicensed)
Last updated: Oct 25, 2018 by Tuula Ronumäki (Unlicensed)
1 min read

PrettyLibServer -hakulittymästä löytyy REST-tyyppinen API (Application Programming Interface), jossa hakutuloksia tms tietoja saa JSON-tietueina.

HUOM: Kaikki API-liittyvät toiminnot voivat muuttua ilman erillistä varoitusta. Toistaiseksi API tarjotaan saman hakukomponentin kautta kuin normaali HTML-hakutoiminnallisuus. Tämä voi muuttua tulevissa versioissa.

JSON tietueet

Palautettu JSON tietue sisältää yleensä (muutama poikkeus) aina aluksi seuraavan osion:

{"status":"OK","failcode":"0","errtxt":""

status

status - kentän sisältö voi olla:

  • "OK" - Mikäli status sisältää tekstijonon "OK", on palautettu jotain.
  • "FAILED" - Mikäli status kentän sisältö on "FAILED", on tapahtunut jokin virhe.


"OK" ei tarkoita välttämättä sitä, että esimerkiksi haussa on löytynyt jotain. "OK" palautetaan myös silloin kun ei ole löytynyt, mutta ei ole tapahtunut mitään virhettäkään.

failcode

failcode - kenttä voi sisältää tietuekohtaisen virhenumeron

errtxt

errtxt - kenttä voi sisältää virhetekstin.

Tietueen muut kentät riippuvat palautettavasta tietotyypistä.

Aihealueeseen liittyviä artikkeleita


Prettylib-tuotetuki