About Features Downloads Getting Started Documentation Events Support GitHub

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

Site Tools


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 revisionBoth sides next revision
development:plugins:ils_drivers [2021/06/16 11:24] – [getCancelHoldDetails] demiankatzdevelopment:plugins:ils_drivers [2021/06/16 11:49] – [getPickUpLocations] emaijala
Line 513: Line 513:
 This method returns a list of locations where a user may collect a hold. (optional) // Not supported prior to VuFind 1.2 // This method returns a list of locations where a user may collect a hold. (optional) // Not supported prior to VuFind 1.2 //
  
-  * Input: Patron array returned by patronLogin method (optional), hold information array similar to placeHold's input (optionalprovided only when user is in the process of placing a hold -- may be used to limit the available pickup options based on item ID, etc.; must never add new options to the return array -- may only be used as a limiter; not supported prior to VuFind 1.3) +Input:  
-  Output: Array of associative arrays containing these keys+ 
-    locationID A pick up location id or code (string) +^ Parameter        ^ Type               ^ Always Provided  ^ Minimum Version  ^ Description ^ 
-    locationDisplay – The text to display for the location (string)+| patron           array              | No                                | Patron information from patronLogin 
 +| holdDetails      | array              | No               | 1.3              | When in the process of placing a hold, an array similar to placeHold's input. When editing a hold, the hold information returned by getMyHolds. May be used to limit the available pickup options based on item ID, etc.; must never add new options to the return array -- may only be used as a limiter. 
 + 
 +Output: An array of associative arrrays with the following fields
 + 
 +^ Key              ^ Type               ^ Required         ^ Minimum Version  ^ Description ^ 
 +locationID       | string             | Yes              |                  | A pick up location id or code | 
 +locationDisplay  | string             | Yes              |                  | The text to display for the location |
  
 ==== getPurchaseHistory ==== ==== getPurchaseHistory ====
development/plugins/ils_drivers.txt · Last modified: 2023/11/28 19:33 by demiankatz