Page tree
Skip to end of metadata
Go to start of metadata

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

Links to PO documentation for data elements: https://docs.google.com/spreadsheets/d/1B924D2JaFUc6dqgItyKoOFdhn36lxwT6jaYmKpyk2Ws/edit#gid=1697459676


Voyager report example: https://drive.google.com/file/d/1d_7VCaav5kE39Fnw3mudWQAfbi8rD3Io/view


*Collection management decisions;

*collection transfers;

*needed by selectors in the spring.

Report Description Detail

  • This report is modeled on UXPROD-2031 (REP-135), report needed at the end of Spring semester .

Data fields

  • BibID, HoldingsID, Title, Call Number, Library Location, holdings statement, volume count, 852z notes, Circulation counts *item holding location needed for circulation counts for particular library

Report Criteria

  • Serials materials with 852$z notes with total circulation and browse counts at the end of the semester.
  • Date range, material type (serials), circulation counts, 852$z notes present.


Folio Attribute (Module/Path:Object)Folio Data Element DescriptionParameters/Query

Table name: mod-inventory-storage/item-storage/items



Item ID (mod-inventory-storage/item-storage/items/ID)The inventory ID of the itemProvides 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 itemProvides a join between mod-inventory-storage/item-storage/items and mod-inventory-storage/holdings-storage/holdings

Item Location (mod-inventory-storage/item-storage/items/permanentLocationID)

Item's permanent location ID

Needed to pull in 'name' element from mod-inventory-storage/locations, as searches for missing items are  done by specific location, and all location fields need to be included



Material Type ID (mod-inventory-storage/item-storage/items/materialTypeID)

ID of the material type

Needed for items with serials material type



Item Enumeration (mod-inventory-storage/item-storage/items/enumeration)Item enumerator (e.g., vol. 1, No. 2, etc.)Needed for circulation and browse count

Item Chronology (mod-inventory-storage/item-storage/items/chronology)Descriptive information for the dating scheme of a serialNeeded for circulation and browse count

Item Copy Number (mod-inventory-storage/item-storage/items/copyNumbers)


Item copy number (e.g., copy 1, copy 2, etc.)Needed for circulation and browse count

Table name: mod-inventory-storage/holdings-storage/holdings



Item holdings ID (mod-inventory-storage/holdings-storage/holdings/ID)The holdings ID of the itemProvides 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 'name' element from mod-inventory-storage/locations, as searches for missing items are  done by specific location, and all location fields need to be included

Item Title (mod-inventory-storage/holdings-storage/holdings/shelvingTitle)The title of the item
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.

 Holding Notes (mod-inventory-storage/holdings-storage/holdings/notes:HoldingNotesTypeIDnotes on the holdingsto view 852 $z notes

Table name: mod-inventory-storage/material-types



(mod-inventory-storage/material-types/ID)The material type ID of the itemProvides 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

For both reports, this provides a filter, as searches for missing items are  done by specific location.

Location ID (mod-inventory-storage/locations/ID)ID of the locationProvides a join between mod-inventory-storage/locations and mod-inventory-storage/item-storage/items

Table name: loan-storage/loans/loans




Loan ID (mod-circulation-storage/loan-storage/loans:id)UUID generated by a loan (identifies a specific circulation transaction)This element will be counted to generate the number of transactions (COUNT(id)). Note: want to count Loan ID for checkouts only.

Loan Date (mod-circulation-storage/loan-storage/loans:loanDate)The date an item was loaned

This data element can be used to filter the report to a date range (where loanDate Between [start] And [end]). It is also used for the date aggregation (to weeks or days/hours). Will also need to (automatically) calculate day of week from this value.

Note: this field is stored as a string but should follow a standardized datetime format (RFC3339 / ISO 8601 date and time). From Marc Johnson: "It should be relatively unlikely [to introduce an error]. Clients which interact with the storage module directly could. With the typical circulation flow it should not be possible"



Item ID (mod-circulation-storage/loan-storage/loans:itemId)Unique ID of the item lent to the patronProvides a join point between mod-circulation-storage/loan-storage/loans and mod-inventory-storage/item-storage/items. 


Notes:

/*Browse counts for this report are not available yet, will need to be added/

  • No labels