Koha Item

A catalog item record from the Taylor's Library Koha REST API.

EducationHigher EducationUniversityLibraryInstitutional RepositoryOpen DataMalaysiaAsia

Properties

Name	Type	Description
item_id	integer	Internal item identifier
biblio_id	integer	Internal identifier for the parent bibliographic record
external_id	stringnull	The item's barcode
callnumber	stringnull	Call number for this item
home_library_id	stringnull	Library the item belongs to
holding_library_id	stringnull	Library currently in possession of the item
item_type_id	stringnull	Itemtype defining the type for this item
collection_code	stringnull	Authorized value for the collection code
location	stringnull	Authorized value for the shelving location
permanent_location	stringnull	The permanent shelving location
copy_number	stringnull	Copy number
inventory_number	stringnull	Inventory number
acquisition_date	stringnull	The date the item was acquired
replacement_price	numbernull	Cost to replace the item
purchase_price	numbernull	Purchase price
public_notes	stringnull	Public notes on this item
internal_notes	stringnull	Non-public notes on this item
checkouts_count	integernull	Number of times this item has been checked out
holds_count	integernull	Number of times this item has been placed on hold
renewals_count	integernull	Number of times this item has been renewed
not_for_loan_status	integer	Authorized value defining why this item is not for loan
last_seen_date	stringnull	The date the item barcode was last scanned
uri	stringnull	URL for the item
timestamp	string	Date and time this item was last altered

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/taylors/main/json-schema/taylors-item-schema.json",
  "title": "Koha Item",
  "description": "A catalog item record from the Taylor's Library Koha REST API.",
  "type": "object",
  "additionalProperties": false,
  "required": ["biblio_id"],
  "properties": {
    "item_id": { "type": "integer", "description": "Internal item identifier" },
    "biblio_id": { "type": "integer", "description": "Internal identifier for the parent bibliographic record" },
    "external_id": { "type": ["string", "null"], "maxLength": 20, "description": "The item's barcode" },
    "callnumber": { "type": ["string", "null"], "maxLength": 255, "description": "Call number for this item" },
    "home_library_id": { "type": ["string", "null"], "maxLength": 10, "description": "Library the item belongs to" },
    "holding_library_id": { "type": ["string", "null"], "maxLength": 10, "description": "Library currently in possession of the item" },
    "item_type_id": { "type": ["string", "null"], "maxLength": 10, "description": "Itemtype defining the type for this item" },
    "collection_code": { "type": ["string", "null"], "maxLength": 80, "description": "Authorized value for the collection code" },
    "location": { "type": ["string", "null"], "maxLength": 80, "description": "Authorized value for the shelving location" },
    "permanent_location": { "type": ["string", "null"], "maxLength": 80, "description": "The permanent shelving location" },
    "copy_number": { "type": ["string", "null"], "maxLength": 32, "description": "Copy number" },
    "inventory_number": { "type": ["string", "null"], "maxLength": 80, "description": "Inventory number" },
    "acquisition_date": { "type": ["string", "null"], "format": "date", "description": "The date the item was acquired" },
    "replacement_price": { "type": ["number", "null"], "description": "Cost to replace the item" },
    "purchase_price": { "type": ["number", "null"], "description": "Purchase price" },
    "public_notes": { "type": ["string", "null"], "description": "Public notes on this item" },
    "internal_notes": { "type": ["string", "null"], "description": "Non-public notes on this item" },
    "checkouts_count": { "type": ["integer", "null"], "description": "Number of times this item has been checked out" },
    "holds_count": { "type": ["integer", "null"], "description": "Number of times this item has been placed on hold" },
    "renewals_count": { "type": ["integer", "null"], "description": "Number of times this item has been renewed" },
    "not_for_loan_status": { "type": "integer", "description": "Authorized value defining why this item is not for loan" },
    "last_seen_date": { "type": ["string", "null"], "format": "date-time", "description": "The date the item barcode was last scanned" },
    "uri": { "type": ["string", "null"], "description": "URL for the item" },
    "timestamp": { "type": "string", "format": "date-time", "description": "Date and time this item was last altered" }
  }
}