JournalTOCs Blog

News and Opinions about current awareness on new research

Archive for the ‘finalProgressPost’ tag

Final Progress Post

with one comment

Title of Primary Project Output: JournalToCsAPI: An API to search current issues of journals for up-to-date content.

Screenshots or diagram of prototype:

Diagram of prototype

Use Cases:

Project Use cases

Description of Prototype:
JournalTOCs is a prototype of a web API(*) that uses the REST software architecture style to search the directory of journals and articles obtained directly from the publishers’ websites by aggregating their TOC RSS feeds (TOC: Table of Contents). The API produce search results in RSS 1.0 web feed format.

The API has four “calls”: journals, articles, user and institution. A “call” is a URL consisting of a base URL, the name of the call and the search query.

JournalTOCs API base URL is “https://www.journaltocs.ac.uk/api“. To use the API you need to combine the base URL and the name of one call. Most calls require a search query or otherwise they won’t work. Guidelines for using each of the calls is found here.

(*) API is an abbreviation of Application Programming Interface. An API is a software programme that enable interaction between two software applications.

End User of Prototype:
The end-user for this API is a developer wanting to combine journal TOC RSS feeds with multiple services into new applications known as mashups. The API is written in PHP and uses MySQL as its back-end database system. You do not need an account to use the API which is free to use for anyone.

When your application points to the API base URL https://www.journaltocs.ac.uk/api the API returns a brief description on how to use the API. The description is found in the <description> element of the unique item encoded in the RSS response. The following screen shows how the response is presented on a browser.

API base URL

Below there is an example showing how to use the API from a PHP script so that you can get an idea on how to use the API calls.

PHP example

If you print the content of $xmlRSS1, you will see that it is an XML file where each article of the search results is included in an <item> element as shown in the following screenshot.

API output showing the item content

Link to working prototype:
https://www.journaltocs.ac.uk/api

Link to end user documentation:
https://www.journaltocs.ac.uk/API

Link to code repository:
https://journaltocsapi.sourceforge.net

Link to technical documentation:
https://www.journaltocs.ac.uk/docs/

Date prototype was launched:
– Beta Version Released 28th November 2009
– Alpha Version Released 23rd September 2009

Project Team Names, Emails and Organisations:
Roger Rist – Project Director r.j.rist@hw.ac.uk
Santy Chumbe – Project Manager s.chumbe@hw.ac.uk
Lisa Rogers – Project Officer l.j.rogers@hw.ac.uk
ICBL, Heriot-Watt University

Project Blog:
https://www.journaltocs.ac.uk/API/blog/

PIMS entry:
https://pims.jisc.ac.uk/projects/view/1390

Table of Content for Project Posts:

  1. Welcome to the journalTOCsAPI Project blog
  2. JournalTOCsAPI Project
  3. OAI-PMH instead of RSS feeds for Use Case 2?
  4. Community engagement: A special invitation
  5. Do we need a “best practice” for generating RSS’s URLs for IR search results?
  6. Community Engagement: Response to Invitation
  7. Methods of Engaging with JournalTOCsAPI Project
  8. Preparing the framework for our RESTful API
  9. Strengths, Weaknesses, Opportunities and Threats analysis
  10. Clarification of Use Cases
  11. Use Cases and Prerequisite Data
  12. Alpha Release of JournalTOCs API
  13. How do you want to be alerted?
  14. User Feedback (1-2 Development Cycle) – I
  15. User Feedback (1-2 Development Cycle) – II
  16. Author Affiliation
  17. The ticTOCs Best Practice Recommendation has been released
  18. Presentation at EUROCRIS
  19. journalTOCs API Project Workshop
  20. JournalTOCs Workshop: Presentation 1 – Introduction and Feedback
  21. JournalTOCs Workshop: Presentation 2 – Repositories and Alert Services
  22. JournalTOCs Workshop: Presentation 3 – Testing the First Use Case
  23. JournalTOCs Workshop: Presentation 4 – Bibliosight Project
  24. JournalTOCs Workshop: Presentation 5 – The Other Side of The Interface
  25. JOURNAL TOCS API Beta 1 Released
  26. JournalsTOCS API Technical Documentation
  27. JournalTOCs Workshop: Presentation 6 – TechXtra and TechJournalContents
  28. JournalTOCs Workshop: Presentation 7 – JournalTOCs in a CRIS
  29. Measuring the usefulness and effectiveness of the API: A retrospective view of prototyping the use cases
  30. Demonstrations of Using the JournalTOCs API

Written by lisa

December 11th, 2009 at 6:58 pm