API reference documentation for all modules located at: https://dev.folio.org/reference/api/
...
- This report is modeled on UXPROD-2032, a cluster of Resource Access reports currently consisting of a single report (REP-238) on slips notices sent to patrons by date and location, that is run as needed. Here is an example of an excising report: slip_notices_sent.PNG
Data fields
- Slip notice namedescription, type, date sent, status (sent or returned due to invalid email address)
...
| Folio Attribute (Module/Path:Object) | Folio Data Element Description | Parameters/Query | ||||
|---|---|---|---|---|---|---|
| Table name: /mod-inventory-storage/item-storage/items | Itemnotify/notify | |||||
| ID (mod-inventory-storage/item-storage/items/notify/notify/ID) | The inventory notification ID of the itemnotice | 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 | text of the notification | Material Type ID (mod-inventory-storage/item-storage/items/materialTypeID)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 | ||||
| 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 (e.g., copy 1, copy 2, etc.) | Needed for item search/replacement | 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/loansscheduled-notices) | ||||||
| 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: This report could include patron personal information such as email, which is not GDPR-compliant. This is needed to identify whether the same patron has an excessive number of 'claimed returned' on items, in which case the patron may be flagged.Notices are available via email only for now