Versions Compared

Key

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

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

...

loan ID /id) Loan IDLoan policy name (/name)Provides a description for the type of loan policy for the item that was claimed returned
Folio Attribute (Module/Path:Object)Folio Data Element DescriptionParameters/Query

Table name: (mod-circulation-storage/requestsrequest-storage/requests



Request ID (mod-circulation-storage/requests-storage/requests/ID)

Request type (mod-circulation-storage/requests-storage/requests/requestType)

Request date (mod-circulation-storage/requests-storage/requests/requestDate)Requester ID (mod-circulation-storage/requests-storage/requests/requesterID)Proxy user ID (mod-circulation-storage/requests-storage/requests/proxyUserID)

Item ID (mod-circulation-storage/requests-storage/requests/itemID)
Provides a join between mod-circulation-storage/requests-storage/requests and mod-inventory-storage/item-storage/items and
Status of the request (mod-circulation-storage/requests-storage/requests/status)

Item barcode (mod-circulation-storage/requests-storage/requests/barcode)

Fulfillment preference (mod-circulation-storage/requests-storage/requests/fulfilmentPreference)

Delivery address type ID (mod-circulation-storage/requests-storage/requests/deliveryAddressTypeID)

Pickup service point ID (mod-circulation-storage/requests-storage/requests/pickupServicePointID)

Requester ID (mod-circulation-storage/requests-storage/requests/requesterID)

Proxy user ID (mod-circulation-storage/requests-storage/requests/proxyUserID)























































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/requests-storage/requests
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

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

ID of the material type

Needed for item search/replacement

Table name: (mod-circulation-storage/loan-storage/loans
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
(mod-circulation-storage/loan-storage/loansNeeded 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 itemWhere item status  = 'Claimed returned'. This data element provides the main filter point for this report.
loan policy ID (mod-circulation-storage/loan-storage/loans/loanPolicyID)ID of the last policy used in relation to this loanProvides 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 returnedProvides 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 IDProvides a join between mod-circulation-storage/loan-storage/loans  and mod-circulation-storage/loan-policy-storage/loan-policies
mod-circulation-storage/loan-policy-storage/loan-policiesdescription of the loan policy, e.g., one hour loan, three week loan, etc.







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

This provides the main location filter  for this report.
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: mod-users/users

User id (mod-users/users/id)The ID of the user whose loan is claimed as returnedProvides a join between mod-circulation-storage/loan-storage/loans and mod-user/users
User patron group ID (mod-users/users/patronGroup)Patron group id of the userUser (patron) group id, to identify patron group name from groups table (e.g., grad student, faculty, staff, etc.)
User Proxy user ID?

Table name: mod-users/groups

User patron group ID (mod-users/groups/id)Patron group id of the userProvides a join between mod-users/groups and mod-user/users
User patron group name (mod-users/groups/name)Patron group name of the userType of patron (user), e.g., grad student, faculty, staff, etc.
Proxy user group name?

...