Aleph Restful APIs Yoel Kortick January 2010

Table of contents Content Slides Introduction 3-4 EL Commons and the APIs 5-6 Functions vs. resources 7-8 jboss and jlog 9 Retrieval of record item 10-12 Bibliographic information 13 Retrieval of patron information 14-18 Retrieval of circulation actions 19-22 Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

Introduction To see a full list of the Aleph Restful APIs: http://www.exlibrisgroup.org/display/AlephOI/RESTful+APIs An introduction to the Aleph Restful APIs (including Jboss configuration) may be found at: http://www.exlibrisgroup.org/display/AlephOI/*Introduction+to+Aleph+RESTful+API Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

Introduction This presentation will not attempt to restate what is already in the previously mentioned documents. It will instead show actual examples via standard URL, with a stress on the Restful API syntax. The presentation is designed to be an accompaniment to a real live lecture. Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

Documentation Via EL Commons Begin with the EL Commons CodeShare Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

Via EL Commons One way to arrive to information about the RESTful APIs is to choose Aleph > Open Interfaces from within CodeShare Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

Functions and Resources The list of RESTful APIs contains both “functions” and “resources”. In general, verbs are “functions” and nouns are “resources”. Thus: “bookings” is a “resource” and has a corresponding URL: http://il-aleph07:1893/rest-dlf/patron/00000036/circulationActions/requests/bookings “holds” is a “resource” and has a corresponding URL: http://il-aleph07:1893/rest-dlf/patron/00000036/circulationActions/requests/holds Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

Functions and Resources “Renew Loan” is a function. It is activates, for example, when a patron renews his loans from Primo This presentation deals only with resources Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

Jboss and jlog For the APIs to work the jboss must be running. There is information regarding jboss configuration on EL commons at http://www.exlibrisgroup.org/display/AlephOI/*Introduction+to+Aleph+RESTful+API The jboss log files are in the jlog directory yoelk@il-aleph07(a20_3):...default/log>alias jlog cd $aleph_dev/ng/aleph/home/system/thirdparty/openserver/server/default/log Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

Record items http://il-aleph07.corp.exlibrisgroup.com:1893/rest-dlf/record/USM01000052405/items This URL shows the items related to a particular record Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

Record items If we remove the /items at the end of the URL … http://il-aleph07.corp.exlibrisgroup.com:1893/rest-dlf/record/USM01000052405/items http://il-aleph07.corp.exlibrisgroup.com:1893/rest-dlf/record/USM01000052405 Then we get a list of the possible additional URLs which may be used for the API. In this case the possibilities are “items” and “holdings” (as we see in the next slide) Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

Record items Possibilities to use with the “record” parameter Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach Possibilities to use with the “record” parameter

Bibliographic information If we remove use the ?view=full option then we can see the record in xml format http://il-aleph07.corp.exlibrisgroup.com:1893/rest-dlf/record/USM01000052405?view=full Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

patron patronInformation address http://il-aleph07.corp.exlibrisgroup.com:1893/rest-dlf/patron/313972002/patronInformation/address This URL shows the address of the patron Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

patron If the URL is changed so that only “patron” and the “patron ID appear” (patronInformation is removed) … http://il-aleph07.corp.exlibrisgroup.com:1893/rest-dlf/patron/313972002/patronInformation/address http://il-aleph07.corp.exlibrisgroup.com:1893/rest-dlf/patron/313972002/ Then a list of all possible options to use with “patron” will appear (as we see on the next slide) Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

patron Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach We see here four possible options which may be used with “patron”

patron Each of the four options on the previous slide also may have additional options. For example the third option http://il-aleph07.corp.exlibrisgroup.com:1893/rest-dlf/patron/313972002/patronStatus/ gives two additional options: blocks and registration Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach Option one Option two

Patron patronStatus blocks Here we are using patron, patronStatus and Blocks Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

circulationActions cash http://il-aleph07.corp.exlibrisgroup.com:1893/rest-dlf/patron/313972002/circulationActions/cash?institution=USM50 This URL shows cash transactions of the patron Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

circulationActions cash Note that the results also include a link to each specific cash transaction Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

circulationActions If we remove the /cash from the URL … http://il-aleph07.corp.exlibrisgroup.com:1893/rest-dlf/patron/313972002/circulationActions/cash?institution=USM50 http://il-aleph07.corp.exlibrisgroup.com:1893/rest-dlf/patron/313972002/circulationActions?institution=USM50 Then we will get a list of links to the possible options which may be used with circulationActions Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

Options with circulationActions Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach Links to the three options which may be used with circulationActions

Yoel Kortick