NCIP API Development

NCIP (NISO Circulation Interchange Protocol, also known as Z39.83) is a North American standard with implementations in the US, Canada, and many other countries around the world. NCIP services facilitate the automation of tasks, the exchange of data, the ability to provide information to library staff, and the empowerment of patrons. Each service is comprised of a request from an initiating application and a reply from a responding application. It is possible for a single software application to play both the initiation and responding roles, but typically there are at least two applications involved. SCSB will play initiating application role and the client (Harvard / PUL) responding application role.

NCIP APIS

Check In Item

Check In Item requests that the client application check in an Item. It also permits the SCSB application to request data about the User and/or Item involved with this check in.

Check Out Item

Check Out Item requests that the client application check out an Item to a User. It also permits the SCSB application to acknowledge the fee amount (if any) associated with the check out. The SCSB application may also request data about the User and/or Item involved with this check out.

Lookup Item

Lookup Item requests data about a particular Item known to the client application. The SCSB provides the Id of the Item and a list of elements for which data is requested.

Lookup User

Lookup User requests data about a particular User known to the client application. The SCSB provides the Id of the User and a list of elements for which data is requested.

Accept Item

Accept Item requests that the client application accept an Item to be circulated to a User. The responding application may be a third party that has no prior knowledge of either the User or the Item. The initiation message identifies the action the responding agency is requested to take when it receives the item. The request may include a date by which the SCSB application requires the Item to be returned, an indication that the user may apply to renew the loan of the Item, and financial data relating to the supply of the Item. If there is a possibility that the client application has no prior knowledge of either the User or the Item, the request may optionally include data about the User and/or the Item.

Cancel Request Item

Cancel Request Item requests that the client application cancel a previous request for an Item. The SCSB application may also request data about the User and/or Item involved with this request cancellation.

Recall Item

Recall Item requests that the Client application recall an Item from a User. The SCSB application may propose a new date due for the Item. SCSB may also request data about the User and/or Item involved with this recall.