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.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
development:plugins:ils_drivers [2023/09/19 16:07] – [getHolding] demiankatz | development:plugins:ils_drivers [2024/04/12 13:05] (current) – [getMyProfile] demiankatz | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== ILS Drivers ====== | ====== ILS Drivers ====== | ||
- | |||
- | // This page refers to VuFind® 2.x and later; use of earlier versions is no longer recommended. // | ||
This page contains details on writing a custom driver for an integrated library system not already supported by VuFind®. | This page contains details on writing a custom driver for an integrated library system not already supported by VuFind®. | ||
Line 293: | Line 291: | ||
| use_unknown_message | bool | no | | use_unknown_message | bool | no | ||
| services | | services | ||
+ | | boundWithRecords | ||
The '' | The '' | ||
* true - Item is available, and ' | * true - Item is available, and ' | ||
Line 302: | Line 300: | ||
* STATUS_AVAILABLE | * STATUS_AVAILABLE | ||
* STATUS_UNCERTAIN | * STATUS_UNCERTAIN | ||
- | |||
- | ==== getHoldings -- DEPRECATED ==== | ||
- | This method queries the ILS for holding information on multiple records at once | ||
- | * Input: Array of RecordIDs | ||
- | * Output: Returns an array of associative arrays, each the return value of getHolding for one of the input RecordIDs. | ||
Line 344: | Line 337: | ||
==== getMyFines ==== | ==== getMyFines ==== | ||
This method queries the ILS for a patron' | This method queries the ILS for a patron' | ||
- | * Input: Patron array returned by patronLogin method | + | |
- | | + | Input: Patron array returned by patronLogin method |
- | | + | |
- | | + | Output: Returns an array of associative arrays, one for each fine associated with the specified account. Each associative array contains these keys: |
- | | + | |
- | | + | ^ Key ^ Type ^ Required |
- | | + | | amount |
- | | + | | checkout |
- | | + | | fine | string |
- | | + | | description |
+ | | balance | ||
+ | | createdate | ||
+ | | duedate | ||
+ | | id | string | ||
+ | | source | ||
==== getMyHolds ==== | ==== getMyHolds ==== | ||
Line 428: | Line 426: | ||
* 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 (in display format, added in VuFind® 4.1) | + | * expiration_date -- account expiration date (in display format, added in VuFind® 4.1; omit or set to null to exclude) |
* birthdate (Y-m-d or an empty string, added in VuFind® 9.0) | * birthdate (Y-m-d or an empty string, added in VuFind® 9.0) | ||
development/plugins/ils_drivers.1695139632.txt.gz · Last modified: 2023/09/19 16:07 by demiankatz