Differences

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

--- development:plugins:ils_drivers [2020/03/11 15:32] – [getHolding] demiankatz
+++ development:plugins:ils_drivers [2020/06/03 15:38] – [getHolding] demiankatz
@@ Line 236: / Line 236: @@
   * Input: RecordID, output of patronLogin (so that patron-specific data may be added to the return array), additional options (beginning in release 6.0; these may include 'page', 'itemLimit' and 'offset' parameters used for result pagination).
-  * Output: Prior to release 6.0, returns an array of associative arrays, one for each item attached to the specified bibliographic record. Beginning with release 6.0, may instead return an associative array with 'total' and 'holdings' keys, where 'total' is the total number of items available in the 'holdings' array, and 'holdings' is the requested page of results, represented as associative arrays). Beginning with release 6.1, an 'electronic_holdings' key may also be included, containing records for online items not found in the regular 'holdings' array; these are highlighted at the top of the holdings display, independently from pagination, to ease access to available full content. Regardless of top-level format or whether it's a 'holding' or 'electronic_holding', each associative array representing an item holding contains these keys:
+  * Output: Prior to release 6.0, returns an array of associative arrays, one for each item attached to the specified bibliographic record. Beginning with release 6.0, may instead return an associative array with 'total' and 'holdings' keys, where 'total' is the total number of items available from the ILS, and 'holdings' is the requested page of results, represented as associative arrays). Beginning with release 6.1, an 'electronic_holdings' key may also be included, containing records for online items not found in the regular 'holdings' array; these are highlighted at the top of the holdings display, independently from pagination, to ease access to available full content. Regardless of top-level format or whether it's a 'holding' or 'electronic_holding', each associative array representing an item holding contains these keys:
     * id - the RecordID that was passed in
     * availability - boolean: is the item available (i.e. on the shelf and/or available for checkout)?
@@ Line 256: / Line 256: @@
     * supplements - an array of strings about supplements associated with holdings (optional, introduced in VuFind 2.3)
     * indexes - an array of strings about indexes associated with holdings (optional, introduced in VuFind 2.3)
-    * is_holdable – whether or not ANY user can place a hold or recall on the item – allows system administrators to determine hold behaviour (optional)
+    * is_holdable – whether or not ANY user can place a hold or recall on the item – allows system administrators to determine hold behaviour (optional; defaults to true if unset)
     * holdtype – the type of hold to be placed – of use for systems with multiple hold types such as "hold" or "recall". Prior to VuFind 4.0, a value of "block" will inform the user that they cannot place a hold on the item due to account blocks (optional); starting in 4.0, the "block" value was replaced with the separate getRequestBlocks method.
     * addLink – whether not the CURRENT user can place a hold or recall on the item – for use with drivers which can determine hold logic based on patron data; normally a boolean, but until VuFind 4.0 may be set to the special value of "block" to indicate a user permission problem (optional; starting in 4.0, use the getRequestBlocks method instead).  Starting with VuFind 1.3, you can also use the special value of "check" which will trigger an AJAX call against the checkRequestIsValid() method to allow complex link rules to be evaluated without holding up the main page load.