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 revisionNext revisionBoth sides next revision | ||
development:plugins:ils_drivers [2023/03/07 13:09] – demiankatz | development:plugins:ils_drivers [2023/06/02 10:13] – [getHolding] emaijala | ||
---|---|---|---|
Line 262: | Line 262: | ||
^ Key ^ Type ^ Required | ^ Key ^ Type ^ Required | ||
| id | string | | id | string | ||
- | | availability | + | | availability |
| status | | status | ||
| location | | location | ||
Line 292: | Line 292: | ||
| use_unknown_message | bool | no | | use_unknown_message | bool | no | ||
| services | | services | ||
+ | |||
+ | The '' | ||
+ | * true - Item is available, and ' | ||
+ | * false - Item is unavailable, | ||
+ | |||
+ | Starting with VuFind 9.1, also the following constants from '' | ||
+ | * STATUS_UNAVAILABLE - Item is unavailable | ||
+ | * STATUS_AVAILABLE | ||
+ | * STATUS_UNCERTAIN | ||
==== getHoldings -- DEPRECATED ==== | ==== getHoldings -- DEPRECATED ==== | ||
Line 461: | Line 470: | ||
* sort - An associative array where each key is a sort key and its value is a translation key | * sort - An associative array where each key is a sort key and its value is a translation key | ||
* default_sort - Default sort key | * default_sort - Default sort key | ||
+ | * getConfig may return also the following keys with boolean true as the value if the service supports purging of all or selected entries from the history: | ||
+ | * purge_all - Supports purging of all entries | ||
+ | * purge_selected - Supports purging of selected entries | ||
* Input: Patron array returned by patronLogin method and an array of optional parameters (keys = ' | * Input: Patron array returned by patronLogin method and an array of optional parameters (keys = ' | ||
* Output: Returns an array of associative arrays containing some or all of these keys: | * Output: Returns an array of associative arrays containing some or all of these keys: | ||
Line 474: | Line 486: | ||
* borrowingLocation - checkout location | * borrowingLocation - checkout location | ||
* message - message about the transaction | * message - message about the transaction | ||
+ | * row_id - ID of the transaction history row (required if purgeTransactionHistory is enabled) | ||
==== getMyTransactions ==== | ==== getMyTransactions ==== | ||
Line 584: | Line 597: | ||
^ Key ^ Type ^ Required | ^ Key ^ Type ^ Required | ||
| id | string | | id | string | ||
- | | availability | + | | availability |
| status | | status | ||
| location | | location | ||
Line 611: | Line 624: | ||
* Output: An array of bibliographic record IDs. | * Output: An array of bibliographic record IDs. | ||
+ | |||
+ | ==== getUrlsForRecord ==== | ||
+ | This optional method (introduced in VuFind® 9.1) returns one or more ILS-specific links associated with the provided bibliographic record ID. | ||
+ | |||
+ | * Input: Bibliographic record ID | ||
+ | * Output: Link data (in the same format returned by the record driver' | ||
==== hasHoldings ==== | ==== hasHoldings ==== | ||
Line 688: | Line 707: | ||
* success – Boolean true or false | * success – Boolean true or false | ||
* sysMessage – A system supplied failure message (optional) | * sysMessage – A system supplied failure message (optional) | ||
+ | |||
+ | ==== purgeTransactionHistory ==== | ||
+ | |||
+ | // Not supported prior to VuFind® 9.1 // | ||
+ | |||
+ | This method deletes selected entries or all entries from the transaction (checkout) history. | ||
+ | |||
+ | Availability of purge options in the UI is controlled by getConfig for getMyTransactionHistory returning '' | ||
+ | |||
+ | Input: | ||
+ | |||
+ | ^ Parameter | ||
+ | | patron | ||
+ | | ids | array or null | No | ||
+ | |||
+ | Output: An associative array containing the following fields: | ||
+ | |||
+ | ^ Key ^ Type ^ Required | ||
+ | | success | ||
+ | | status | ||
+ | | sysMessage | ||
==== renewMyItems ==== | ==== renewMyItems ==== |
development/plugins/ils_drivers.txt · Last modified: 2024/06/25 13:35 by demiankatz