Ready to Learn?Ex Libris products all provide open APIs

NCIP V.1 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:

Event 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)ItemCheckedInCirculation (Alma)
ILL cancels the requestILL (Borrowing agency)ItemRequestCancelledCirculation (Alma)
ILL agrees to process the ILL request.ILL (Lending agency)ItemRequestedCirculation (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)Cancel RequestCirculation (Alma)

 

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

ServiceFieldRequired (R) or Optional (O)Description
InitiationHeaderFromAgencyId.UniqueAgencyId.valueOThe broker ILL system name.
 ToAgencyId.UniqueAgencyId.valueRYour Alma institution code, for example: 60univ_inst.
 ApplicationProfileType.valueRThe Partner Code which represents the NCIP ILL application in Alma.
ResponseHeaderFromAgencyId.UniqueAgencyId.valueRYour Alma institution code, for example: 60univ_inst.
 ToAgencyId.UniqueAgencyId.valueOThe broker ILL system name (if received in the request message).
LookUpUserUniqueUserId.UserIdentifierValueOAlma expects UniqueUserId or
VisibleUserId as the user ID to be authenticated:
UniqueUserId- the primary id
VisibleUserId - additional unique identifer type and value.
 VisibleUserId.VisibleUserIdentifierType.valueOAlma expects UniqueUserId or
VisibleUserId as the user ID to be authenticated:
UniqueUserId - the primary id
VisibleUserId - additional unique identifer type and value.
 VisibleUserId.VisibleUserIdentifierOAlma expects UniqueUserId or
VisibleUserId as the user ID to be authenticated:
UniqueUserId- the primary id
VisibleUserId - additional unique identifer type and value.
 UserElementType.valueOUser related information that should be returned. This can be: User Address Information, Block Or Trap, Name Information, User Privilege, Visible User Id.
LookupUserResponseUniqueUserId.UserIdentifierValueOThe authenticated user ID (if received in the request message).
 VisibleUserId.VisibleUserIdentifierOThe authenticated user ID (if received in the request message).
 UserElementType.valueOUser related information, if requested.
AcceptItemUniqueRequestId.RequestIdentifierValueRRequest ID in the broker ILL system. This information will be kept on the “external ID” field of the borrowing request in Alma.
 RequestedActionType.valueRShould be ‘Hold for Pickup’.
 UniqueUserId.UserIdentifierValueRThe requesting user's ID. Alma expects the user identifier type as defined on the partner.
 DateForReturnOIf not supplied, Alma will calculate the due date according to the relevant policies.
 ItemOptionalFields.BibliographicDescriptionRAll known bibliographic details. Will be used for creating the temporary item. Supported options are: Title, Author, TitleOfComponent, Pagination, BibliographicRecordId, Publisher, PublicationDate, PublicationDateOfComponent, Edition.
 UniqueItemId.ItemIdentifierValueOItem ID in the broker ILL system.
ItemCheckedInUniqueItemId.ItemIdentifierValueOAlma expects UniqueItemId or
VisibleItemId :
UniqueItemId - the external request id
VisibleItemId - the temporary item's barcode.
 VisibleItemIdOAlma expects UniqueItemId or
VisibleItemId :
UniqueItemId - the external request id
VisibleItemId - the temporary item's barcode.
ItemRequestCancelledUniqueItemId.ItemIdentifierValueRItem ID.
 UniqueUserId.UserIdentifierValueRPut any value
 RequestType.valueRShould be 'hold'
RequestItemUniqueItemId.ItemIdentifierValueRThe Item barcode of the item to ship. The lending request will be created with the barcode as the "external request id".
 RequestType.valueRhold
 RequestScopeType.valueRitem
 UniqueUserId.UserIdentifierValueRPut any value.
 DateOfUserRequestOThe last interesting date.
CheckOutItemUniqueItemId.ItemIdentifierValueRItem barcode
 UniqueUserId.UserIdentifierValueRPut any value
CheckInItemUniqueItemId.ItemIdentifierValueRItem ID in the broker ILL system.