| Both sides previous revisionPrevious revision | Next revisionBoth sides next revision |
| development:plugins:ils_drivers [2021/06/08 16:37] – [getHolding] demiankatz | development:plugins:ils_drivers [2021/06/08 16:53] – [getStatus] demiankatz |
|---|
| * Input: Bibliographic record ID | * Input: Bibliographic record ID |
| * Output: Returns an array of associative arrays, one for each item attached to the specified bibliographic record. Each associative array contains these keys: | * Output: Returns an array of associative arrays, one for each item attached to the specified bibliographic record. Each associative array contains these keys: |
| * id - The bibliographic record ID (same as input). | |
| * status - String describing the status of the item. | ^ Key ^ Type ^ Required ^ Minimum Version ^ Description ^ |
| * location - The location of the item (string). Note: prior to VuFind 1.3, some drivers HTML entity encoded this string; that is incorrect behavior in VuFind 1.3 or later -- this should be plain text, not HTML. | | id | string | yes | | The bibliographic record ID (same as input) | |
| * reserve - Is the item on course reserve? ("Y" for yes, "N" for no). | | availability | boolean | yes | | is the item available (i.e. on the shelf and/or available for checkout)? | |
| * callnumber - The item's call number. | | status | string | yes | | description of the availability status of the item | |
| * availability - Boolean: is the item available (i.e. on the shelf and/or available for checkout)? | | location | string | yes | | description of the physical location of the item. Note: prior to VuFind 1.3, some drivers HTML entity encoded this string; that is incorrect behavior in VuFind 1.3 or later -- this should be plain text, not HTML. | |
| * use_unknown_message - An optional boolean that, when set to true, will cause display of a message indicating that the status of the item is unknown. | | reserve | string | yes | | Is the item on course reserve? ("Y" for yes, "N" for no) | |
| * services - Starting with VuFind 3.0, this optional value can be used to indicate availability services (loan, presence). When set, the value is expected to be an array of strings representing available services for the current item. These services will be displayed in the result list in order to provide more detailed availability information than simply showing binary available/unavailable status. Further display control can be achieved through CSS classes assigned to every service. For now, only the services "loan" (available to be borrowed) and "presentation" (available for use within the institution) are supported (including appropriate translation strings). See additional documentation on services [[development:architecture:real_time_availability_status#services|here]]. | | callnumber | string | yes | | the call number of this item | |
| * error - Starting with VuFind 5.0, if you set this to an error string, all other fields except id will be ignored, and the error message will be displayed to the user along with an "Item Status Unavailable" status. This is particularly useful in the [[configuration:ils:multibackend_driver|MultiBackend driver]] for dealing with partial failures, but other applications may exist. | | callnumber_prefix | string | no | 8.0 | a call number prefix (i.e. a value that sets the context of the call number, such as a material format designation, but is not part of the call number for sorting purposes, etc.) | |
| | | 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 can be used to indicate availability services (loan, presence). When set, the value is expected to be an array of strings representing available services for the current item. These services will be displayed in the result list in order to provide more detailed availability information than simply showing binary available/unavailable status. Further display control can be achieved through CSS classes assigned to every service. For now, only the services "loan" (available to be borrowed) and "presentation" (available for use within the institution) are supported (including appropriate translation strings). See additional documentation on services [[development:architecture:real_time_availability_status#services|here]]. | |
| | | error | string | no | 5.0 | If you set this to an error string, all other fields except id will be ignored, and the error message will be displayed to the user along with an "Item Status Unavailable" status. This is particularly useful in the [[configuration:ils:multibackend_driver|MultiBackend driver]] for dealing with partial failures, but other applications may exist. | |
| |
| Note: Some driver implementations add additional values beyond those listed above. However, these extra values are not used by core code and should generally be ignored. | Note: Some driver implementations add additional values beyond those listed above. However, these extra values are not used by core code and should generally be ignored. |
