Ready to Learn?Ex Libris products all provide open APIs

NCIP V.2 specifications

Required and Optional Services

The following table lists required and optional services, messages, and responses required by this profile. NCIP services not listed are not used by this profile:
 

Events Table

Triggering Event Initiating ApplicationService InitiatedResponding Application
ILL needs to authenticate the user before submitting a request.ILL (Borrowing agency)LookUpUserCirculation (Alma)
ILL Receives the requested item.ILL (Borrowing agency)AcceptItemCirculation (Alma)
ILL Returns the loaned item to the LenderILL (Borrowing agency)CheckInItemCirculation (Alma)
ILL agrees to process the ILL request.ILL (Lending agency)RequestItemCirculation (Alma)
ILL ships the item to the requesterILL (Lending agency)CheckOutItemCirculation (Alma)
ILL receives the Item from the Borrower.ILL (Lending agency)CheckInItemCirculation (Alma)
ILL cancels the requestILL (Lending agency)CancelRequestedItemCirculation (Alma)
ILL recalls the requestILL (Borrowing agency)RecallItemCirculation (Alma)
ILL renews the requestILL (Borrowing agency)RenewItemCirculation (Alma)
ILL receives renew requestILL (lending agency)RenewItemCirculation (Alma)
 

 

The following table describes the fields which are relevant for each service:

ServiceFieldRequired (R) or Optional (O)Description
InitiationHeaderFromAgencyId.
AgencyId
OThe broker ILL system name.
 ToAgencyId.
AgencyId
RYour Alma institution code, for example: 60univ_inst.
 ApplicationProfileTypeRThe Partner Code which represents the NCIP ILL application in Alma.
ResponseHeaderFromAgencyId.
AgencyId
RYour Alma institution code, for example: 60univ_inst.
 ToAgencyId.
AgencyId
OThe broker ILL system name (if received in the request message).
LookUpUserUserId.
UserIdentifierValue
RThe user ID to be authenticated.
Alma expects the user's primary id or the identifier type as defined on the partner.
 UserElementTypeOUser related information that should be returned.
This can be:
User Address Information
Block Or Trap
Name Information
User Privilege
User ID
LookupUserResponseUserId.
UserIdentifierValue
RThe authenticated user ID.
 UserElementTypeOUser related information, if requested.
AcceptItemRequestId.
RequestIdentifierValue
RRequest ID in the broker ILL system.
This information will be kept on the “external ID” field of the borrowing request in Alma.
 RequestedActionTypeRShould be ‘Hold For Pickup And Notify’.
 UserId.
UserIdentifierValue
RThe requesting user's ID.
Alma expects the user identifier type as defined on the partner.
 NonReturnableFlagOThis element indicates that the borrowing request is for digital.
 DateForReturnOIf not supplied, Alma will calculate the due date according to the relevant policies.
 ItemOptionalFields.
BibliographicDescription
RAll known bibliographic details. Will be used for creating the temporary item.
Supported options are: Title, Author, TitleOfComponent, Pagination, BibliographicRecordId, Publisher, PublicationDate, PublicationDateOfComponent, Edition.
 PickupLocationOA valid pickup location in Alma. This can be a library code in Alma,or HOME/OFFICE for home delivery.
If not supplied, Alma will use default that is defined on the partner.
For digital delivery, leave empty.
 ItemId.
ItemIdentifierValue
OItem ID in the broker ILL system.
If not supplied, a barcode will be generated. Note that auto receive will not work if item identifier was not supplied.
AcceptItemResponseRequestId.
RequestIdentifierValue
RRequest ID in the broker ILL system.
 ItemId.
ItemIdentifierValue
OItem ID in the broker ILL system (if received in the request message).
CheckInItemItemId.
ItemIdentifierValue
RItem ID in the broker ILL system.
CheckInItemResponseItemId.
ItemIdentifierValue
RItem ID in the broker ILL system.
RequestItemRequestId.
RequestIdentifierValue
RRequest ID in the broker ILL system. This information will be kept on the “external ID” field of the lending request in Alma.
 BibliographicId.
BibliographicRecordId.
BibliographicRecordIdentifier
RIdentifier of the requested bibliographic record. Currently this should be only the OCLC identifier.
 BibliographicId. BibliographicRecordId. BibliographicRecordIdentifierCodeRSearch can be done based on the MMS ID, ISBN/ISSN or any identifier
according to the BibliographicRecordIdentifierCode element (LCCN,OCLC,ISBN_ISSN,MMS_ID).
 RequestTypeRShould be 'Loan'
 ItemOptionalFields. BibliographicDescription. MediumTypeRThe following value are considered as a request for physical:
Audio Tape, Book, Book With Audio Tape,
Book With Compact Disc, Book With Diskette, Bound Journal,
CD-ROM, Compact Disc (CD), Diskette, Magazine,
Microform, Video Tape
Any other value is considered as a request for digital .
 RequestScopeTypeRShould be 'Bibliographic Item'
 UserId.
UserIdentifierValue
RPut any value.
 NeedBeforeDateOThe last interesting date.
RequestItemResponseRequestId.
RequestIdentifierValue
RRequest ID in the broker ILL system.
 UserId.
UserIdentifierValue
RThe value received for user in the request message.
 RequestTypeR'Hold'
 RequestScopeTypeR'Bibliographic Item'
CheckOutItemRequestId.
RequestIdentifierValue
RRequest ID in the broker ILL system.
This information will be kept on the “external ID” field of the lending request in Alma.
 UserId.
UserIdentifierValue
RPut any value.
 DesiredDateDueOThe due date.
 ItemId.
ItemIdentifierValue
RItem barcode of the shipped item.
CheckOutItemResponseItemId.
ItemIdentifierValue
RItem barcode of the shipped item.
 UserId.
UserIdentifierValue
RThe value received for user in the request message.
 DateDueRThe due date.
CancelRequestItemRequestId.
RequestIdentifierValue
RRequest ID in the broker ILL system.
 UserId.
UserIdentifierValue
RPut any value.
 RequestTypeRShould be 'Hold'
CancelRequestItemResponseItemId.
ItemIdentifierValue
RItem ID of the shipped item.
 UserId.
UserIdentifierValue
RThe value received for user in the request message.
 RequestId.
RequestIdentifierValue
RRequest ID in the broker ILL system.
RecallItemItemId.
ItemIdentifierValue
RID of the recalled item
 DateDueOIf not supplied, Alma will calculate due date according its policy.
RecallItemResponseItemId.
ItemIdentifierValue
RID of the recalled item
 DateDueRThe updated due date
 UserId.
UserIdentifierValue
RThe user which requested the item
RenewItemItemId.
ItemIdentifierValue
RID of the item to be renewed
 UserId.
UserIdentifierValue
OThe user which requested the renewal (In the borrowing side).
In the lending side - leave empty
 DateDueOIf not supplied, Alma will calculate due date according its policy.
RenewItemResponseItemId.
ItemIdentifierValue
RID of the renewed item
 DateDueRThe updated due date
 UserId.
UserIdentifierValue
RThe user which requested the item