API reference documentation for all modules located at: https://dev.folio.org/reference/api/
*This report gives a count of patron requests placed by request type, patron group, patron status, delivery method (pick-up vs. delivery), owning location, pick-up location
Report Description Detail
- This report is modeled on UXPROD-2029, a cluster of Resource Access reports currently consisting of a single report (REP-143) on count of patron requests placed by request type, patron group, patron status, delivery method (pick-up vs. delivery), owning location, pick-up location , that is run as needed.
Data fields
- Date range, request type, patron group, patron status, delivery method (pick-up vs. delivery), owning location, pick-up location.
Report Criteria
- Within a specified date range, provides a count of patron requests placed by request type, patron group, patron status, delivery method (pick-up vs. delivery), owning location, pick-up location.
Filters
- Date range.
Report example: Requests Cluster Prototype report_ Request by Type FY20.xlsx
Voyager report example: Report for number of requests filled, by library and type of request.pdf
| Folio Attribute (Module/Path:Object) | Folio Data Element Description | Parameters/Query |
|---|---|---|
Table name: (mod-circulation-storage/requests-storage/requests | ||
| Request ID (mod-circulation-storage/requests-storage/requests/ID) | ||
| Request type (mod-circulation-storage/requests-storage/requests/requestType) | ||
| Request date (mod-circulation-storage/requests-storage/requests/requestDate) | ||
| Requester ID (mod-circulation-storage/requests-storage/requests/requesterID) | ||
| Proxy user ID (mod-circulation-storage/requests-storage/requests/proxyUserID) | ||
| Item ID (mod-circulation-storage/requests-storage/requests/itemID) | ||
| Status of the request (mod-circulation-storage/requests-storage/requests/status) | ||
| Item barcode (mod-circulation-storage/requests-storage/requests/barcode) | ||
| Fulfillment preference (mod-circulation-storage/requests-storage/requests/fulfilmentPreference) | ||
| Delivery address type ID (mod-circulation-storage/requests-storage/requests/deliveryAddressTypeID) | ||
| Pickup service point ID (mod-circulation-storage/requests-storage/requests/pickupServicePointID) | ||
| Table name: mod-inventory-storage/item-storage/items | ||
| Item ID (mod-inventory-storage/item-storage/items/ID) | The inventory ID of the item | Provides a join between mod-inventory-storage/item-storage/items and mod-circulation-storage/loan-storage/loans |
| Item holdings record ID (mod-inventory-storage/item-storage/items/holdingsRecordID) | The holdings record ID of the item | Provides a join between mod-inventory-storage/item-storage/items and mod-inventory-storage/holdings-storage/holdings |
| Item permanent location ID (mod-inventory-storage/item-storage/items/permanentLocationID) | Item's permanent location ID | Needed to pull in location name element from mod-inventory-storage/locations; provides join between mod-inventory-storage/item-storage/items and mod-inventory-storage/locations |
| Item temporary location ID (mod-inventory-storage/item-storage/items/temporaryLocationID) | Item's temporary location ID | Needed to pull in location name element from mod-inventory-storage/locations; provides join between mod-inventory-storage/item-storage/items and mod-inventory-storage/locations |
| Item temporary location ID (mod-inventory-storage/item-storage/items/effectiveLocationID) | Item's effective location | Needed to pull in location name element from mod-inventory-storage/locations; provides join between mod-inventory-storage/item-storage/items and mod-inventory-storage/locations |
| Item Barcode (mod-inventory-storage/item-storage/items/barcode) | The barcode of the item | Needed for item search/replacement |
Material Type ID (mod-inventory-storage/item-storage/items/materialTypeID) | ID of the material type | Needed for item search/replacement |
Item Call Number (mod-inventory-storage/item-storage/items/itemLevelCallNumber) | The call number of the item | Needed for item search/replacement |
Item Volume Number (mod-inventory-storage/item-storage/items/itemVolumeNumber) | Used for a multipart monograph | Needed for item search/replacement |
| Item Enumeration (mod-inventory-storage/item-storage/items/enumeration) | Item enumerator (e.g., vol. 1, No. 2, etc.) | Needed for item search/replacement |
| Item Chronology (mod-inventory-storage/item-storage/items/chronology) | Descriptive information for the dating scheme of a serial | Needed for item search/replacement |
Item Copy Number (mod-inventory-storage/item-storage/items/copyNumbers) | Item copy number (e.g., copy 1, copy 2, etc.) | Needed for item search/replacement |
Item note (mod-inventory-storage/item-storage/items/notes: description) | Notes about the item | The item notes field may contain information that could be useful for an item search. All notes associated with an item should be included. |
| Table name: mod-inventory-storage/holdings-storage/holdings | ||
| Item holdings ID (mod-inventory-storage/holdings-storage/holdings/ID) | The holdings ID of the item | Provides a join between mod-inventory-storage/holdings-storage/holdings and mod-inventory-storage/item-storage/items. |
| Item Location (mod-inventory-storage/holdings-storage/holdings/permanentLocationID) | Item's permanent holdings location ID | Needed to pull in location name element from mod-inventory-storage/locations; provides join between mod-inventory-storage/holdings-storage/holdings and mod-inventory-storage/locations |
| Item Location (mod-inventory-storage/holdings-storage/holdings/temporaryLocationID) | Item's temporary holdings location ID | Needed to pull in location name element from mod-inventory-storage/locations; provides join between mod-inventory-storage/holdings-storage/holdings and mod-inventory-storage/locations |
| Item Title (mod-inventory-storage/holdings-storage/holdings/shelvingTitle) | The title of the claimed returned item | Needed for item search/replacement |
| Instance ID (mod-inventory-storage/holdings-storage/holdings/InstanceID) | The instance ID of the item | Provides a join between mod-inventory-storage/holdings-storage/holdings and mod-inventory-storage/instance-storage/instances. |
| Table name: (mod-circulation-storage/loan-storage/loans | ||
| Item checkout location (mod-circulation-storage/loan-storage/loans/itemEffectiveLocationAtCheckOut) | Location from where item was checked out | Item checkout location, could be a location filter for this report.l |
| loan ID (mod-circulation-storage/loan-storage/loans/id) | Loan ID | Needed to count the number of unique loans, to calculate historic charges |
| Loan item status (mod-circulation-storage/loan-storage/loans/itemStatus) | Status of the loan item | Where item status = 'Claimed returned'. This data element provides the main filter point for this report. |
| claimed returned date (mod-circulation-storage/loan-storage/loans/claimedReturnedDate) | Date the item was claimed returned for this loan | This data element provides a filter point for this report (where claimedReturnedDate between [start] And [end]). |
| loan renewal count (mod-circulation-storage/loan-storage/loans/renewal count) | Number of times an item loan has been renewed | Needed to add to the count of unique loan ids to calculate historic charges |
| loan policy ID (mod-circulation-storage/loan-storage/loans/loanPolicyID) | ID of the last policy used in relation to this loan | Provides a join between mod-circulation-storage/loan-storage/loans and mod-circulation-storage/loan-policy-storage/loan-policies |
| Item ID (mod-circulation-storage/loan-storage/loans/itemId) | The UUID of the item | Provides a join point between mod-circulation-storage/loan-storage/loans and mod-inventory-storage/item-storage/items |
| User ID (mod-circulation-storage/loan-storage/loans/userId) | The ID of the user whose loan is claimed as returned | Provides a join between mod-circulation-storage/loan-storage/loans and mod-user/users; needed to connect to user table to bring in patron information |
| Table name: mod-circulation-storage/loan-policy-storage/loan-policies | ||
| Loan policy id (mod-circulation-storage/loan-policy-storage/loan-policies/id) | loan policy ID | Provides a join between mod-circulation-storage/loan-storage/loans and mod-circulation-storage/loan-policy-storage/loan-policies |
| Loan policy name (mod-circulation-storage/loan-policy-storage/loan-policies/name) | description of the loan policy, e.g., one hour loan, three week loan, etc. | Provides a description for the type of loan policy for the item that was claimed returned |
| Table name: mod-inventory-storage/instance-storage/instances | ||
| ID (mod-inventory-storage/instance-storage/instances/id) | The instance ID of the item | Provides a join between (mod-inventory-storage/instance-storage/instances and mod-inventory-storage/holdings-storage/holdings |
Date of Publication (mod-inventory-storage/instance-storage/instances/publication:dateOfPublication) | Date (year YYYY) of publication, distribution, etc. | Needed for item search/replacement |
| Item Record Date (mod-inventory-storage/instance-storage/instances/cataloguedDate) | Date item record was created (date the item first entered the system after being acquired) | Needed for item search/replacement |
| Table name: mod-inventory-storage/material-types | ||
| (mod-inventory-storage/material-types/id) | The material type ID of the item | Provides a join between mod-inventory-storage/material-types and mod-inventory-storage/item-storage/items |
| Material Type Name (mod-inventory-storage/material-types/name) | Name of the material type (e.g., book, DVD, etc.) | Needed for item search/replacement |
| Table name: mod-inventory-storage/locations | ||
| Location name (mod-inventory-storage/locations/name) | Name of location | This provides the main location filter for this report. |
| Location ID (mod-inventory-storage/locations/id) | ID of the location | Provides a join between mod-inventory-storage/locations and mod-inventory-storage/item-storage/items |
| Table name: mod-users/users | ||
| User id (mod-users/users/id) | The ID of the user whose loan is claimed as returned | Provides a join between mod-circulation-storage/loan-storage/loans and mod-user/users |
| User first name (mod-users/users/firstName) | First name of the user | User's first name |
| User middle name (mod-users/users/middleName) | Middle name of the user | User's middle name |
| User last name (mod-users/users/lastName) | Last name of the user | User's last name |
| User patron group ID (mod-users/users/patronGroup) | Patron group id of the user | User (patron) group id, to identify patron group name from groups table (e.g., grad student, faculty, staff, etc.) |
| Table name: mod-users/groups | ||
| User patron group ID (mod-users/groups/id) | Patron group id of the user | Provides a join between mod-users/groups and mod-user/users |
| User patron group name (mod-users/groups/name) | Patron group name of the user | Type of patron (user), e.g., grad student, faculty, staff, etc. |
Note: Elena OMalley suggested including the name of the staff member who applied the 'claimed returned' status, in case the person using this report wants to talk to that person about a special situation. Is there a data element for staff audit trail here, the equivalent of 'operator id' in Voyager?
An example report may look like this:
| loan_status | status_date | item_location1 | item call number | item material type | item volume number | item copy number | item notes | other item details2 | number of loans | number of renewals | loan policy name | User first name | User middle name | User last name | User email | User patron group name |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| claimed returned | 3-15-20 | Fine Arts Library | xxx | book | - | 2 | xxxx | xxx | 14 | 6 | 3 week loan | Aretha | Jill | Franklin | ajf60@univ.edu | undergrad student |
| claimed returned | 3-15-20 | Fine Arts Library | xxx | monograph | 3 | 1 | xxxx | xxx | 2 | 0 | 1 year loan | Carlos | Kid | Santana | czs92@univ.edu | graduate student |
| claimed returned | 3-10-20 | Fine Arts Library | xxx | DVD | - | 1 | xxxx | xxx | 9 | 4 | 1 year loan | Gin | Zappa | Wigmore | gcw54@univ.edu | staff |
1Item location can be temporary or permanent, or checkout point.
2Item details will include several columns of data, including item call number, bar code, material type, volume number, numeration, publication date, copy number, item notes, etc.