Guidelines

ISO 18626 Interlibrary Loan Transactions

CILLT - Centre for Interlibrary Loan Transactions

 

Identifier: http://illtransactions.org/guidelinesusecases/guidelines/2021/

Hosted by OCLC, Inc.

Last update: 4 August 2022

 

 


Guidelines for ISO 18626:2021


2021-12-20 Added guideline 11, for handling Odyssey delivery.
Added guideline 12, for indicating the version of ISO18626:2021 in use.
2021-08-23 Added guideline 9, for handling a patron request.
Added guideline 10, for handling a transfer request.
2021-05-08 Added guideline 7, for handling multi-volume requesting.
Added guideline 8, for sending a Retry for a multi-volume title.
2022-08-04 Updated guideline 12, for indicating the June 2022 version of the XML Schema of ISO18626:2021 in use.

1. Display of codes and encoded information


2. Use of AnswerYesNo in the Supplying Agency message


3. Use of RetryInfo in the Supplying Agency message


4. Use of DeliveryInfo in the Supplying Agency message


5. Use of ShippingInfo in the Supplying Agency message


6. Use of ReturnInfo in the Supplying Agency message


7. Multi-volume requesting
7.1 Sending a request for a multi-volume title
7.2 Responding to a request for a multi-volume title


8. Sending a Retry request for a multi-volume title


9. Sending a Patron request


10. Sending a Transfer request


11. Requesting and sending an item using Odyssey delivery


12. Indicating the version of ISO18626 in use




1. Display of codes and encoded information


It is not necessary to display the codes specified in this document to library users and staff. Codes and encoded information may be mapped to alternate values or be presented in the language of the ILL application's user interface.


For example, if Library XYZ (using English) sends a request to Library ABC (using Danish), then codes and encoded information is presented in English in the ILL application of the requesting library and in Danish in the ILL application of the supplying library.



2. Use of AnswerYesNo in the Supplying Agency message


In the Supplying Agency message -> MessageInfo inclusion of the element, AnswerYesNo is limited to and mandatory ONLY when,

  • ReasonForMessage = RenewResponse, or
  • ReasonForMessage = CancelResponse


3. Use of RetryInfo in the Supplying Agency message


In the Supplying Agency message, the RetryInfo element is used only when the supplier is suggesting that the request be retried, i.e, when

  • StatusInfo -> Status = RetryPossible


4. Use of DeliveryInfo in the Supplying Agency message


In the Supplying Agency message, the DeliveryInfo element is recommended when the supplier is delivering something, i.e., when,

  • StatusInfo -> Status = Loaned or
  • StatusInfo ->Status = CopyCompleted


5. Use of ShippingInfo in the Supplying Agency message


In the Supplying Agency message, the ShippingInfo element is used only when the supplier is sending something via courier, i.e., when,

  • DeliveryInfo -> DeliveryMethod = Courier


6. Use of ReturnInfo in the Supplying Agency message


In the Supplying Agency message, the ReturnInfo element can be included. In ISO18626:2021, use of this element is no longer restricted to situations where the supplier is asking the requester to return the item to another address.



7. Multi-volume requesting


7.1 Sending a request for a multi-volume title


When the requesting library is sending a request for a specific volume or volumes, or all volumes from a multi-volume title then the volumes should be indicated using the Volume element (repeatable), in the BibliographicInfo section of the Request message. See Use Case 21 & Use Case 21a for examples.


7.2 Responding to a request for a multi-volume title


There are three ways in which a supplying library may respond to a request for a multi-volume title


7.2.1 If there is no indication in the Request message that a specific volume or volumes are needed


If during the process of filling a request, staff at the supplying library determine that there are multiple volumes associated with the title requested, but the requesting library has not specified which volume are volumes are needed, then the supplying library should send a Status of RetryPossible in the SupplyingAgency message and indicate which volume or volumes are available. See Use Case 22a for an example. The requesting library can then submit a RetryRequest indicating which volume or volumes are needed. See Guideline 8.


7.2.2 If the request specifies which volume or volumes to supply and the supplying library CAN provide ALL the volumes requested


If the request includes which volume or volumes are needed, then the supplying library can send multiple ItemId elements (one for each volume supplied) in the DeliveryInfo section of the SupplyingAgency message. The supplying library may also include the volume numbers supplied in the Note element of the MessageInfo section. If volume numbers are provided, they should be listed in the same order as the list of ItemIds. See Use Case 21 for an example.


7.2.3 If a specific volume or volumes are indicated in the request and the supplying library CANNOT provide ALL the volumes requested


If the request includes which volume or volumes are needed, but the supplying library cannot provide all the volumes requested, then the supplying library should send a Status of RetryPossible in the SupplyingAgency message and indicate which volume or volumes are available. See Use Case 21a for an example. The requesting library can then submit a RetryRequest indicating which volume or volumes to supply. See Guideline 8.



8. Sending a Retry request for a multi-volume title


After receiving a Status of RetryPossible from the supplying library, indicating which volume or volumes of a multi-volume title are available, the requesting library can send a Retry request. The specific volume or volumes should be indicated using the Volume element (repeatable), in the BibliographicInfo section of the Request message. See Use Case 21b and Use Case 22b for examples.



9. Sending a Patron request


When a patron is using an OPAC or search portal which includes an option to submit a request, then the OPAC or search portal can use the Patron request to submit the request to the patron's local interlibrary loan system for further processing and fulfillment.
See Use Case 23 for an example.
Note that in ISO18626:2021 there are no additional messages available to support the exchange of information, e.g., sending the request id assigned by the ILL system to the OPAC or search portal.



10. Sending a Transfer request


When a library uses more than one ILL system,then the Transfer request can be used to transfer requests between systems. The library may send the request id from the initiating system as part of the Request message.
See Use Case 24 for an example.
Note that in ISO18626:2021 there are no additional messages available to support the exchange of information between the two ILL systems, e.g., sending the request id assigned by the receiving system to the initiating system or sending status information.



11. Requesting and sending an item using Odyssey delivery


When the requesting library is requesting delivery of a document via Odyssey, the ElectronicAddressType = Odyssey should be used. Note: a new Open Code value of Odyssey has been registered for ElectronicAddressType.
When the supplying library is delivering a document via Odyssey, the address to which the document is delivered should be included in the URL element of the DeliveryInfo section.
See Use Case 25 for an example.



12. Indicating the version of ISO18626 in use


Currently there are 3 versions of ISO18626 in use. When two ILL systems are interoperating using two different versions of ISO18626, e.g., ISO18626:2017 and ISO18626:2021, then the version number in use should be provided in the XML header of each message using the format provided in the following table.

Version of protocol Version identifier in XML header
Version 1 (ISO18626:2014) 1_1_2014
Version 2 (ISO18626:2017) 1_2_2017
Version 3 (ISO18626:2021) 2021-1
Version 3 (ISO18626:2021)
(update June 2022 of the XML Schema)
2021-2

Inclusion of the version number in the XML header ensures the sender and receiver both understand which version of the standard and which version of the XSD is being used.
See Use Case 26 for an example.



 

 


CILLT has done its best to ensure that the information contained on this Website and the resources available for download are accurate.


You agree to take full responsibility for any products/works developed as a result of the use, or non-use, of the information available on this Website or the resources available for download from this Website.