Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
development:plugins:ils_drivers [2023/05/02 06:17] – 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 | 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 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 | |
| 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. | |
| |
| The ''availability'' field may contain a boolean value: |
| * true - Item is available, and 'Available' is displayed as status |
| * false - Item is unavailable, and the ''status'' field is 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: |
| * STATUS_UNAVAILABLE - Item is unavailable |
| * STATUS_AVAILABLE - Item is available |
| * 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. | |