| 
  • If you are citizen of an European Union member nation, you may not use this service unless you are at least 16 years old.

  • Stop wasting time looking for files and revisions. Connect your Gmail, DriveDropbox, and Slack accounts and in less than 2 minutes, Dokkio will automatically organize all your file attachments. Learn more and claim your free account.

View
 

Iteration 1 Documentation

Page history last edited by Hiten Vaghmaria 9 years, 6 months ago

Jorum API Guide (1st Release)

Download this document

The API server is now live here:  http://api.jorum.ac.uk/v0p1/

 


NOTE: This is the first release and further developments and iterations are planned in the future.  

It should be noted that by default if no target is specified you are redirected to the Collections
List target, i.e, http://api.jorum.ac.uk/v0p1/collection/list

This is the first release of the Jorum API and is currently restricted to the search targets below. The API allows users to query the Jorum Repository via the API Server (http://api.jorum.ac.uk/v0p1/)and users can receive responses in 4 formats: XML, RSS, JSON and JSONP.

The information below is a guide on how to use the API. The available targets are listed below.




 

COLLECTIONS LIST

 

 


 


This target lists all the collections (subjects) in Jorum, with their associated DSpace identifiers, in XML format. The format of the response returned can be altered by adding a suffix to the request:

XML   - http://api.jorum.ac.uk/v0p1/collection/list.xml
JSON  - http://api.jorum.ac.uk/v0p1/collection/list.json

and in the case of JSONP by supplying an additional callback function parameter:

JSONP - http://api.jorum.ac.uk/v0p1/collection/list.jsonp?callback=myFunc

NOTE: The collections list is not available via RSS.  


 

RESOURCES BY COLLECTION

 

 

 


 



This target lists the 10 most recent submissions to a collection in XML format. The target expects to be passed a COLLECTION_ID which can be determined from the Collections List target (See above in Collections List). For example:

http://api.jorum.ac.uk/v0p1/resource/collection/COLLECTION_ID

The format of the response returned can be altered by adding a suffix to the request:

XML   - http://api.jorum.ac.uk/v0p1/resource/collection/COLLECTION_ID.xml
JSON  - http://api.jorum.ac.uk/v0p1/resource/collection/COLLECTION_ID.json
RSS   - http://api.jorum.ac.uk/v0p1/resource/collection/COLLECTION_ID.rss

and in the case of JSONP by supplying a callback function parameter:

JSONP -
http://api.jorum.ac.uk/v0p1/resource/collection/COLLECTION_ID.jsonp?callback=myFunc


 

RESOURCES BY SUBMITTER

 

 




This target lists all submissions by a specified submitter in XML format. The target expects to be passed a SUBMITTER_EMAIL_ADDRESS which is the email address that a user of Jorum has set in their profile. Any user of the API can retrieve a list of any submitter's submissions assuming they know their email address. A submitter's email address can be discovered in Jorum by viewing the full item record page and looking at the dc.description.provenance field. An example of this target is:

http://api.jorum.ac.uk/v0p1/resource/user/SUBMITTER_EMAIL_ADDRESS

The format of the response returned can be altered by adding a suffix to the request:

XML   -
http://api.jorum.ac.uk/v0p1/resource/user/SUBMITTER_EMAIL_ADDRESS.xml
JSON  -
http://api.jorum.ac.uk/v0p1/resource/user/SUBMITTER_EMAIL_ADDRESS.json
RSS   -
http://api.jorum.ac.uk/v0p1/resource/user/SUBMITTER_EMAIL_ADDRESS.rss

and in the case of JSONP by supplying an additional callback function parameter:

JSONP -
http://api.jorum.ac.uk/v0p1/resource/user/SUBMITTER_EMAIL_ADDRESS.xml.jsonp ?callback=myFunc



 

RESOURCES BY SEARCH TERM

 

 




This target lists the 10 most relevant submissions for a specific search term in XML format. The target expects to be passed a SEARCH_TERM which can be formatted in the same way that a search term is constructed in the simple search box in Jorum. For example:

http://api.jorum.ac.uk/v0p1/resource/search/SEARCH_TERM

The format of the response returned can be altered by adding a suffix to the request:

XML   - http://api.jorum.ac.uk/v0p1/resource/search/SEARCH_TERM.xml
JSON  - http://api.jorum.ac.uk/v0p1/resource/search/SEARCH_TERM.json
RSS   - http://api.jorum.ac.uk/v0p1/resource/search/SEARCH_TERM.rss

and in the case of JSONP by supplying an additional callback function parameter:

JSONP -
http://api.jorum.ac.uk/v0p1/resource/search/SEARCH_TERM.jsonp?callback=myFunc

An example of a simple search would be:
http://api.jorum.ac.uk/v0p1/resource/search/fit
A more complex search would be:
http://api.jorum.ac.uk/v0p1/resource/search/fit+for+future
A yet more complex search would be:
http://api.jorum.ac.uk/v0p1/resource/search/fit+for+future+AND+module+3

As you can see by adding the AND search operator to the search term it is simple to narrow down the search results to a few specific items.

 

 

 

 

 

 

 

 

Comments (0)

You don't have permission to comment on this page.