Differences

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

--- development:plugins:ils_drivers [2021/06/16 11:23] – [cancelHolds] demiankatz
+++ development:plugins:ils_drivers [2021/06/16 11:49] – [getPickUpLocations] emaijala
@@ Line 119: / Line 119: @@
 ==== getCancelHoldDetails ====
-This method returns a string to use as the input form value for cancelling each hold item. (optional, but required if you implement cancelHolds). // Not supported prior to VuFind 1.2 //
+This method returns a string to use as the input form value for cancelling each hold item. If determining this identifier does not require complex calculations, you can fill in the cancel_details key directly in the getMyHolds method instead of implementing this method. (optional, but required if you implement cancelHolds and do not provide cancel_details in getMyHolds). // Not supported prior to VuFind 1.2 //
   * Input:
@@ 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 //
-  * Input: Patron array returned by patronLogin method (optional), hold information array similar to placeHold's input (optional, provided 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 ====