RA-Slips Notices Cluster Prototype- In Progress

RA-Slips Notices Cluster Prototype- In Progress

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

*Field "Date sent" needed, as well as linking between location table and notices-storage

*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:

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 Description

Parameters/Query

Folio Attribute (Module/Path:Object)

Folio Data Element Description

Parameters/Query

Table name: /mod-notify/notify

 

 

ID (mod-notify/notify/ID)

The notification ID of the notice

Provides type of notices

recipientId (mod-notify/notify/recipientId)

The holdings record ID of the item

Provides an ID of the user if needed

text

text of the notification

Text of the notices sent

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

 

 

id (mod-circulation-storage/scheduled-notice-storage/id)

The UUID of scheduled task

 

LoanId (mod-circulation-storage/scheduled-notice-storage/loanId)

The UUID of related loan for loan notices

 

 

requestId

 (mod-circulation-storage/scheduled-notice-storage/requestID)

UUID of related request for request notices

 

 

feeFineActionId

 (mod-circulation-storage/scheduled-notice-storage/feeFineActionID)

The

UUID of related action for fee/fine notices

 

Instance ID (mod-inventory-storage/holdings-storage/holdings/InstanceID)

The instance ID of the item

 

Table name: (mod-circulation-storage/scheduled-notices)

 

 

Item checkout location (mod-circulation-storage/loan-storage/loans/itemEffectiveLocationAtCheckOut)

Location from where item was checked out

 

loan ID (mod-circulation-storage/loan-storage/loans/id)

Loan ID

 

Table name: mod-inventory-storage/location-units

 

 

ID (mod-inventory-storage/location-units/institutions/id

The instance ID of the item

 

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

Date (year YYYY) of publication, distribution, etc.

 

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

Date item record was created (date the item first entered the system after being acquired)

 

Table name: (patron-notice-policy)

 

 

sendoption

 

 

sendwhen

 

 

triggering even

 

 

*NOTE:Notices are available via email only for now