| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| development:plugins:ils_drivers [2023/09/19 16:06] – [getHolding] demiankatz | development:plugins:ils_drivers [2024/04/12 13:05] (current) – [getMyProfile] demiankatz |
|---|
| ====== 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®. VuFind® supports many platforms, so check to see if it already has support before you try to write your own! | This page contains details on writing a custom driver for an integrated library system not already supported by VuFind®. VuFind® supports many platforms, so check to see if it already has support before you try to write your own! |
| | barcode | string | yes | | the barcode number for this item (important: even if you do not have access to real barcode numbers, you may want to include dummy values, since a missing barcode will prevent some other item information from displaying in the VuFind® interface). | | | barcode | string | yes | | the barcode number for this item (important: even if you do not have access to real barcode numbers, you may want to include dummy values, since a missing barcode will prevent some other item information from displaying in the VuFind® interface). | |
| | notes | string[] | no | :!: deprecated in 3.0| an array of notes associated with holdings | | | notes | string[] | no | :!: deprecated in 3.0| an array of notes associated with holdings | |
| | holding_id | string | no | | the ID of the holdings record containing the current item | | | holdings_id | string | no | | the ID of the holdings record containing the current item | |
| | holdings_notes | string[] | no | 3.0 | an array of notes associated with holdings record containing the current item | | | holdings_notes | string[] | no | 3.0 | an array of notes associated with holdings record containing the current item | |
| | item_notes | string[] | no | 3.0 | an array of notes associated with the current item | | | item_notes | string[] | no | 3.0 | an array of notes associated with the current item | |
| | use_unknown_message | bool | no | | when set to true, will cause display of a message indicating that the status of the item is unknown. | | | use_unknown_message | bool | no | | when set to true, will cause display of a message indicating that the status of the item is unknown. | |
| | services | string[] | no | 3.0 | this value can be used to indicate availability services (loan, presence). For now, 'services' is only used by code calling getStatus(), not getHolding(), but setting it here as well will not hurt anything and may be useful for future enhancements. See the [[#getstatus|getStatus()]] documentation for more details. | | | services | string[] | no | 3.0 | this value can be used to indicate availability services (loan, presence). For now, 'services' is only used by code calling getStatus(), not getHolding(), but setting it here as well will not hurt anything and may be useful for future enhancements. See the [[#getstatus|getStatus()]] documentation for more details. | |
| | | boundWithRecords | array | no | 10.0 | an array of arrays, where each instance defines bibId and title keys describing a "bound-with" record associated with the current record; title keys may be null if title information is unavailable | |
| The ''availability'' field may contain a boolean value: | The ''availability'' field may contain a boolean value: |
| * true - Item is available, and 'Available' is displayed as status | * true - Item is available, and 'Available' is displayed as status |
| * STATUS_AVAILABLE - Item is available | * STATUS_AVAILABLE - Item is available |
| * STATUS_UNCERTAIN - Item availability is uncertain (the item could be available e.g. only to a specific patron group) | * STATUS_UNCERTAIN - Item availability is uncertain (the item could be available e.g. only to a specific patron group) |
| |
| ==== 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. The indexing of this array does not necessarily correspond with the input index values; to find a specific record, you should loop through and check "id" values. | |
| |
| |
| ==== getMyFines ==== | ==== getMyFines ==== |
| This method queries the ILS for a patron's current fines | This method queries the ILS for a patron's current fines |
| * 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: | Input: Patron array returned by patronLogin method |
| * amount - The total amount of the fine IN PENNIES. Be sure to adjust decimal points appropriately (i.e. for a $1.00 fine, amount should be set to 100). | |
| * checkout - A string representing the date when the item was checked out. | Output: Returns an array of associative arrays, one for each fine associated with the specified account. Each associative array contains these keys: |
| * fine - A string describing the reason for the fine (i.e. "Overdue", "Long Overdue"). | |
| * balance - The unpaid portion of the fine IN PENNIES. | ^ Key ^ Type ^ Required ^ Minimum Version ^ Description ^ |
| * createdate – A string representing the date when the fine was accrued (optional) | | amount | int | No | | The total amount of the fine IN PENNIES. Be sure to adjust decimal points appropriately (i.e. for a $1.00 fine, amount should be set to 100) | |
| * duedate - A string representing the date when the item was due. | | checkout | string | No | | A string representing the date when the item was checked out | |
| * id - The bibliographic ID of the record involved in the fine. | | fine | string | No | | A string describing the reason for the fine (i.e. "Overdue", "Long Overdue") | |
| * source - The search backend from which the record may be retrieved (optional - defaults to Solr). // Introduced in VuFind® 2.4. // | | description | string | No | 10.0 | A string with textual description for the fine (e.g. manual fine reason) | |
| | | balance | int | No | | The unpaid portion of the fine IN PENNIES | |
| | | createdate | string | No | | A string representing the date when the fine was accrued (optional) | |
| | | duedate | string | No | | A string representing the date when the item was due | |
| | | id | string | No | | The bibliographic ID of the record involved in the fine | |
| | | source | string | No | 2.4 | The search backend from which the record may be retrieved (defaults to Solr) | |
| |
| ==== getMyHolds ==== | ==== getMyHolds ==== |
| * 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) |
| |
