Indian Institute of Technology Kanpur · Schema

Koha Library Item

EducationHigher EducationUniversityResearchIndiaOpen AccessLibraryMetadata

Properties

Name	Type	Description
_strings	objectnull	A return claims object if one exists that's unresolved
acquisition_date	stringnull	The date the item was acquired
acquisition_source	stringnull	Information about the acquisition source (it is not really a vendor id)
biblio	object
biblio_id	integer	Internal identifier for the parent bibliographic record
bookable	boolean	Allow bookings on this item.
call_number_sort	stringnull	?
call_number_source	stringnull	Classification source used on this item
callnumber	stringnull	Call number for this item
checked_out_date	stringnull	Defines if item is checked out (NULL for not checked out, and checkout date for checked out)
checkouts_count	integernull	Number of times this item has been checked out/issued
coded_location_qualifier	stringnull	Coded location qualifier
collection_code	stringnull	Authorized value for the collection code associated with this item
copy_number	stringnull	Copy number
damaged_date	stringnull	The date and time an item was last marked as damaged, NULL if not damaged
damaged_status	integer	Authorized value defining this item as damaged
effective_item_type_id	stringnull	Effective itemtype defining the type for this item_id
effective_not_for_loan_status	integer	Authorized value defining why this item is not for not_for_loan_status
exclude_from_local_holds_priority	boolean	Exclude this item from local holds priority.
extended_subfields	stringnull	Additional 952 subfields in XML format
external_id	stringnull	The item's barcode
holding_library_id	stringnull	Library that is currently in possession item
holds_count	integernull	Number of times this item has been placed on hold/reserved
home_library_id	stringnull	Internal library id for the library the item belongs to
internal_notes	stringnull	Non-public notes on this item
inventory_number	stringnull	Inventory number
item_id	integer	Internal item identifier
item_type_id	stringnull	Itemtype defining the type for this item
last_checkout_date	stringnull	The date the item was last checked out
last_seen_date	stringnull	The date the item barcode was last scanned
location	stringnull	Authorized value for the shelving location for this item
lost_date	stringnull	The date and time an item was last marked as lost, NULL if not lost
lost_status	integer	Authorized value defining this item as lost
materials_notes	stringnull	Materials specified
new_status	stringnull	'new' value, whatever free-text information.
not_for_loan_status	integer	Authorized value defining why this item is not for loan
permanent_location	stringnull	Linked to the CART and PROC temporary locations feature, stores the permanent shelving location
public_notes	stringnull	Public notes on this item
purchase_price	numbernull	Purchase price
renewals_count	integernull	Number of times this item has been renewed
replacement_price	numbernull	Cost the library charges to replace the item (e.g. if lost)
replacement_price_date	stringnull	The date the replacement price is effective from
restricted_status	integernull	Authorized value defining use restrictions for this item
return_claim	objectnull
return_claims	array	An array of all return claims associated with this item
serial_issue_number	stringnull	serial enumeration/chronology for the item
timestamp	string	Date and time this item was last altered
uri	stringnull	URL for the item
withdrawn	integer	Authorized value defining this item as withdrawn
withdrawn_date	stringnull	The date and time an item was last marked as withdrawn, NULL if not withdrawn

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/iit-kanpur/main/json-schema/iit-kanpur-item-schema.json",
  "title": "Koha Library Item",
  "type": "object",
  "properties": {
    "_strings": {
      "description": "A return claims object if one exists that's unresolved",
      "type": [
        "object",
        "null"
      ]
    },
    "acquisition_date": {
      "description": "The date the item was acquired",
      "format": "date",
      "type": [
        "string",
        "null"
      ]
    },
    "acquisition_source": {
      "description": "Information about the acquisition source (it is not really a vendor id)",
      "type": [
        "string",
        "null"
      ]
    },
    "biblio": {},
    "biblio_id": {
      "description": "Internal identifier for the parent bibliographic record",
      "type": "integer"
    },
    "bookable": {
      "description": "Allow bookings on this item.",
      "type": "boolean"
    },
    "call_number_sort": {
      "description": "?",
      "type": [
        "string",
        "null"
      ]
    },
    "call_number_source": {
      "description": "Classification source used on this item",
      "type": [
        "string",
        "null"
      ]
    },
    "callnumber": {
      "description": "Call number for this item",
      "type": [
        "string",
        "null"
      ]
    },
    "checked_out_date": {
      "description": "Defines if item is checked out (NULL for not checked out, and checkout date for checked out)",
      "format": "date",
      "type": [
        "string",
        "null"
      ]
    },
    "checkouts_count": {
      "description": "Number of times this item has been checked out/issued",
      "type": [
        "integer",
        "null"
      ]
    },
    "coded_location_qualifier": {
      "description": "Coded location qualifier",
      "type": [
        "string",
        "null"
      ]
    },
    "collection_code": {
      "description": "Authorized value for the collection code associated with this item",
      "type": [
        "string",
        "null"
      ]
    },
    "copy_number": {
      "description": "Copy number",
      "type": [
        "string",
        "null"
      ]
    },
    "damaged_date": {
      "description": "The date and time an item was last marked as damaged, NULL if not damaged",
      "type": [
        "string",
        "null"
      ]
    },
    "damaged_status": {
      "description": "Authorized value defining this item as damaged",
      "type": "integer"
    },
    "effective_item_type_id": {
      "description": "Effective itemtype defining the type for this item_id",
      "type": [
        "string",
        "null"
      ]
    },
    "effective_not_for_loan_status": {
      "description": "Authorized value defining why this item is not for not_for_loan_status",
      "type": "integer"
    },
    "exclude_from_local_holds_priority": {
      "description": "Exclude this item from local holds priority.",
      "type": "boolean"
    },
    "extended_subfields": {
      "description": "Additional 952 subfields in XML format",
      "type": [
        "string",
        "null"
      ]
    },
    "external_id": {
      "description": "The item's barcode",
      "type": [
        "string",
        "null"
      ]
    },
    "holding_library_id": {
      "description": "Library that is currently in possession item",
      "type": [
        "string",
        "null"
      ]
    },
    "holds_count": {
      "description": "Number of times this item has been placed on hold/reserved",
      "type": [
        "integer",
        "null"
      ]
    },
    "home_library_id": {
      "description": "Internal library id for the library the item belongs to",
      "type": [
        "string",
        "null"
      ]
    },
    "internal_notes": {
      "description": "Non-public notes on this item",
      "type": [
        "string",
        "null"
      ]
    },
    "inventory_number": {
      "description": "Inventory number",
      "type": [
        "string",
        "null"
      ]
    },
    "item_id": {
      "description": "Internal item identifier",
      "type": "integer"
    },
    "item_type_id": {
      "description": "Itemtype defining the type for this item",
      "type": [
        "string",
        "null"
      ]
    },
    "last_checkout_date": {
      "description": "The date the item was last checked out",
      "format": "date",
      "type": [
        "string",
        "null"
      ]
    },
    "last_seen_date": {
      "description": "The date the item barcode was last scanned",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "location": {
      "description": "Authorized value for the shelving location for this item",
      "type": [
        "string",
        "null"
      ]
    },
    "lost_date": {
      "description": "The date and time an item was last marked as lost, NULL if not lost",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "lost_status": {
      "description": "Authorized value defining this item as lost",
      "type": "integer"
    },
    "materials_notes": {
      "description": "Materials specified",
      "type": [
        "string",
        "null"
      ]
    },
    "new_status": {
      "description": "'new' value, whatever free-text information.",
      "type": [
        "string",
        "null"
      ]
    },
    "not_for_loan_status": {
      "description": "Authorized value defining why this item is not for loan",
      "type": "integer"
    },
    "permanent_location": {
      "description": "Linked to the CART and PROC temporary locations feature, stores the permanent shelving location",
      "type": [
        "string",
        "null"
      ]
    },
    "public_notes": {
      "description": "Public notes on this item",
      "type": [
        "string",
        "null"
      ]
    },
    "purchase_price": {
      "description": "Purchase price",
      "type": [
        "number",
        "null"
      ]
    },
    "renewals_count": {
      "description": "Number of times this item has been renewed",
      "type": [
        "integer",
        "null"
      ]
    },
    "replacement_price": {
      "description": "Cost the library charges to replace the item (e.g. if lost)",
      "type": [
        "number",
        "null"
      ]
    },
    "replacement_price_date": {
      "description": "The date the replacement price is effective from",
      "format": "date",
      "type": [
        "string",
        "null"
      ]
    },
    "restricted_status": {
      "description": "Authorized value defining use restrictions for this item",
      "type": [
        "integer",
        "null"
      ]
    },
    "return_claim": {
      "type": [
        "object",
        "null"
      ]
    },
    "return_claims": {
      "description": "An array of all return claims associated with this item",
      "type": "array"
    },
    "serial_issue_number": {
      "description": "serial enumeration/chronology for the item",
      "type": [
        "string",
        "null"
      ]
    },
    "timestamp": {
      "description": "Date and time this item was last altered",
      "format": "date-time",
      "type": "string"
    },
    "uri": {
      "description": "URL for the item",
      "type": [
        "string",
        "null"
      ]
    },
    "withdrawn": {
      "description": "Authorized value defining this item as withdrawn",
      "type": "integer"
    },
    "withdrawn_date": {
      "description": "The date and time an item was last marked as withdrawn, NULL if not withdrawn",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "additionalProperties": false
}