Skip to end of banner
Go to start of banner

RA-Slips Notices Cluster Prototype- In Process

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

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


*General notice counts.

*Includes notices send by day, by type, by library or department.


Report Description Detail

  • 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 description, type, date sent, status (sent or returned due to invalid email address)

Report Criteria

  • On a specified date, provides a number of slips sent to patrons.

Filters

  • Date range, type of notices.

Data elements can be found at:

https://s3.amazonaws.com/foliodocs/api/mod-circulation-storage/p/scheduled-notice-storage.html#scheduled_notice_storage_scheduled_notices__scheduled_noticeid__get

https://s3.amazonaws.com/foliodocs/api/mod-circulation-storage/p/patron-notice-policy.html#patron_notice_policy_storage_patron_notice_policies__patronnoticepolicyid__get


Folio Attribute (Module/Path:Object)Folio Data Element DescriptionParameters/Query
Table name: /mod-notify/notify


ID (mod-notify/notify/ID)The notification ID of the noticeProvides a join between mod-inventory-storage/item-storage/items and mod-circulation-storage/loan-storage/loans
recipientId (mod-notify/notify/recipientId)
The holdings record ID of the itemProvides a join between mod-inventory-storage/item-storage/items and mod-inventory-storage/holdings-storage/holdings
text

text of the notification

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

Table name:mod-circulation-storage/scheduled-notice-storage

id (mod-circulation-storage/scheduled-notice-storage/id)The UUID of scheduled taskProvides a join between mod-inventory-storage/holdings-storage/holdings and mod-inventory-storage/item-storage/items.
LoanId (mod-circulation-storage/scheduled-notice-storage/loanId)
The UUID of related loan for loan notices


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
requestId
 (mod-circulation-storage/scheduled-notice-storage/requestID)
UUID of related request for request notices


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
feeFineActionId
 (mod-circulation-storage/scheduled-notice-storage/feeFineActionID)		The
UUID of related action for fee/fine notices
Needed for item search/replacement
Instance ID (mod-inventory-storage/holdings-storage/holdings/InstanceID)The instance ID of the itemProvides a join between mod-inventory-storage/holdings-storage/holdings and mod-inventory-storage/instance-storage/instances.
Table name: (mod-circulation-storage/scheduled-notices)

Item checkout location (mod-circulation-storage/loan-storage/loans/itemEffectiveLocationAtCheckOut)Location from where item was checked outItem checkout location, could be a location filter for this report.l
loan ID (mod-circulation-storage/loan-storage/loans/id) Loan IDNeeded to count the number of unique loans, to calculate historic charges
Table name: mod-inventory-storage/location-units

ID (mod-inventory-storage/location-units/institutions/idThe instance ID of the itemProvides a join between (mod-inventory-storage/instance-storage/instances and mod-inventory-storage/holdings-storage/holdings

ID(mod-inventory-storage/location-units/campuses/id)

Date (year YYYY) of publication, distribution, etc.Needed for item search/replacement
ID(mod-inventory-storage/location-units/libraries/id)Date item record was created (date the item first entered the system after being acquired)Needed for item search/replacement

*NOTE:Notices are available via email only for now


  • No labels