API ctiveAPI reference documentation for all modules located at: https://dev.folio.org/reference/api/
...
| Folio Attribute (Module/Path:Object) | Folio Data Element Description | Parameters/Query | |||||
|---|---|---|---|---|---|---|---|
Table name: (mod-circulation-storage/requests-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) | |||||||
| Table name: mod-inventory-storage/item-storage/items | |||||||
| Item ID (mod-inventory-storage/item-storage/items/ID) | The inventory ID of the item | Provides a join between mod-inventory-storage/item-storage/items and mod-circulation-storage/requests-storage/requests | |||||
| Item holdings record ID (mod-inventory-storage/item-storage/items/holdingsRecordID) | The holdings record ID of the item | Provides a join between mod-inventory-storage/item-storage/items and mod-inventory-storage/holdings-storage/holdings | 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 | Item's temporary 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 |
| Item temporary location ID (mod-inventory-storage/item-storage/items/effectiveLocationID) | Item's effective location | 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 | |||||
| Item Barcode (mod-inventory-storage/item-storage/items/barcode) | The barcode of the item | Needed for item search/replacement | |||||
Material Type ID (mod-inventory-storage/item-storage/items/materialTypeID) | Item Volume Number (mod-inventory-storage/item-storage/items/itemVolumeNumber)ID of the material type | Needed for item search/replacement | |||||
Item Call Number (mod-inventory-storage/item-storage/items/itemLevelCallNumber) | The call number of the item | Needed for item search/replacement | |||||
| Used for a multipart monograph | Needed for item search/replacement | ||||||
| Item Enumeration (mod-inventory-storage/item-storage/items/enumeration) | Item enumerator (e.g., vol. 1, No. 2, etc.) | Needed for item search/replacement | |||||
| Item Chronology (mod-inventory-storage/item-storage/items/chronology) | Descriptive information for the dating scheme of a serial | Needed for item search/replacement | |||||
| Item copy number (e.g., copy 1, copy 2, etc.) | Needed for item search/replacement | Notes about the item | The item notes field may contain information that could be useful for an item search. All notes associated with an item should be included. | ||||
| Table name: (mod-circulation-storage/loan-storage/loans | |||||||
| Item checkout location (mod-circulation-storage/loan-storage/loans/itemEffectiveLocationAtCheckOut) | Location from where item was checked out | Item checkout location, could be a location filter for this report.l | |||||
| loan ID (mod-circulation-storage/loan-storage/loans/id) | Loan ID | Needed 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 item | Where 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 loan | Provides 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 returned | Provides 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 ID | Provides a join between mod-circulation-storage/loan-storage/loans and mod-circulation-storage/loan-policy-storage/loan-policies | |||||
| Loan policy name (mod-circulation-storage/loan-policy-storage/loan-policies/name) | description of the loan policy, e.g., one hour loan, three week loan, etc. | Provides a description for the type of loan policy for the item that was claimed returned | |||||
| Table name: mod-inventory-storage/material-types | |||||||
| (mod-inventory-storage/material-types/id) | The material type ID of the item | Provides 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 location | Provides 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 returned | Provides 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 user | User (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 user | Provides a join between mod-users/groups and mod-user/users | |||||
| User patron group name (mod-users/groups/name) | Patron group name of the user | Type of patron (user), e.g., grad student, faculty, staff, etc. | |||||
| Proxy user group name? |
...