Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
development:plugins:ils_drivers [2023/06/01 17:28] – [getHolding] emaijala | development:plugins:ils_drivers [2023/06/02 10:13] – [getHolding] emaijala |
---|
^ Key ^ Type ^ Required ^ Minimum Version ^ Description ^ | ^ Key ^ Type ^ Required ^ Minimum Version ^ Description ^ |
| id | string | yes | | the RecordID that was passed in | | | id | string | yes | | the RecordID that was passed in | |
| availability | boolean/int | yes | | is the item available (i.e. on the shelf and/or available for checkout)? See below for further information. | | | availability | boolean/int | yes | * / 9.1 | is the item available (i.e. on the shelf and/or available for checkout)? See below for further information. | |
| status | string | yes | | description of the availability status of the item | | | status | string | yes | | description of the availability status of the item | |
| 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. | | | 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. | |
* false - Item is unavailable, and the ''status'' field is used for display | * false - Item is unavailable, and the ''status'' field is used for display |
| |
Starting with VuFind 9.1, also the following constants from ''\VuFind\ILS\Connection'' class can be used, and the ''status'' field is always used for display: | Starting with VuFind 9.1, also the following constants from ''\VuFind\ILS\Logic\ItemStatus'' class can be used, and the ''status'' field is always used for display: |
* ITEM_STATUS_UNAVAILABLE - Item is unavailable | * STATUS_UNAVAILABLE - Item is unavailable |
* ITEM_STATUS_AVAILABLE - Item is available | * STATUS_AVAILABLE - Item is available |
* ITEM_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 ==== | ==== getHoldings -- DEPRECATED ==== |
^ Key ^ Type ^ Required ^ Minimum Version ^ Description ^ | ^ Key ^ Type ^ Required ^ Minimum Version ^ Description ^ |
| id | string | yes | | The bibliographic record ID (same as input) | | | id | string | yes | | The bibliographic record ID (same as input) | |
| availability | boolean | yes | | is the item available (i.e. on the shelf and/or available for checkout)? | | | availability | boolean/int | yes | * / 9.1 | Is the item available (i.e. on the shelf and/or available for checkout)? See the description in getHolding for further information. | |
| status | string | yes | | description of the availability status of the item | | | status | string | yes | | description of the availability status of the item | |
| 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. | | | 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. | |