| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| development:plugins:ils_drivers [2021/08/27 10:36] – [getConfig] emaijala | development:plugins:ils_drivers [2021/11/12 17:52] – [getMyHolds] demiankatz |
|---|
| | in_transit | string/boolean | No | | If in transit, either boolean true or a string describing the destination location; false otherwise | | | in_transit | string/boolean | No | | If in transit, either boolean true or a string describing the destination location; false otherwise | |
| | last_pickup_date | locale date string | No | 5.1 | A string representing the deadline for picking up the item; ignored unless available (above) is set to true | | | last_pickup_date | locale date string | No | 5.1 | A string representing the deadline for picking up the item; ignored unless available (above) is set to true | |
| | frozen | boolean | with frozenUntil | 8.0 | Whether the hold is temporarily suspended | | | frozen | boolean | with frozenThrough | 8.0 | Whether the hold is temporarily suspended | |
| | frozenUntil | locale date string | No | 8.0 | Last suspension date if a hold is temporarily suspended | | | frozenThrough | locale date string | No | 8.0 | Last suspension date if a hold is temporarily suspended | |
| | cancel_details | string | No | 3.1 | A cancel token, or a blank string to indicate that the hold cannot be canceled. If omitted, this will be dynamically generated using getCancelHoldDetails(). The value is passed to the cancelHolds method when a hold is canceled. You can fill this in if it is efficient to calculate the value up front; if it is an expensive calculation, you should omit the value entirely and let getCancelHoldDetails() do its job on demand (note, however, that getCancelHoldDetails is currently called for each hold unconditionally). | | | cancel_details | string | No | 3.1 | A cancel token, or a blank string to indicate that the hold cannot be canceled. If omitted, this will be dynamically generated using getCancelHoldDetails(). The value is passed to the cancelHolds method when a hold is canceled. You can fill this in if it is efficient to calculate the value up front; if it is an expensive calculation, you should omit the value entirely and let getCancelHoldDetails() do its job on demand (note, however, that getCancelHoldDetails is currently called for each hold unconditionally). | |
| | updateDetails | string | No | 8.0 | An update token, or a blank string to indicate that the hold cannot be updated. The value is passed to the updateHolds method when holds are updated. If both this and cancel_details are non-empty, the values must match. | | | updateDetails | string | No | 8.0 | An update token, or a blank string to indicate that the hold cannot be updated. The value is passed to the updateHolds method when holds are updated. If both this and cancel_details are non-empty, the values must match. | |
| * [[http://blog.library.villanova.edu/libtech/2011/06/02/expanded-ils-functionality-in-vufind/|Expanded ILS Functionality in VuFind]] -- Blog post providing an overview of how the driver's hold/recall/renewal functionality works. | * [[http://blog.library.villanova.edu/libtech/2011/06/02/expanded-ils-functionality-in-vufind/|Expanded ILS Functionality in VuFind]] -- Blog post providing an overview of how the driver's hold/recall/renewal functionality works. |
| * [[configuration:ils:troubleshooting|ILS Driver Troubleshooting]] | * [[configuration:ils:troubleshooting|ILS Driver Troubleshooting]] |
| | |
| | ===== Related Video ===== |
| | |
| | See [[videos:ils_drivers_1|ILS Drivers, Part 1]] for further discussion of ILS drivers. |
| ---- struct data ---- | ---- struct data ---- |
| ---- | ---- |
| |
