Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

...

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/loanstype of notices
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/holdingsan ID of the user if needed
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/locationsText of the notices sent

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)
Table name: (patron-notice-policy)

sendoption

sendwhen

triggering even

*NOTE:Notices are available via email only for now

...