NCIP Version 2

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:

ServiceRequired (R) or Optional (O)
LookUpUserO
AcceptItemR
RequestItemO
CheckOutItemR
CheckInItemR
CancelRequestedItemO
RecallItemO
RenewItemO

Events Table

Triggering EventInitiating ApplicationService InitiatedResponding Application
ILL needs to authenticate the user before submitting a requestILL (Borrowing agency)LookUpUserCirculation (Alma)
Borrowing request is submittedILL (Borrowing agency)RequestItemCirculation (Alma)
ILL agrees to process the ILL requestILL (Lending agency)RequestItemCirculation (Alma)
ILL ships the item to the requesterILL (Lending agency)CheckOutItemCirculation (Alma)
ILL Receives the requested itemILL (Borrowing agency)AcceptItemCirculation (Alma)
ILL Returns the loaned item to the LenderILL (Borrowing agency)CheckInItemCirculation (Alma)
ILL receives the Item from the BorrowerILL (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
ROne of two options:

  1. The Alma institution code, for example: 60univ_inst.
  2. The institution/library ISIL code (defined on the institution/library ISIL field).
ToAgencyId.
AgencyId
ROne of two options:

  1. The Alma institution code, for example: 60univ_inst.
  2. The institution/library ISIL code (defined on the institution/library ISIL field).
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. If identifier type is defined on the partner, that identifier will also be accepted.
UserElementTypeOUser related information that should be returned.
This can be:
User Address Information
Block Or Trap
Name Information
User Privilege
User ID
AuthenticationInput.
AuthenticationInputType
OType of the password of the user. Currently supported: Password
AuthenticationInput.
AuthenticationInputData
OPassword of the user to be authenticated.
This information is required if “Require authentication” is set to Y on the NCIP partner that is defined in Alma.
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_DELIVERY 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. The identifier should be of the type specified in BibliographicRecordIdentifierCode.
BibliographicId. BibliographicRecordId. BibliographicRecordIdentifierCodeRSearch can be done based on: LCCN,OCLC,ISBN_ISSN,MMS_ID. Specify the identifier type in this field.
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.
Ext.PartsOIf received, this field will be populated in the created lending request in Alma.
Ext.IssuesOIf received, this field will be populated in the created lending request in Alma.
Ext.ChaptersOIf received, this field will be populated in the created lending request in Alma.
Ext.PagesOIf received, this field will be populated in the created lending request in Alma.
Ext.ItemNoteOIf received, this field will be populated in the created lending request in Alma.
Ext.VolumesOIf received, this field will be populated in the created lending request in Alma.
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
OItem barcode of the shipped item.
Required if the request is for physical delivery.
CheckOutItemResponseItemId.
ItemIdentifierValue
OItem barcode of the shipped item.
Required if the request is for physical delivery.
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
For borrowing: R
For lending: O
For borrowing: The user which requested the renewal
For lending: 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

Note that RequestItem message can be sent either to create a borrowing request or a lending request. Alma differentiates the flow based on the agency id of the user.

XML Samples