/
RA-Collections Recalls Cluster Prototype - in review

RA-Collections Recalls Cluster Prototype - in review

API reference documentation for all modules located at:  https://dev.folio.org/reference/api/


*This report provides a count of recalls by borrower type and patron category (who received recalls and not who placed them), by date range (academic quarter or semester).


Report Description Detail

  • This report is modeled on UXPROD-2017, a cluster of Resource Access reports currently consisting of a single report (REP-202) on recalls by borrower type, that is run annually, or as needed.

Data fields

  • Date range, borrower type (patron group of borrower who received the recall request), item type (this is not requested in the report, but might be useful to include),

Report Criteria

  • Within a specified date range, provides a count of items that have been recalled by borrower type.

Filters

  • Date range.



Folio Attribute (Module/Path:Object)Folio Data Element DescriptionParameters/Query
Table name: mod-circulation-storage/request-storage-requests

(mod-circulation-storage/request-storage/requests/itemId)ID of the item being recalledProvides a join between mod-circulation-storage/requests-storage/requests and mod-circulation-storage/loan-storage/loans.
Request id (mod-circulation-storage/request-storage/requests/id)The ID of the recall requestNeeded to count the number of unique recall requests.
(mod-circulation-storage/request-storage/requests/requestType)Type of request (whether the item has been recalled, paged for, should be held upon return, etc.)Needed to filter by type of request (where type = recall). This data element provides a filter point for this report.
(mod-circulation-storage/request-storage/requests/requestDate)Date the request was madeThis data element provides a filter point for this report (where requestDate between [start] and [end]).
(mod-circulation-storage/request-storage/requests/requesterId)ID of the patron making the recall requestProvides a join between mod-circulation-storage/requests-storage/requests and mod-users/users (in case there is a need to pull in the patron group of the requester)
Table name: (mod-circulation-storage/loan-storage/loans

Item ID (mod-circulation-storage/loan-storage/loans/itemId)
The ID of the item (being recalled)
Provides a join between mod-circulation-storage/loan-storage/loans and <