About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

VuFind Documentation

Site Tools

You are here: start » development » plugins » ils_drivers
Trace:
Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:plugins:ils_drivers

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
development:plugins:ils_drivers [2021/11/12 17:52] – [getMyHolds] demiankatzdevelopment:plugins:ils_drivers [2023/03/07 13:05] – [getMyHolds] demiankatz
Line 376: Line 376:
 | oclc             | string             | No               | 2.3              | OCLC number for use in cover image loading | | oclc             | string             | No               | 2.3              | OCLC number for use in cover image loading |
 | upc              | string             | No               | 2.3              | UPC for use in cover image loading | | upc              | string             | No               | 2.3              | UPC for use in cover image loading |
 +| proxiedBy        | string             | No               | 9.0              | Display name of user that placed the request (if different from the current user) | 
 +| proxiedFor       | string             | No               | 9.0              | Display name of user for whom the request was placed (if different from the current user) |
 ==== getMyILLRequests ==== ==== getMyILLRequests ====
 This method queries the ILS for a patron's current ILL requests. (optional) // Not supported prior to VuFind 2.3 //  This method queries the ILS for a patron's current ILL requests. (optional) // Not supported prior to VuFind 2.3 // 
Line 417: Line 418:
     * mobile_phone (added in VuFind 5.0)     * mobile_phone (added in VuFind 5.0)
     * group -- i.e. Student, Staff, Faculty, etc.     * group -- i.e. Student, Staff, Faculty, etc.
-    * expiration_date -- account expiration date (added in VuFind 4.1)+    * expiration_date -- account expiration date (in display format, added in VuFind 4.1) 
 +    * birthdate (Y-m-d or an empty string, added in VuFind 9.0)
  
 ==== getMyStorageRetrievalRequests ==== ==== getMyStorageRetrievalRequests ====
Line 476: Line 478:
 This method queries the ILS for a patron's current checked out items This method queries the ILS for a patron's current checked out items
   * Starting with VuFind 5.1, getConfig may return the following keys if the service supports paging on the ILS side:   * Starting with VuFind 5.1, getConfig may return the following keys if the service supports paging on the ILS side:
-    * max_results - Maximum number of results that can be requested at once. Overrides the config.ini Catalog section setting historic_loan_page_size.+    * max_results - Maximum number of results that can be requested at once. Overrides the config.ini Catalog section setting checked_out_page_size.
     * page_size - An array of allowed page sizes (number of records per page)     * page_size - An array of allowed page sizes (number of records per page)
     * default_page_size - Default number of records per page     * default_page_size - Default number of records per page
Line 537: Line 539:
 | locationID       | string             | Yes              |                  | A pick up location id or code | | locationID       | string             | Yes              |                  | A pick up location id or code |
 | locationDisplay  | string             | Yes              |                  | The text to display for the location | | locationDisplay  | string             | Yes              |                  | The text to display for the location |
 +
 +==== getProxiedUsers ====
 +
 +This method returns a list of users for which the provided user can place proxy requests. // This method was added in VuFind 9.0. //
 +
 +  * Input: Patron array returned by patronLogin method
 +  * Output: Associative array of user ID => user display name
  
 ==== getPurchaseHistory ==== ==== getPurchaseHistory ====
Line 738: Line 747:
 See [[videos:ils_drivers_1|ILS Drivers, Part 1]] for further discussion of ILS drivers. See [[videos:ils_drivers_1|ILS Drivers, Part 1]] for further discussion of ILS drivers.
 ---- struct data ---- ---- struct data ----
 +properties.Page Owner : 
 ---- ----
  
development/plugins/ils_drivers.txt · Last modified: 2024/06/25 13:35 by demiankatz