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/request-storage/requests | |||
| Request ID (mod-circulation-storage/requests-storage/requests/ID) | ID of the request | ||
| Item ID (mod-circulation-storage/requests-storage/requests/itemID) | ID of the item requested | Provides a join between mod-circulation-storage/requests-storage/requests and mod-inventory-storage/item-storage/items | |
| Delivery address type ID (mod-circulation-storage/requests-storage/requests/deliveryAddressTypeID) | Provides a join between mod-circulation-storage/requests-storage/requests and mod-users/addresstTypes | ||
| Pickup service point ID (mod-circulation-storage/requests-storage/requests/pickupServicePointID) | |||
| Requester ID (mod-circulation-storage/requests-storage/requests/requesterID) | |||
| Request type (mod-circulation-storage/requests-storage/requests/requestType) | The type of request (hold, recall, etc.) | ||
| Request date (mod-circulation-storage/requests-storage/requests/requestDate) | Date the patron sent in the request | ||
| Status of the request (mod-circulation-storage/requests-storage/requests/status) | Status of the request: there are currently 8 request status values in the LPD, such as Open - Awaiting pickup, Open - Awaiting delivery", Closed - Filled, etc. | ||
| Item barcode (mod-circulation-storage/requests-storage/requests/barcode) | Barcode of the item requested | ||
| Fulfillment preference (mod-circulation-storage/requests-storage/requests/fulfilmentPreference) | How the request should be fulfilled (e.g, hold on shelf, delivery, etc.) | ||
| Table name: mod-inventory-storage/service-point/service-points | |||
| Pickup service point ID (mod-inventory-storage/service-point/service-points/ID) | |||
| Pickup service point location name (mod-inventory-storage/service-point/service-points/name) | name of pick up location | ||
| 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 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-users/addressTypes | user ID|||
| Delivery address type ID (mod-users/addressTypes/addresstype/ID) | This type of ID must match with ID where deliveries are allowed | ||
| user id | |||
| 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-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.) | |
| addressTypeID | |||
| address | |||
| Table name: mod-users/groups | |||
| User patron group ID (mod-users/groups/idID) | 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. | |
| Table name: mod-inventory-storage/locations | |||
| 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 | |
| Location name (mod-inventory-storage/locations/name) | Name of location | This provides the main location filter for this report. |
An example report may look like this:
...