Source:

Module: mod-inventory-storage

Interface: /holdings-storage/holdings

Attributes:

Property Name Property Type Property Description
id string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
_version integer Record version for optimistic locking
sourceId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
hrid string the human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID
holdingsTypeId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
formerIds array Previous ID(s) assigned to the holdings record
instanceId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
permanentLocationId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
temporaryLocationId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
effectiveLocationId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
electronicAccess array List of electronic access items
additionalCallNumbers array Additional Call Numbers to track the history of identifiers assigned to an item.
callNumberTypeId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
callNumberPrefix string Prefix of the call number on the holding level.
callNumber string Call Number is an identifier assigned to an item, usually printed on a label attached to the item.
callNumberSuffix string Suffix of the call number on the holding level.
shelvingTitle string Indicates the shelving form of title.
acquisitionFormat string Format of holdings record acquisition
acquisitionMethod string Method of holdings record acquisition
receiptStatus string Receipt status (e.g. pending, awaiting receipt, partially received, fully received, receipt not required, and cancelled)
administrativeNotes array Administrative notes
notes array Notes about action, copy, binding etc.
illPolicyId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
retentionPolicy string Records information regarding how long we have agreed to keep something.
digitizationPolicy string Records information regarding digitization aspects.
holdingsStatements array Holdings record statements
holdingsStatementsForIndexes array Holdings record indexes statements
holdingsStatementsForSupplements array Holdings record supplements statements
copyNumber string Item/Piece ID (usually barcode) for systems that do not use item records. Ability to designate the copy number if institution chooses to use copy numbers.
numberOfItems string Text (Number)
receivingHistory object Receiving history of holdings record
receivingHistory/displayType string Display hint. 1: Display fields separately. 2: Display fields concatenated
receivingHistory/entries array Entries of receiving history
discoverySuppress boolean records the fact that the record should not be displayed in a discovery system
statisticalCodeIds array List of statistical code IDs
tags object List of simple tags that can be added to an object
tags/tagList array List of tags
metadata object Metadata about creation and changes to records, provided by the server (client should not provide)
metadata/createdDate string Date and time when the record was created
metadata/createdByUserId string ID of the user who created the record (when available)
metadata/createdByUsername string Username of the user who created the record (when available)
metadata/updatedDate string Date and time when the record was last updated
metadata/updatedByUserId string ID of the user who last updated the record (when available)
metadata/updatedByUsername string Username of the user who last updated the record (when available)