Google Groups Home
Help | Sign in
Recent pages and files
jangle spec    

Jangle Draft Specification

Jangle is a middleware API to establish an interface between an Integrated Library System and an external module or application. Jangle follows the DLF ILS Draft for building an Interface between an ILS and an external discovery layer.

Discovery Platform
|
Jangle API
Jangle Core
Jangle ILS Connector
|
ILS

 

The Jangle System consists of three components – an API which allows the external modules to interact with Jangle via a REST interface, the Jangle Core which translates the REST interface into the various data bindings that the 3rd component, the ILS Connector, uses to interact with the ILS.

Jangle API

The Jangle API creates a REST based interface for the external system to adopt and adhere to.

Data Harvesting

The data harvesting component will allow an entity to withdraw data from the ILS in a batch process.

Binding: Atom Publishing Protocol

Methods:

  • HarvestBibliographicRecords
    • Input: StartDate, EndDate 
  • HarvestAuthorityRecords
    •  Input: StartDate, EndDate
  • HarvestExpandedRecords
    • Input: StartDate, EndDate
  • HarvestHoldingRecords
    • Input: StartDate, EndDate

Data Search

The data search component will allow an entity to lookup data from the ILS in a live query.

Binding: Atom Publishing Protocol

Methods:

  • GetAvailability
    • Input: Array RecordId
    • Output: Bool Availability, String Status, String Location, Bool Reserve, String Call Number, String Due Date, Int Item Number, String ItemID
  • GetRecords
  • Search 
  • Scan
  • GetAuthorityRecords

Patron Information

The patron information component will allow an entity to retrieve information about a patron via an authentication mechanism.  This component will also allow a patron to initiate a transaction.

 

Binding: Atom Publishing Protocol

Methods:

  • LookupPatron
    • Input: patronID
  • AuthenticatePatron
    • Input: username, password
    • Output: patronID 
  • GetPatronInfo
    • Input: patronID
    • Output: first name, last name, address, etc.
  • GetPatronStatus
    • Input: patronID
    • Output: Boolean 
  • RenewLoan
    • Input: patronID, itemID 
    • output: boolean 
  • HoldTitle 
  • HoldItem
    • input: patronID, itemID
    • output: boolean 
  • CancelHold
    • input: patronID, itemID
    • output: boolean 
  • RecallItem
    • input: patronID, itemID
    • output: boolean 
  • CancelRecall
    • input: patronID, itemID
    • output: boolean  

Jangle ILS Connector

Data Harvesting

Binding: OAI-PMH

Methods:

  • Identify
  • GetRecord
  • ListIdentifiers
  • ListMetadataFormats
  • ListRecords
  • ListSets

Data Search

Binding: SRU

Methods:

  • SearchRetrieve

Patron Information

The patron information component will allow an entity to retrieve information about a patron via an authentication mechanism.  This component will also allow a patron to initiate a transaction.

 

Binding: NCIP

Methods:

  • LookupUser
  • AuthenticateUser
  • ItemRenewed
  • RecallItem
  • CancelRequestItem

 

Version: 
2 messages about this page
Mar 17 2008 by Ross Singer
I have also begun to draft how this would look in an AtomPub context here:
http://code.google.com/p/jangle/wiki/AtomPublishingProtocolProposalStrawman
-Ross.
Mar 17 2008 by Andrew Nagy
I created a page in the googlegroup site with all of my notes and
ideas. Feel free to edit or just delete it if you don't agree

Click on http://groups.google.com/group/jangle-discuss/web/jangle-spec
- or copy & paste it into your browser's address bar if that doesn't
work.
Create a group - Google Groups - Google Home - Terms of Service - Privacy Policy
©2008 Google