NCIP Version 1
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:
| Service | Required (R) or Optional (O) |
|---|---|
| LookUp user | O |
| AcceptItem | R |
| ItemCheckedIn | R |
| CheckInItem | R |
| ItemRequested | O |
| CheckOutItem | R |
| ItemRequestCancelled | O |
Event Table
| Triggering Event | Initiating Application | Service Initiated | Responding Application |
|---|---|---|---|
| ILL needs to authenticate the user before submitting a request. | ILL (Borrowing agency) | LookupUser | Circulation (Alma) |
| ILL Receives the requested item. | ILL (Borrowing agency) | AcceptItem | Circulation (Alma) |
| ILL Returns the loaned item to the Lender | ILL (Borrowing agency) | ItemCheckedIn | Circulation (Alma) |
| ILL cancels the request | ILL (Borrowing agency) | ItemRequestCancelled | Circulation (Alma) |
| ILL agrees to process the ILL request. | ILL (Lending agency) | ItemRequested | Circulation (Alma) |
| ILL ships the item to the requester | ILL (Lending agency) | CheckOutItem | Circulation (Alma) |
| ILL receives the Item from the Borrower. | ILL (Lending agency) | CheckInItem | Circulation (Alma) |
| ILL cancels the request | ILL (Lending agency) | Cancel Request | Circulation (Alma) |
The following table describes the fields which are relevant for each service:
| Service | Field | Required (R) or Optional (O) | Description |
|---|---|---|---|
| InitiationHeader | FromAgencyId.UniqueAgencyId.value | O | The broker ILL system name. |
| ToAgencyId.UniqueAgencyId.value | R | One of two options:
| |
| ApplicationProfileType.value | R | The Partner Code which represents the NCIP ILL application in Alma. Note: in case of LookupUser the partner code can optionally sent in FromAgencyAuthentication.value tag. | |
| ResponseHeader | FromAgencyId.UniqueAgencyId.value | R | Your Alma institution code, for example: 60univ_inst. |
| ToAgencyId.UniqueAgencyId.value | O | The broker ILL system name (if received in the request message). | |
| LookUpUser | UniqueUserId.UserIdentifierValue | O | Alma expects UniqueUserId or VisibleUserId as the user ID to be authenticated: UniqueUserId– the primary id VisibleUserId – additional unique identifer type and value. |
| VisibleUserId.VisibleUserIdentifierType.value | O | Alma expects UniqueUserId or VisibleUserId as the user ID to be authenticated: UniqueUserId – the primary id VisibleUserId – additional unique identifer type and value. | |
| VisibleUserId.VisibleUserIdentifier | O | Alma expects UniqueUserId or VisibleUserId as the user ID to be authenticated: UniqueUserId– the primary id VisibleUserId – additional unique identifer type and value. | |
| UserElementType.value | O | User related information that should be returned. This can be: User Address Information, Block Or Trap, Name Information, User Privilege, Visible User Id. | |
| AuthenticationInput.AuthenticationInputType | O | Type of the password of the user. Currently supported: Password | |
| AuthenticationInput.AuthenticationInputData | O | Password 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. | |
| LookupUserResponse | UniqueUserId.UserIdentifierValue | O | The authenticated user ID (if received in the request message). |
| VisibleUserId.VisibleUserIdentifier | O | The authenticated user ID (if received in the request message). | |
| UserElementType.value | O | User related information, if requested. | |
| AcceptItem | UniqueRequestId.RequestIdentifierValue | R | Request ID in the broker ILL system. This information will be kept on the “external ID” field of the borrowing request in Alma. |
| RequestedActionType.value | R | Should be ‘Hold for Pickup’. | |
| UniqueUserId.UserIdentifierValue | R | The requesting user’s ID. Alma expects the user identifier type as defined on the partner. | |
| DateForReturn | O | If not supplied, Alma will calculate the due date according to the relevant policies. | |
| ItemOptionalFields.BibliographicDescription | R | All known bibliographic details. Will be used for creating the temporary item. Supported options are: Title, Author, TitleOfComponent, Pagination, BibliographicRecordId, Publisher, PublicationDate, PublicationDateOfComponent, Edition. | |
| UniqueItemId.ItemIdentifierValue | O | Item ID in the broker ILL system. | |
| ItemCheckedIn | UniqueItemId.ItemIdentifierValue | O | Alma expects UniqueItemId or VisibleItemId : UniqueItemId – the external request id VisibleItemId – the temporary item’s barcode. |
| VisibleItemId | O | Alma expects UniqueItemId or VisibleItemId : UniqueItemId – the external request id VisibleItemId – the temporary item’s barcode. | |
| ItemRequestCancelled | UniqueItemId.ItemIdentifierValue | R | Item ID. |
| UniqueUserId.UserIdentifierValue | R | Put any value | |
| RequestType.value | R | Should be ‘hold’ | |
| RequestItem | UniqueItemId.ItemIdentifierValue | R | The Item barcode of the item to ship. The lending request will be created with the barcode as the “external request id”. |
| RequestType.value | R | hold | |
| RequestScopeType.value | R | item | |
| UniqueUserId.UserIdentifierValue | R | Put any value. | |
| DateOfUserRequest | O | The last interesting date. | |
| CheckOutItem | UniqueItemId.ItemIdentifierValue | R | Item barcode |
| UniqueUserId.UserIdentifierValue | R | Put any value | |
| CheckInItem | UniqueItemId.ItemIdentifierValue | R | Item ID in the broker ILL system. |