| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| development:plugins:ils_drivers [2023/06/01 17:55] – [getStatus] emaijala | development:plugins:ils_drivers [2023/09/19 16:07] – [getHolding] demiankatz |
|---|
| ^ 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. | |
| | 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 | |
| | | 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 | |
| * 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 ==== |
