Didn't find what you were looking for?

Email questions or documentation suggestions to info@projectreshare.org.

Request and Supply Data Dictionary

Request records appear in both the Request and Supply apps and share most of the same metadata.

Request Information

Request information is specific to the request and lives locally on the request record.

Data element


Data element


Request ID

A human-readable ID that is shared between the requester and the supplier. The requester can define a request ID prefix in its local settings. It is recommended that each requester prefix requests with its ReShare symbol to help immediately identify the source of a request.

Full ID

The full ID is a universally unique ID assigned and used internally within the ReShare system. It is generally not used for most staff-facing purposes.

Date submitted

The date and time a request was first submitted by a staff member or patron.

Last updated

The date and time of the last time a change was made to the request metadata or status.

Date needed

The date after which the patron no longer needs the request.

Pickup location

The location where the patron will come to retrieve the requested item.


General notes about the request. A patron can include a note when creating a request and staff can continue to amend the notes field as the request is processed.

Requesting Institution

The requesting institution is the library that the requesting patron is affiliated with. Each request record is associated with a requesting institution, and more detailed information about that institution is pulled in from the ReShare directory.

Requesting User

The requesting user is the patron who the request is for. Note that patron data is not stored in the ReShare Users app, which is solely for managing staff users at this time.

Data element


Data element


User ID

A unique ID for the user that serves as a match point within the user’s institution’s library management system. The source of the user ID will vary by institution and management system.

First name

The first name of the user.

Last name

The last name of the user.

Email address

The email address of the user.

Citation Metadata

Citation metadata is the “raw data” associated with the requested item. It is pulled from a record in a discovery tool and inserted into the appropriate fields in a ReShare OpenURL.

Catalog Record

In ReShare applications using mod-inventory, the catalog record identifies the unique record in the ReShare Shared Inventory that represents the requested item. Clicking “view record” will link you to that record. Note that a valid login for the shared inventory tenant is required.

In ReShare applications using Reservoir, request displays do not include a “Catalog Record”. Use the “View in Shared Index” link on the Flow page to view the record in the shared catalog.

When shared inventory metadata is used with a discovery tool, a universally unique ID for each record is included in the OpenURL that is used to generate a request. This ID is passed back to ReShare as part of a request, allowing an exact match to be made to the shared inventory.


The suppliers section lists the potential suppliers for a request in the order they will be contacted. This list of suppliers is often known as a lending string or rota. The list of suppliers is determined by querying the shared inventory to determine which libraries hold the item, then applying load balancing algorithms to determine the sequence of lenders.

Audit Trail

The audit trail provides a time and date stamped list of state changes that have occurred for the request. In some cases, the audit trail may also provide more detailed information about errors or exceptions that occur as a request is processed.








Operated as a Community Resource by the Open Library Foundation