About Features Downloads Getting Started Documentation Events Support GitHub

Site Tools


development:plugins:ils_drivers

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
development:plugins:ils_drivers [2020/03/11 15:32]
demiankatz [getHolding]
development:plugins:ils_drivers [2020/03/18 14:31] (current)
demiankatz [getHolding]
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).   * 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     * id - the RecordID that was passed in
     * availability - boolean: is the item available (i.e. on the shelf and/or available for checkout)?     * availability - boolean: is the item available (i.e. on the shelf and/or available for checkout)?
development/plugins/ils_drivers.txt · Last modified: 2020/03/18 14:31 by demiankatz