1. Aleph Restful APIs
Ori Miller June 2012

2. Table of contents Content Introduction EL Commons and the APIs
Functions vs. resources
JBoss and jlog
Retrieval of record item
Bibliographic information
Retrieval of patron information
Retrieval of circulation actions
Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

3. Introduction What is an API (Application Programming Interface)? URL
HTML
XML
RESTful URL
Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

4. Introduction
Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

5. Introduction
Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

6. Introduction
The nice thing is that this URL can be sent from any software, not only Primo.
Such as VuFind, or even your local institution web-site.
Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

7. Introduction
To see a full list of the Aleph Restful APIs:
An introduction to the Aleph Restful APIs (including JBoss configuration) may be found at:
Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

8. 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

9. 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

10. 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

11. Functions and Resources
From wikipedia:
Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach
See also:

12. Functions and Resources
We don’t need documentation. Only the URL:
For POST / PUT / DELETE:
Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

13. 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:
“holds” is a “resource” and has a corresponding URL:
“Renew Loan” is a function.
It is activates, for example, when a patron renews his loans from Primo
Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

14. JBoss and jlog For the APIs to work, the JBoss must be running.
There is information regarding JBoss configuration on EL commons at
And: How to Configure JBoss in Aleph.pdf
(including: how to accept requests from specific IP address, and how to compress the XML)
The JBoss log files are in the jlog directory.
See KB if you the log disappeared after SP
Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach
aleph(a20_1)> alias jlog
cd $aleph_dev/ng/aleph/home/system/thirdparty/openserver/server/default/log

15. Record 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

16. Record items If we remove the /items at the end of the URL …
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

17. 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

18. Bibliographic information
If we remove use the ?view=full option then we can see the record in xml format
Unlike our competitors, we did not release a new revolutionized system every few years but rather took the evolutionary approach

19. patron 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

20. patron
If the URL is changed so that only “patron” and the “patron ID appear” (patronInformation is removed) …
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

21. 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”

22. patron
Each of the four options on the previous slide also may have additional options.
For example the third option 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

23. 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

24. circulationActions cash
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

25. 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

26. circulationActions If we remove the /cash from the URL …
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

27. 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

28. POST, PUT and DELETE Limit to IP and gzip